Model

API reference › yii › base › Model

class	yii\base\Model
Extends	Component » BaseObject
Implements	StaticInstanceInterface, IteratorAggregate, ArrayAccess, Arrayable, Configurable
Uses traits	ArrayableTrait, StaticInstanceTrait
Since	2.0
Source	framework/base/Model.php

8 subclasses

• DynamicModel
• yii\data\DataFilter
• yii\db\BaseActiveRecord
• yii\debug\models\UserSwitch
• yii\debug\models\router\ActionRoutes
• yii\debug\models\router\RouterRules
• yii\debug\models\search\Base
• yii\debug\models\search\UserSearch

Model is the base class for data models.

Model implements the following commonly used features:

• attribute declaration: by default, every public class member is considered as a model attribute
• attribute labels: each attribute may be associated with a label for display purpose
• massive attribute assignment
• scenario-based validation

Model also raises the following events when performing data validation:

• EVENT_BEFORE_VALIDATE: an event raised at the beginning of validate()
• EVENT_AFTER_VALIDATE: an event raised at the end of validate()

You may directly use Model to store model data, or extend it with customization.

For more details and usage information on Model, see the guide article on models.

Properties

Property	Type	Description	Defined by
$activeValidators read-only	yii\validators\Validator[]	The validators applicable to the current $scenario.	Model
$attributes	array<string, mixed>	Attribute values (name => value).	Model
$behaviors read-only	array<Behavior<static>>	List of behaviors attached to this component.	Component
$errors read-only	array<string, string[]>	Errors for all attributes.	Model
$firstErrors read-only	array<string, string>	The first errors.	Model
$iterator read-only	ArrayIterator<string, mixed>	An iterator for traversing the items in the list.	Model
$scenario	string	The scenario that this model is in.	Model
$validators read-only	ArrayObject<int, yii\validators\Validator>|yii\validators\Validator[]	All the validators declared in the model.	Model

Methods

Method	Description	Defined by
__construct()	Constructor.	BaseObject
__call()	Calls the named method which is not a class method.	Component
__clone()	This method is called after the object is created by cloning an existing one.	Model
__get()	Returns the value of a component property.	Component
__isset()	Checks if a property is set, i.e. defined and not null.	Component
__set()	Sets the value of a component property.	Component
__unset()	Sets a component property to be null.	Component
activeAttributes()	Returns the attribute names that are subject to validation in the current scenario.	Model
addError()	Adds a new error to the specified attribute.	Model
addErrors()	Adds a list of errors.	Model
afterValidate()	This method is invoked after validation ends.	Model
attachBehavior()	Attaches a behavior to this component.	Component
attachBehaviors()	Attaches a list of behaviors to the component.	Component
attributeHints()	Returns the attribute hints.	Model
attributeLabels()	Returns the attribute labels.	Model
attributes()	Returns the list of attribute names.	Model
beforeValidate()	This method is invoked before validation starts.	Model
behaviors()	Returns a list of behaviors that this component should behave as.	Component
canGetProperty()	Returns a value indicating whether a property can be read.	Component
canSetProperty()	Returns a value indicating whether a property can be set.	Component
className() static	Returns the fully qualified name of this class.	BaseObject
clearErrors()	Removes errors for all attributes or a single attribute.	Model
createValidators()	Creates validator objects based on the validation rules specified in rules().	Model
detachBehavior()	Detaches a behavior from the component.	Component
detachBehaviors()	Detaches all behaviors from the component.	Component
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.	Component
extraFields()	Returns the list of fields that can be expanded further and returned by toArray().	ArrayableTrait
fields()	Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.	Model
formName()	Returns the form name that this model class should use.	Model
generateAttributeLabel()	Generates a user friendly attribute label based on the give attribute name.	Model
getActiveValidators()	Returns the validators applicable to the current $scenario.	Model
getAttributeHint()	Returns the text hint for the specified attribute.	Model
getAttributeLabel()	Returns the text label for the specified attribute.	Model
getAttributes()	Returns attribute values.	Model
getBehavior()	Returns the named behavior object.	Component
getBehaviors()	Returns all behaviors attached to this component.	Component
getErrors()	Returns the errors for all attributes or a single attribute.	Model
getErrorSummary()	Returns the errors for all attributes as a one-dimensional array.	Model
getFirstError()	Returns the first error of the specified attribute.	Model
getFirstErrors()	Returns the first error of every attribute in the model.	Model
getIterator()	Returns an iterator for traversing the attributes in the model.	Model
getScenario()	Returns the scenario that this model is used in.	Model
getValidators()	Returns all the validators declared in rules().	Model
hasErrors()	Returns a value indicating whether there is any validation error.	Model
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.	Component
hasMethod()	Returns a value indicating whether a method is defined.	Component
hasProperty()	Returns a value indicating whether a property is defined for this component.	Component
init()	Initializes the object.	BaseObject
instance() static	Returns static class instance, which can be used to obtain meta information.	StaticInstanceTrait
isAttributeActive()	Returns a value indicating whether the attribute is active in the current scenario.	Model
isAttributeRequired()	Returns a value indicating whether the attribute is required.	Model
isAttributeSafe()	Returns a value indicating whether the attribute is safe for massive assignments.	Model
load()	Populates the model with input data.	Model
loadMultiple() static	Populates a set of models with the data from end user.	Model
off()	Detaches an existing event handler from this component.	Component
offsetExists()	Returns whether there is an element at the specified offset.	Model
offsetGet()	Returns the element at the specified offset.	Model
offsetSet()	Sets the element at the specified offset.	Model
offsetUnset()	Sets the element value at the specified offset to null.	Model
on()	Attaches an event handler to an event.	Component
onUnsafeAttribute()	This method is invoked when an unsafe attribute is being massively assigned.	Model
rules()	Returns the validation rules for attributes.	Model
safeAttributes()	Returns the attribute names that are safe to be massively assigned in the current scenario.	Model
scenarios()	Returns a list of scenarios and the corresponding active attributes.	Model
setAttributes()	Sets the attribute values in a massive way.	Model
setScenario()	Sets the scenario for the model.	Model
toArray()	Converts the model into an array.	ArrayableTrait
trigger()	Triggers an event.	Component
validate()	Performs the data validation.	Model
validateMultiple() static	Validates multiple models.	Model
extractFieldsFor() protected	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”.	ArrayableTrait
extractRootFields() protected	Extracts the root field names from nested fields.	ArrayableTrait
resolveFields() protected	Determines which fields can be returned by toArray().	ArrayableTrait

Events

Event	Type	Description	Defined by
EVENT_BEFORE_VALIDATE	ModelEvent	An event raised at the beginning of validate(). Event name: 'beforeValidate'.	Model
EVENT_AFTER_VALIDATE	Event	An event raised at the end of validate() Event name: 'afterValidate'.	Model

Constants

Constant	Value	Description	Defined by
SCENARIO_DEFAULT	'default'	The name of the default scenario.	Model

Property details

$errors

public array<string, string[]> $errors

Errors for all attributes.

This is a two-dimensional array of errors for all attributes, similar to the following:

[
    'username' => [
        'Username is required.',
        'Username must contain only word characters.',
    ],
    'email' => [
        'Email address is invalid.',
    ]
]

Empty array if no errors.

Access

Read-only (virtual property).

$firstErrors

public array<string, string> $firstErrors

The first errors.

The array keys are the attribute names, and the array values are the corresponding error messages. An empty array will be returned if there is no error.

Access

Read-only (virtual property).

$scenario

public string $scenario

The scenario that this model is in.

Defaults to SCENARIO_DEFAULT.

Method details

__clone()

public function __clone(): mixed

This method is called after the object is created by cloning an existing one.

It removes all behaviors because they are attached to the old object.

Returns

mixed

activeAttributes()

public function activeAttributes(): string[]

Returns the attribute names that are subject to validation in the current scenario.

Returns

string[]: Safe attribute names

addError()

public function addError(string $attribute, string $error = ''): mixed

Adds a new error to the specified attribute.

Parameters

Parameter	Type	Description
$attribute	string	Attribute name
$error	string	New error message

Returns

mixed

addErrors()

public function addErrors(array $items): mixed

Adds a list of errors.

Parameters

Parameter	Type	Description
$items	array	A list of errors. The array keys must be attribute names. The array values should be error messages. If an attribute has multiple errors, these errors must be given in terms of an array. You may use the result of getErrors() as the value for this parameter.

Returns

mixed

Since

2.0.2

afterValidate()

public function afterValidate(): mixed

This method is invoked after validation ends.

The default implementation raises an afterValidate event. You may override this method to do postprocessing after validation. Make sure the parent implementation is invoked so that the event can be raised.

Returns

mixed

attributeHints()

public function attributeHints(): array<string, string>

Returns the attribute hints.

Attribute hints are mainly used for display purpose. For example, given an attribute isPublic, we can declare a hint Whether the post should be visible for not logged in users, which provides user-friendly description of the attribute meaning and can be displayed to end users.

Unlike label hint will not be generated, if its explicit declaration is omitted.

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

Returns

array<string, string>: Attribute hints (name => hint)

Since

2.0.4

attributeLabels()

public function attributeLabels(): array<string, string>

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().

Returns

array<string, string>: Attribute labels (name => label)

See also

• generateAttributeLabel()

attributes()

public function attributes(): string[]

Returns the list of attribute names.

By default, this method returns all public non-static properties of the class. You may override this method to change the default behavior.

Returns

string[]: List of attribute names.

beforeValidate()

public function beforeValidate(): bool

This method is invoked before validation starts.

The default implementation raises a beforeValidate event. You may override this method to do preliminary checks before validation. Make sure the parent implementation is invoked so that the event can be raised.

Returns

bool: Whether the validation should be executed. Defaults to true. If false is returned, the validation will stop and the model is considered invalid.

clearErrors()

public function clearErrors(string|null $attribute = null): mixed

Removes errors for all attributes or a single attribute.

Parameters

Parameter	Type	Description
$attribute	string|null	Attribute name. Use null to remove errors for all attributes.

Returns

mixed

createValidators()

public function createValidators(): ArrayObject<int, yii\validators\Validator>

Creates validator objects based on the validation rules specified in rules().

Unlike getValidators(), each time this method is called, a new list of validators will be returned.

Returns

ArrayObject<int, yii\validators\Validator>: Validators

Throws

• InvalidConfigException: if any validation rule configuration is invalid

fields()

public function fields(): array

Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.

A field is a named element in the returned array by toArray().

This method should return an array of field names or field definitions. If the former, the field name will be treated as an object property name whose value will be used as the field value. If the latter, the array key should be the field name while the array value should be the corresponding field definition which can be either an object property name or a PHP callable returning the corresponding field value. The signature of the callable should be:

function ($model, $field) {
    // return field value
}

For example, the following code declares four fields:

• email: the field name is the same as the property name email;
• firstName and lastName: the field names are firstName and lastName, and their values are obtained from the first_name and last_name properties;
• fullName: the field name is fullName. Its value is obtained by concatenating first_name and last_name.

return [
    'email',
    'firstName' => 'first_name',
    'lastName' => 'last_name',
    'fullName' => function ($model) {
        return $model->first_name . ' ' . $model->last_name;
    },
];

In this method, you may also want to return different lists of fields based on some context information. For example, depending on $scenario or the privilege of the current application user, you may return different sets of visible fields or filter out some fields.

The default implementation of this method returns attributes() indexed by the same attribute names.

Returns

array: The list of field names or field definitions.

See also

• toArray()

formName()

public function formName(): string

Returns the form name that this model class should use.

The form name is mainly used by ActiveForm to determine how to name the input fields for the attributes in a model. If the form name is “A” and an attribute name is “b”, then the corresponding input name would be “A[b]”. If the form name is an empty string, then the input name would be “b”.

The purpose of the above naming schema is that for forms which contain multiple different models, the attributes of each model are grouped in sub-arrays of the POST-data and it is easier to differentiate between them.

By default, this method returns the model class name (without the namespace part) as the form name. You may override it when the model is used in different forms.

Returns

string: The form name of this model class.

Throws

• InvalidConfigException: when form is defined with anonymous class and formName() method is not overridden.

See also

• load()

generateAttributeLabel()

public function generateAttributeLabel(string $name): string

Generates a user friendly attribute label based on the give attribute name.

This is done by replacing underscores, dashes and dots with blanks and changing the first letter of each word to upper case. For example, ‘department_name’ or ‘DepartmentName’ will generate ‘Department Name’.

Parameters

Parameter	Type	Description
$name	string	The column name

Returns

string: The attribute label

getActiveValidators()

public function getActiveValidators(string|null $attribute = null): yii\validators\Validator[]

Returns the validators applicable to the current $scenario.

Parameters

Parameter	Type	Description
$attribute	string|null	The name of the attribute whose applicable validators should be returned. If this is null, the validators for ALL attributes in the model will be returned.

Returns

yii\validators\Validator[]: The validators applicable to the current $scenario.

getAttributeHint()

public function getAttributeHint(string $attribute): string

Returns the text hint for the specified attribute.

Parameters

Parameter	Type	Description
$attribute	string	The attribute name

Returns

string: The attribute hint

Since

2.0.4

See also

• attributeHints()

getAttributeLabel()

public function getAttributeLabel(string $attribute): string

Returns the text label for the specified attribute.

Parameters

Parameter	Type	Description
$attribute	string	The attribute name

Returns

string: The attribute label

See also

• generateAttributeLabel()
• attributeLabels()

getAttributes()

public function getAttributes(array|null $names = null, array $except = []): array<string, mixed>

Returns attribute values.

Parameters

Parameter	Type	Description
$names	array|null	List of attributes whose value needs to be returned. Defaults to null, meaning all attributes listed in attributes() will be returned. If it is an array, only the attributes in the array will be returned.
$except	array	List of attributes whose value should NOT be returned.

Returns

array<string, mixed>: Attribute values (name => value).

getErrors()

public function getErrors(string|null $attribute = null): ($attribute is null ? array<string, string[]> : string[])

Returns the errors for all attributes or a single attribute.

Parameters

Parameter	Type	Description
$attribute	string|null	Attribute name. Use null to retrieve errors for all attributes.

Returns

($attribute is null ? array<string, string[]> : string[]): Errors for all attributes or the specified attribute. Empty array is returned if no error. Note that when returning errors for all attributes, the result is a two-dimensional array, like the following: [ ‘username’ => [ ‘Username is required.’, ‘Username must contain only word characters.’, ], ‘email’ => [ ‘Email address is invalid.’, ] ]

See also

• getFirstErrors()
• getFirstError()

getErrorSummary()

public function getErrorSummary(bool $showAllErrors): string[]

Returns the errors for all attributes as a one-dimensional array.

Parameters

Parameter	Type	Description
$showAllErrors	bool	Boolean, if set to true every error message for each attribute will be shown otherwise only the first error message for each attribute will be shown.

Returns

string[]: Errors for all attributes as a one-dimensional array. Empty array is returned if no error.

Since

2.0.14

See also

• getErrors()
• getFirstErrors()

getFirstError()

public function getFirstError(string $attribute): string|null

Returns the first error of the specified attribute.

Parameters

Parameter	Type	Description
$attribute	string	Attribute name.

Returns

string|null: The error message. Null is returned if no error.

See also

• getErrors()
• getFirstErrors()

getFirstErrors()

public function getFirstErrors(): array<string, string>

Returns the first error of every attribute in the model.

Returns

array<string, string>: The first errors. The array keys are the attribute names, and the array values are the corresponding error messages. An empty array will be returned if there is no error.

See also

• getErrors()
• getFirstError()

getIterator()

public function getIterator(): ArrayIterator<string, mixed>

Returns an iterator for traversing the attributes in the model.

This method is required by the interface IteratorAggregate.

Returns

ArrayIterator<string, mixed>: An iterator for traversing the items in the list.

getScenario()

public function getScenario(): string

Returns the scenario that this model is used in.

Scenario affects how validation is performed and which attributes can be massively assigned.

Returns

string: The scenario that this model is in. Defaults to SCENARIO_DEFAULT.

getValidators()

public function getValidators(): ArrayObject<int, yii\validators\Validator>|yii\validators\Validator[]

Returns all the validators declared in rules().

This method differs from getActiveValidators() in that the latter only returns the validators applicable to the current $scenario.

Because this method returns an ArrayObject object, you may manipulate it by inserting or removing validators (useful in model behaviors). For example,

$model->validators[] = $newValidator;

Returns

ArrayObject<int, yii\validators\Validator>|yii\validators\Validator[]: All the validators declared in the model.

hasErrors()

public function hasErrors(string|null $attribute = null): bool

Returns a value indicating whether there is any validation error.

Parameters

Parameter	Type	Description
$attribute	string|null	Attribute name. Use null to check all attributes.

Returns

bool: Whether there is any error.

isAttributeActive()

public function isAttributeActive(string $attribute): bool

Returns a value indicating whether the attribute is active in the current scenario.

Parameters

Parameter	Type	Description
$attribute	string	Attribute name

Returns

bool: Whether the attribute is active in the current scenario

See also

• activeAttributes()

isAttributeRequired()

public function isAttributeRequired(string $attribute): bool

Returns a value indicating whether the attribute is required.

This is determined by checking if the attribute is associated with a required validation rule in the current $scenario.

Note that when the validator has a conditional validation applied using $when this method will return false regardless of the when condition because it may be called be before the model is loaded with data.

Parameters

Parameter	Type	Description
$attribute	string	Attribute name

Returns

bool: Whether the attribute is required

isAttributeSafe()

public function isAttributeSafe(string $attribute): bool

Returns a value indicating whether the attribute is safe for massive assignments.

Parameters

Parameter	Type	Description
$attribute	string	Attribute name

Returns

bool: Whether the attribute is safe for massive assignments

See also

• safeAttributes()

load()

public function load(array $data, string|null $formName = null): bool

Populates the model with input data.

This method provides a convenient shortcut for:

if (isset($_POST['FormName'])) {
    $model->attributes = $_POST['FormName'];
    if ($model->save()) {
        // handle success
    }
}

which, with load() can be written as:

if ($model->load($_POST) && $model->save()) {
    // handle success
}

load() gets the 'FormName' from the model’s formName() method (which you may override), unless the $formName parameter is given. If the form name is empty, load() populates the model with the whole of $data, instead of $data['FormName'].

Note, that the data being populated is subject to the safety check by setAttributes().

Parameters

Parameter	Type	Description
$data	array	The data array to load, typically $_POST or $_GET.
$formName	string|null	The form name to use to load the data into the model, empty string when form not use. If not set, formName() is used.

Returns

bool: Whether load() found the expected form in $data.

loadMultiple()

public static function loadMultiple(array $models, array $data, string|null $formName = null): bool

Populates a set of models with the data from end user.

This method is mainly used to collect tabular data input. The data to be loaded for each model is $data[formName][index], where formName refers to the value of formName(), and index the index of the model in the $models array. If formName() is empty, $data[index] will be used to populate each model. The data being populated to each model is subject to the safety check by setAttributes().

Parameters

Parameter	Type	Description
$models	array	The models to be populated. Note that all models should have the same class.
$data	array	The data array. This is usually $_POST or $_GET, but can also be any valid array supplied by end user.
$formName	string|null	The form name to be used for loading the data into the models. If not set, it will use the formName() value of the first model in $models. This parameter is available since version 2.0.1.

Returns

bool: Whether at least one of the models is successfully populated.

offsetExists()

public function offsetExists(string $offset): bool

Returns whether there is an element at the specified offset.

This method is required by the SPL interface ArrayAccess. It is implicitly called when you use something like isset($model[$offset]).

Parameters

Parameter	Type	Description
$offset	string	The offset to check on.

Returns

bool: Whether or not an offset exists.

offsetGet()

public function offsetGet(string $offset): mixed

Returns the element at the specified offset.

This method is required by the SPL interface ArrayAccess. It is implicitly called when you use something like $value = $model[$offset];.

Parameters

Parameter	Type	Description
$offset	string	The offset to retrieve element.

Returns

mixed: The element at the offset, null if no element is found at the offset

offsetSet()

public function offsetSet(string $offset, mixed $value): mixed

Sets the element at the specified offset.

This method is required by the SPL interface ArrayAccess. It is implicitly called when you use something like $model[$offset] = $value;.

Parameters

Parameter	Type	Description
$offset	string	The offset to set element
$value	mixed	The element value

Returns

mixed

offsetUnset()

public function offsetUnset(string $offset): mixed

Sets the element value at the specified offset to null.

This method is required by the SPL interface ArrayAccess. It is implicitly called when you use something like unset($model[$offset]).

Parameters

Parameter	Type	Description
$offset	string	The offset to unset element

Returns

mixed

onUnsafeAttribute()

public function onUnsafeAttribute(string $name, mixed $value): mixed

This method is invoked when an unsafe attribute is being massively assigned.

The default implementation will log a warning message if YII_DEBUG is on. It does nothing otherwise.

Parameters

Parameter	Type	Description
$name	string	The unsafe attribute name
$value	mixed	The attribute value

Returns

mixed

rules()

public function rules(): array<int, array<array-key, mixed>|yii\validators\Validator>

Returns the validation rules for attributes.

Validation rules are used by validate() to check if attribute values are valid. Child classes may override this method to declare different validation rules.

Each rule is an array with the following structure:

[
    ['attribute1', 'attribute2'],
    'validator type',
    'on' => ['scenario1', 'scenario2'],
    //...other parameters...
]

where

• attribute list: required, specifies the attributes array to be validated, for single attribute you can pass a string;
• validator type: required, specifies the validator to be used. It can be a built-in validator name, a method name of the model class, an anonymous function, or a validator class name.
• on: optional, specifies the scenarios array in which the validation rule can be applied. If this option is not set, the rule will apply to all scenarios.
• additional name-value pairs can be specified to initialize the corresponding validator properties. Please refer to individual validator class API for possible properties.

A validator can be either an object of a class extending Validator, or a model class method (called inline validator) that has the following signature:

// $params refers to validation parameters given in the rule
function validatorName($attribute, $params)

In the above $attribute refers to the attribute currently being validated while $params contains an array of validator configuration options such as max in case of string validator. The value of the attribute currently being validated can be accessed as $this->$attribute. Note the $ before attribute; this is taking the value of the variable $attribute and using it as the name of the property to access.

Yii also provides a set of built-in validators. Each one has an alias name which can be used when specifying a validation rule.

Below are some examples:

[
    // built-in "required" validator
    [['username', 'password'], 'required'],
    // built-in "string" validator customized with "min" and "max" properties
    ['username', 'string', 'min' => 3, 'max' => 12],
    // built-in "compare" validator that is used in "register" scenario only
    ['password', 'compare', 'compareAttribute' => 'password2', 'on' => 'register'],
    // an inline validator defined via the "authenticate()" method in the model class
    ['password', 'authenticate', 'on' => 'login'],
    // a validator of class "DateRangeValidator"
    ['dateRange', 'DateRangeValidator'],
];

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

Returns

array<int, array<array-key, mixed>|yii\validators\Validator>: Validation rules

See also

• scenarios()

safeAttributes()

public function safeAttributes(): string[]

Returns the attribute names that are safe to be massively assigned in the current scenario.

Returns

string[]: Safe attribute names

scenarios()

public function scenarios(): array<string, string[]>

Returns a list of scenarios and the corresponding active attributes.

An active attribute is one that is subject to validation in the current scenario. The returned array should be in the following format:

[
    'scenario1' => ['attribute11', 'attribute12', ...],
    'scenario2' => ['attribute21', 'attribute22', ...],
    ...
]

By default, an active attribute is considered safe and can be massively assigned. If an attribute should NOT be massively assigned (thus considered unsafe), please prefix the attribute with an exclamation character (e.g. '!rank').

The default implementation of this method will return all scenarios found in the rules() declaration. A special scenario named SCENARIO_DEFAULT will contain all attributes found in the rules(). Each scenario will be associated with the attributes that are being validated by the validation rules that apply to the scenario.

Returns

array<string, string[]>: A list of scenarios and the corresponding active attributes.

setAttributes()

public function setAttributes(array<string, mixed> $values, bool $safeOnly = true): mixed

Sets the attribute values in a massive way.

Parameters

Parameter	Type	Description
$values	array<string, mixed>	Attribute values (name => value) to be assigned to the model.
$safeOnly	bool	Whether the assignments should only be done to the safe attributes. A safe attribute is one that is associated with a validation rule in the current $scenario.

Returns

mixed

See also

• safeAttributes()
• attributes()

setScenario()

public function setScenario(string $value): mixed

Sets the scenario for the model.

Note that this method does not check if the scenario exists or not. The method validate() will perform this check.

Parameters

Parameter	Type	Description
$value	string	The scenario that this model is in.

Returns

mixed

validate()

public function validate(string[]|string|null $attributeNames = null, bool $clearErrors = true): bool

Performs the data validation.

This method executes the validation rules applicable to the current $scenario. The following criteria are used to determine whether a rule is currently applicable:

• the rule must be associated with the attributes relevant to the current scenario;
• the rules must be effective for the current scenario.

This method will call beforeValidate() and afterValidate() before and after the actual validation, respectively. If beforeValidate() returns false, the validation will be cancelled and afterValidate() will not be called.

Errors found during the validation can be retrieved via getErrors(), getFirstErrors() and getFirstError().

Parameters

Parameter	Type	Description
$attributeNames	string[]|string|null	Attribute name or list of attribute names that should be validated. If this parameter is empty, it means any attribute listed in the applicable validation rules should be validated.
$clearErrors	bool	Whether to call clearErrors() before performing validation

Returns

bool: Whether the validation is successful without any error.

Throws

• InvalidArgumentException: if the current scenario is unknown.

validateMultiple()

public static function validateMultiple(array $models, array|null $attributeNames = null): bool

Validates multiple models.

This method will validate every model. The models being validated may be of the same or different types.

Parameters

Parameter	Type	Description
$models	array	The models to be validated
$attributeNames	array|null	List of attribute names that should be validated. If this parameter is empty, it means any attribute listed in the applicable validation rules should be validated.

Returns

bool: Whether all models are valid. False will be returned if one or multiple models have validation error.