类 yii\log\Dispatcher
继承关系 | yii\log\Dispatcher » yii\base\Component » yii\base\BaseObject |
---|---|
实现接口 | yii\base\Configurable |
可用版本 | 2.0 |
源代码 | https://github.com/yiisoft/yii2/blob/master/framework/log/Dispatcher.php |
Dispatcher 管理一组 日志目标。
Dispatcher 实现 dispatch() 方法,该方法将来自 yii\log\Logger 的日志消息转发到已注册的日志 $targets。
Dispatcher 的实例被注册为核心应用程序组件,可以使用 Yii::$app->log
访问。
您可以在应用程序配置中配置目标,如下所示
[
'components' => [
'log' => [
'targets' => [
'file' => [
'class' => 'yii\log\FileTarget',
'levels' => ['trace', 'info'],
'categories' => ['yii\*'],
],
'email' => [
'class' => 'yii\log\EmailTarget',
'levels' => ['error', 'warning'],
'message' => [
'to' => '[email protected]',
],
],
],
],
],
]
每个日志目标都可以有一个名称,并且可以通过 $targets 属性引用,如下所示
Yii::$app->log->targets['file']->enabled = false;
公共属性
属性 | 类型 | 描述 | 定义于 |
---|---|---|---|
$behaviors | yii\base\Behavior[] | 附加到此组件的行为列表。 | yii\base\Component |
$flushInterval | integer | 在将消息发送到目标之前应记录的消息数量。 | yii\log\Dispatcher |
$logger | yii\log\Logger | 日志记录器。 | yii\log\Dispatcher |
$targets | array|yii\log\Target[] | 日志目标。 | yii\log\Dispatcher |
$traceLevel | integer | 每个消息应与多少个应用程序调用栈一起记录。 | yii\log\Dispatcher |
公共方法
属性详情
在将消息发送到目标之前应记录的消息数量。此方法返回 yii\log\Logger::$flushInterval 的值。
日志记录器。如果未设置,将使用 Yii::getLogger()。请注意,此属性在 getter 和 setter 中的类型不同。有关详细信息,请参见 getLogger() 和 setLogger()。
每个消息一起记录多少个应用程序调用栈。此方法返回 yii\log\Logger::$traceLevel 的值。默认为 0。
方法详情
定义于: yii\base\Component::__call()
调用不是类方法的命名方法。
此方法将检查任何附加的行为是否具有指定名称的方法,如果可用则执行它。
不要直接调用此方法,因为它是一个 PHP 魔术方法,当调用未知方法时会隐式调用。
public mixed __call ( $name, $params ) | ||
$name | string |
方法名 |
$params | array |
方法参数 |
返回值 | mixed |
方法的返回值 |
---|---|---|
抛出异常 | 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()");
}
public void __clone ( ) |
public function __clone()
{
$this->_events = [];
$this->_eventWildcards = [];
$this->_behaviors = null;
}
构造函数。
默认实现执行两件事
- 使用给定的配置
$config
初始化对象。 - 调用 init()。
如果此方法在子类中被重写,建议
- 构造函数的最后一个参数是一个配置数组,就像这里的
$config
一样。 - 在构造函数的末尾调用父类的实现。
public void __construct ( $config = [] ) | ||
$config | array |
将用于初始化对象属性的名称-值对 |
public function __construct($config = [])
{
// ensure logger gets set before any other config option
if (isset($config['logger'])) {
$this->setLogger($config['logger']);
unset($config['logger']);
}
// connect logger and dispatcher
$this->getLogger();
parent::__construct($config);
}
定义于: yii\base\Component::__get()
返回组件属性的值。
此方法将按以下顺序检查并相应地采取行动
- 由 getter 定义的属性:返回 getter 的结果
- 行为的属性:返回行为属性的值
不要直接调用此方法,因为它是一个 PHP 魔术方法,当执行 $value = $component->property;
时会隐式调用。
另请参阅 __set()。
public mixed __get ( $name ) | ||
$name | string |
属性名 |
返回值 | mixed |
属性值或行为属性的值 |
---|---|---|
抛出异常 | 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);
}
定义于: yii\base\Component::__isset()
检查属性是否已设置,即定义且不为 null。
此方法将按以下顺序检查并相应地采取行动
- 由 setter 定义的属性:返回属性是否已设置
- 行为的属性:返回属性是否已设置
- 对于不存在的属性返回
false
不要直接调用此方法,因为它是一个 PHP 魔术方法,当执行 isset($component->property)
时会隐式调用。
public boolean __isset ( $name ) | ||
$name | string |
属性名或事件名 |
返回值 | 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;
}
定义于: yii\base\Component::__set()
设置组件属性的值。
此方法将按以下顺序检查并相应地采取行动
- 由 setter 定义的属性:设置属性值
- 格式为“on xyz”的事件:将处理程序附加到事件“xyz”
- 格式为“as xyz”的行为:附加名为“xyz”的行为
- 行为的属性:设置行为属性的值
不要直接调用此方法,因为它是一个 PHP 魔术方法,当执行 $component->property = $value;
时会隐式调用。
另请参阅 __get()。
public void __set ( $name, $value ) | ||
$name | string |
属性名或事件名 |
$value | mixed |
属性值 |
抛出异常 | 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);
}
定义于: yii\base\Component::__unset()
将组件属性设置为 null。
此方法将按以下顺序检查并相应地采取行动
- 由 setter 定义的属性:将属性值设置为 null
- 行为的属性:将属性值设置为 null
不要直接调用此方法,因为它是一个 PHP 魔术方法,当执行 unset($component->property)
时会隐式调用。
public void __unset ( $name ) | ||
$name | string |
属性名 |
抛出异常 | 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);
}
定义于: yii\base\Component::attachBehavior()
将行为附加到此组件。
此方法将根据给定的配置创建行为对象。之后,行为对象将通过调用 yii\base\Behavior::attach() 方法附加到此组件。
另请参阅 detachBehavior()。
public yii\base\Behavior attachBehavior ( $name, $behavior ) | ||
$name | string |
行为的名称。 |
$behavior | string|array|yii\base\Behavior |
行为配置。可以是以下之一
|
返回值 | yii\base\Behavior |
行为对象 |
---|
public function attachBehavior($name, $behavior)
{
$this->ensureBehaviors();
return $this->attachBehaviorInternal($name, $behavior);
}
定义于: yii\base\Component::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);
}
}
定义于: yii\base\Component::behaviors()
返回此组件应表现为的行为列表。
子类可以重写此方法来指定它们希望表现出的行为。
此方法的返回值应该是一个行为对象或配置的数组,并以行为名称作为索引。行为配置可以是指定行为类的字符串,也可以是以下结构的数组
'behaviorName' => [
'class' => 'BehaviorClass',
'property1' => 'value1',
'property2' => 'value2',
]
请注意,行为类必须扩展自 yii\base\Behavior。可以使用名称或匿名方式附加行为。当使用名称作为数组键时,可以使用此名称,稍后可以使用 getBehavior() 获取行为,或使用 detachBehavior() 分离行为。匿名行为无法检索或分离。
在此方法中声明的行为将自动附加到组件(按需)。
public 数组 behaviors ( ) | ||
返回值 | array |
行为配置。 |
---|
public function behaviors()
{
return [];
}
定义于: yii\base\Component::canGetProperty()
返回一个值,指示是否可以读取属性。
如果可以读取属性,则
- 类具有与指定名称关联的 getter 方法(在这种情况下,属性名称不区分大小写);
- 类具有与指定名称相同的成员变量(当
$checkVars
为 true 时); - 附加的行为具有给定名称的可读属性(当
$checkBehaviors
为 true 时)。
另请参阅 canSetProperty()。
public 布尔值 canGetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
属性名 |
$checkVars | boolean |
是否将成员变量视为属性 |
$checkBehaviors | 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;
}
定义于: yii\base\Component::canSetProperty()
返回一个值,指示是否可以设置属性。
如果可以写入属性,则
- 类具有与指定名称关联的 setter 方法(在这种情况下,属性名称不区分大小写);
- 类具有与指定名称相同的成员变量(当
$checkVars
为 true 时); - 附加的行为具有给定名称的可写属性(当
$checkBehaviors
为 true 时)。
另请参阅 canGetProperty()。
public 布尔值 canSetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
属性名 |
$checkVars | boolean |
是否将成员变量视为属性 |
$checkBehaviors | 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;
}
::class
。
定义于: yii\base\BaseObject::className()
返回此类的完全限定名称。
public static 字符串 className ( ) | ||
返回值 | string |
此类的完全限定名称。 |
---|
public static function className()
{
return get_called_class();
}
public yii\base\Behavior|null detachBehavior ( $name ) | ||
$name | string |
行为的名称。 |
返回值 | 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;
}
定义于: yii\base\Component::detachBehaviors()
从组件中分离所有行为。
public void detachBehaviors ( ) |
public function detachBehaviors()
{
$this->ensureBehaviors();
foreach ($this->_behaviors as $name => $behavior) {
$this->detachBehavior($name);
}
}
将记录的消息分派到 $targets。
public void dispatch ( $messages, $final ) | ||
$messages | array |
已记录的消息 |
$final | boolean |
此方法是否在当前应用程序结束时调用 |
public function dispatch($messages, $final)
{
$targetErrors = [];
foreach ($this->targets as $target) {
if (!$target->enabled) {
continue;
}
try {
$target->collect($messages, $final);
} catch (\Throwable $t) {
$target->enabled = false;
$targetErrors[] = $this->generateTargetFailErrorMessage($target, $t, __METHOD__);
} catch (\Exception $e) {
$target->enabled = false;
$targetErrors[] = $this->generateTargetFailErrorMessage($target, $e, __METHOD__);
}
}
if (!empty($targetErrors)) {
$this->dispatch($targetErrors, true);
}
}
定义于: 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);
}
}
}
生成目标错误消息
protected 数组 generateTargetFailErrorMessage ( $target, $throwable, $method ) | ||
$target | yii\log\Target |
日志目标对象 |
$throwable | Throwable |
捕获的异常 |
$method | string |
完整的路径方法 |
返回值 | array |
生成的错误消息数据 |
---|
protected function generateTargetFailErrorMessage($target, $throwable, $method)
{
return [
'Unable to send log via ' . get_class($target) . ': ' . ErrorHandler::convertExceptionToVerboseString($throwable),
Logger::LEVEL_WARNING,
$method,
microtime(true),
[],
];
}
定义于: yii\base\Component::getBehavior()
返回命名的行为对象。
public yii\base\Behavior|null getBehavior ( $name ) | ||
$name | string |
行为名称 |
返回值 | yii\base\Behavior|null |
行为对象,如果行为不存在则为 null |
---|
public function getBehavior($name)
{
$this->ensureBehaviors();
return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}
定义于: yii\base\Component::getBehaviors()
返回附加到此组件的所有行为。
public yii\base\Behavior[] getBehaviors ( ) | ||
返回值 | yii\base\Behavior[] |
附加到此组件的行为列表 |
---|
public function getBehaviors()
{
$this->ensureBehaviors();
return $this->_behaviors;
}
public 整数 getFlushInterval ( ) | ||
返回值 | integer |
在将消息发送到目标之前应记录的消息数量。此方法返回 yii\log\Logger::$flushInterval 的值。 |
---|
public function getFlushInterval()
{
return $this->getLogger()->flushInterval;
}
获取连接的日志记录器。
如果未设置,则将使用 Yii::getLogger()。
public yii\log\Logger getLogger ( ) | ||
返回值 | yii\log\Logger |
日志记录器。 |
---|
public function getLogger()
{
if ($this->_logger === null) {
$this->setLogger(Yii::getLogger());
}
return $this->_logger;
}
public 整数 getTraceLevel ( ) | ||
返回值 | integer |
每个消息一起记录多少个应用程序调用栈。此方法返回 yii\log\Logger::$traceLevel 的值。默认为 0。 |
---|
public function getTraceLevel()
{
return $this->getLogger()->traceLevel;
}
定义于: yii\base\Component::hasEventHandlers()
返回一个值,指示是否有任何处理程序附加到命名事件。
public 布尔值 hasEventHandlers ( $name ) | ||
$name | string |
事件名称 |
返回值 | 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);
}
定义于: yii\base\Component::hasMethod()
返回一个值,指示方法是否已定义。
如果定义了方法,则
- 类具有指定名称的方法
- 附加的行为具有给定名称的方法(当
$checkBehaviors
为 true 时)。
public 布尔值 hasMethod ( $name, $checkBehaviors = true ) | ||
$name | string |
属性名 |
$checkBehaviors | 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;
}
定义于: yii\base\Component::hasProperty()
返回一个值,指示是否为此组件定义了属性。
如果定义了属性,则
- 类具有与指定名称关联的 getter 或 setter 方法(在这种情况下,属性名称不区分大小写);
- 类具有与指定名称相同的成员变量(当
$checkVars
为 true 时); - 附加的行为具有给定名称的属性(当
$checkBehaviors
为 true 时)。
另请参阅
public 布尔值 hasProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
属性名 |
$checkVars | boolean |
是否将成员变量视为属性 |
$checkBehaviors | boolean |
是否将行为的属性视为此组件的属性 |
返回值 | boolean |
属性是否已定义 |
---|
public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}
初始化对象。
此方法在构造函数结束时调用,在对象使用给定配置初始化之后。
public void init ( ) |
public function init()
{
parent::init();
foreach ($this->targets as $name => $target) {
if (!$target instanceof Target) {
$this->targets[$name] = Yii::createObject($target);
}
}
}
定义于: yii\base\Component::off()
从此组件中分离现有的事件处理程序。
此方法与 on() 相反。
注意:如果为事件名称传递了通配符模式,则只会删除使用此通配符注册的处理程序,而使用与该通配符匹配的普通名称注册的处理程序将保留。
另请参阅 on()。
public 布尔值 off ( $name, $handler = null ) | ||
$name | string |
事件名称 |
$handler | 可调用|空 |
要删除的事件处理程序。如果为 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;
}
将事件处理程序附加到事件。
事件处理程序必须是有效的 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 | 可调用 |
事件处理程序 |
$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]);
}
}
public void setFlushInterval ( $value ) | ||
$value | integer |
记录多少条消息后将它们发送到目标。此方法将设置 yii\log\Logger::$flushInterval 的值。默认为 1000,这意味着 yii\log\Logger::flush() 方法将每记录 1000 条消息调用一次。如果不想在应用程序终止之前刷新消息,请将此属性设置为 0。此属性主要影响记录的消息将占用多少内存。较小的值表示较少的内存,但由于 yii\log\Logger::flush() 的开销,将增加执行时间。 |
public function setFlushInterval($value)
{
$this->getLogger()->flushInterval = $value;
}
设置连接的日志记录器。
public void setLogger ( $value ) | ||
$value | yii\log\Logger|字符串|数组 |
要使用的日志记录器。这可以是日志记录器实例或配置,该配置将用于使用 Yii::createObject() 创建一个日志记录器。如果您提供自定义日志记录器配置,并希望将其用于整个应用程序,而不仅仅用于调度程序,则应使用 Yii::setLogger()。 |
public function setLogger($value)
{
if (is_string($value) || is_array($value)) {
$value = Yii::createObject($value);
}
$this->_logger = $value;
$this->_logger->dispatcher = $this;
}
public void setTraceLevel ( $value ) | ||
$value | integer |
每个消息应该记录多少个应用程序调用栈。此方法将设置 yii\log\Logger::$traceLevel 的值。如果该值大于 0,则最多记录指定数量的调用栈。请注意,只计算应用程序调用栈。默认为 0。 |
public function setTraceLevel($value)
{
$this->getLogger()->traceLevel = $value;
}
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);
}
请注册或登录以发表评论。