PHP Class TippingCanoe\Imager\Storage\Filesystem

Inheritance: extends Base

Show file Open project: tippingcanoe/imager

Protected Properties

Property	Type	Description
$publicPrefix	string
$root	string

Public Methods

Method	Description
delete ( Image $image, array $filters = [] )	Deletes an image.
getPublicUri ( Image $image, array $filters = [] ) : string
has ( Image $image, array $filters = [] ) : boolean \| mixed
saveFile ( File $file, Image $image, array $filters = [] )	Saves an image.
setPublicPrefix ( string $prefix )
setRoot ( $path )
tempOriginal ( Image $image ) : File	Tells the driver to prepare a copy of the original image locally.

Protected Methods

Method	Description
generateFilePath ( Image $image, array $filters = [] ) : string
getPublicPrefix ( ) : string

Method Details

delete() public method

If the image is the original, also removes all derived images.

public delete ( Image $image, array $filters = [] )
$image	TippingCanoe\Imager\Model\Image
$filters	array

generateFilePath() protected method

protected generateFilePath ( Image $image, array $filters = [] ) : string
$image	TippingCanoe\Imager\Model\Image
$filters	array
return	string

getPublicPrefix() protected method

protected getPublicPrefix ( ) : string
return	string

getPublicUri() public method

public getPublicUri ( Image $image, array $filters = [] ) : string
$image	TippingCanoe\Imager\Model\Image
$filters	array
return	string

has() public method

public has ( Image $image, array $filters = [] ) : boolean \| mixed
$image	TippingCanoe\Imager\Model\Image
$filters	array
return	boolean \| mixed

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

setPublicPrefix() public method

public setPublicPrefix ( string $prefix )
$prefix	string

setRoot() public method

public setRoot ( $path )
$path

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

$publicPrefix protected property

protected string $publicPrefix
return	string

$root protected property

protected string $root
return	string