yii2 源码分析Event类分析 （三）

转载请注明链接：http://www.cnblogs.com/liuwanqiu/p/6739880.html

Event是所有事件的基类，它继承Object类

Event类上面的注释的大致意思：

 * Event是所有事件类的基类，它封装了与事件关联的参数
 * sender属性指的是谁发起来的事件.
 * handled属性指的是事件的处理方式. 如果一个事件处理程序设置了handled为true，其它未处理的事件处理程序将不会被调用。
 *
 * 当附加事件处理程序时，可能会通过额外的数据 ，当事件处理程序被调用时，可通过[ data]属性提供

class Event extends Object
{
    /**
     * 事件的名字,通过[[Component::trigger()]] 和 [[trigger()]]方法设置，事件处理程序可以使用此属性来检查它的处理事件
     */
    public $name;
    /**
     * 触发事件的对象，如果未设置，则设置为调用"trigger()"方法的对象，如果是在静态环境下触发的类级别的事件，属性为空
     */
    public $sender;
    /**
     *如果一个事件处理程序设置了handled为true，其它未处理的事件处理程序将不会被执行，默认值为false
     */
    public $handled = false;
    /**
     * 附加一个事件处理程序时通过[[Component::on()]]传入data，且对应当前执行的事件处理程序
     * 注意，这取决于哪个事件处理程序当前正在执行。
     */
    public $data;

    /**
     * @var 数组包含所有全局注册的事件处理程序，存储所有的 event，所有的 event 对象/类都共用这一数据
     */
    private static $_events = [];

    /**
     * 为一个类添加事件
     * 当一个类级别事件触发，将调用该类和所有父类的事件处理程序
     * 例如：
     * 该处理程序是将每一个成功的[[ActiveRecord]]插入调用
     * ```php
     * Event::on(ActiveRecord::className(), ActiveRecord::EVENT_AFTER_INSERT, function ($event) {
     *     Yii::trace(get_class($event->sender) . ' is inserted.');
     * });
     * ```
     *
     * @param string $class 定义的类级别的对象或者类名称.
     * @param string $name 事件名.
     * @param callable $handler 事件处理程序.
     * @param mixed $data 当事件被触发时，将传递给事件处理程序的数据。当调用事件处理程序时，该数据可以通过[[Event::data]]传递
     * @param boolean $append 是否将新事件处理程序附加到现有的处理程序列表的结尾。
     * 如果false，新的处理程序将被插入到现有的处理程序列表开头
     * @see off()
     */
    public static function on($class, $name, $handler, $data = null, $append = true)
    {
        // 去掉 class 最左边的反斜杠，主要是针对类的静态方法
        $class = ltrim($class, '\\');
        if ($append || empty(self::$_events[$name][$class])) {
            //如果 append 为true，附加到$_events中名字为 $name 的数组结尾
            self::$_events[$name][$class][] = [$handler, $data];
        } else {
            //如果false，被插入列表开头
            array_unshift(self::$_events[$name][$class], [$handler, $data]);
        }
    }

    /**
     * [[on()]]的反方法，移除一个类的事件
     *
     * @param string $class 定义类级别的对象或者类名称.
     * @param string $name  事件名
     * @param callable $handler 事件处理程序.如果是null，移除所有相关事件
     * @return boolean 一个处理程序是否被发现且分离.
     * @see on()
     */
    public static function off($class, $name, $handler = null)
    {
         // 去掉最左边的反斜线，主要是针对类的静态方法
        $class = ltrim($class, '\\');
        if (empty(self::$_events[$name][$class])) {
            // 该事件不存在，返回false
            return false;
        }
        if ($handler === null) {
            // 如果 $handler 为空，该类下该所有是这个名字的事件移除，
            unset(self::$_events[$name][$class]);
            return true;
        } else {
            $removed = false;
            foreach (self::$_events[$name][$class] as $i => $event) {
                // 如果 $handler 不为空，循环 $_events 找到相应的 $handler，只移除这个 $handler 和 data 组成的数组
                if ($event[0] === $handler) {
                    unset(self::$_events[$name][$class][$i]);
                    $removed = true;
                }
            }
            if ($removed) {
                // 移除成功，使数组重新变成一个自然数组
                self::$_events[$name][$class] = array_values(self::$_events[$name][$class]);
            }

            return $removed;
        }
    }

    /**
     * 解除所有的事件处理程序
     * @since 2.0.10
     */
    public static function offAll()
    {
        self::$_events = [];
    }

    /**
     * 是否给某个类绑定了某个事件
     * 检测在某个类或者对象是否具有某个事件 同时检测父类
     * @param string|object $class 定义类级别的对象或者类名称.
     * @param string $name the event name.事件名
     * @return boolean 是否有处理程序连接到事件.
     */
    public static function hasHandlers($class, $name)
    {
        if (empty(self::$_events[$name])) {
             //如果不存在事件，返回false
            return false;
        }
        if (is_object($class)) {
            //如果是对象，获取类名
            $class = get_class($class);
        } else {
            //如果是类名，去掉左边的反斜杠，主要是针对类的静态方法
            $class = ltrim($class, '\\');
        }
        //将当前类，当前类的父类，父类所实现的接口合并成一个数组
        $classes = array_merge(
            [$class],
            class_parents($class, true),
            class_implements($class, true)
        );

        foreach ($classes as $class) {
            if (!empty(self::$_events[$name][$class])) {
                //找到了就返回true
                return true;
            }
        }

        return false;
    }

    /**
     *  触发类级别事件。
     * 该方法将调用指定类中的事件处理程序
     * @param string|object $class 定义的类级别的对象或者类名称.
     * @param string $name 事件名.
     * @param Event $event  事件参数，未设置则默认创建
     */
    public static function trigger($class, $name, $event = null)
    {
        if (empty(self::$_events[$name])) {
            //如果事件为空，直接返回
            return;
        }
        if ($event === null) {
            // 事件不存在，就创建一个静态 Event 对象
            $event = new static;
        }
        $event->handled = false;//事件是否被处理标志，默认未处理
        $event->name = $name;//事件名

        if (is_object($class)) {
            if ($event->sender === null) {
                // 如果 $class 是个对象，并且sender为空，就将 $class赋给sender，即$class发起事件
                $event->sender = $class;
            }
            $class = get_class($class);//获取类名
        } else {
            //不是对象，去掉左边的反斜线
            $class = ltrim($class, '\\');
        }
        //将当前类，当前类的父类，父类所实现的接口合并成一个数组
        $classes = array_merge(
            [$class],
            class_parents($class, true),
            class_implements($class, true)
        );

        foreach ($classes as $class) {
            if (!empty(self::$_events[$name][$class])) {
                foreach (self::$_events[$name][$class] as $handler) {
                     // 将参数赋到 event 对象的 data 属性上
                    $event->data = $handler[1];
                     // 调用 $handler 方法
                    call_user_func($handler[0], $event);
                    if ($event->handled) {
                        //事件处理程序handled为true，其它未处理的事件处理程序将不会被调用。
                        return;
                    }
                }
            }
        }
    }
}