PHP Class TippingCanoe\Imager\Storage\S3

Inheritance: extends Base
Mostra file Open project: tippingcanoe/imager

Protected Properties

Property Type Description
$awsBucket string
$s3 Aws\S3\S3Client

Public Methods

Method Description
__construct ( S3Client $s3Client )
delete ( Image $image, array $filters = [] ) Tells the driver to delete an image.
getPublicUri ( Image $image, array $filters = [] ) : string Returns the public URI for an image by a specific configuration.
has ( Image $image, array $filters = [] ) : boolean Asks the driver if it has a particular image.
saveFile ( File $file, Image $image, array $filters = [] ) Saves an image.
setBucket ( string $bucket )
tempOriginal ( Image $image ) : File Tells the driver to prepare a copy of the original image locally.

Method Details

__construct() public method

public __construct ( S3Client $s3Client )
$s3Client Aws\S3\S3Client

delete() public method

Deleting must at least ensure that afterwards, any call to has() returns false.
public delete ( Image $image, array $filters = [] )
$image TippingCanoe\Imager\Model\Image
$filters array

getPublicUri() public method

Returns the public URI for an image by a specific configuration.
public getPublicUri ( Image $image, array $filters = [] ) : string
$image TippingCanoe\Imager\Model\Image
$filters array
return string

has() public method

Asks the driver if it has a particular image.
public has ( Image $image, array $filters = [] ) : boolean
$image TippingCanoe\Imager\Model\Image
$filters array
return boolean

saveFile() public method

Exceptions can provide extended error information and will abort the save process.
public saveFile ( File $file, Image $image, array $filters = [] )
$file Symfony\Component\HttpFoundation\File\File
$image TippingCanoe\Imager\Model\Image
$filters array

setBucket() public method

public setBucket ( string $bucket )
$bucket string

tempOriginal() public method

Tells the driver to prepare a copy of the original image locally.
public tempOriginal ( Image $image ) : File
$image TippingCanoe\Imager\Model\Image
return Symfony\Component\HttpFoundation\File\File

Property Details

$awsBucket protected_oe property

protected string $awsBucket
return string

$s3 protected_oe property

protected S3Client,Aws\S3 $s3
return Aws\S3\S3Client