0 关注者

类 yii\mutex\MysqlMutex

继承yii\mutex\MysqlMutex » yii\mutex\DbMutex » yii\mutex\Mutex » yii\base\Component » yii\base\BaseObject
实现yii\base\Configurable
可用版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/mutex/MysqlMutex.php

MysqlMutex 通过 MySQL 锁实现互斥锁“锁定”机制。

应用程序配置示例

[
    'components' => [
        'db' => [
            'class' => 'yii\db\Connection',
            'dsn' => 'mysql:host=127.0.0.1;dbname=demo',
        ]
        'mutex' => [
            'class' => 'yii\mutex\MysqlMutex',
        ],
    ],
]

另请参阅 yii\mutex\Mutex.

公共属性

隐藏继承属性

属性 类型 描述 定义于
$autoRelease 布尔值 是否所有在该进程中获取的锁(即本地锁)必须在脚本执行结束前自动释放。 yii\mutex\Mutex
$behaviors yii\base\Behavior[] 附加到该组件的行为列表。 yii\base\Component
$db yii\db\Connection|数组|字符串 数据库连接对象或数据库连接的应用程序组件 ID。 yii\mutex\DbMutex
$keyPrefix yii\db\Expression|字符串| 前缀值。 yii\mutex\MysqlMutex

公共方法

隐藏继承方法

方法 描述 定义于
__call() 调用不是类方法的命名方法。 yii\base\Component
__clone() 在通过克隆现有对象创建对象后调用此方法。 yii\base\Component
__construct() 构造函数。 yii\base\BaseObject
__get() 返回组件属性的值。 yii\base\Component
__isset() 检查属性是否已设置,即定义且不为空。 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() 初始化 MySQL 特定的互斥锁组件实现。 yii\mutex\MysqlMutex
isAcquired() 检查当前进程是否已获取锁。 yii\mutex\Mutex
off() 从该组件中分离现有的事件处理程序。 yii\base\Component
on() 将事件处理程序附加到事件。 yii\base\Component
release() 释放获取的锁。如果未找到锁,此方法将返回 false。 yii\mutex\Mutex
trigger() 触发事件。 yii\base\Component

受保护方法

隐藏继承方法

方法 描述 定义于
acquireLock() 按给定名称获取锁。 yii\mutex\MysqlMutex
hashLockName() 为锁名称生成哈希值,以避免超过锁名称长度限制。 yii\mutex\MysqlMutex
prepareName() 准备锁名称 yii\mutex\MysqlMutex
releaseLock() 按给定名称释放锁。 yii\mutex\MysqlMutex

属性详细信息

隐藏继承属性

$keyPrefix 公共属性(自版本 2.0.47 起可用)

前缀值。如果为 null(默认值),则使用连接的当前数据库名称。

方法详细信息

隐藏继承方法

__call() 公共方法

定义于: yii\base\Component::__call()

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

此方法将检查任何附加的行为是否具有命名的 方法,如果可用,将执行该方法。

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

public 混合 __call ( $name, $params )
$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() 公共方法

定义于: yii\base\Component::__clone()

在通过克隆现有对象创建对象后调用此方法。

它会移除所有行为,因为它们已附加到旧对象。

public __clone ( )

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

            
__construct() 公共方法

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

构造函数。

默认实现执行两件事

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

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

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

将用于初始化对象属性的键值对

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

            
__get() 公共方法

定义于: yii\base\Component::__get()

返回组件属性的值。

此方法将按以下顺序检查并采取相应操作

  • 由 getter 定义的属性:返回 getter 结果
  • 行为的属性:返回行为的属性值

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行$value = $component->property;时会隐式调用。

另见 __set().

public mixed __get ( $name )
$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() 公共方法

定义于: yii\base\Component::__isset()

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

此方法将按以下顺序检查并采取相应操作

  • 由 setter 定义的属性:返回属性是否已设置
  • 行为的属性:返回属性是否已设置
  • 对于不存在的属性,返回false

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行isset($component->property)时会隐式调用。

另见 https://php.ac.cn/manual/en/function.isset.php.

public boolean __isset ( $name )
$name 字符串

属性名或事件名

返回值 布尔值

命名的属性是否已设置

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

定义于: yii\base\Component::__set()

设置组件属性的值。

此方法将按以下顺序检查并采取相应操作

  • 由 setter 定义的属性:设置属性值
  • "on xyz" 格式的事件:将处理程序附加到事件 "xyz"
  • "as xyz" 格式的行为:附加名为 "xyz" 的行为
  • 行为的属性:设置行为属性值

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行$component->property = $value;时会隐式调用。

另见 __get().

public void __set ( $name, $value )
$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() 公共方法

定义于: yii\base\Component::__unset()

将组件属性设置为 null。

此方法将按以下顺序检查并采取相应操作

  • 由 setter 定义的属性:将属性值设置为 null
  • 行为的属性:将属性值设置为 null

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行unset($component->property)时会隐式调用。

另见 https://php.ac.cn/manual/en/function.unset.php.

public void __unset ( $name )
$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() 公共方法

定义于: yii\mutex\Mutex::acquire()

按名称获取锁。

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

要获取的锁。必须是唯一的。

$timeout integer

等待锁释放的时间(以秒为单位)。默认为零,表示如果锁已经被获取,该方法将立即返回 false。

返回值 布尔值

获取锁的结果。

                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 boolean acquireLock ( $name, $timeout 0 )
$name 字符串

要获取的锁。

$timeout integer

等待锁释放的时间(以秒为单位)。

返回值 布尔值

获取结果。

                protected function acquireLock($name, $timeout = 0)
{
    return $this->db->useMaster(function ($db) use ($name, $timeout) {
        /** @var \yii\db\Connection $db */
        $nameData = $this->prepareName();
        return (bool)$db->createCommand(
            'SELECT GET_LOCK(' . $nameData[0] . ', :timeout), :prefix',
            array_merge(
                [':name' => $this->hashLockName($name), ':timeout' => $timeout, ':prefix' => $this->keyPrefix],
                $nameData[1]
            )
        )->queryScalar();
    });
}

            
attachBehavior() 公共方法

定义于: yii\base\Component::attachBehavior()

将行为附加到该组件。

此方法将根据给定的配置创建行为对象。之后,行为对象将通过调用yii\base\Behavior::attach()方法附加到此组件。

另见 detachBehavior().

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

行为的名称。

$behavior string|array|yii\base\Behavior

行为配置。这可以是以下之一

返回值 yii\base\Behavior

行为对象

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

            
attachBehaviors() 公共方法

定义于: 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() 公共方法

定义在: yii\base\Component::behaviors()

返回该组件应表现为的行为列表。

子类可以覆盖此方法以指定它们想要执行的行为。

此方法的返回值应为行为对象的数组或行为名称索引的行为配置。行为配置可以是指定行为类的字符串,也可以是以下结构的数组

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

请注意,行为类必须扩展自 yii\base\Behavior。可以使用名称或匿名方式附加行为。当使用名称作为数组键时,可以使用此名称,稍后可以使用 getBehavior() 检索行为,或使用 detachBehavior() 分离行为。匿名行为无法检索或分离。

在此方法中声明的行为将自动附加到组件(按需)。

public array behaviors ( )
返回值 数组

行为配置。

                public function behaviors()
{
    return [];
}

            
canGetProperty() 公共方法

定义在: yii\base\Component::canGetProperty()

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

属性可读,如果

  • 该类具有与指定名称关联的 getter 方法(在这种情况下,属性名称不区分大小写);
  • 该类具有与指定名称相同的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有给定名称的可读属性(当 $checkBehaviors 为 true 时)。

另请参阅 canSetProperty()

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

属性名

$checkVars 布尔值

是否将成员变量视为属性

$checkBehaviors 布尔值

是否将行为的属性视为此组件的属性

返回值 布尔值

属性是否可读

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

定义在: yii\base\Component::canSetProperty()

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

属性可写,如果

  • 该类具有与指定名称关联的 setter 方法(在这种情况下,属性名称不区分大小写);
  • 该类具有与指定名称相同的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有给定名称的可写属性(当 $checkBehaviors 为 true 时)。

另请参阅 canGetProperty()

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

属性名

$checkVars 布尔值

是否将成员变量视为属性

$checkBehaviors 布尔值

是否将行为的属性视为此组件的属性

返回值 布尔值

属性是否可写

                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() 公共静态方法
自 2.0.14 起弃用。在 PHP >=5.5 上,请改用 ::class

定义在: yii\base\BaseObject::className()

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

public static string className ( )
返回值 字符串

此类的完全限定名称。

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

            
detachBehavior() 公共方法

定义在: yii\base\Component::detachBehavior()

从组件中分离行为。

将调用行为的 yii\base\Behavior::detach() 方法。

public yii\base\Behavior|null detachBehavior ( $name )
$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() 公共方法

定义在: yii\base\Component::detachBehaviors()

从组件中分离所有行为。

public void detachBehaviors ( )

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

            
ensureBehaviors() 公共方法

定义在: 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() 公共方法

定义在: yii\base\Component::getBehavior()

返回命名的行为对象。

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

行为名称

返回值 yii\base\Behavior|null

行为对象,如果行为不存在,则为 null

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

            
getBehaviors() 公共方法

定义在: yii\base\Component::getBehaviors()

返回附加到该组件的所有行为。

public yii\base\Behavior[] getBehaviors ( )
返回值 yii\base\Behavior[]

附加到此组件的行为列表

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

            
hasEventHandlers() 公共方法

定义在: yii\base\Component::hasEventHandlers()

返回一个值,指示是否已将任何处理程序附加到命名的事件。

public boolean hasEventHandlers ( $name )
$name 字符串

事件名称

返回值 布尔值

事件是否已附加任何处理程序。

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

定义在: yii\base\Component::hasMethod()

返回一个值,指示是否已定义方法。

方法已定义,如果

  • 该类具有与指定名称相同的 method
  • 附加的行为具有给定名称的方法(当 $checkBehaviors 为 true 时)。
public boolean hasMethod ( $name, $checkBehaviors true )
$name 字符串

属性名

$checkBehaviors 布尔值

是否将行为的方法视为此组件的方法

返回值 布尔值

方法是否已定义

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

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

返回一个值,指示该组件是否已定义属性。

属性定义在以下情况:

  • 类具有与指定名称关联的 getter 或 setter 方法(在这种情况下,属性名称不区分大小写);
  • 该类具有与指定名称相同的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有给定名称的属性(当 $checkBehaviors 为 true 时)。

另请参阅

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

属性名

$checkVars 布尔值

是否将成员变量视为属性

$checkBehaviors 布尔值

是否将行为的属性视为此组件的属性

返回值 布尔值

属性是否已定义

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

            
hashLockName() 受保护方法 (自版本 2.0.16 可用)

为锁名称生成哈希值,以避免超过锁名称长度限制。

另请参阅 https://github.com/yiisoft/yii2/pull/16836.

protected string hashLockName ( $name )
$name 字符串

                protected function hashLockName($name)
{
    return sha1($name);
}

            
init() 公共方法

初始化 MySQL 特定的互斥锁组件实现。

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

如果 $db 不是 MySQL 连接。

                public function init()
{
    parent::init();
    if ($this->db->driverName !== 'mysql') {
        throw new InvalidConfigException('In order to use MysqlMutex connection must be configured to use MySQL database.');
    }
    if ($this->keyPrefix === null) {
        $this->keyPrefix = new Expression('DATABASE()');
    }
}

            
isAcquired() 公共方法 (自版本 2.0.36 可用)

定义于: yii\mutex\Mutex::isAcquired()

检查当前进程是否已获取锁。

请注意,如果互斥锁在另一个进程中被获取,则它将返回 false。

public boolean isAcquired ( $name )
$name 字符串

要检查的锁。

返回值 布尔值

如果当前已获取,则返回 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 )
$name 字符串

事件名称

$handler callable|null

要删除的事件处理程序。如果它为 null,则将删除附加到该命名事件的所有处理程序。

返回值 布尔值

如果找到并分离处理程序,则

                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 )
$name 字符串

事件名称

$handler callable

事件处理程序

$data 混合

触发事件时要传递给事件处理程序的数据。当调用事件处理程序时,可以通过 yii\base\Event::$data 访问此数据。

$append 布尔值

是否将新的事件处理程序追加到现有处理程序列表的末尾。如果为 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]);
    }
}

            
prepareName() 受保护方法 (自版本 2.0.48 可用)

准备锁名称

protected array prepareName ( )
返回值 数组

表达式和参数

                protected function prepareName()
{
    $params = [];
    $expression = 'SUBSTRING(CONCAT(:prefix, :name), 1, 64)';
    if ($this->keyPrefix instanceof Expression) {
        $expression = strtr($expression, [':prefix' => $this->keyPrefix->expression]);
        $params = $this->keyPrefix->params;
    }
    return [$expression, $params];
}

            
release() 公共方法

定义于: yii\mutex\Mutex::release()

释放获取的锁。如果未找到锁,此方法将返回 false。

public boolean release ( $name )
$name 字符串

要释放的锁。此锁必须已存在。

返回值 布尔值

锁释放结果:如果未找到命名锁,则为 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() 受保护方法
protected boolean releaseLock ( $name )
$name 字符串

要释放的锁。

返回值 布尔值

释放结果。

                protected function releaseLock($name)
{
    return $this->db->useMaster(function ($db) use ($name) {
        /** @var \yii\db\Connection $db */
        $nameData = $this->prepareName();
        return (bool)$db->createCommand(
            'SELECT RELEASE_LOCK(' . $nameData[0] . '), :prefix',
            array_merge(
                [':name' => $this->hashLockName($name), ':prefix' => $this->keyPrefix],
                $nameData[1]
            )
        )->queryScalar();
    });
}

            
trigger() 公共方法

定义于: yii\base\Component::trigger()

触发事件。

此方法表示事件的发生。它调用事件的所有附加处理程序,包括类级别的处理程序。

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

事件名称

$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);
}