class Transaction (View source)

A storage entity for a thumbnail creation request.

Properties

protected string $filePath
protected Image $srcImage
protected Image $errorImage
protected string $action
protected Dimensions $target
protected string|null $requestPath

Methods

__construct(Image|string $file, string $action = Action::CROP, Dimensions $dimensions = null, string|null $requestPath = null)

Transaction Constructor.

string
getHash()

Returns a hash string of this transaction.

string
getRequestPath()

Returns the request path for this thumbnail, used for saving a static file.

string
getFilePath()

Returns the filepath. Used for finding image in filesystem.

Image
getSrcImage()

No description

setSrcImage(Image $srcImage)

No description

Image
getErrorImage()

No description

setErrorImage(Image $errorImage)

No description

string
getAction()

No description

setAction(string $action)

No description

Dimensions
getTarget()

No description

setTarget(Dimensions $target)

No description

Details

__construct(Image|string $file, string $action = Action::CROP, Dimensions $dimensions = null, string|null $requestPath = null)

Transaction Constructor.

Parameters

Image|string $file
string $action
Dimensions $dimensions
string|null $requestPath

string getHash()

Returns a hash string of this transaction.

Return Value

string

string getRequestPath()

Returns the request path for this thumbnail, used for saving a static file.

Return Value

string

string getFilePath()

Returns the filepath. Used for finding image in filesystem.

Return Value

string

Image getSrcImage()

Return Value

Image

Transaction setSrcImage(Image $srcImage)

Parameters

Image $srcImage

Return Value

Transaction

Image getErrorImage()

Return Value

Image

Transaction setErrorImage(Image $errorImage)

Parameters

Image $errorImage

Return Value

Transaction

string getAction()

Return Value

string

Transaction setAction(string $action)

Parameters

string $action

Return Value

Transaction

Dimensions getTarget()

Return Value

Dimensions

Transaction setTarget(Dimensions $target)

Parameters

Dimensions $target

Return Value

Transaction