Info

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

Class Info model.

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
configMapstring – JSON array of configuration map of UIDs to location in configuration
dateCreatedDateTime, null – Date created
dateUpdatedDateTime, null – Date updated
editioninteger
errorsarray – Errors for all attributes or the specified attribute.
fieldVersionstring – Field version
firstErrorsarray – The first errors.
idinteger, null – ID
iteratorArrayIterator – An iterator for traversing the items in the list.
maintenanceboolean – Maintenance
namestring
onboolean
scenariostring – The scenario that this model is in.
schemaVersionstring – Schema version
timezonestring
uidstring, null – Uid
validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.
versionstring, null – Version

configMap

Type
string

JSON array of configuration map of UIDs to location in configuration

View source

dateCreated

Type
DateTime, null

Date created

View source

dateUpdated

Type
DateTime, null

Date updated

View source

edition

Type
integer
Access
Read-only

View source

fieldVersion

Type
string

Field version

View source

id

Type
integer, null

ID

View source

maintenance

Type
boolean

Maintenance

View source

name

Type
string
Access
Read-only

View source

on

Type
boolean
Access
Read-only

View source

schemaVersion

Type
string

Schema version

View source

timezone

Type
string
Access
Read-only

View source

uid

Type
string, null

Uid

View source

version

Type
string, null

Version

View source

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()
__construct()Constructor.
__get()Returns the value of an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__unset()Sets an object property to 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.
getEdition()Returns the active Craft edition.
getError()Returns the first error of the specified attribute.
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.
getName()Returns the system name.
getOn()Returns whether the system is currently live.
getScenario()Returns the scenario that this model is used in.
getTimezone()Returns the system time zone.
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.
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.
toArray()Converts the model into an array.
trigger()Triggers an event.
validate()Performs the data validation.
validateMultiple()Validates multiple models.

getEdition()

DEPRECATED

Deprecated in 3.1.0. Use Craft::$app->getEdition() instead.

Returns the active Craft edition.

View source

Returns

integer

getName()

DEPRECATED

Deprecated in 3.1.0. Use Craft::$app->getSystemName() instead.

Returns the system name.

View source

Returns

string

getOn()

DEPRECATED

Deprecated in 3.1.0. Use Craft::$app->getIsLive() instead.

Returns whether the system is currently live.

View source

Returns

boolean

getTimezone()

DEPRECATED

Deprecated in 3.1.0. Use Craft::$app->getTimeZone() instead.

Returns the system time zone.

View source

Returns

string

Protected Methods

MethodDescription
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
SCENARIO_DEFAULTThe name of the default scenario.