1 追蹤者

類別 yii\behaviors\OptimisticLockBehavior

所有類別 | Properties | Methods
繼承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() 的方法，該方法將模型的版本加一，當您需要將實體標記為在連接的客戶端之間過時，並避免對其進行任何更改，直到它們再次載入它時，這可能會很有用

$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() 將版本值加一並儲存到資料庫。 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

方法參數
return mixed

方法傳回值
throws 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

屬性名稱
return mixed

屬性值
throws yii\base\UnknownPropertyException

如果未定義屬性
throws 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.dev.org.tw/manual/en/function.isset.php。

public boolean __isset ( $name )
$name string

屬性名稱或事件名稱
return 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

屬性值
throws yii\base\UnknownPropertyException

如果未定義屬性
throws 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.dev.org.tw/manual/en/function.unset.php。

public void __unset ( $name )
$name string

屬性名稱
throws 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

是否將成員變數視為屬性
return 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

是否將成員變數視為屬性
return 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 ( )
return 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 ( )
return 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 ( )
return string

屬性名稱。
throws 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

觸發目前屬性更新的事件。
return 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

方法名稱
return 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

是否將成員變數視為屬性
return 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 起可用)

將版本值加一並儲存到資料庫。

$model->upgrade();
public void upgrade ( )
throws 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]);
}