0 关注者

类 yii\mutex\FileMutex

所有类 | 属性 | 方法
继承yii\mutex\FileMutex » yii\mutex\Mutex » yii\base\Component » yii\base\BaseObject
实现yii\base\Configurable
使用 Traitsyii\mutex\RetryAcquireTrait
自版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/mutex/FileMutex.php

FileMutex 通过本地文件系统文件实现互斥“锁”机制。

此组件依赖于 PHP `flock()` 函数。

应用程序配置示例

[
    'components' => [
        'mutex' => [
            'class' => 'yii\mutex\FileMutex'
        ],
    ],
]

注意: 此组件只能维护单个 Web 服务器的锁，如果使用云服务器解决方案，可能不适用。

警告: 由于 `flock()` 函数的特性，此组件在使用多线程服务器 API（如 ISAPI）时不可靠。

另请参阅 yii\mutex\Mutex。

公共属性

隐藏继承的属性

属性 类型 描述 定义于
$autoRelease 布尔值 是否必须在脚本执行结束前自动释放此进程（即本地锁）中获取的所有锁。 yii\mutex\Mutex
$behaviors yii\base\Behavior[] 附加到此组件的行为列表。 yii\base\Component
$dirMode 整数 为新创建的目录设置的权限。 yii\mutex\FileMutex
$fileMode 整数|null 为新创建的互斥文件设置的权限。 yii\mutex\FileMutex
$isWindows 布尔值|null 文件处理是否应假定为 Windows 文件系统。 yii\mutex\FileMutex
$mutexPath 字符串 存储互斥文件目录。 yii\mutex\FileMutex
$retryDelay 整数 在 `acquire()` 中每次尝试之间以毫秒为单位的延迟时间，直到指定的超时时间到期。 yii\mutex\RetryAcquireTrait

公共方法

隐藏继承的方法

方法 描述 定义于
__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() 初始化用于 UNIX、GNU/Linux、Mac OS X 和其他类 UNIX 操作系统的互斥组件实现。 yii\mutex\FileMutex
isAcquired() 检查当前进程是否获取了锁。 yii\mutex\Mutex
off() 从此组件中分离现有事件处理程序。 yii\base\Component
on() 将事件处理程序附加到事件。 yii\base\Component
release() 释放已获取的锁。如果找不到锁，此方法将返回 false。 yii\mutex\Mutex
trigger() 触发事件。 yii\base\Component

受保护的方法

隐藏继承的方法

方法 描述 定义于
acquireLock() 按给定名称获取锁。 yii\mutex\FileMutex
getLockFilePath() 生成锁文件路径。 yii\mutex\FileMutex
releaseLock() 按给定名称释放锁。 yii\mutex\FileMutex

属性详情

隐藏继承的属性

$dirMode 公共属性

为新创建的目录设置的权限。此值将由 PHP chmod() 函数使用。不会应用 umask。默认为 0775，这意味着目录对所有者和组可读可写，但对其他用户只读。

public 整数 $dirMode = 0775
$fileMode 公共属性

为新创建的互斥文件设置的权限。此值将由 PHP chmod() 函数使用。不会应用 umask。如果没有设置，则权限将由当前环境确定。

public 整数|null $fileMode = null
$isWindows 公共属性 (自版本 2.0.16 起可用)

文件处理是否应假定为 Windows 文件系统。此值将决定 releaseLock() 删除锁文件的方式。如果没有设置，则通过检查 DIRECTORY_SEPARATOR 常量来确定。

public 布尔值|null $isWindows = null
$mutexPath 公共属性

存储互斥文件 的目录。您可以在此处使用 路径别名。默认为应用程序运行时路径下的“mutex”子目录。

public 字符串 $mutexPath = '@runtime/mutex'

方法详情

隐藏继承的方法

__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 void __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 混合 __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()

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

此方法将按以下顺序检查并相应地执行：

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

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

另请参阅 https://php.ac.cn/manual/en/function.isset.php。

public 布尔值 __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 布尔值 acquire ( $name, $timeout = 0 )
$name 字符串

要获取的锁。必须是唯一的。
$timeout 整数

等待锁释放的时间（以秒为单位）。默认为零，这意味着如果锁已获取，则方法会立即返回 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 布尔值 acquireLock ( $name, $timeout = 0 )
$name 字符串

要获取的锁。
$timeout 整数

等待锁释放的时间（以秒为单位）。
返回 布尔值

获取结果。

 

                protected function acquireLock($name, $timeout = 0)
{
    $filePath = $this->getLockFilePath($name);
    return $this->retryAcquire($timeout, function () use ($filePath, $name) {
        $file = fopen($filePath, 'w+');
        if ($file === false) {
            return false;
        }
        if ($this->fileMode !== null) {
            @chmod($filePath, $this->fileMode);
        }
        if (!flock($file, LOCK_EX | LOCK_NB)) {
            fclose($file);
            return false;
        }
        // Under unix we delete the lock file before releasing the related handle. Thus it's possible that we've acquired a lock on
        // a non-existing file here (race condition). We must compare the inode of the lock file handle with the inode of the actual lock file.
        // If they do not match we simply continue the loop since we can assume the inodes will be equal on the next try.
        // Example of race condition without inode-comparison:
        // Script A: locks file
        // Script B: opens file
        // Script A: unlinks and unlocks file
        // Script B: locks handle of *unlinked* file
        // Script C: opens and locks *new* file
        // In this case we would have acquired two locks for the same file path.
        if (DIRECTORY_SEPARATOR !== '\\' && fstat($file)['ino'] !== @fileinode($filePath)) {
            clearstatcache(true, $filePath);
            flock($file, LOCK_UN);
            fclose($file);
            return false;
        }
        $this->_files[$name] = $file;
        return true;
    });
}
attachBehavior() 公共方法

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

将行为附加到此组件。

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

另请参阅 detachBehavior()。

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

行为的名称。
$behavior 字符串|数组|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()。

公共 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() 分离它。匿名行为无法获取或分离。

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

公共 数组 behaviors ( )
返回 数组

行为配置。

 

                public function behaviors()
{
    return [];
}
canGetProperty() 公共方法

定义于： yii\base\Component::canGetProperty()

返回一个指示属性是否可读的值。

如果：

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

另请参阅 canSetProperty()。

公共 布尔值 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()。

公共 布尔值 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()

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

公共静态 字符串 className ( )
返回 字符串

此类的完全限定名称。

 

                public static function className()
{
    return get_called_class();
}
detachBehavior() 公共方法

定义于： yii\base\Component::detachBehavior()

从组件中分离行为。

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

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

从组件中分离所有行为。

公共 void detachBehaviors ( )

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

定义于： yii\base\Component::ensureBehaviors()

确保在 behaviors() 中声明的行为附加到此组件。

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

返回命名行为对象。

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

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

公共 yii\base\Behavior[] getBehaviors ( )
返回 yii\base\Behavior[]

附加到此组件的行为列表

 

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}
获取锁文件路径() 保护方法 (自 2.0.10 版本起可用)

生成锁文件路径。

protected 字符串 获取锁文件路径 ( $name )
$name 字符串 

                protected function getLockFilePath($name)
{
    return $this->mutexPath . DIRECTORY_SEPARATOR . md5($name) . '.lock';
}
是否有事件处理程序() 公共方法

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

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

public 布尔值 是否有事件处理程序 ( $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);
}
是否有方法() 公共方法

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

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

如果定义了方法

  • 类中具有指定名称的方法
  • 附加的行为具有给定名称的方法 (当 $checkBehaviors 为 true 时)。
public 布尔值 是否有方法 ( $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;
}
是否有属性() 公共方法

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

返回一个指示此组件是否有定义属性的值。

属性已定义，如果

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

另请参阅

public 布尔值 是否有属性 ( $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);
}
初始化() 公共方法

初始化用于 UNIX、GNU/Linux、Mac OS X 和其他类 UNIX 操作系统的互斥组件实现。

public void 初始化 ( )
抛出 yii\base\InvalidConfigException 

                public function init()
{
    parent::init();
    $this->mutexPath = Yii::getAlias($this->mutexPath);
    if (!is_dir($this->mutexPath)) {
        FileHelper::createDirectory($this->mutexPath, $this->dirMode, true);
    }
    if ($this->isWindows === null) {
        $this->isWindows = DIRECTORY_SEPARATOR === '\\';
    }
}
是否已获取() 公共方法 (自 2.0.36 版本起可用)

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

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

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

public 布尔值 是否已获取 ( $name )
$name 字符串

要检查的锁。
返回 布尔值

如果当前已获取，则返回 true。

 

                public function isAcquired($name)
{
    return in_array($name, $this->_locks, true);
}
关闭() 公共方法

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

从此组件中分离现有事件处理程序。

此方法与 on() 相反。

注意：如果为事件名称传递了通配符模式，则只会删除使用此通配符注册的处理程序，而不会删除使用与该通配符匹配的普通名称注册的处理程序。

另请参阅 on().

public 布尔值 关闭 ( $name, $handler = null )
$name 字符串

事件名称
$handler 可调用|空值

要删除的事件处理程序。如果为空，则将删除附加到命名事件的所有处理程序。
返回 布尔值

如果找到处理程序并将其分离

 

                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;
}
打开() 公共方法

定义于: 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.');
});

另请参阅 关闭().

public void 打开 ( $name, $handler, $data = null, $append = true )
$name 字符串

事件名称
$handler 可调用

事件处理程序
$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]);
    }
}
释放() 公共方法

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

释放已获取的锁。如果找不到锁，此方法将返回 false。

public 布尔值 释放 ( $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;
}
释放锁() 保护方法

按给定名称释放锁。

protected 布尔值 释放锁 ( $name )
$name 字符串

要释放的锁。
返回 布尔值

释放结果。

 

                protected function releaseLock($name)
{
    if (!isset($this->_files[$name])) {
        return false;
    }
    if ($this->isWindows) {
        // Under windows it's not possible to delete a file opened via fopen (either by own or other process).
        // That's why we must first unlock and close the handle and then *try* to delete the lock file.
        flock($this->_files[$name], LOCK_UN);
        fclose($this->_files[$name]);
        @unlink($this->getLockFilePath($name));
    } else {
        // Under unix it's possible to delete a file opened via fopen (either by own or other process).
        // That's why we must unlink (the currently locked) lock file first and then unlock and close the handle.
        unlink($this->getLockFilePath($name));
        flock($this->_files[$name], LOCK_UN);
        fclose($this->_files[$name]);
    }
    unset($this->_files[$name]);
    return true;
}
触发() 公共方法

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

触发事件。

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

public void 触发 ( $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);
}