ImageTransformer
- Type
- Class
- Namespace
- craft\imagetransforms
- Inherits
- craft\imagetransforms\ImageTransformer » craft\base\Component » craft\base\Model » yii\base\Model (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- ArrayAccess (opens new window), IteratorAggregate (opens new window), craft\base\ComponentInterface, craft\base\ModelInterface, craft\base\imagetransforms\EagerImageTransformerInterface, craft\base\imagetransforms\ImageEditorTransformerInterface, craft\base\imagetransforms\ImageTransformerInterface, yii\base\Arrayable (opens new window), yii\base\Configurable (opens new window), yii\base\StaticInstanceInterface (opens new window)
- Uses traits
- craft\base\ClonefixTrait, yii\base\ArrayableTrait (opens new window), yii\base\StaticInstanceTrait (opens new window)
- Since
- 4.0.0
ImageTransformer transforms image assets using GD or ImageMagick.
View source (opens new window)
# Public Properties
# editedImageHeight
- Type
- integer (opens new window)
- Default value
null
View source (opens new window)
# editedImageWidth
- Type
- integer (opens new window)
- Default value
null
View source (opens new window)
# pendingTransformIndexIds
- Type
- array (opens new window)
- Default value
null
View source (opens new window)
# Protected Properties
Property | Description |
---|---|
eagerLoadedTransformIndexes | craft\models\ImageTransformIndex[] |
imageEditorData | array (opens new window) |
# eagerLoadedTransformIndexes
- Type
- craft\models\ImageTransformIndex[]
- Default value
[]
View source (opens new window)
# imageEditorData
- Type
- array (opens new window)
- Default value
[]
View source (opens new window)
# Public Methods
Method | Description |
---|---|
__call() (opens new window) | Calls the named method which is not a class method. |
__clone() | |
__construct() | |
__get() (opens new window) | Returns the value of a component property. |
__isset() (opens new window) | Checks if a property is set, i.e. defined and not null. |
__set() (opens new window) | Sets the value of a component property. |
__unset() (opens new window) | Sets a component property to be null. |
activeAttributes() (opens new window) | Returns the attribute names that are subject to validation in the current scenario. |
addError() (opens new window) | Adds a new error to the specified attribute. |
addErrors() (opens new window) | Adds a list of errors. |
addModelErrors() | Adds errors from another model, with a given attribute name prefix. |
afterValidate() (opens new window) | This method is invoked after validation ends. |
attachBehavior() (opens new window) | Attaches a behavior to this component. |
attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
attributeHints() (opens new window) | Returns the attribute hints. |
attributeLabels() (opens new window) | Returns the attribute labels. |
attributes() (opens new window) | Returns the list of attribute names. |
beforeValidate() (opens new window) | This method is invoked before validation starts. |
behaviors() | Returns a list of behaviors that this component should behave as. |
canGetProperty() (opens new window) | Returns a value indicating whether a property can be read. |
canSetProperty() (opens new window) | 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() (opens new window) | Returns the fully qualified name of this class. |
clearErrors() (opens new window) | Removes errors for all attributes or a single attribute. |
createValidators() (opens new window) | Creates validator objects based on the validation rules specified in rules() (opens new window). |
crop() | Crops the image. |
datetimeAttributes() | Returns the names of any attributes that should hold DateTime (opens new window) values. |
deleteImageTransformFile() | |
detachBehavior() (opens new window) | Detaches a behavior from the component. |
detachBehaviors() (opens new window) | 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() (opens new window) | Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component. |
extraFields() (opens new window) | Returns the list of fields that can be expanded further and returned by toArray() (opens new window). |
fields() (opens new window) | Returns the list of fields that should be returned by default by toArray() (opens new window) 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() (opens new window) | Returns the form name that this model class should use. |
generateAttributeLabel() (opens new window) | Generates a user friendly attribute label based on the give attribute name. |
getActiveValidators() (opens new window) | Returns the validators applicable to the current scenario (opens new window). |
getAttributeHint() (opens new window) | Returns the text hint for the specified attribute. |
getAttributeLabel() (opens new window) | Returns the text label for the specified attribute. |
getAttributes() (opens new window) | Returns attribute values. |
getBehavior() (opens new window) | Returns the named behavior object. |
getBehaviors() (opens new window) | 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() (opens new window) | Returns the errors for all attributes as a one-dimensional array. |
getErrors() (opens new window) | Returns the errors for all attributes or a single attribute. |
getFirstError() (opens new window) | Returns the first error of the specified attribute. |
getFirstErrors() (opens new window) | Returns the first error of every attribute in the model. |
getIterator() (opens new window) | Returns an iterator for traversing the attributes in the model. |
getPendingTransformIndexIds() | Returns a list of pending transform index IDs. |
getScenario() (opens new window) | 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() (opens new window) | Returns all the validators declared in rules() (opens new window). |
hasErrors() | Returns a value indicating whether there is any validation error. |
hasEventHandlers() (opens new window) | Returns a value indicating whether there is any handler attached to the named event. |
hasMethod() (opens new window) | Returns a value indicating whether a method is defined. |
hasProperty() (opens new window) | Returns a value indicating whether a property is defined for this component. |
init() | Initializes the object. |
instance() (opens new window) | Returns static class instance, which can be used to obtain meta information. |
invalidateAssetTransforms() | Invalidates all transforms for an asset. |
isAttributeActive() (opens new window) | Returns a value indicating whether the attribute is active in the current scenario. |
isAttributeRequired() (opens new window) | Returns a value indicating whether the attribute is required. |
isAttributeSafe() (opens new window) | 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() (opens new window) | Populates the model with input data. |
loadMultiple() (opens new window) | Populates a set of models with the data from end user. |
off() (opens new window) | Detaches an existing event handler from this component. |
offsetExists() (opens new window) | Returns whether there is an element at the specified offset. |
offsetGet() (opens new window) | Returns the element at the specified offset. |
offsetSet() (opens new window) | Sets the element at the specified offset. |
offsetUnset() (opens new window) | Sets the element value at the specified offset to null. |
on() (opens new window) | Attaches an event handler to an event. |
onUnsafeAttribute() (opens new window) | This method is invoked when an unsafe attribute is being massively assigned. |
rotateImage() | Rotates the image. |
rules() | Returns the validation rules for attributes. |
safeAttributes() (opens new window) | Returns the attribute names that are safe to be massively assigned in the current scenario. |
scaleImage() | Scales the image. |
scenarios() (opens new window) | Returns a list of scenarios and the corresponding active attributes. |
setAttributes() | Sets the attribute values in a massive way. |
setScenario() (opens new window) | Sets the scenario for the model. |
startImageEditing() | Begins an image editing process. |
storeTransformIndexData() | Store a transform index data by it's model. |
toArray() (opens new window) | Converts the model into an array. |
trigger() (opens new window) | Triggers an event. |
validate() (opens new window) | Performs the data validation. |
validateMultiple() (opens new window) | Validates multiple models. |
# cancelImageEditing()
Aborts the image editing process and returns the location of a temporary file that was created.
View source (opens new window)
Returns
# crop()
Crops the image.
View source (opens new window)
Arguments
$x
(integer (opens new window))$y
(integer (opens new window))$width
(integer (opens new window))$height
(integer (opens new window))
# deleteImageTransformFile()
View source (opens new window)
Arguments
$asset
(craft\elements\Asset)$transformIndex
(craft\models\ImageTransformIndex)
Throws
# eagerLoadTransforms()
Eager-loads the given transforms for the given assets.
View source (opens new window)
Arguments
$transforms
(craft\models\ImageTransform[])$assets
(craft\elements\Asset[])
# finishImageEditing()
Completes an image editing process and returns the file location of the resulting image;
View source (opens new window)
Returns
# flipImage()
Flips the image.
View source (opens new window)
Arguments
$flipX
(boolean (opens new window))$flipY
(boolean (opens new window))
# getEditedImageHeight()
Returns the current height of the edited image.
View source (opens new window)
Returns
integer (opens new window) – $height
# getEditedImageWidth()
Returns the current width of the edited image.
View source (opens new window)
Returns
integer (opens new window) – $width
# getPendingTransformIndexIds()
Returns a list of pending transform index IDs.
View source (opens new window)
Returns
# getTransformIndex()
Get a transform index row. If it doesn't exist - create one.
View source (opens new window)
Arguments
$asset
(craft\elements\Asset)$transform
(craft\models\ImageTransform, string (opens new window), array (opens new window), null (opens new window))
Returns
craft\models\ImageTransformIndex
Throws
- craft\errors\ImageTransformException
if the transform cannot be found by the handle
# getTransformIndexModelById()
Get a transform index model by a row id.
View source (opens new window)
Arguments
$transformId
(integer (opens new window))
Returns
craft\models\ImageTransformIndex, null (opens new window)
# getTransformUrl()
Returns the URL for an image transform.
View source (opens new window)
Arguments
$asset
(craft\elements\Asset)$imageTransform
(craft\models\ImageTransform)$immediately
(boolean (opens new window)) – Whether the image should be transformed immediately
Returns
string (opens new window) – The URL for the transform
Throws
- yii\base\NotSupportedException (opens new window)
if the transformer can’t be used with the given asset. - craft\errors\ImageTransformException
if a problem occurs.
# invalidateAssetTransforms()
Invalidates all transforms for an asset.
View source (opens new window)
Arguments
$asset
(craft\elements\Asset)
# rotateImage()
Rotates the image.
View source (opens new window)
Arguments
$degrees
(float (opens new window))
# scaleImage()
Scales the image.
View source (opens new window)
Arguments
$width
(integer (opens new window))$height
(integer (opens new window))
# startImageEditing()
Begins an image editing process.
View source (opens new window)
Arguments
$asset
(craft\elements\Asset)
# storeTransformIndexData()
Store a transform index data by it's model.
View source (opens new window)
Arguments
$index
(craft\models\ImageTransformIndex)
Returns
craft\models\ImageTransformIndex
# Protected Methods
Method | Description |
---|---|
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() (opens new window) | 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() (opens new window) | 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() (opens new window) | Determines which fields can be returned by toArray() (opens new window). |
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 (opens new window)
Arguments
$assetId
(integer (opens new window))
# ensureTransformUrlByIndexModel()
DEPRECATED
Deprecated in 4.4.0. getTransformUrl() should be used instead.
Get a transform URL by the transform index model.
View source (opens new window)
Arguments
$asset
(craft\elements\Asset)$index
(craft\models\ImageTransformIndex)
Returns
Throws
- craft\errors\ImageTransformException
If there was an error generating the transform.
# generateTransformedImage()
Generate the actual image for the Asset by the transform index.
View source (opens new window)
Arguments
$asset
(craft\elements\Asset)$index
(craft\models\ImageTransformIndex)
Throws
- craft\errors\ImageTransformException
If a transform index has an invalid transform assigned.
# getAllCreatedTransformsForAsset()
Get an array of ImageTransformIndex models for all created transforms for an Asset.
View source (opens new window)
Arguments
$asset
(craft\elements\Asset)
Returns
craft\models\ImageTransformIndex[]
# getSimilarTransformIndex()
Find a similar image transform for reuse for an asset and existing transform.
View source (opens new window)
Arguments
$asset
(craft\elements\Asset)$index
(craft\models\ImageTransformIndex)
Returns
craft\models\ImageTransformIndex, null (opens new window)
Throws
# getTransformBasePath()
Get the transform base path for a given asset.
View source (opens new window)
Arguments
$asset
(craft\elements\Asset)
Returns
Throws
# getTransformFilename()
Return the filename used by the Transform Index for the Asset.
View source (opens new window)
Arguments
$asset
(craft\elements\Asset)$transformIndex
(craft\models\ImageTransformIndex)
Returns
Throws
# getTransformSubfolder()
Return a subfolder used by the Transform Index for the Asset.
View source (opens new window)
Arguments
$asset
(craft\elements\Asset)$transformIndex
(craft\models\ImageTransformIndex)
Returns
Throws
# getTransformSubpath()
Returns the path to a transform, relative to the asset's folder.
View source (opens new window)
Arguments
$asset
(craft\elements\Asset)$transformIndex
(craft\models\ImageTransformIndex)
Returns
Throws
# getTransformUri()
Returns the URI for a transform, relative to the asset's folder.
View source (opens new window)
Arguments
$asset
(craft\elements\Asset)$index
(craft\models\ImageTransformIndex)
Returns
# 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 (opens new window)
Arguments
$index
(craft\models\ImageTransformIndex)
Returns
boolean (opens new window) – 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 (opens new window)
Arguments
$result
(array (opens new window))$transform
(craft\models\ImageTransform)$asset
(array (opens new window), craft\elements\Asset) – The asset object or a raw database result
Returns
boolean (opens new window) – Whether the index result is still valid
# Constants
Constant | Description |
---|---|
SCENARIO_DEFAULT | The name of the default scenario. |
# Events
# EVENT_DELETE_TRANSFORMED_IMAGE
The event that is fired when a generated image transform is deleted
# EVENT_TRANSFORM_IMAGE
The event that is fired when an image is transformed