Класс yii\behaviors\AttributeTypecastBehavior

AttributeTypecastBehavior предоставляет возможность автоматического приведения типов атрибутов модели.

Этот бихевиор очень полезен при использовании ActiveRecord для схемозависимых баз данных, таких как MongoDB или Redis. Он также может пригодиться для обычных yii\db\ActiveRecord или даже yii\base\Model, позволяя поддерживать строгие типы атрибутов после валидации модели.

Этот бихевиор должен быть прикреплён к yii\base\Model или наследнику yii\db\BaseActiveRecord.

Вы должны указать точные типы атрибутов через $attributeTypes.

Например:

use yii\behaviors\AttributeTypecastBehavior;

class Item extends \yii\db\ActiveRecord
{
    public function behaviors()
    {
        return [
            'typecast' => [
                'class' => AttributeTypecastBehavior::className(),
                'attributeTypes' => [
                    'amount' => AttributeTypecastBehavior::TYPE_INTEGER,
                    'price' => AttributeTypecastBehavior::TYPE_FLOAT,
                    'is_active' => AttributeTypecastBehavior::TYPE_BOOLEAN,
                ],
                'typecastAfterValidate' => true,
                'typecastBeforeSave' => false,
                'typecastAfterFind' => false,
            ],
        ];
    }

    // ...
}

Подсказка: вы можете оставить $attributeTypes пустым — в этом случае его значение будет определено автоматически на основе правил валидации владельца. Следующий пример автоматически создаст то же значение $attributeTypes, что и в предыдущем:

use yii\behaviors\AttributeTypecastBehavior;

class Item extends \yii\db\ActiveRecord
{

    public function rules()
    {
        return [
            ['amount', 'integer'],
            ['price', 'number'],
            ['is_active', 'boolean'],
        ];
    }

    public function behaviors()
    {
        return [
            'typecast' => [
                'class' => AttributeTypecastBehavior::className(),
                // 'attributeTypes' will be composed automatically according to `rules()`
            ],
        ];
    }

    // ...
}

Этот бихевиор позволяет автоматически приводить типы атрибутов в следующих случаях:

• после успешной валидации модели
• перед сохранением модели (вставка или обновление)
• после поиска модели (найденной запросом или обновлённой)

Вы можете управлять автоматическим приведением типов для конкретного случая, используя поля $typecastAfterValidate, $typecastBeforeSave и $typecastAfterFind. По умолчанию приведение типов будет выполняться только после валидации модели.

Примечание: вы можете вручную вызвать приведение типов атрибутов в любое время, вызвав метод typecastAttributes():

$model = new Item();
$model->price = '38.5';
$model->is_active = 1;
$model->typecastAttributes();

Открытые свойства

Открытые методы

Защищённые методы

Константы

Подробное описание свойств

$attributeTypes общедоступное свойство

Карта типов преобразования атрибутов в формате: имяАтрибута => тип. Тип может быть задан с помощью вызова PHP, принимающего исходное значение в качестве аргумента и возвращающего результат преобразования. Например:

[
    'amount' => 'integer',
    'price' => 'float',
    'is_active' => 'boolean',
    'date' => function ($value) {
        return ($value instanceof \DateTime) ? $value->getTimestamp(): (int)$value;
    },
]

Если не задано, карта типов атрибутов будет составлена автоматически из правил валидации владельца.

public array $attributeTypes = null

$owner общедоступное свойство

Владелец данного поведения.

public yii\base\Model|yii\db\BaseActiveRecord $owner = null

$skipOnNull общедоступное свойство

Необходимо ли пропускать преобразование типов для значений null. Если включено, значение атрибута, равное null, не будет преобразовано (например, null останется null), в противном случае оно будет преобразовано в соответствии с типом, настроенным в $attributeTypes.

public boolean $skipOnNull = true

$typecastAfterFind общедоступное свойство

Выполнять ли преобразование типов после извлечения данных модели владельца из базы данных (после find или refresh). Этот параметр можно отключить для повышения производительности. Например, при использовании yii\db\ActiveRecord, преобразование после find, как правило, не приносит пользы и может быть отключено. Обратите внимание, что изменение этого значения не повлияет после того, как это поведение было прикреплено к модели.

public boolean $typecastAfterFind = false

$typecastAfterValidate общедоступное свойство

Выполнять ли преобразование типов после валидации модели владельца. Обратите внимание, что преобразование типов будет выполнено только в случае успешной валидации, т. е. если у модели владельца нет ошибок. Обратите внимание, что изменение этого значения не повлияет после того, как это поведение было прикреплено к модели.

public boolean $typecastAfterValidate = true

$typecastBeforeSave общедоступное свойство

Выполнять ли преобразование типов перед сохранением модели владельца (вставка или обновление). Этот параметр можно отключить для повышения производительности. Например, при использовании yii\db\ActiveRecord, преобразование перед сохранением, как правило, не приносит пользы и может быть отключено. Обратите внимание, что изменение этого значения не повлияет после того, как это поведение было прикреплено к модели.

public boolean $typecastBeforeSave = false

Подробное описание методов

[
    Model::EVENT_BEFORE_VALIDATE => 'myBeforeValidate',
    Model::EVENT_AFTER_VALIDATE => 'myAfterValidate',
]