Skip to content

ImageTransform

Type
Class
Namespace
craft\models
Inherits
craft\models\ImageTransform » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
Implements
ArrayAccess, IteratorAggregate, craft\base\ModelInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
Uses traits
craft\base\ClonefixTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Since
4.0.0

The ImageTransform model class.

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.
configarray
errorsarray – Errors for all attributes or the specified attribute.
fillstring, null – Fill color
firstErrorsarray – The first errors.
formatstring, null – Format
handlestring, null – Handle
heightinteger, null – Height
idinteger, null – ID
imageTransformercraft\base\imagetransforms\ImageTransformerInterface
interlacestring – Interlace
isNamedTransformboolean – Whether this is a named transform
iteratorArrayIterator – An iterator for traversing the items in the list.
modestring – 'crop'
namestring, null – Name
parameterChangeTimeDateTime, null – Dimension change time
positionstring – Position
qualityinteger, null – Quality
scenariostring – The scenario that this model is in.
uidstring, null – UID
upscaleboolean, null – Allow upscaling
validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.
widthinteger, null – Width

config

Type
array
Default value
null
Access
Read-only
Since
4.4.2

View source

fill

Type
string, null
Default value
null
Since
4.4.0

Fill color

View source

format

Type
string, null
Default value
null

Format

View source

handle

Type
string, null
Default value
null

Handle

View source

height

Type
integer, null
Default value
null

Height

View source

id

Type
integer, null
Default value
null

ID

View source

imageTransformer

Type
craft\base\imagetransforms\ImageTransformerInterface
Default value
null
Access
Read-only

View source

interlace

Type
string
Default value
'none'

Interlace

View source

isNamedTransform

Type
boolean
Default value
null

Whether this is a named transform

View source

mode

Type
string
Default value
'crop'

'crop'|'fit'|'stretch'|'letterbox' Mode

View source

name

Type
string, null
Default value
null

Name

View source

parameterChangeTime

Type
DateTime, null
Default value
null

Dimension change time

View source

position

Type
string
Default value
'center-center'

Position

View source

quality

Type
integer, null
Default value
null

Quality

View source

uid

Type
string, null
Default value
null

UID

View source

upscale

Type
boolean, null
Default value
null
Since
4.4.0

Allow upscaling

View source

width

Type
integer, null
Default value
null

Width

View source

Protected Properties

PropertyDescription
transformerstring – The image transformer to use.

transformer

Type
string
Default value
self::DEFAULT_TRANSFORMER

The image transformer to use.

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.
__toString()Use the folder name as the string representation.
__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.
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().
datetimeAttributes()Returns the names of any attributes that should hold DateTime values.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
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.
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.
getConfig()Returns the transform’s config.
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.
getImageTransformer()Return the image transformer for this transform.
getIsNamedTransform()Return whether this is a named transform
getIterator()Returns an iterator for traversing the attributes in the model.
getScenario()Returns the scenario that this model is used in.
getTransformer()Returns the image transformer.
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.
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.
load()Populates the model with input data.
loadMultiple()Populates a set of models with the data from end user.
modes()Get a list of transform modes.
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.
rules()Returns the validation rules for attributes.
safeAttributes()Returns the attribute names that are safe to be massively assigned in the current scenario.
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.
setTransformer()Sets the image transformer.
toArray()Converts the model into an array.
trigger()Triggers an event.
validate()Performs the data validation.
validateMultiple()Validates multiple models.

__construct()

View source

Arguments

  • $config

__toString()

Use the folder name as the string representation.

View source

Returns

string

attributeLabels()

Returns the attribute labels.

Attribute labels are mainly used for display purpose. For example, given an attribute firstName, we can declare a label First Name which is more user-friendly and can be displayed to end users.

By default an attribute label is generated using generateAttributeLabel(). This method allows you to explicitly specify attribute labels.

Note, in order to inherit labels defined in the parent class, a child class needs to merge the parent labels with child labels using functions such as array_merge().

View source

Returns

array – Attribute labels (name => label)

getConfig()

Since
4.4.2

Returns the transform’s config.

View source

Returns

array

getImageTransformer()

Return the image transformer for this transform.

View source

Returns

craft\base\imagetransforms\ImageTransformerInterface

getIsNamedTransform()

Return whether this is a named transform

View source

Returns

boolean

getTransformer()

Returns the image transformer.

View source

Returns

string

init()

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

View source

modes()

Get a list of transform modes.

View source

Returns

array

setTransformer()

Sets the image transformer.

View source

Arguments

Protected Methods

MethodDescription
defineBehaviors()Returns the behaviors to attach to this class.
defineRules()Returns the validation rules for attributes.
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.
resolveFields()Determines which fields can be returned by toArray().

defineRules()

Since
3.4.0

Returns the validation rules for attributes.

See rules() for details about what should be returned.

Models should override this method instead of rules() so EVENT_DEFINE_RULES handlers can modify the class-defined rules.

View source

Returns

array

Constants

ConstantDescription
DEFAULT_TRANSFORMER
SCENARIO_DEFAULTThe name of the default scenario.