Skip to content

ImageTransformer

Type
Class
Namespace
craft\imagetransforms
Inherits
craft\imagetransforms\ImageTransformer » craft\base\Component » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
Implements
ArrayAccess, IteratorAggregate, craft\base\ComponentInterface, craft\base\ModelInterface, craft\base\imagetransforms\EagerImageTransformerInterface, craft\base\imagetransforms\ImageEditorTransformerInterface, craft\base\imagetransforms\ImageTransformerInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
Uses traits
craft\base\ClonefixTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Since
4.0.0

ImageTransformer transforms image assets using GD or ImageMagick.

View source

Public Properties

PropertyDescription
activeValidatorsyii\validators\Validator – The validators applicable to the current scenario.
attributesarray – Attribute values (name => value).
behaviorsyii\base\Behavior – List of behaviors attached to this component.
editedImageHeightinteger
editedImageWidthinteger
errorsarray – Errors for all attributes or the specified attribute.
firstErrorsarray – The first errors.
iteratorArrayIterator – An iterator for traversing the items in the list.
pendingTransformIndexIdsarray
scenariostring – The scenario that this model is in.
validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.

editedImageHeight

Type
integer
Default value
null

View source

editedImageWidth

Type
integer
Default value
null

View source

pendingTransformIndexIds

Type
array
Default value
null

View source

Protected Properties

PropertyDescription
eagerLoadedTransformIndexescraft\models\ImageTransformIndex[]
imageEditorDataarray

eagerLoadedTransformIndexes

Type
craft\models\ImageTransformIndex[]
Default value
[]

View source

imageEditorData

Type
array
Default value
[]

View source

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()This method is called after the object is created by cloning an existing one.
__construct()
__get()Returns the value of a component property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets the value of a component property.
__unset()Sets a component property to be null.
activeAttributes()Returns the attribute names that are subject to validation in the current scenario.
addError()Adds a new error to the specified attribute.
addErrors()Adds a list of errors.
addModelErrors()Adds errors from another model, with a given attribute name prefix.
afterValidate()This method is invoked after validation ends.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attributeHints()Returns the attribute hints.
attributeLabels()Returns the attribute labels.
attributes()Returns the list of attribute names.
beforeValidate()This method is invoked before validation starts.
behaviors()Returns a list of behaviors that this component should behave as.
canGetProperty()Returns a value indicating whether a property can be read.
canSetProperty()Returns a value indicating whether a property can be set.
cancelImageEditing()Aborts the image editing process and returns the location of a temporary file that was created.
className()Returns the fully qualified name of this class.
clearErrors()Removes errors for all attributes or a single attribute.
createValidators()Creates validator objects based on the validation rules specified in rules().
crop()Crops the image.
datetimeAttributes()Returns the names of any attributes that should hold DateTime values.
deleteImageTransformFile()
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
displayName()Returns the display name of this class.
eagerLoadTransforms()Eager-loads the given transforms for the given assets.
ensureBehaviors()Makes sure that the behaviors declared in behaviors() are attached to this component.
extraFields()Returns the list of fields that can be expanded further and returned by toArray().
fields()Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.
finishImageEditing()Completes an image editing process and returns the file location of the resulting image;
flipImage()Flips the image.
formName()Returns the form name that this model class should use.
generateAttributeLabel()Generates a user friendly attribute label based on the give attribute name.
getActiveValidators()Returns the validators applicable to the current scenario.
getAttributeHint()Returns the text hint for the specified attribute.
getAttributeLabel()Returns the text label for the specified attribute.
getAttributes()Returns attribute values.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getEditedImageHeight()Returns the current height of the edited image.
getEditedImageWidth()Returns the current width of the edited image.
getErrorSummary()Returns the errors for all attributes as a one-dimensional array.
getErrors()Returns the errors for all attributes or a single attribute.
getFirstError()Returns the first error of the specified attribute.
getFirstErrors()Returns the first error of every attribute in the model.
getIterator()Returns an iterator for traversing the attributes in the model.
getPendingTransformIndexIds()Returns a list of pending transform index IDs.
getScenario()Returns the scenario that this model is used in.
getTransformIndex()Get a transform index row. If it doesn't exist - create one.
getTransformIndexModelById()Get a transform index model by a row id.
getTransformUrl()Returns the URL for an image transform.
getValidators()Returns all the validators declared in rules().
hasErrors()Returns a value indicating whether there is any validation error.
hasEventHandlers()Returns a value indicating whether there is any handler attached to the named event.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined for this component.
init()Initializes the object.
instance()Returns static class instance, which can be used to obtain meta information.
invalidateAssetTransforms()Invalidates all transforms for an asset.
isAttributeActive()Returns a value indicating whether the attribute is active in the current scenario.
isAttributeRequired()Returns a value indicating whether the attribute is required.
isAttributeSafe()Returns a value indicating whether the attribute is safe for massive assignments.
isSelectable()Returns whether the component should be selectable in component Type selects.
load()Populates the model with input data.
loadMultiple()Populates a set of models with the data from end user.
off()Detaches an existing event handler from this component.
offsetExists()Returns whether there is an element at the specified offset.
offsetGet()Returns the element at the specified offset.
offsetSet()Sets the element at the specified offset.
offsetUnset()Sets the element value at the specified offset to null.
on()Attaches an event handler to an event.
onUnsafeAttribute()This method is invoked when an unsafe attribute is being massively assigned.
rotateImage()Rotates the image.
rules()Returns the validation rules for attributes.
safeAttributes()Returns the attribute names that are safe to be massively assigned in the current scenario.
scaleImage()Scales the image.
scenarios()Returns a list of scenarios and the corresponding active attributes.
setAttributes()Sets the attribute values in a massive way.
setScenario()Sets the scenario for the model.
startImageEditing()Begins an image editing process.
storeTransformIndexData()Store a transform index data by it's model.
toArray()Converts the model into an array.
trigger()Triggers an event.
validate()Performs the data validation.
validateMultiple()Validates multiple models.

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

deleteImageTransformFile()

View source

Arguments

Throws

eagerLoadTransforms()

Eager-loads the given transforms for the given assets.

View source

Arguments

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

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

getPendingTransformIndexIds()

Returns a list of pending transform index IDs.

View source

Returns

array

getTransformIndex()

Get a transform index row. If it doesn't exist - create one.

View source

Arguments

Returns

craft\models\ImageTransformIndex

Throws

getTransformIndexModelById()

Get a transform index model by a row id.

View source

Arguments

Returns

craft\models\ImageTransformIndex, null

getTransformUrl()

Returns the URL for an image transform.

View source

Arguments

Returns

string – The URL for the transform

Throws

invalidateAssetTransforms()

Invalidates all transforms for an asset.

View source

Arguments

rotateImage()

Rotates the image.

View source

Arguments

scaleImage()

Scales the image.

View source

Arguments

startImageEditing()

Begins an image editing process.

View source

Arguments

storeTransformIndexData()

Store a transform index data by it's model.

View source

Arguments

Returns

craft\models\ImageTransformIndex

Protected Methods

MethodDescription
defineBehaviors()Returns the behaviors to attach to this class.
defineRules()Returns the validation rules for attributes.
deleteTransformIndexDataByAssetId()Delete transform records by an Asset id
ensureTransformUrlByIndexModel()Get a transform URL by the transform index model.
extractFieldsFor()Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id".
extractRootFields()Extracts the root field names from nested fields.
generateTransformedImage()Generate the actual image for the Asset by the transform index.
getAllCreatedTransformsForAsset()Get an array of ImageTransformIndex models for all created transforms for an Asset.
getSimilarTransformIndex()Find a similar image transform for reuse for an asset and existing transform.
getTransformBasePath()Get the transform base path for a given asset.
getTransformFilename()Return the filename used by the Transform Index for the Asset.
getTransformSubfolder()Return a subfolder used by the Transform Index for the Asset.
getTransformSubpath()Returns the path to a transform, relative to the asset's folder.
getTransformUri()Returns the URI for a transform, relative to the asset's folder.
procureTransformedImage()Check if a transformed image exists. If it does not, attempt to generate it.
resolveFields()Determines which fields can be returned by toArray().
validateTransformIndexResult()Validates a transform index result to see if the index is still valid for a given asset.

deleteTransformIndexDataByAssetId()

Delete transform records by an Asset id

View source

Arguments

ensureTransformUrlByIndexModel()

DEPRECATED

Deprecated in 4.4.0. getTransformUrl() should be used instead.

Get a transform URL by the transform index model.

View source

Arguments

Returns

string

Throws

generateTransformedImage()

Generate the actual image for the Asset by the transform index.

View source

Arguments

Throws

getAllCreatedTransformsForAsset()

Get an array of ImageTransformIndex models for all created transforms for an Asset.

View source

Arguments

Returns

craft\models\ImageTransformIndex[]

getSimilarTransformIndex()

Find a similar image transform for reuse for an asset and existing transform.

View source

Arguments

Returns

craft\models\ImageTransformIndex, null

Throws

getTransformBasePath()

Get the transform base path for a given asset.

View source

Arguments

Returns

string

Throws

getTransformFilename()

Return the filename used by the Transform Index for the Asset.

View source

Arguments

Returns

string

Throws

getTransformSubfolder()

Return a subfolder used by the Transform Index for the Asset.

View source

Arguments

Returns

string

Throws

getTransformSubpath()

Returns the path to a transform, relative to the asset's folder.

View source

Arguments

Returns

string

Throws

getTransformUri()

Returns the URI for a transform, relative to the asset's folder.

View source

Arguments

Returns

string

procureTransformedImage()

DEPRECATED

Deprecated in 4.4.0. \craft\imagetransforms\generateTransform() should be used instead.

Check if a transformed image exists. If it does not, attempt to generate it.

View source

Arguments

Returns

boolean – True if transform exists for the index

Throws

validateTransformIndexResult()

Validates a transform index result to see if the index is still valid for a given asset.

View source

Arguments

Returns

boolean – Whether the index result is still valid

Constants

ConstantDescription
SCENARIO_DEFAULTThe name of the default scenario.

Events

EVENT_DELETE_TRANSFORMED_IMAGE

Type
craft\events\ImageTransformerOperationEvent

The event that is fired when a generated image transform is deleted


EVENT_TRANSFORM_IMAGE

Type
craft\events\ImageTransformerOperationEvent

The event that is fired when an image is transformed