0 关注者

类 yii\behaviors\AttributeTypecastBehavior

继承关系	yii\behaviors\AttributeTypecastBehavior » yii\base\Behavior » yii\base\BaseObject
实现接口	yii\base\Configurable
可用版本	2.0.10
源代码	https://github.com/yiisoft/yii2/blob/master/framework/behaviors/AttributeTypecastBehavior.php

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::class,
                '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::class,
                // '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	array\|null	属性类型转换映射，格式为：属性名 => 类型。	yii\behaviors\AttributeTypecastBehavior
$owner	yii\base\Model\|yii\db\BaseActiveRecord	此行为的所有者。	yii\behaviors\AttributeTypecastBehavior
$skipOnNull	boolean	是否跳过 `null` 值的类型转换。	yii\behaviors\AttributeTypecastBehavior
$typecastAfterFind	boolean	是否在从数据库中检索所有者模型数据后（查找或刷新后）执行类型转换。	yii\behaviors\AttributeTypecastBehavior
$typecastAfterSave	boolean	是否在保存所有者模型（插入或更新）后执行类型转换。	yii\behaviors\AttributeTypecastBehavior
$typecastAfterValidate	boolean	是否在所有者模型验证后执行类型转换。	yii\behaviors\AttributeTypecastBehavior
$typecastBeforeSave	boolean	是否在保存所有者模型（插入或更新）之前执行类型转换。	yii\behaviors\AttributeTypecastBehavior

公共方法

隐藏继承的方法

方法	描述	定义于
__call()	调用不是类方法的命名方法。	yii\base\BaseObject
__construct()	构造函数。	yii\base\BaseObject
__get()	返回对象属性的值。	yii\base\BaseObject
__isset()	检查属性是否已设置，即定义且不为 null。	yii\base\BaseObject
__set()	设置对象属性的值。	yii\base\BaseObject
__unset()	将对象属性设置为 null。	yii\base\BaseObject
afterFind()	处理所有者的 'afterFind' 事件，确保属性类型转换。	yii\behaviors\AttributeTypecastBehavior
afterSave()	处理所有者的 'afterInsert' 和 'afterUpdate' 事件，确保属性类型转换。	yii\behaviors\AttributeTypecastBehavior
afterValidate()	处理所有者的 'afterValidate' 事件，确保属性类型转换。	yii\behaviors\AttributeTypecastBehavior
attach()	将行为对象附加到组件。	yii\behaviors\AttributeTypecastBehavior
beforeSave()	处理所有者的 'beforeInsert' 和 'beforeUpdate' 事件，确保属性类型转换。	yii\behaviors\AttributeTypecastBehavior
canGetProperty()	返回一个值，指示是否可以读取属性。	yii\base\BaseObject
canSetProperty()	返回一个值，指示是否可以设置属性。	yii\base\BaseObject
className()	返回此类的完全限定名称。	yii\base\BaseObject
clearAutoDetectedAttributeTypes()	清除所有受影响的所有者类上自动检测到的 $attributeTypes 值的内部静态缓存。	yii\behaviors\AttributeTypecastBehavior
detach()	将行为对象从组件分离。	yii\base\Behavior
events()	声明 $owner 事件的事件处理程序。	yii\behaviors\AttributeTypecastBehavior
hasMethod()	返回一个值，指示方法是否已定义。	yii\base\BaseObject
hasProperty()	返回一个值，指示属性是否已定义。	yii\base\BaseObject
init()	初始化对象。	yii\base\BaseObject
typecastAttributes()	根据 $attributeTypes 对所有者属性进行类型转换。	yii\behaviors\AttributeTypecastBehavior

受保护的方法

隐藏继承的方法

方法	描述	定义于
detectAttributeTypes()	根据所有者验证规则为 $attributeTypes 组成默认值。	yii\behaviors\AttributeTypecastBehavior
resetOldAttributes()	重置命名属性的旧值。	yii\behaviors\AttributeTypecastBehavior
typecastValue()	将给定值转换为指定类型。	yii\behaviors\AttributeTypecastBehavior

常量

隐藏继承的常量

常量	值	定义于
TYPE_BOOLEAN	'boolean'	yii\behaviors\AttributeTypecastBehavior
TYPE_FLOAT	'float'	yii\behaviors\AttributeTypecastBehavior
TYPE_INTEGER	'integer'	yii\behaviors\AttributeTypecastBehavior
TYPE_STRING	'string'	yii\behaviors\AttributeTypecastBehavior

属性详情

隐藏继承的属性

$attributeTypes 公共属性

属性类型转换映射，格式为：属性名 => 类型。类型可以通过 PHP 可调用函数设置，该函数接受原始值作为参数，并应返回类型转换结果。例如

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

如果未设置，则属性类型映射将根据所有者验证规则自动组成。

public array|null $attributeTypes = null

$owner 公共属性

此行为的所有者。

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

$skipOnNull 公共属性

是否跳过对 null 值的类型转换。如果启用，则等于 null 的属性值将不会进行类型转换（例如，null 保持 null），否则它将根据 $attributeTypes 中配置的类型进行转换。

public boolean $skipOnNull = true

$typecastAfterFind 公共属性

是否在从数据库中检索拥有者模型数据后（查找或刷新后）执行类型转换。可以禁用此选项以提高性能。例如，在 yii\db\ActiveRecord 使用的情况下，查找后进行类型转换在大多数情况下都不会带来好处，因此可以禁用。请注意，在此行为附加到模型后，更改此选项值将无效。

public boolean $typecastAfterFind = false

$typecastAfterSave 公共属性 (自版本 2.0.14 起可用)

是否在保存拥有者模型（插入或更新）后执行类型转换。可以禁用此选项以提高性能。例如，在 yii\db\ActiveRecord 使用的情况下，保存后进行类型转换不会带来任何好处，因此可以禁用。请注意，在此行为附加到模型后，更改此选项值将无效。

public boolean $typecastAfterSave = false

$typecastAfterValidate 公共属性

是否在拥有者模型验证后执行类型转换。请注意，只有在验证成功的情况下才会执行类型转换，例如拥有者模型没有错误。请注意，在此行为附加到模型后，更改此选项值将无效。

public boolean $typecastAfterValidate = true

$typecastBeforeSave 公共属性

是否在保存拥有者模型（插入或更新）之前执行类型转换。可以禁用此选项以提高性能。例如，在 yii\db\ActiveRecord 使用的情况下，保存前进行类型转换不会带来任何好处，因此可以禁用。请注意，在此行为附加到模型后，更改此选项值将无效。

public boolean $typecastBeforeSave = false

方法详情

隐藏继承的方法

__call() 公共方法

定义于： yii\base\BaseObject::__call()

调用不是类方法的命名方法。

不要直接调用此方法，因为它是一个 PHP 魔术方法，当调用未知方法时会隐式调用。

public mixed __call ( $name, $params )
$name	string	方法名称
$params	array	方法参数
返回值	mixed	方法返回值
抛出	yii\base\UnknownMethodException	调用未知方法时

public void __construct ( $config = [] )
$config	array	将用于初始化对象属性的名称-值对

public mixed __get ( $name )
$name	string	属性名称
返回值	mixed	属性值
抛出	yii\base\UnknownPropertyException	如果未定义属性
抛出	yii\base\InvalidCallException	如果属性是只写属性

public boolean __isset ( $name )
$name	string	属性名称或事件名称
返回值	boolean	命名的属性是否已设置（非 null）。

public void __set ( $name, $value )
$name	string	属性名称或事件名称
$value	mixed	属性值
抛出	yii\base\UnknownPropertyException	如果未定义属性
抛出	yii\base\InvalidCallException	如果属性是只读属性

public void __unset ( $name )
$name	string	属性名称
抛出	yii\base\InvalidCallException	如果属性为只读。

public void afterFind ( $event )
$event	yii\base\Event	事件实例。

public void afterSave ( $event )
$event	yii\base\Event	事件实例。

public void afterValidate ( $event )
$event	yii\base\Event	事件实例。

public void attach ( $owner )
$owner	yii\base\Component	要将此行为附加到的组件。

public void beforeSave ( $event )
$event	yii\base\Event	事件实例。

protected array detectAttributeTypes ( )
返回值	array	属性类型映射。

public 数组 events ( )
返回值	array	事件（数组键）和对应的事件处理程序方法（数组值）。

public void typecastAttributes ( $attributeNames = null )
$attributeNames	array\|null	应该进行类型转换的属性名称列表。如果此参数为空，则表示应转换 $attributeTypes 中列出的任何属性。

protected 混合 typecastValue ( $value, $type )
$value	mixed	要进行类型转换的值。
$type	字符串\|可调用	类型名称或类型转换可调用。
返回值	mixed	类型转换结果。

public boolean canGetProperty ( $name, $checkVars = true )
$name	string	属性名称
$checkVars	boolean	是否将成员变量视为属性
返回值	boolean	属性是否可读

public boolean canSetProperty ( $name, $checkVars = true )
$name	string	属性名称
$checkVars	boolean	是否将成员变量视为属性
返回值	boolean	属性是否可写

public static string className ( )
返回值	string	此类的完全限定名称。

public 布尔值 hasMethod ( $name )
$name	string	方法名称
返回值	boolean	方法是否已定义

public 布尔值 hasProperty ( $name, $checkVars = true )
$name	string	属性名称
$checkVars	boolean	是否将成员变量视为属性
返回值	boolean	属性是否已定义