0 关注者

类 yii\behaviors\AttributesBehavior

所有类 | 属性 | 方法
继承yii\behaviors\AttributesBehavior » yii\base\Behavior » yii\base\BaseObject
实现yii\base\Configurable
版本可用2.0.13
源代码 https://github.com/yiisoft/yii2/blob/master/framework/behaviors/AttributesBehavior.php

AttributesBehavior 在特定事件发生时自动将指定的值分配给 ActiveRecord 对象的一个或多个属性。

要使用 AttributesBehavior，请配置 $attributes 属性，该属性应指定需要更新的属性列表以及应触发更新的对应事件。然后，使用 PHP 可调用函数配置封闭数组的值，其返回值将用于分配给当前属性。例如：

use yii\behaviors\AttributesBehavior;

public function behaviors()
{
    return [
        [
            'class' => AttributesBehavior::class,
            'attributes' => [
                'attribute1' => [
                    ActiveRecord::EVENT_BEFORE_INSERT => new Expression('NOW()'),
                    ActiveRecord::EVENT_BEFORE_UPDATE => \Yii::$app->formatter->asDatetime('2017-07-13'),
                ],
                'attribute2' => [
                    ActiveRecord::EVENT_BEFORE_VALIDATE => [$this, 'storeAttributes'],
                    ActiveRecord::EVENT_AFTER_VALIDATE => [$this, 'restoreAttributes'],
                ],
                'attribute3' => [
                    ActiveRecord::EVENT_BEFORE_VALIDATE => $fn2 = [$this, 'getAttribute2'],
                    ActiveRecord::EVENT_AFTER_VALIDATE => $fn2,
                ],
                'attribute4' => [
                    ActiveRecord::EVENT_BEFORE_DELETE => function ($event, $attribute) {
                        static::disabled() || $event->isValid = false;
                    },
                ],
            ],
        ],
    ];
}

由于属性值将由此行为自动设置，因此它们通常不是用户输入，因此不应进行验证，即它们不应出现在模型的 rules() 方法中。

公共属性

隐藏继承的属性

属性 类型 描述 定义于
$attributes array 要通过封闭数组中指定的值自动填充的属性列表。 yii\behaviors\AttributesBehavior
$order array 要通过事件自动填充的属性顺序列表。 yii\behaviors\AttributesBehavior
$owner yii\base\Component|null 此行为的所有者 yii\base\Behavior
$preserveNonEmptyValues boolean 是否保留非空属性值。 yii\behaviors\AttributesBehavior
$skipUpdateOnClean boolean 当 $owner 未被修改时是否跳过此行为 yii\behaviors\AttributesBehavior

公共方法

隐藏继承的方法

方法 描述 定义于
__call() 调用不是类方法的命名方法。 yii\base\BaseObject
__construct() 构造函数。 yii\base\BaseObject
__get() 返回对象属性的值。 yii\base\BaseObject
__isset() 检查属性是否已设置，即已定义且不为空。 yii\base\BaseObject
__set() 设置对象属性的值。 yii\base\BaseObject
__unset() 将对象属性设置为 null。 yii\base\BaseObject
attach() 将行为对象附加到组件。 yii\base\Behavior
canGetProperty() 返回一个值，指示是否可以读取属性。 yii\base\BaseObject
canSetProperty() 返回一个值，指示是否可以设置属性。 yii\base\BaseObject
className() 返回此类的完全限定名称。 yii\base\BaseObject
detach() 将行为对象从组件分离。 yii\base\Behavior
evaluateAttributes() 评估属性值并将其分配给当前属性。 yii\behaviors\AttributesBehavior
events() 声明 $owner 事件的事件处理程序。 yii\behaviors\AttributesBehavior
hasMethod() 返回一个值，指示是否定义了方法。 yii\base\BaseObject
hasProperty() 返回一个值，指示是否定义了属性。 yii\base\BaseObject
init() 初始化对象。 yii\base\BaseObject

受保护的方法

隐藏继承的方法

方法 描述 定义于
getValue() 返回当前属性的值。 yii\behaviors\AttributesBehavior

属性详细信息

隐藏继承的属性

$attributes public property

要通过封闭数组中指定的值自动填充的属性列表。数组键是要更新事件的 ActiveRecord 属性，数组值是对应事件的数组。对于此封闭数组：数组键是要更新属性的 ActiveRecord 事件，数组值是要分配给当前属性的值。这可以是匿名函数、数组格式的可调用函数（例如 [$this, 'methodName']）、表示 DB 表达式的 Expression 对象（例如 new Expression('NOW()')）、标量、字符串或任意值。如果是前者，函数的返回值将分配给属性。

[
  'attribute1' => [
      ActiveRecord::EVENT_BEFORE_INSERT => new Expression('NOW()'),
      ActiveRecord::EVENT_BEFORE_UPDATE => \Yii::$app->formatter->asDatetime('2017-07-13'),
  ],
  'attribute2' => [
      ActiveRecord::EVENT_BEFORE_VALIDATE => [$this, 'storeAttributes'],
      ActiveRecord::EVENT_AFTER_VALIDATE => [$this, 'restoreAttributes'],
  ],
  'attribute3' => [
      ActiveRecord::EVENT_BEFORE_VALIDATE => $fn2 = [$this, 'getAttribute2'],
      ActiveRecord::EVENT_AFTER_VALIDATE => $fn2,
  ],
  'attribute4' => [
      ActiveRecord::EVENT_BEFORE_DELETE => function ($event, $attribute) {
          static::disabled() || $event->isValid = false;
      },
  ],
]
public array $attributes = []
$order public property

要通过事件自动填充的属性顺序列表。数组键是要更新属性的 ActiveRecord 事件，数组值表示对应属性的顺序。其余属性最后处理。如果此属性的 $attributes 未指定此事件，则忽略该属性。

[
    ActiveRecord::EVENT_BEFORE_VALIDATE => ['attribute1', 'attribute2'],
    ActiveRecord::EVENT_AFTER_VALIDATE => ['attribute2', 'attribute1'],
]
public array $order = []
$preserveNonEmptyValues public property

是否保留非空属性值。

public boolean $preserveNonEmptyValues = false
$skipUpdateOnClean 公共属性

当 $owner 未被修改时是否跳过此行为

public boolean $skipUpdateOnClean = true

方法详情

隐藏继承的方法

__call() 公共方法

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

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

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

public mixed __call ( $name, $params )
$name string

方法名称
$params array

方法参数
返回值 mixed

方法返回值
抛出异常 yii\base\UnknownMethodException

调用未知方法时

 

                public function __call($name, $params)
{
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
__construct() 公共方法

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

构造函数。

默认实现执行两件事

  • 使用给定的配置 $config 初始化对象。
  • 调用 init().

如果此方法在子类中被重写，建议

  • 构造函数的最后一个参数是一个配置数组，就像这里的 $config 一样。
  • 在构造函数的末尾调用父类的实现。
public void __construct ( $config = [] )
$config array

将用于初始化对象属性的名称-值对

 

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}
__get() 公共方法

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

返回对象属性的值。

不要直接调用此方法，因为它是 PHP 魔术方法，当执行 $value = $object->property; 时会被隐式调用。

另请参阅 __set().

public mixed __get ( $name )
$name string

属性名称
返回值 mixed

属性值
抛出异常 yii\base\UnknownPropertyException

如果属性未定义
抛出异常 yii\base\InvalidCallException

如果属性是只写属性

 

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter();
    } elseif (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
__isset() 公共方法

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

检查属性是否已设置，即已定义且不为空。

不要直接调用此方法，因为它是 PHP 魔术方法，当执行 isset($object->property) 时会被隐式调用。

请注意，如果属性未定义，将返回 false。

另请参阅 https://php.ac.cn/manual/en/function.isset.php.

public boolean __isset ( $name )
$name string

属性名称或事件名称
返回值 boolean

命名的属性是否已设置（非空）。

 

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    return false;
}
__set() 公共方法

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

设置对象属性的值。

不要直接调用此方法，因为它是 PHP 魔术方法，当执行 $object->property = $value; 时会被隐式调用。

另请参阅 __get().

public void __set ( $name, $value )
$name string

属性名称或事件名称
$value mixed

属性值
抛出异常 yii\base\UnknownPropertyException

如果属性未定义
抛出异常 yii\base\InvalidCallException

如果属性是只读属性

 

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter($value);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    } else {
        throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
    }
}
__unset() 公共方法

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

将对象属性设置为 null。

不要直接调用此方法，因为它是 PHP 魔术方法，当执行 unset($object->property) 时会被隐式调用。

请注意，如果属性未定义，此方法将不做任何事。如果属性是只读属性，它将抛出异常。

另请参阅 https://php.ac.cn/manual/en/function.unset.php.

public void __unset ( $name )
$name string

属性名称
抛出异常 yii\base\InvalidCallException

如果属性是只读属性。

 

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
    }
}
attach() 公共方法

定义于： yii\base\Behavior::attach()

将行为对象附加到组件。

默认实现将设置 $owner 属性，并根据 events() 中的声明附加事件处理程序。如果您重写此方法，请确保调用父类的实现。

public void attach ( $owner )
$owner yii\base\Component

要附加此行为的组件。

 

                public function attach($owner)
{
    $this->owner = $owner;
    foreach ($this->events() as $event => $handler) {
        $this->_attachedEvents[$event] = $handler;
        $owner->on($event, is_string($handler) ? [$this, $handler] : $handler);
    }
}
canGetProperty() 公共方法

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

返回一个值，指示是否可以读取属性。

属性是可读的，如果

  • 类具有与指定名称关联的 getter 方法（在这种情况下，属性名称不区分大小写）；
  • 类具有与指定名称相同的成员变量（当 $checkVars 为 true 时）；

另请参阅 canSetProperty().

public boolean canGetProperty ( $name, $checkVars = true )
$name string

属性名称
$checkVars boolean

是否将成员变量视为属性
返回值 boolean

属性是否可读

 

                public function canGetProperty($name, $checkVars = true)
{
    return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
canSetProperty() 公共方法

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

返回一个值，指示是否可以设置属性。

属性是可写的，如果

  • 类具有与指定名称关联的 setter 方法（在这种情况下，属性名称不区分大小写）；
  • 类具有与指定名称相同的成员变量（当 $checkVars 为 true 时）；

另请参阅 canGetProperty().

public boolean canSetProperty ( $name, $checkVars = true )
$name string

属性名称
$checkVars boolean

是否将成员变量视为属性
返回值 boolean

属性是否可写

 

                public function canSetProperty($name, $checkVars = true)
{
    return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
className() 公共静态方法
自 2.0.14 起已弃用。在 PHP >=5.5 上，使用 ::class 代替。

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

返回此类的完全限定名称。

public static string className ( )
返回值 string

此类的完全限定名称。

 

                public static function className()
{
    return get_called_class();
}
detach() 公共方法

定义于: yii\base\Behavior::detach()

将行为对象从组件分离。

默认实现将取消设置 $owner 属性并分离在 events() 中声明的事件处理程序。如果覆盖此方法，请确保调用父级实现。

public void detach ( )

                public function detach()
{
    if ($this->owner) {
        foreach ($this->_attachedEvents as $event => $handler) {
            $this->owner->off($event, is_string($handler) ? [$this, $handler] : $handler);
        }
        $this->_attachedEvents = [];
        $this->owner = null;
    }
}
evaluateAttributes() 公共方法

评估属性值并将其分配给当前属性。

public void evaluateAttributes ( $event )
$event yii\base\Event 

                public function evaluateAttributes($event)
{
    if (
        $this->skipUpdateOnClean
        && $event->name === ActiveRecord::EVENT_BEFORE_UPDATE
        && empty($this->owner->dirtyAttributes)
    ) {
        return;
    }
    $attributes = array_keys(array_filter($this->attributes, function ($carry) use ($event) {
        return array_key_exists($event->name, $carry);
    }));
    if (!empty($this->order[$event->name])) {
        $attributes = array_merge(
            array_intersect((array) $this->order[$event->name], $attributes),
            array_diff($attributes, (array) $this->order[$event->name])
        );
    }
    foreach ($attributes as $attribute) {
        if ($this->preserveNonEmptyValues && !empty($this->owner->$attribute)) {
            continue;
        }
        $this->owner->$attribute = $this->getValue($attribute, $event);
    }
}
events() 公共方法

声明 $owner 事件的事件处理程序。

子类可以覆盖此方法来声明应附加到 $owner 组件事件的 PHP 回调函数。

当行为附加到所有者时，回调函数将附加到 $owner 的事件；当行为从组件中分离时，它们将从事件中分离。

回调函数可以是以下任何一种：

  • 此行为中的方法：'handleClick'，等效于 [$this, 'handleClick']
  • 对象方法：[$object, 'handleClick']
  • 静态方法：['Page', 'handleClick']
  • 匿名函数：function ($event) { ... }

以下是一个示例

[
    Model::EVENT_BEFORE_VALIDATE => 'myBeforeValidate',
    Model::EVENT_AFTER_VALIDATE => 'myAfterValidate',
]
public array events ( )
返回值 array

事件（数组键）和相应的事件处理程序方法（数组值）。

 

                public function events()
{
    return array_fill_keys(
        array_reduce($this->attributes, function ($carry, $item) {
            return array_merge($carry, array_keys($item));
        }, []),
        'evaluateAttributes'
    );
}
getValue() 受保护方法

返回当前属性的值。

此方法由 evaluateAttributes() 调用。它的返回值将被分配给触发事件的相应目标属性。

protected mixed getValue ( $attribute, $event )
$attribute string

目标属性名称
$event yii\base\Event

触发当前属性更新的事件。
返回值 mixed

属性值

 

                protected function getValue($attribute, $event)
{
    if (!isset($this->attributes[$attribute][$event->name])) {
        return null;
    }
    $value = $this->attributes[$attribute][$event->name];
    if ($value instanceof Closure || (is_array($value) && is_callable($value))) {
        return $value($event, $attribute);
    }
    return $value;
}
hasMethod() 公共方法

定义于: yii\base\BaseObject::hasMethod()

返回一个值，指示是否定义了方法。

默认实现是调用 php 函数 method_exists()。当您实现 php 魔术方法 __call() 时，您可能会覆盖此方法。

public boolean hasMethod ( $name )
$name string

方法名称
返回值 boolean

方法是否已定义

 

                public function hasMethod($name)
{
    return method_exists($this, $name);
}
hasProperty() 公共方法

定义于: yii\base\BaseObject::hasProperty()

返回一个值，指示是否定义了属性。

如果定义了属性

  • 该类具有与指定名称关联的 getter 或 setter 方法（在这种情况下，属性名称不区分大小写）；
  • 类具有与指定名称相同的成员变量（当 $checkVars 为 true 时）；

另见

public boolean hasProperty ( $name, $checkVars = true )
$name string

属性名称
$checkVars boolean

是否将成员变量视为属性
返回值 boolean

属性是否已定义

 

                public function hasProperty($name, $checkVars = true)
{
    return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
init() 公共方法

定义于: yii\base\BaseObject::init()

初始化对象。

此方法在构造函数结束时调用，在对象使用给定配置初始化后调用。

public void init ( )

                public function init()
{
}