ImageEditorTransformerInterface

Type

Interface

Namespace

craft\base\imagetransforms

Implemented by

craft\imagetransforms\ImageTransformer

Since

4.0.0

ImageEditorTransformerInterface defines the common interface to be implemented by image drivers that support the Image Editor

View source

Public Methods

Method	Description
cancelImageEditing()	Aborts the image editing process and returns the location of a temporary file that was created.
crop()	Crops the image.
finishImageEditing()	Completes an image editing process and returns the file location of the resulting image;
flipImage()	Flips the image.
getEditedImageHeight()	Returns the current height of the edited image.
getEditedImageWidth()	Returns the current width of the edited image.
rotateImage()	Rotates the image.
scaleImage()	Scales the image.
startImageEditing()	Begins an image editing process.

cancelImageEditing()

Aborts the image editing process and returns the location of a temporary file that was created.

View source

Returns

string

crop()

Crops the image.

View source

Arguments

• $x (integer)
• $y (integer)
• $width (integer)
• $height (integer)

finishImageEditing()

Completes an image editing process and returns the file location of the resulting image;

View source

Returns

string

flipImage()

Flips the image.

View source

Arguments

• $flipX (boolean)
• $flipY (boolean)

getEditedImageHeight()

Returns the current height of the edited image.

View source

Returns

integer – $height

getEditedImageWidth()

Returns the current width of the edited image.

View source

Returns

integer – $width

rotateImage()

Rotates the image.

View source

Arguments

• $degrees (float)

scaleImage()

Scales the image.

View source

Arguments

• $width (integer)
• $height (integer)

startImageEditing()

Begins an image editing process.

View source

Arguments

• $asset (craft\elements\Asset)