1 位关注者

类 yii\behaviors\OptimisticLockBehavior

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

OptimisticLockBehavior 会自动使用 optimisticLock() 返回的列名来升级模型的锁版本。

乐观锁允许多个用户访问同一个记录进行编辑，并避免潜在的冲突。如果用户尝试在某些过时数据（因为其他用户修改了数据）的基础上保存记录，则会抛出 StaleObjectException 异常，并且更新或删除操作会被跳过。

要使用此行为，首先按照 optimisticLock() 中列出的步骤启用乐观锁，从 ActiveRecord 类的 rules() 方法中移除保存锁版本的列名，然后添加以下代码：

use yii\behaviors\OptimisticLockBehavior;

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

默认情况下，OptimisticLockBehavior 将使用 getBodyParam() 解析提交的值，或者在任何失败时将其设置为 0。这意味着没有包含版本属性的请求可能会成功更新实体第一次，但从那里开始，任何进一步的尝试都将失败，除非请求包含预期的版本号。

附加后，如果模型类的内部使用没有包含 getBodyParam() 中的版本号，则保存记录也会失败。扩展模型类可能很有用，通过覆盖 optimisticLock() 在父类中启用乐观锁，然后将行为附加到子类，以便您可以将父模型绑定到内部使用，同时将包含此行为的子模型绑定到负责接收最终用户输入的控制器。或者，您还可以使用 PHP 可调用函数配置 $value 属性以实现不同的逻辑。

OptimisticLockBehavior 还提供了一个名为 upgrade() 的方法，该方法将模型的版本增加 1，当您需要将实体标记为在连接的客户端之间过时并避免对其进行任何更改，直到它们再次加载它时，这可能很有用。

$model->upgrade();

有关如何启用乐观锁的详细信息，另请参见 yii\db\BaseActiveRecord::optimisticLock()。

公共属性

隐藏继承的属性

属性 类型 描述 定义于
$attributes array 要使用 $value 指定的值自动填充的属性列表。 yii\behaviors\AttributeBehavior
$owner yii\base\Component|null 此行为的所有者 yii\base\Behavior
$preserveNonEmptyValues boolean 是否保留非空属性值。 yii\behaviors\AttributeBehavior
$skipUpdateOnClean boolean 当 $owner 未被修改时是否跳过此行为 yii\behaviors\OptimisticLockBehavior
$value mixed 将分配给当前属性的值。 yii\behaviors\OptimisticLockBehavior

公共方法

隐藏继承的方法

方法 描述 定义于
__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
attach() 将行为对象附加到组件。 yii\behaviors\OptimisticLockBehavior
canGetProperty() 返回一个值，指示是否可以读取属性。 yii\base\BaseObject
canSetProperty() 返回一个值，指示是否可以设置属性。 yii\base\BaseObject
className() 返回此类的完全限定名称。 yii\base\BaseObject
detach() 将行为对象从组件分离。 yii\base\Behavior
evaluateAttributes() 评估属性值并将其分配给当前属性。 yii\behaviors\AttributeBehavior
events() 声明 $owner 事件的事件处理程序。 yii\behaviors\OptimisticLockBehavior
hasMethod() 返回一个值，指示方法是否已定义。 yii\base\BaseObject
hasProperty() 返回一个值，指示属性是否已定义。 yii\base\BaseObject
init() 初始化对象。 yii\base\BaseObject
upgrade() 将版本值增加 1 并将其存储到数据库中。 yii\behaviors\OptimisticLockBehavior

受保护的方法

隐藏继承的方法

方法 描述 定义于
getLockAttribute() 返回保存版本值的列名，如 optimisticLock() 中所定义。 yii\behaviors\OptimisticLockBehavior
getValue() 返回当前属性的值。 yii\behaviors\OptimisticLockBehavior

属性详情

隐藏继承的属性

$skipUpdateOnClean 公共属性 (自 2.0.8 版本起可用)

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

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

如果值为 null，则将直接从 getBodyParam() 解析或设置为 0。

将分配给当前属性的值。这可以是匿名函数、数组格式的可调用函数（例如 [$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()

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

不要直接调用此方法，因为它是一个 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() 公共方法

将行为对象附加到组件。

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

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

要将此行为附加到的组件。

 

                public function attach($owner)
{
    parent::attach($owner);
    if (empty($this->attributes)) {
        $lock = $this->getLockAttribute();
        $this->attributes = array_fill_keys(array_keys($this->events()), $lock);
    }
}
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() 公共方法

声明 $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 Yii::$app->request instanceof \yii\web\Request ? [
        BaseActiveRecord::EVENT_BEFORE_INSERT => 'evaluateAttributes',
        BaseActiveRecord::EVENT_BEFORE_UPDATE => 'evaluateAttributes',
        BaseActiveRecord::EVENT_BEFORE_DELETE => 'evaluateAttributes',
    ] : [];
}
getLockAttribute() 受保护的方法（自版本 2.0.16 起可用）

返回保存版本值的列名，如 optimisticLock() 中所定义。

protected string getLockAttribute ( )
返回值 string

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

如果 optimisticLock() 配置不正确。

 

                protected function getLockAttribute()
{
    if ($this->_lockAttribute) {
        return $this->_lockAttribute;
    }
    /* @var $owner BaseActiveRecord */
    $owner = $this->owner;
    $lock = $owner->optimisticLock();
    if ($lock === null || $owner->hasAttribute($lock) === false) {
        throw new InvalidCallException("Unable to get the optimistic lock attribute. Probably 'optimisticLock()' method is misconfigured.");
    }
    $this->_lockAttribute = $lock;
    return $lock;
}
getValue() 受保护的方法

返回当前属性的值。

如果为 null，则值将从 getBodyParam() 中解析或设置为 0。

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

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

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

属性值

 

                protected function getValue($event)
{
    if ($this->value === null) {
        $request = Yii::$app->getRequest();
        $lock = $this->getLockAttribute();
        $formName = $this->owner->formName();
        $formValue = $formName ? ArrayHelper::getValue($request->getBodyParams(), $formName . '.' . $lock) : null;
        $input = $formValue ?: $request->getBodyParam($lock);
        $isValid = $input && (new NumberValidator())->validate($input);
        return $isValid ? $input : 0;
    }
    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() 公共方法

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

初始化对象。

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

public void init ( )

                public function init()
{
}
upgrade() 公共方法（自版本 2.0.16 起可用）

将版本值增加 1 并将其存储到数据库中。

$model->upgrade();
public void upgrade ( )
抛出异常 yii\base\InvalidCallException

如果所有者是新记录。

 

                public function upgrade()
{
    /* @var $owner BaseActiveRecord */
    $owner = $this->owner;
    if ($owner->getIsNewRecord()) {
        throw new InvalidCallException('Upgrading the model version is not possible on a new record.');
    }
    $lock = $this->getLockAttribute();
    $version = $owner->$lock ?: 0;
    $owner->updateAttributes([$lock => $version + 1]);
}