ImageTransformIndex

Type

Class

Namespace

craft\models

Inherits

craft\models\ImageTransformIndex » 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

Class ImageTransformIndex model.

View source

Public Properties

Property	Description
activeValidators	yii\validators\Validator – The validators applicable to the current scenario.
assetId	integer, null – Asset ID
attributes	array – Attribute values (name => value).
behaviors	yii\base\Behavior – List of behaviors attached to this component.
dateCreated	DateTime, null – Date created
dateIndexed	DateTime, null – Date indexed
dateUpdated	DateTime, null – Date updated
detectedFormat	string, null – Detected format
error	boolean – Transform generation failed
errors	array – Errors for all attributes or the specified attribute.
fileExists	boolean – File exists
filename	string, null – Filename
firstErrors	array – The first errors.
format	string, null – Format
id	integer, null – ID
inProgress	boolean – In progress
iterator	ArrayIterator – An iterator for traversing the items in the list.
scenario	string – The scenario that this model is in.
transform	craft\models\ImageTransform
transformString	string, null – Location
transformer	string – The image transformer
validators	ArrayObject, yii\validators\Validator – All the validators declared in the model.

assetId

Type

integer, null

Default value

null

Asset ID

View source

dateCreated

Type

DateTime, null

Default value

null

Date created

View source

dateIndexed

Type

DateTime, null

Default value

null

Date indexed

View source

dateUpdated

Type

DateTime, null

Default value

null

Date updated

View source

detectedFormat

Type

string, null

Default value

null

Detected format

View source

error

Type

boolean

Default value

false

Transform generation failed

View source

fileExists

Type

boolean

Default value

false

File exists

View source

filename

Type

string, null

Default value

null

Filename

View source

format

Type

string, null

Default value

null

Format

View source

id

Type

integer, null

Default value

null

ID

View source

inProgress

Type

boolean

Default value

false

In progress

View source

transform

Type

craft\models\ImageTransform

Default value

null

View source

transformString

Type

string, null

Default value

null

Location

View source

transformer

Type

string

Default value

\craft\models\ImageTransform::DEFAULT_TRANSFORMER

The image transformer

View source

Public Methods

Method	Description
__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.
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.
getScenario()	Returns the scenario that this model is used in.
getTransform()	Returns the transform associated with this index.
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.
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.
setTransform()	Sets the transform associated with this index.
toArray()	Converts the model into an array.
trigger()	Triggers an event.
validate()	Performs the data validation.
validateMultiple()	Validates multiple models.

__toString()

Use the folder name as the string representation.

View source

Returns

string

getTransform()

Returns the transform associated with this index.

View source

Returns

craft\models\ImageTransform

Throws

• yii\base\InvalidConfigException
  if transformString is invalid

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

setTransform()

Sets the transform associated with this index.

View source

Arguments

• $transform (craft\models\ImageTransform)

Protected Methods

Method	Description
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

Constant	Description
SCENARIO_DEFAULT	The name of the default scenario.