0 关注者

类 yii\behaviors\BlameableBehavior

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

BlameableBehavior 自动用当前用户 ID 填充指定的属性。

要使用 BlameableBehavior，请在您的 ActiveRecord 类中插入以下代码

use yii\behaviors\BlameableBehavior;

public function behaviors()
{
    return [
        BlameableBehavior::class,
    ];
}

默认情况下，BlameableBehavior 会在关联的 AR 对象被插入时用当前用户 ID 填充 created_by 和 updated_by 属性；它会在 AR 对象被更新时用当前用户 ID 填充 updated_by 属性。

由于属性值会由此行为自动设置，因此它们通常不是用户输入，因此不应该被验证，例如 created_by 和 updated_by 不应该出现在模型的 rules() 方法中。

如果您的属性名称不同，您可以配置 $createdByAttribute 和 $updatedByAttribute 属性，如下所示

public function behaviors()
{
    return [
        [
            'class' => BlameableBehavior::class,
            'createdByAttribute' => 'author_id',
            'updatedByAttribute' => 'updater_id',
        ],
    ];
}

公共属性

隐藏继承的属性

属性 类型 描述 定义
$attributes array 将自动填充通过 $value 指定的值的属性列表。 yii\behaviors\AttributeBehavior
$createdByAttribute string 将接收当前用户 ID 值的属性。如果不想记录创建者 ID，请将此属性设置为 false。 yii\behaviors\BlameableBehavior
$defaultValue mixed 用户为访客时的默认值 yii\behaviors\BlameableBehavior
$owner yii\base\Component|null 此行为的拥有者 yii\base\Behavior
$preserveNonEmptyValues boolean 是否保留非空属性值。 yii\behaviors\AttributeBehavior
$skipUpdateOnClean boolean 当 $owner 未被修改时，是否跳过此行为 yii\behaviors\AttributeBehavior
$updatedByAttribute string 将接收当前用户 ID 值的属性。如果不想记录更新者 ID，请将此属性设置为 false。 yii\behaviors\BlameableBehavior
$value mixed 将分配给当前属性的值。 yii\behaviors\BlameableBehavior

公共方法

隐藏继承的方法

方法 描述 定义
__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\AttributeBehavior
events() 声明 $owner 事件的事件处理程序。 yii\behaviors\AttributeBehavior
hasMethod() 返回一个值，指示方法是否已定义。 yii\base\BaseObject
hasProperty() 返回一个值，指示属性是否已定义。 yii\base\BaseObject
init() 初始化对象。 yii\behaviors\BlameableBehavior

受保护的方法

隐藏继承的方法

方法 描述 定义
getDefaultValue() 获取默认值 yii\behaviors\BlameableBehavior
getValue() 返回当前属性的值。 yii\behaviors\BlameableBehavior

属性详细信息

隐藏继承的属性

$createdByAttribute 公共属性

将接收当前用户 ID 值的属性。如果不想记录创建者 ID，请将此属性设置为 false。

public string $createdByAttribute = 'created_by'
$defaultValue 公共属性 (可用版本 2.0.14)

用户为访客时的默认值

public mixed $defaultValue = null
$updatedByAttribute 公共属性

将接收当前用户 ID 值的属性。如果不想记录更新者 ID，请将此属性设置为 false。

public string $updatedByAttribute = 'updated_by'
$value 公共属性

如果属性为 null，则将使用 Yii::$app->user->id 的值作为值。

将被分配给当前属性的值。它可以是匿名函数、数组格式的可调用对象（例如 [$this, 'methodName']）、表示数据库表达式的 Expression 对象（例如 new Expression('NOW()')）、标量、字符串或任意值。如果是前者，则函数的返回值将被分配给属性。函数的签名应如下所示，

function ($event)
{
    // return value will be assigned to the attribute
}
public mixed $value = null

方法详情

隐藏继承的方法

__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

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

 

                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() 公共方法

定义于： yii\behaviors\AttributeBehavior::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;
    }
    if (!empty($this->attributes[$event->name])) {
        $attributes = (array) $this->attributes[$event->name];
        $value = $this->getValue($event);
        foreach ($attributes as $attribute) {
            // ignore attribute names which are not string (e.g. when set by TimestampBehavior::updatedAtAttribute)
            if (is_string($attribute)) {
                if ($this->preserveNonEmptyValues && !empty($this->owner->$attribute)) {
                    continue;
                }
                $this->owner->$attribute = $value;
            }
        }
    }
}
events() 公共方法

定义于： yii\behaviors\AttributeBehavior::events()

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

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

当行为附加到所有者时，回调将附加到 $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_keys($this->attributes),
        'evaluateAttributes'
    );
}
getDefaultValue() 受保护方法 (自版本 2.0.14 起可用)

获取默认值

protected array|mixed getDefaultValue ( $event )
$event yii\base\Event 

                protected function getDefaultValue($event)
{
    if ($this->defaultValue instanceof \Closure || (is_array($this->defaultValue) && is_callable($this->defaultValue))) {
        return call_user_func($this->defaultValue, $event);
    }
    return $this->defaultValue;
}
getValue() 受保护方法

返回当前属性的值。

如果 $value 属性为 null，则 $defaultValue 的值将用作该值。

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

protected mixed getValue ( $event )
$event yii\base\Event

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

属性值

 

                protected function getValue($event)
{
    if ($this->value === null && Yii::$app->has('user')) {
        $userId = Yii::$app->get('user')->id;
        if ($userId === null) {
            return $this->getDefaultValue($event);
        }
        return $userId;
    } elseif ($this->value === null) {
        return $this->getDefaultValue($event);
    }
    return parent::getValue($event);
}
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() 公共方法

初始化对象。

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

public void init ( )

                public function init()
{
    parent::init();
    if (empty($this->attributes)) {
        $this->attributes = [
            BaseActiveRecord::EVENT_BEFORE_INSERT => [$this->createdByAttribute, $this->updatedByAttribute],
            BaseActiveRecord::EVENT_BEFORE_UPDATE => $this->updatedByAttribute,
        ];
    }
}