0 追蹤者

抽象類別 yii\mutex\DbMutex

繼承關係yii\mutex\DbMutex » yii\mutex\Mutex » yii\base\Component » yii\base\BaseObject
實作介面yii\base\Configurable
子類別yii\mutex\MysqlMutex, yii\mutex\OracleMutex, yii\mutex\PgsqlMutex
自版本起可用2.0
原始碼 https://github.com/yiisoft/yii2/blob/master/framework/mutex/DbMutex.php

DbMutex 是實現互斥鎖 "lock" 機制的基礎類別,其依賴於資料庫。

另請參閱 yii\mutex\Mutex

公開屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$autoRelease boolean 是否必須在結束腳本執行之前自動釋放在此進程中取得的所有鎖(即本地鎖)。 yii\mutex\Mutex
$behaviors yii\base\Behavior[] 附加到此組件的行為列表。 yii\base\Component
$db yii\db\Connection|array|string DB 連線物件或 DB 連線的應用程式組件 ID。 yii\mutex\DbMutex

公開方法

隱藏繼承的方法

方法 描述 定義於
__call() 調用未作為類別方法的具名方法。 yii\base\Component
__clone() 在通過克隆現有物件建立物件後,將調用此方法。 yii\base\Component
__construct() 建構子。 yii\base\BaseObject
__get() 傳回組件屬性的值。 yii\base\Component
__isset() 檢查是否已設定屬性,即已定義且非 null。 yii\base\Component
__set() 設定組件屬性的值。 yii\base\Component
__unset() 將組件屬性設定為 null。 yii\base\Component
acquire() 通過名稱取得鎖。 yii\mutex\Mutex
attachBehavior() 將行為附加到此組件。 yii\base\Component
attachBehaviors() 將行為列表附加到組件。 yii\base\Component
behaviors() 傳回此組件應表現為的行為列表。 yii\base\Component
canGetProperty() 傳回一個值,指示是否可以讀取屬性。 yii\base\Component
canSetProperty() 傳回一個值,指示是否可以設定屬性。 yii\base\Component
className() 傳回此類別的完整限定名稱。 yii\base\BaseObject
detachBehavior() 從組件分離行為。 yii\base\Component
detachBehaviors() 從組件分離所有行為。 yii\base\Component
ensureBehaviors() 確保在 behaviors() 中宣告的行為已附加到此組件。 yii\base\Component
getBehavior() 傳回具名的行為物件。 yii\base\Component
getBehaviors() 傳回附加到此組件的所有行為。 yii\base\Component
hasEventHandlers() 傳回一個值,指示是否有名稱事件的任何處理常式附加。 yii\base\Component
hasMethod() 傳回一個值,指示是否已定義方法。 yii\base\Component
hasProperty() 傳回一個值,指示是否為此組件定義了屬性。 yii\base\Component
init() 初始化基於通用資料庫表的互斥鎖實作。 yii\mutex\DbMutex
isAcquired() 檢查目前進程是否已取得鎖。 yii\mutex\Mutex
off() 從此組件分離現有的事件處理常式。 yii\base\Component
on() 將事件處理常式附加到事件。 yii\base\Component
release() 釋放已取得的鎖。如果未找到鎖,此方法將傳回 false。 yii\mutex\Mutex
trigger() 觸發事件。 yii\base\Component

受保護方法

隱藏繼承的方法

方法 描述 定義於
acquireLock() 此方法應由具體的 Mutex 實作擴展。通過名稱取得鎖。 yii\mutex\Mutex
releaseLock() 此方法應由具體的 Mutex 實作擴展。通過給定名稱釋放鎖。 yii\mutex\Mutex

屬性詳細資訊

隱藏繼承的屬性

$db 公開屬性

DB 連線物件或 DB 連線的應用程式組件 ID。 在建立 Mutex 物件後,如果要更改此屬性,則應僅使用 DB 連線物件對其進行賦值。 從 2.0.2 版本開始,這也可以是用於建立物件的組態陣列。

方法詳細資訊

隱藏繼承的方法

__call() 公開方法

定義於: yii\base\Component::__call()

調用未作為類別方法的具名方法。

此方法將檢查任何附加的行為是否具有具名方法,如果可用,將執行該方法。

不要直接調用此方法,因為它是一個 PHP 魔術方法,當調用未知方法時,將隱式調用它。

public mixed __call ( $name, $params )
名稱 字串

方法名稱

參數 陣列

方法參數

回傳 混合型別

方法回傳值

拋出 yii\base\UnknownMethodException

當呼叫未知方法時

                public function __call($name, $params)
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $object) {
        if ($object->hasMethod($name)) {
            return call_user_func_array([$object, $name], $params);
        }
    }
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

            
__clone() public method

定義於: yii\base\Component::__clone()

在通過克隆現有物件建立物件後,將調用此方法。

它會移除所有行為,因為它們附加到舊的物件。

public void __clone ( )

                public function __clone()
{
    $this->_events = [];
    $this->_eventWildcards = [];
    $this->_behaviors = null;
}

            
__construct() public method

定義於: yii\base\BaseObject::__construct()

建構子。

預設實作會做兩件事

  • 使用給定的組態 $config 初始化物件。
  • 呼叫 init()

如果這個方法在子類別中被覆寫,建議

  • 建構子的最後一個參數是一個組態陣列,就像這裡的 $config 一樣。
  • 在建構子的結尾呼叫父類別的實作。
public void __construct ( $config = [] )
組態 陣列

將用於初始化物件屬性的 名稱-值 配對

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

            
__get() public method

定義於: yii\base\Component::__get()

傳回組件屬性的值。

此方法將依以下順序檢查並相應地執行動作

  • 由 getter 定義的屬性:回傳 getter 結果
  • 行為的屬性:回傳行為屬性值

不要直接呼叫此方法,因為它是 PHP 魔術方法,當執行 $value = $component->property; 時會隱含地呼叫它。

另請參閱 __set()

public mixed __get ( $name )
名稱 字串

屬性名稱

回傳 混合型別

屬性值或行為屬性的值

拋出 yii\base\UnknownPropertyException

如果屬性未定義

拋出 yii\base\InvalidCallException

如果屬性為唯寫。

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        // read property, e.g. getName()
        return $this->$getter();
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name;
        }
    }
    if (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() public method

定義於: yii\base\Component::__isset()

檢查是否已設定屬性,即已定義且非 null。

此方法將依以下順序檢查並相應地執行動作

  • 由 setter 定義的屬性:回傳屬性是否已設定
  • 行為的屬性:回傳屬性是否已設定
  • 對於不存在的屬性,回傳 false

不要直接呼叫此方法,因為它是 PHP 魔術方法,當執行 isset($component->property) 時會隱含地呼叫它。

另請參閱 https://php.dev.org.tw/manual/en/function.isset.php

public boolean __isset ( $name )
名稱 字串

屬性名稱或事件名稱

回傳 boolean

具名屬性是否已設定

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name !== null;
        }
    }
    return false;
}

            
__set() public method

定義於: yii\base\Component::__set()

設定組件屬性的值。

此方法將依以下順序檢查並相應地執行動作

  • 由 setter 定義的屬性:設定屬性值
  • 格式為 "on xyz" 的事件:將處理常式附加到事件 "xyz"
  • 格式為 "as xyz" 的行為:附加名為 "xyz" 的行為
  • 行為的屬性:設定行為屬性值

不要直接呼叫此方法,因為它是 PHP 魔術方法,當執行 $component->property = $value; 時會隱含地呼叫它。

另請參閱 __get()

public void __set ( $name, $value )
名稱 字串

屬性名稱或事件名稱

混合型別

屬性值

拋出 yii\base\UnknownPropertyException

如果屬性未定義

拋出 yii\base\InvalidCallException

如果屬性為唯讀。

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        // set property
        $this->$setter($value);
        return;
    } elseif (strncmp($name, 'on ', 3) === 0) {
        // on event: attach event handler
        $this->on(trim(substr($name, 3)), $value);
        return;
    } elseif (strncmp($name, 'as ', 3) === 0) {
        // as behavior: attach behavior
        $name = trim(substr($name, 3));
        $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = $value;
            return;
        }
    }
    if (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}

            
__unset() public method

定義於: yii\base\Component::__unset()

將組件屬性設定為 null。

此方法將依以下順序檢查並相應地執行動作

  • 由 setter 定義的屬性:將屬性值設定為 null
  • 行為的屬性:將屬性值設定為 null

不要直接呼叫此方法,因為它是 PHP 魔術方法,當執行 unset($component->property) 時會隱含地呼叫它。

另請參閱 https://php.dev.org.tw/manual/en/function.unset.php

public void __unset ( $name )
名稱 字串

屬性名稱

拋出 yii\base\InvalidCallException

如果屬性為唯讀。

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = null;
            return;
        }
    }
    throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}

            
acquire() public method

定義於: yii\mutex\Mutex::acquire()

通過名稱取得鎖。

public boolean acquire ( $name, $timeout 0 )
名稱 字串

要取得的鎖定名稱。必須是唯一的。

逾時 整數

等待鎖定釋放的時間(以秒為單位)。預設為零,表示如果鎖定已被取得,方法將立即回傳 false。

回傳 boolean

鎖定取得結果。

                public function acquire($name, $timeout = 0)
{
    if (!in_array($name, $this->_locks, true) && $this->acquireLock($name, $timeout)) {
        $this->_locks[] = $name;
        return true;
    }
    return false;
}

            
acquireLock() protected abstract method

定義於: yii\mutex\Mutex::acquireLock()

此方法應由具體的 Mutex 實作擴展。通過名稱取得鎖。

protected abstract boolean acquireLock ( $name, $timeout 0 )
名稱 字串

要取得的鎖定名稱。

逾時 整數

等待鎖定釋放的時間(以秒為單位)。

回傳 boolean

取得結果。

                abstract protected function acquireLock($name, $timeout = 0);

            
attachBehavior() public method

定義於: yii\base\Component::attachBehavior()

將行為附加到此組件。

此方法將根據給定的組態建立行為物件。之後,將透過呼叫 yii\base\Behavior::attach() 方法將行為物件附加到此元件。

另請參閱 detachBehavior()

public yii\base\Behavior attachBehavior ( $name, $behavior )
名稱 字串

行為的名稱。

行為 字串|陣列|yii\base\Behavior

行為組態。可以是下列其中之一

回傳 yii\base\Behavior

行為物件

                public function attachBehavior($name, $behavior)
{
    $this->ensureBehaviors();
    return $this->attachBehaviorInternal($name, $behavior);
}

            
attachBehaviors() public method

定義於: yii\base\Component::attachBehaviors()

將行為列表附加到組件。

每個行為都以其名稱編製索引,並且應該是 yii\base\Behavior 物件、指定行為類別的字串,或用於建立行為的組態陣列。

另請參閱 attachBehavior()

public void attachBehaviors ( $behaviors )
$behaviors 陣列

要附加到元件的行為列表

                public function attachBehaviors($behaviors)
{
    $this->ensureBehaviors();
    foreach ($behaviors as $name => $behavior) {
        $this->attachBehaviorInternal($name, $behavior);
    }
}

            
behaviors() public method

定義於: yii\base\Component::behaviors()

傳回此組件應表現為的行為列表。

子類別可以覆寫此方法,以指定它們想要表現為哪些行為。

此方法的回傳值應該是以行為名稱索引的行為物件或組態陣列。行為組態可以是指定行為類別的字串,或具有以下結構的陣列

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

請注意,行為類別必須繼承自 yii\base\Behavior。行為可以使用名稱或匿名方式附加。當名稱用作陣列鍵時,使用此名稱,稍後可以使用 getBehavior() 檢索該行為,或使用 detachBehavior() 分離該行為。匿名行為無法檢索或分離。

在此方法中宣告的行為將自動(按需)附加到元件。

public array behaviors ( )
回傳 陣列

行為組態。

                public function behaviors()
{
    return [];
}

            
canGetProperty() public method

定義於: yii\base\Component::canGetProperty()

傳回一個值,指示是否可以讀取屬性。

如果符合以下條件,則可以讀取屬性

  • 類別具有與指定名稱關聯的 getter 方法(在這種情況下,屬性名稱不區分大小寫);
  • 類別具有具有指定名稱的成員變數(當 $checkVars 為 true 時);
  • 附加的行為具有給定名稱的可讀屬性(當 $checkBehaviors 為 true 時)。

另請參閱 canSetProperty()

public boolean canGetProperty ( $name, $checkVars true, $checkBehaviors true )
名稱 字串

屬性名稱

檢查變數 boolean

是否將成員變數視為屬性

檢查行為 boolean

是否將行為的屬性視為此元件的屬性

回傳 boolean

屬性是否可以讀取

                public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
canSetProperty() public method

定義於: yii\base\Component::canSetProperty()

傳回一個值,指示是否可以設定屬性。

如果符合以下條件,則可以寫入屬性

  • 類別具有與指定名稱關聯的 setter 方法(在這種情況下,屬性名稱不區分大小寫);
  • 類別具有具有指定名稱的成員變數(當 $checkVars 為 true 時);
  • 附加的行為具有給定名稱的可寫屬性(當 $checkBehaviors 為 true 時)。

另請參閱 canGetProperty()

public boolean canSetProperty ( $name, $checkVars true, $checkBehaviors true )
名稱 字串

屬性名稱

檢查變數 boolean

是否將成員變數視為屬性

檢查行為 boolean

是否將行為的屬性視為此元件的屬性

回傳 boolean

屬性是否可以寫入

                public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
className() public static method
自 2.0.14 版本起已過時。在 PHP >=5.5 上,請改用 ::class

定義於: yii\base\BaseObject::className()

傳回此類別的完整限定名稱。

public static string className ( )
回傳 字串

這個類別的完整限定名稱。

                public static function className()
{
    return get_called_class();
}

            
detachBehavior() public method

定義於: yii\base\Component::detachBehavior()

從組件分離行為。

將會調用行為的 yii\base\Behavior::detach() 方法。

public yii\base\Behavior|null detachBehavior ( $name )
名稱 字串

行為的名稱。

回傳 yii\base\Behavior|null

已分離的行為。如果行為不存在,則為 Null。

                public function detachBehavior($name)
{
    $this->ensureBehaviors();
    if (isset($this->_behaviors[$name])) {
        $behavior = $this->_behaviors[$name];
        unset($this->_behaviors[$name]);
        $behavior->detach();
        return $behavior;
    }
    return null;
}

            
detachBehaviors() public method

定義於: yii\base\Component::detachBehaviors()

從組件分離所有行為。

public void detachBehaviors ( )

                public function detachBehaviors()
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $name => $behavior) {
        $this->detachBehavior($name);
    }
}

            
ensureBehaviors() public method

定義於: yii\base\Component::ensureBehaviors()

確保在 behaviors() 中宣告的行為已附加到此組件。

public void ensureBehaviors ( )

                public function ensureBehaviors()
{
    if ($this->_behaviors === null) {
        $this->_behaviors = [];
        foreach ($this->behaviors() as $name => $behavior) {
            $this->attachBehaviorInternal($name, $behavior);
        }
    }
}

            
getBehavior() public method

定義於: yii\base\Component::getBehavior()

傳回具名的行為物件。

public yii\base\Behavior|null getBehavior ( $name )
名稱 字串

行為名稱

回傳 yii\base\Behavior|null

行為物件,如果行為不存在則為 null

                public function getBehavior($name)
{
    $this->ensureBehaviors();
    return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}

            
getBehaviors() public method

定義於: yii\base\Component::getBehaviors()

傳回附加到此組件的所有行為。

public yii\base\Behavior[] getBehaviors ( )
回傳 yii\base\Behavior[]

附加到此元件的行為列表

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}

            
hasEventHandlers() public method

定義於: yii\base\Component::hasEventHandlers()

傳回一個值,指示是否有名稱事件的任何處理常式附加。

public boolean hasEventHandlers ( $name )
名稱 字串

事件名稱

回傳 boolean

是否有任何處理常式附加到事件。

                public function hasEventHandlers($name)
{
    $this->ensureBehaviors();
    if (!empty($this->_events[$name])) {
        return true;
    }
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
            return true;
        }
    }
    return Event::hasHandlers($this, $name);
}

            
hasMethod() public method

定義於: yii\base\Component::hasMethod()

傳回一個值,指示是否已定義方法。

如果符合以下條件,則定義方法

  • 類別具有具有指定名稱的方法
  • 附加的行為具有給定名稱的方法(當 $checkBehaviors 為 true 時)。
public boolean hasMethod ( $name, $checkBehaviors true )
名稱 字串

屬性名稱

檢查行為 boolean

是否將行為的方法視為此元件的方法

回傳 boolean

方法是否已定義

                public function hasMethod($name, $checkBehaviors = true)
{
    if (method_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->hasMethod($name)) {
                return true;
            }
        }
    }
    return false;
}

            
hasProperty() public method

定義於: yii\base\Component::hasProperty()

傳回一個值,指示是否為此組件定義了屬性。

如果符合以下條件,則定義屬性

  • 類別具有與指定名稱關聯的 getter 或 setter 方法(在這種情況下,屬性名稱不區分大小寫);
  • 類別具有具有指定名稱的成員變數(當 $checkVars 為 true 時);
  • 附加的行為具有給定名稱的屬性(當 $checkBehaviors 為 true 時)。

另請參閱

public boolean hasProperty ( $name, $checkVars true, $checkBehaviors true )
名稱 字串

屬性名稱

檢查變數 boolean

是否將成員變數視為屬性

檢查行為 boolean

是否將行為的屬性視為此元件的屬性

回傳 boolean

屬性是否已定義

                public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
    return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}

            
init() public method

初始化基於通用資料庫表的互斥鎖實作。

public void init ( )
拋出 yii\base\InvalidConfigException

如果 $db 無效。

                public function init()
{
    parent::init();
    $this->db = Instance::ensure($this->db, Connection::className());
}

            
isAcquired() public method (available since version 2.0.36)

定義於: yii\mutex\Mutex::isAcquired()

檢查目前進程是否已取得鎖。

請注意,如果 mutex 在另一個進程中取得,則它會回傳 false。

public boolean isAcquired ( $name )
名稱 字串

要檢查的鎖定名稱。

回傳 boolean

如果目前已取得,則回傳 true。

                public function isAcquired($name)
{
    return in_array($name, $this->_locks, true);
}

            
off() 公有方法

定義於: yii\base\Component::off()

從此組件分離現有的事件處理常式。

此方法與 on() 相反。

注意:萬一事件名稱傳遞了萬用字元模式時,只有使用此萬用字元註冊的處理程序會被移除,而使用符合此萬用字元的純名稱註冊的處理程序將會保留。

另請參閱 on()

public boolean off ( $name, $handler null )
名稱 字串

事件名稱

$handler callable|null

要移除的事件處理程序。如果為 null,則會移除附加到具名事件的所有處理程序。

回傳 boolean

如果找到並分離處理程序

                public function off($name, $handler = null)
{
    $this->ensureBehaviors();
    if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
        return false;
    }
    if ($handler === null) {
        unset($this->_events[$name], $this->_eventWildcards[$name]);
        return true;
    }
    $removed = false;
    // plain event names
    if (isset($this->_events[$name])) {
        foreach ($this->_events[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_events[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_events[$name] = array_values($this->_events[$name]);
            return true;
        }
    }
    // wildcard event names
    if (isset($this->_eventWildcards[$name])) {
        foreach ($this->_eventWildcards[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_eventWildcards[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
            // remove empty wildcards to save future redundant regex checks:
            if (empty($this->_eventWildcards[$name])) {
                unset($this->_eventWildcards[$name]);
            }
        }
    }
    return $removed;
}

            
on() 公有方法

定義於: yii\base\Component::on()

將事件處理常式附加到事件。

事件處理程序必須是有效的 PHP 回呼函數。以下是一些範例

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

事件處理程序必須使用以下簽名定義:

function ($event)

其中 $event 是一個 yii\base\Event 物件,其中包含與事件相關聯的參數。

自 2.0.14 版本起,您可以將事件名稱指定為萬用字元模式

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

另請參閱 off()

public void on ( $name, $handler, $data null, $append true )
名稱 字串

事件名稱

$handler callable

事件處理程序

$data 混合型別

事件觸發時要傳遞給事件處理程序的資料。當事件處理程序被調用時,可以透過 yii\base\Event::$data 存取此資料。

$append boolean

是否將新的事件處理程序附加到現有處理程序列表的末尾。如果為 false,則新的處理程序將插入到現有處理程序列表的開頭。

                public function on($name, $handler, $data = null, $append = true)
{
    $this->ensureBehaviors();
    if (strpos($name, '*') !== false) {
        if ($append || empty($this->_eventWildcards[$name])) {
            $this->_eventWildcards[$name][] = [$handler, $data];
        } else {
            array_unshift($this->_eventWildcards[$name], [$handler, $data]);
        }
        return;
    }
    if ($append || empty($this->_events[$name])) {
        $this->_events[$name][] = [$handler, $data];
    } else {
        array_unshift($this->_events[$name], [$handler, $data]);
    }
}

            
release() 公有方法

定義於: yii\mutex\Mutex::release()

釋放已取得的鎖。如果未找到鎖,此方法將傳回 false。

public boolean release ( $name )
名稱 字串

要釋放的鎖。此鎖必須已存在。

回傳 boolean

鎖釋放結果:如果找不到具名鎖,則為 false。

                public function release($name)
{
    if ($this->releaseLock($name)) {
        $index = array_search($name, $this->_locks);
        if ($index !== false) {
            unset($this->_locks[$index]);
        }
        return true;
    }
    return false;
}

            
releaseLock() 受保護的抽象方法

定義於: yii\mutex\Mutex::releaseLock()

此方法應由具體的 Mutex 實作擴展。通過給定名稱釋放鎖。

protected abstract boolean releaseLock ( $name )
名稱 字串

要釋放的鎖。

回傳 boolean

釋放結果。

                abstract protected function releaseLock($name);

            
trigger() 公有方法

定義於: yii\base\Component::trigger()

觸發事件。

此方法表示事件的發生。它會調用事件的所有附加處理程序,包括類別層級的處理程序。

public void trigger ( $name, yii\base\Event $event null )
名稱 字串

事件名稱

$event yii\base\Event|null

事件實例。如果未設定,將會建立預設的 yii\base\Event 物件。

                public function trigger($name, Event $event = null)
{
    $this->ensureBehaviors();
    $eventHandlers = [];
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (StringHelper::matchWildcard($wildcard, $name)) {
            $eventHandlers[] = $handlers;
        }
    }
    if (!empty($this->_events[$name])) {
        $eventHandlers[] = $this->_events[$name];
    }
    if (!empty($eventHandlers)) {
        $eventHandlers = call_user_func_array('array_merge', $eventHandlers);
        if ($event === null) {
            $event = new Event();
        }
        if ($event->sender === null) {
            $event->sender = $this;
        }
        $event->handled = false;
        $event->name = $name;
        foreach ($eventHandlers as $handler) {
            $event->data = $handler[1];
            call_user_func($handler[0], $event);
            // stop further handling if the event is handled
            if ($event->handled) {
                return;
            }
        }
    }
    // invoke class-level attached handlers
    Event::trigger($this, $name, $event);
}