[TOC]
# 简介
可以将自定义代码“注入”到现有代码中的特定执行点。附加自定义代码到某个事件，当这个事件被触发时，这些代码就会自动执行。
例如，邮件程序对象成功发出消息时可触发 `messageSend` 事件。如想追踪成功发送的消息，可以附加相应追踪代码到 `messageSend` 事件。
Yii 引入了名为`yii\base\Component`的基类以支持事件。如果一个类需要触发事件就应该继承`yii\base\Component`或其子类。
# 事件处理器
* 对象名和方法名数组形式指定的对象方法，如 `[$object, $method]`
~~~
use app\events\MessageEvent;
...
const EVENT_HELLO = 'sayHello';
public function actionIndex()
{
$event = new MessageEvent;
$event->message = 'new message from actionIndex method';
$this->on(self::EVENT_HELLO,[$event,'hello']);
$this->trigger(self::EVENT_HELLO,$event); // 打印 new message from actionIndex method
}
~~~
其中`app\events\MessageEvent`类代码很简单，如下：
~~~
<?php
namespace app\events;
use yii\base\Event;
use Yii;
class MessageEvent extends Event
{
public $message;
public function hello($event)
{
echo $event->message;
}
}
~~~
* 类名和方法名数组形式指定的**静态类方法**，如 `[$class, $method]`
~~~
use app\events\MessageEvent;
...
const EVENT_HELLO = 'sayHello';
public function actionIndex()
{
$event = new MessageEvent;
$event->message = 'new message from actionIndex method';
$this->on(self::EVENT_HELLO,['app\events\MessageEvent','hello']);
$this->trigger(self::EVENT_HELLO,$event);
}
~~~
其中`app\events\MessageEvent`类代码很简单，如下：
~~~
<?php
namespace app\events;
use yii\base\Event;
use Yii;
class MessageEvent extends Event
{
public $message;
static public function hello($event)
{
echo $event->message;
}
}
~~~
* 匿名函数，如 `function ($event) { ... }`
~~~
const EVENT_HELLO = 'sayHello';
public function actionIndex()
{
$this->on(self::EVENT_HELLO,function ($event){ // 绑定一个Event事件
foreach ($event->data as $data){
echo strtoupper($data),PHP_EOL;
}
}, ['abc','dev']);
$this->trigger(self::EVENT_HELLO); // 触发事件 得到结果：ABC DEV
}
~~~
# 绑定与解除
有了事件handler，还要告诉Yii，这个handler是负责处理哪种事件的。这个过程，就是事件的绑定， 把事件和事件handler这两个蚂蚱绑在一根绳上，当事件跳起来的时候，就会扯动事件handler啦。
`yii\base\Component::on()` 就是用来绑定的，很容易就猜到， `yii\base\Component::off()` 就是用来解除的。对于绑定，有以下形式:
~~~
$person = new Person;
// 使用PHP全局函数作为handler来进行绑定
$person->on(Person::EVENT_GREET, 'person_say_hello');
// 使用对象$obj的成员函数say_hello来进行绑定
$person->on(Person::EVENT_GREET, [$obj, 'say_hello']);
// 使用类Greet的静态成员函数say_hello进行绑定
$person->on(Person::EVENT_GREET, ['app\helper\Greet', 'say_hello']);
// 使用匿名函数
$person->on(Person::EVENT_GREET, function ($event) {
echo 'Hello';
});
~~~
`yii\base\Component` 维护了一个handler数组，用来保存绑定的handler:
~~~
// 这个就是handler数组
private _events = [];
// 绑定过程就是将handler写入_event[]
public function on($name, $handler, $data = null, $append = true)
{
$this->ensureBehaviors();
if ($append || empty($this->_events[$name])) {
$this->_events[$name][] = [$handler, $data];
} else {
array_unshift($this->_events[$name], [$handler, $data]);
}
}
~~~
在事件的绑定逻辑上，按照以下顺序：
* 参数$append是否为true。为true表示所要绑定的事件handler要放在$\_event\[\]数组的最后面。这也是默认的绑定方式。
* 参数$append是否为false。表示handler要放在数组的最前面。这个时候，要多进行一次判定。
* 如果所有绑定的事件还没有已经绑定好的handler，也就是说，将要绑定的handler是第一个，那么无论$append是否是true，该handler必然是第一个元素，也是最后一个元素。
* 如果$append为false，且要绑定的事件已经有了handler，那么，就将新绑定的事件插入到数组的最前面。
handler在$event\[\]数组中的位置很重要，代表的是执行的先后顺序。这个在[多个事件handler的顺序](http://www.digpage.com/event.html#id7)中会讲到。
在解除时，就是使用 unset() 函数，处理 `$_event[]` 数组的相应元素。 `yii\base\Component::off()` 如下所示:
~~~
public function off($name, $handler = null)
{
$this->ensureBehaviors();
if (empty($this->_events[$name])) {
return false;
}
// $handler === null 时解除所有的handler
if ($handler === null) {
unset($this->_events[$name]);
return true;
} else {
$removed = false;
// 遍历所有的 $handler
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 $removed;
}
}
~~~
要留意以下几点：
当 $handler 为 null 时，表示解除 $name 事件的所有handler。
在解除 $handler 时，将会解除所有的这个事件下的 $handler 。虽然一个handler多次绑定在同一事件上的情况不多见，但这并不是没有，也不是没有意义的事情。在特定的情况下，确实有一个handler多次绑定在同一事件上。因此在解除时，所有的 $handler 都会被解除。而且没有办法只解除其中的一两个。
# 事件的级别
## 类级别事件
**当对象触发事件时，它首先调用实例级别的处理器，然后才会调用类级别处理器**
先讲讲类级别的事件。类级别事件用于响应所有类实例的事件。比如，工头需要了解所有工人的下班时间， 那么，对于数百个工人，即数百个Worker实例，工头难道要一个一个去绑定自己的handler么？ 这也太低级了吧？其实，他只需要绑定一个handler到Worker类，这样每个工人下班时，他都能知道了。 与实例级别的事件不同，类级别事件的绑定需要使用 yii\base\Event::on()
~~~
Event::on(
Worker::className(), // 第一个参数表示事件发生的类
Worker::EVENT_OFF_DUTY, // 第二个参数表示是什么事件
function ($event) { // 对事件的处理
echo $event->sender . ' 下班了';
}
);
~~~
这样，每个工人下班时，会触发自己的事件处理函数，比如去打卡。之后，会触发类级别事件。 类级别事件的触发仍然是在 yii\base\Component::trigger() 中，还记得该函数的最后一个语句么:
~~~
Event::trigger($this, $name, $event); // 触发类一级的事件
~~~
这个语句就触发了类级别的事件。类级别事件，总是在实例事件后触发。既然触发时机靠后，那么如果有一天你要早退又不想老板知道，你就可以向小煤窑老板那样，通过 $event->handled = true ，来终止事件处理。
从 yii\base\Event::trigger() 的参数列表来看，比 yii\base\Component::trigger() 多了一个参数 $class 表示这是哪个类的事件。因此，在保存 $_event[] 数组上， yii\base\Event 也比 yii\base\Component 要多一个维度:
~~~
// Component中的$_event[] 数组
$_event[$eventName][] = [$handler, $data];
// Event中的$_event[] 数组
$_event[$eventName][$calssName][] = [$handler, $data];
~~~
那么，反过来的话，低级别的handler可以在高级别事件发生时发生作用么？这当然也是不行的。由于类级别事件不与任意的实例相关联，所以，类级别事件触发时，类的实例可能都还没有呢，怎么可能进行处理呢？
类级别事件的触发，应使用 yii\base\Event::trigger() 。这个函数不会触发实例级别的事件。值得注意的是， $event->sender 在实例级别事件中， $event->sender 指向触发事件的实例，而在类级别事件中， 指向的是类名。在 yii\base\Event::trigger() 代码中，有:
~~~
if (is_object($class)) { // $class 是trigger()的第一个参数，表示类名
if ($event->sender === null) {
$event->sender = $class;
}
$class = get_class($class); // 传入的是一个实例，则以类名替换之
} else {
$class = ltrim($class, '\\');
}
~~~
这段代码会对 $evnet->sender 进行设置，如果传入的时候，已经指定了他的值，那么这个值会保留，否则，就会替换成类名。
对于类级别事件，有一个要格外注意的地方，就是他不光会触发自身这个类的事件，这个类的所有祖先类的同一事件也会被触发。但是，自身类事件与所有祖先类的事件，视为同一级别:
~~~
// 最外面的循环遍历所有祖先类
do {
if (!empty(self::$_events[$name][$class])) {
foreach (self::$_events[$name][$class] as $handler) {
$event->data = $handler[1];
call_user_func($handler[0], $event);
// 所有的事件都是同一级别，可以随时终止
if ($event->handled) {
return;
}
}
}
} while (($class = get_parent_class($class)) !== false);
~~~
上面的嵌套循环的深度，或者叫时间复杂度，受两个方面影响，一是类继承结构的深度，二是 `$_event[$name][$class][] `数组的元素个数，即已经绑定的handler的数量。从实践经验看，一般软件工程继承深度超过十层的就很少见，而事件绑定上，同一事件的绑定handler超过十几个也比较少见。因此，上面的嵌套循环运算数量级大约在100～1000之间，这是可以接受的。
但是，从机制上来讲，由于类级别事件会被类自身、类的实例、后代类、后代类实例所触发，所以，对于越底层的类而言，其类事件的影响范围就越大。因此，在使用类事件上要注意，尽可能往后代类安排，以控制好影响范围，尽可能不在基础类上安排类事件。
## 全局事件
接下来再讲讲全局级别事件。上面提到过，所谓的全局事件，本质上只是一个实例事件罢了。他只是利用了Application实例在整个应用的生命周期中全局可访问的特性，来实现这个全局事件的。当然，你也可以将他绑定在任意全局可访问的的Component上。
全局事件一个最大优势在于：在任意需要的时候，都可以触发全局事件，也可以在任意必要的时候绑定，或解除一个事件:
~~~
Yii::$app->on('bar', function ($event) {
echo get_class($event->sender); // 显示当前触发事件的对象的类名称
});
~~~
~~~
Yii::$app->trigger('bar', new Event(['sender' => $this]));
~~~
上面的 `Yii::$app->on()` 可以在任何地方调用，就可以完成事件的绑定。而 `Yii::$app->trigger()` 只要在绑定之后的任何时候调用就OK了。
- 目录
- 配置
- 简介
- 别名
- gii
- 配置项
- 模型
- 简介
- 增删改查
- AR和model
- 模型事件
- 场景
- query查询
- 增删改
- AR查询器
- 模型关系定义
- AR模型连表查询
- fields
- where拼接
- 模块
- 创建模块
- 控制器
- 表单
- 跳转
- 响应
- 验证器
- Action
- 组件
- url
- 分页
- 验证码
- 缓存
- 文件上传
- 预启动组件
- 事件
- 自定义组件
- redis
- 日志
- 行为
- cookie和session
- 基础知识
- 创建一个类
- 配置一个类
- object基类
- component组件类特性
- phpstorm无法更改php等级
- url地址美化
- 过滤器
- 请求处理
- 请求组件
- 响应组件
- header
- 用户登录
- 实现IdentityInterface接口
- 登录
- 自动检测登录
- 获取用户信息
- 访问行为追踪
- phpstorm+postman断点调试