0 关注者

类 yii\base\Component

继承yii\base\Component » yii\base\BaseObject
实现yii\base\Configurable
子类yii\base\Actionyii\base\Applicationyii\base\Controlleryii\base\DynamicModelyii\base\ErrorHandleryii\base\InlineActionyii\base\Modelyii\base\Moduleyii\base\Requestyii\base\Responseyii\base\Securityyii\base\Themeyii\base\Viewyii\base\ViewRendereryii\base\Widgetyii\caching\ApcCacheyii\caching\ArrayCacheyii\caching\Cacheyii\caching\DbCacheyii\caching\DummyCacheyii\caching\FileCacheyii\caching\MemCacheyii\caching\WinCacheyii\caching\XCacheyii\caching\ZendDataCacheyii\captcha\Captchayii\captcha\CaptchaActionyii\captcha\CaptchaValidatoryii\console\Applicationyii\console\Controlleryii\console\ErrorHandleryii\console\Requestyii\console\Responseyii\console\controllers\AssetControlleryii\console\controllers\BaseMigrateControlleryii\console\controllers\CacheControlleryii\console\controllers\FixtureControlleryii\console\controllers\HelpControlleryii\console\controllers\MessageControlleryii\console\controllers\MigrateControlleryii\console\controllers\ServeControlleryii\console\widgets\Tableyii\data\ActiveDataFilteryii\data\ActiveDataProvideryii\data\ArrayDataProvideryii\data\BaseDataProvideryii\data\DataFilteryii\data\SqlDataProvideryii\db\ActiveQueryyii\db\ActiveRecordyii\db\BaseActiveRecordyii\db\BatchQueryResultyii\db\Commandyii\db\Connectionyii\db\Migrationyii\db\Queryyii\db\SqlTokenizeryii\db\oci\Commandyii\db\sqlite\Commandyii\db\sqlite\SqlTokenizeryii\di\Containeryii\di\ServiceLocatoryii\filters\AccessRuleyii\grid\GridViewyii\i18n\DbMessageSourceyii\i18n\Formatteryii\i18n\GettextFileyii\i18n\GettextMessageSourceyii\i18n\GettextMoFileyii\i18n\GettextPoFileyii\i18n\I18Nyii\i18n\Localeyii\i18n\MessageFormatteryii\i18n\MessageSourceyii\i18n\PhpMessageSourceyii\log\DbTargetyii\log\Dispatcheryii\log\EmailTargetyii\log\FileTargetyii\log\Loggeryii\log\SyslogTargetyii\log\Targetyii\mail\BaseMaileryii\mutex\DbMutexyii\mutex\FileMutexyii\mutex\Mutexyii\mutex\MysqlMutexyii\mutex\OracleMutexyii\mutex\PgsqlMutexyii\rbac\BaseManageryii\rbac\DbManageryii\rbac\PhpManageryii\rest\Actionyii\rest\ActiveControlleryii\rest\Controlleryii\rest\CreateActionyii\rest\DeleteActionyii\rest\IndexActionyii\rest\OptionsActionyii\rest\Serializeryii\rest\UpdateActionyii\rest\ViewActionyii\test\ActiveFixtureyii\test\ArrayFixtureyii\test\BaseActiveFixtureyii\test\DbFixtureyii\test\Fixtureyii\test\InitDbFixtureyii\validators\BooleanValidatoryii\validators\CompareValidatoryii\validators\DateValidatoryii\validators\DefaultValueValidatoryii\validators\EachValidatoryii\validators\EmailValidatoryii\validators\ExistValidatoryii\validators\FileValidatoryii\validators\FilterValidatoryii\validators\ImageValidatoryii\validators\InlineValidatoryii\validators\IpValidatoryii\validators\NumberValidatoryii\validators\RangeValidatoryii\validators\RegularExpressionValidatoryii\validators\RequiredValidatoryii\validators\SafeValidatoryii\validators\StringValidatoryii\validators\TrimValidatoryii\validators\UniqueValidatoryii\validators\UrlValidatoryii\validators\Validatoryii\web\Applicationyii\web\AssetConverteryii\web\AssetManageryii\web\CacheSessionyii\web\Controlleryii\web\DbSessionyii\web\ErrorActionyii\web\ErrorHandleryii\web\HtmlResponseFormatteryii\web\JsonResponseFormatteryii\web\MultiFieldSessionyii\web\Requestyii\web\Responseyii\web\Sessionyii\web\UrlManageryii\web\Useryii\web\Viewyii\web\ViewActionyii\web\XmlResponseFormatteryii\widgets\ActiveFieldyii\widgets\ActiveFormyii\widgets\BaseListViewyii\widgets\Blockyii\widgets\Breadcrumbsyii\widgets\ContentDecoratoryii\widgets\DetailViewyii\widgets\FragmentCacheyii\widgets\InputWidgetyii\widgets\LinkPageryii\widgets\LinkSorteryii\widgets\ListViewyii\widgets\MaskedInputyii\widgets\Menuyii\widgets\Pjaxyii\widgets\Spaceless
自版本可用2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/base/Component.php

Component 是实现 属性事件行为 特性的基类。

Component 提供 事件行为 特性,以及在父类 BaseObject 中实现的 属性 特性。

事件是一种在特定位置将自定义代码“注入”到现有代码中的方法。例如,评论对象可以在用户添加评论时触发“添加”事件。我们可以编写自定义代码并将其附加到此事件,以便在触发事件时(即评论将被添加),我们的自定义代码将被执行。

事件由一个名称标识,该名称在定义它的类中应该是唯一的。事件名称区分大小写。

可以将一个或多个 PHP 回调(称为 事件处理程序)附加到事件。您可以调用 trigger() 来引发事件。当引发事件时,事件处理程序将按其附加顺序自动调用。

要将事件处理程序附加到事件,请调用 on()

$post->on('update', function ($event) {
    // send email notification
});

在上面,一个匿名函数被附加到帖子的“更新”事件。您可以附加以下类型的事件处理程序

  • 匿名函数:function ($event) { ... }
  • 对象方法:[$object, 'handleAdd']
  • 静态类方法:['Page', 'handleAdd']
  • 全局函数:'handleAdd'

事件处理程序的签名应类似于以下内容

function foo($event)

其中 $event 是一个 yii\base\Event 对象,其中包含与事件相关的参数。

您还可以在使用配置数组配置组件时将处理程序附加到事件。语法如下

[
    'on add' => function ($event) { ... }
]

其中 on add 表示将事件附加到 add 事件。

有时,您可能希望在将事件处理程序附加到事件时将额外的數據与事件处理程序相关联,然后在调用处理程序时访问该數據。您可以通过以下方式做到这一点

$post->on('update', function ($event) {
    // the data can be accessed via $event->data
}, $data);

行为是 yii\base\Behavior 或其子类的实例。组件可以附加一个或多个行为。当行为附加到组件时,它的公共属性和方法可以通过组件直接访问,就好像组件拥有这些属性和方法一样。

要将行为附加到组件,请在 behaviors() 中声明它,或显式调用 attachBehavior()。在 behaviors() 中声明的行为会自动附加到相应的组件。

您也可以在使用配置数组配置组件时将行为附加到组件。语法如下

[
    'as tree' => [
        'class' => 'Tree',
    ],
]

其中 as tree 表示附加名为 tree 的行为,数组将传递给 Yii::createObject() 来创建行为对象。

有关 Component 的更多详细信息和使用信息,请参阅 组件指南文章

公共属性

隐藏继承的属性

属性 类型 描述 定义于
$behaviors yii\base\Behavior[] 附加到此组件的行为列表。 yii\base\Component

公共方法

隐藏继承的方法

方法 描述 定义于
__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
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\base\BaseObject
off() 从该组件中分离现有的事件处理程序。 yii\base\Component
on() 将事件处理程序附加到事件。 yii\base\Component
trigger() 触发事件。 yii\base\Component

属性详情

隐藏继承的属性

$behaviors 公共属性

附加到此组件的行为列表。

public yii\base\Behavior[] $behaviors null

方法详情

隐藏继承的方法

__call() 公共方法

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

该方法将检查任何附加的行为是否具有指定的方法,并在可用时执行它。

不要直接调用此方法,因为它是一个 PHP 魔术方法,将在调用未知方法时隐式调用。

public mixed __call ( $name, $params )
$name string

方法名

$params array

方法参数

return mixed

方法返回值

throws 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 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 array

将用于初始化对象属性的名称-值对

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

            
__get() 公共方法

返回组件属性的值。

该方法将按以下顺序检查并采取相应措施

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

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 $value = $component->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)) {
        // 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() 公共方法

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

该方法将按以下顺序检查并采取相应措施

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

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

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

public boolean __isset ( $name )
$name string

属性名或事件名

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

设置组件属性的值。

该方法将按以下顺序检查并采取相应措施

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

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 $component->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)) {
        // 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() 公共方法

将组件属性设置为 null。

该方法将按以下顺序检查并采取相应措施

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

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

另见 https://php.ac.cn/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);
        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);
}

            
attachBehavior() 公共方法

将行为附加到此组件。

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

另见 detachBehavior().

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name string

行为的名称。

$behavior string|array|yii\base\Behavior

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

return yii\base\Behavior

行为对象

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

            
attachBehaviors() 公共方法

将行为列表附加到组件。

每个行为都由其名称索引,并且应该是 yii\base\Behavior 对象、指定行为类的字符串,或者用于创建行为的配置数组。

另见 attachBehavior().

public void attachBehaviors ( $behaviors )
$behaviors array

要附加到组件的行为列表

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

            
behaviors() 公共方法

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

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

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

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

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

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

public array behaviors ( )
return array

行为配置。

                public function behaviors()
{
    return [];
}

            
canGetProperty() 公共方法

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

如果可以读取属性

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

另请参见 canSetProperty()

public boolean canGetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

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

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

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

如果可以写入属性

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

另请参见 canGetProperty()

public boolean canSetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

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

return 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() 公共静态方法
自 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();
}

            
detachBehavior() 公共方法

从组件中分离行为。

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

public yii\base\Behavior|null detachBehavior ( $name )
$name string

行为的名称。

return 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 void detachBehaviors ( )

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

            
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 yii\base\Behavior|null getBehavior ( $name )
$name string

行为名称

return yii\base\Behavior|null

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

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

            
getBehaviors() 公共方法

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

public yii\base\Behavior[] getBehaviors ( )
return yii\base\Behavior[]

附加到此组件的行为列表

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

            
hasEventHandlers() 公共方法

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

public boolean hasEventHandlers ( $name )
$name string

事件名称

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

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

如果定义了方法

  • 该类具有与指定名称匹配的方法
  • 附加的行为具有给定名称的方法(当 $checkBehaviors 为 true 时)。
public boolean hasMethod ( $name, $checkBehaviors true )
$name string

属性名

$checkBehaviors boolean

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

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

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

如果定义了属性

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

另请参见

public boolean hasProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

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

return boolean

属性是否已定义

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

            
init() 公共方法

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

初始化对象。

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

public void init ( )

                public function init()
{
}

            
off() 公共方法

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

此方法与 on() 相反。

注意:如果为事件名称传递了通配符模式,则仅使用此通配符注册的处理程序将被删除,而使用与此通配符匹配的普通名称注册的处理程序将保留。

另请参阅 on().

public boolean off ( $name, $handler null )
$name string

事件名称

$handler callable|null

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

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

将事件处理程序附加到事件。

事件处理程序必须是一个有效的 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 string

事件名称

$handler callable

事件处理程序

$data mixed

触发事件时传递给事件处理程序的数据。调用事件处理程序时,可以通过 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]);
    }
}

            
trigger() 公共方法

触发事件。

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

public void trigger ( $name, yii\base\Event $event null )
$name string

事件名称

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