首頁 後端開發 php教程 Yii2的深入學習--yiibaseEvent 類

Yii2的深入學習--yiibaseEvent 類

Jul 29, 2016 am 09:08 AM
class event handler name the

根据之前一篇文章,我们知道 Yii2 的事件分两类,一是类级别的事件,二是实例级别的事件。类级别的事件是基于 yii\base\Event 实现,实例级别的事件是基于 yii\base\Component 实现。

今天先来看下类级别事件的实现,代码是 yii\base\Event 类。

<?<span>php
namespace yii\base;

</span><span>/*</span><span>*
 * Event is the base class for all event classes.
 </span><span>*/</span><span>class</span> Event <span>extends</span><span>Object</span><span>{
    </span><span>/*</span><span>*
     * @var string the event name. This property is set by [[Component::trigger()]] and [[trigger()]].
     * Event handlers may use this property to check what event it is handling.
     * 事件的名字
     </span><span>*/</span><span>public</span><span>$name</span><span>;
    </span><span>/*</span><span>*
     * @var object the sender of this event. If not set, this property will be
     * set as the object whose "trigger()" method is called.
     * This property may also be a `null` when this event is a
     * class-level event which is triggered in a static context.
     * 触发事件的对象
     </span><span>*/</span><span>public</span><span>$sender</span><span>;
    </span><span>/*</span><span>*
     * @var boolean whether the event is handled. Defaults to false.
     * When a handler sets this to be true, the event processing will stop and
     * ignore the rest of the uninvoked event handlers.
     * 记录事件是否已被处理,当 handled 被设置为 true 时,执行到这个 event 的时候,会停止,并忽略剩下的 event
     </span><span>*/</span><span>public</span><span>$handled</span> = <span>false</span><span>;
    </span><span>/*</span><span>*
     * @var mixed the data that is passed to [[Component::on()]] when attaching an event handler.
     * Note that this varies according to which event handler is currently executing.
     </span><span>*/</span><span>public</span><span>$data</span><span>;

    </span><span>/*</span><span>*
     * 存储所有的 event,因为是 static 的属性,所有的 event 对象/类都共享这一份数据
     </span><span>*/</span><span>private</span><span>static</span><span>$_events</span> =<span> [];


    </span><span>/*</span><span>*
     * Attaches an event handler to a class-level event.
     *
     * When a class-level event is triggered, event handlers attached
     * to that class and all parent classes will be invoked.
     *
     * For example, the following code attaches an event handler to `ActiveRecord`'s
     * `afterInsert` event:
     *
     * ~~~
     * Event::on(ActiveRecord::className(), ActiveRecord::EVENT_AFTER_INSERT, function ($event) {
     *     Yii::trace(get_class($event->sender) . ' is inserted.');
     * });
     * ~~~
     *
     * The handler will be invoked for EVERY successful ActiveRecord insertion.
     *
     * For more details about how to declare an event handler, please refer to [[Component::on()]].
     *
     * 为一个类添加事件
     *
     * @param string $class the fully qualified class name to which the event handler needs to attach.
     * @param string $name the event name.
     * @param callable $handler the event handler.
     * @param mixed $data the data to be passed to the event handler when the event is triggered.
     * When the event handler is invoked, this data can be accessed via [[Event::data]].
     * @param boolean $append whether to append new event handler to the end of the existing
     * handler list. If false, the new handler will be inserted at the beginning of the existing
     * handler list.
     * @see off()
     <span>*/</span><span>public</span><span>static</span><span>function</span> on(<span>$class</span>, <span>$name</span>, <span>$handler</span>, <span>$data</span> = <span>null</span>, <span>$append</span> = <span>true</span><span>)
    {
        </span><span>//</span><span> 去掉 class 最左边的斜杠</span><span>$class</span> = <span>ltrim</span>(<span>$class</span>, '\\'<span>);
        </span><span>//</span><span> 如果 append 为true,就放到 $_events 中名字为 $name 的数组的最后,否则放到最前面</span><span>if</span> (<span>$append</span> || <span>empty</span>(self::<span>$_events</span>[<span>$name</span>][<span>$class</span><span>])) {
            self</span>::<span>$_events</span>[<span>$name</span>][<span>$class</span>][] = [<span>$handler</span>, <span>$data</span><span>];
        } </span><span>else</span><span> {
            </span><span>array_unshift</span>(self::<span>$_events</span>[<span>$name</span>][<span>$class</span>], [<span>$handler</span>, <span>$data</span><span>]);
        }
    }

    </span><span>/*</span><span>*
     * Detaches an event handler from a class-level event.
     *
     * This method is the opposite of [[on()]].
     *
     * 移除一个类的事件
     *
     * @param string $class the fully qualified class name from which the event handler needs to be detached.
     * @param string $name the event name.
     * @param callable $handler the event handler to be removed.
     * If it is null, all handlers attached to the named event will be removed.
     * @return boolean whether a handler is found and detached.
     * @see on()
     </span><span>*/</span><span>public</span><span>static</span><span>function</span> off(<span>$class</span>, <span>$name</span>, <span>$handler</span> = <span>null</span><span>)
    {
        </span><span>$class</span> = <span>ltrim</span>(<span>$class</span>, '\\'<span>);
        </span><span>if</span> (<span>empty</span>(self::<span>$_events</span>[<span>$name</span>][<span>$class</span><span>])) {
            </span><span>//</span><span> 不存在该事件</span><span>return</span><span>false</span><span>;
        }
        </span><span>if</span> (<span>$handler</span> === <span>null</span><span>) {
            </span><span>//</span><span> 如果 handler 为空,直接将在该类下该事件移除,即移出所有的是这个名字的事件</span><span>unset</span>(self::<span>$_events</span>[<span>$name</span>][<span>$class</span><span>]);
            </span><span>return</span><span>true</span><span>;
        } </span><span>else</span><span> {
            </span><span>$removed</span> = <span>false</span><span>;
            </span><span>//</span><span> 如果 $handler 不为空,循环 $_events 找到相应的 handler,只移除这个 handler 和 data 组成的数组</span><span>foreach</span> (self::<span>$_events</span>[<span>$name</span>][<span>$class</span>] <span>as</span><span>$i</span> => <span>$event</span><span>) {
                </span><span>if</span> (<span>$event</span>[0] === <span>$handler</span><span>) {
                    </span><span>unset</span>(self::<span>$_events</span>[<span>$name</span>][<span>$class</span>][<span>$i</span><span>]);
                    </span><span>$removed</span> = <span>true</span><span>;
                }
            }
            </span><span>if</span> (<span>$removed</span><span>) {
                </span><span>//</span><span> 移除之后,使数组重新变成一个自然数组</span>                self::<span>$_events</span>[<span>$name</span>][<span>$class</span>] = <span>array_values</span>(self::<span>$_events</span>[<span>$name</span>][<span>$class</span><span>]);
            }

            </span><span>return</span><span>$removed</span><span>;
        }
    }

    </span><span>/*</span><span>*
     * Returns a value indicating whether there is any handler attached to the specified class-level event.
     * Note that this method will also check all parent classes to see if there is any handler attached
     * to the named event.
     * 检测在某个类或者对象是否具有某个事件
     * @param string|object $class the object or the fully qualified class name specifying the class-level event.
     * @param string $name the event name.
     * @return boolean whether there is any handler attached to the event.
     </span><span>*/</span><span>public</span><span>static</span><span>function</span> hasHandlers(<span>$class</span>, <span>$name</span><span>)
    {
        </span><span>if</span> (<span>empty</span>(self::<span>$_events</span>[<span>$name</span><span>])) {
            </span><span>//</span><span> 不存在,直接返回</span><span>return</span><span>false</span><span>;
        }
        </span><span>if</span> (<span>is_object</span>(<span>$class</span><span>)) {
            </span><span>//</span><span> 如果是一个 object,就获取其类名</span><span>$class</span> = <span>get_class</span>(<span>$class</span><span>);
        } </span><span>else</span><span> {
            </span><span>//</span><span> 如果是一个类名,就去掉 class 最左边的斜杠</span><span>$class</span> = <span>ltrim</span>(<span>$class</span>, '\\'<span>);
        }
        </span><span>//</span><span> 如果该类中找不到,就去父类中找,直到找到或者没有父类了为止</span><span>do</span><span> {
            </span><span>if</span> (!<span>empty</span>(self::<span>$_events</span>[<span>$name</span>][<span>$class</span><span>])) {
                </span><span>return</span><span>true</span><span>;
            }
        } </span><span>while</span> ((<span>$class</span> = <span>get_parent_class</span>(<span>$class</span>)) !== <span>false</span><span>);

        </span><span>return</span><span>false</span><span>;
    }

    </span><span>/*</span><span>*
     * Triggers a class-level event.
     * This method will cause invocation of event handlers that are attached to the named event
     * for the specified class and all its parent classes.
     * 触发某个类或者对象的某个事件
     * @param string|object $class the object or the fully qualified class name specifying the class-level event.
     * @param string $name the event name.
     * @param Event $event the event parameter. If not set, a default [[Event]] object will be created.
     </span><span>*/</span><span>public</span><span>static</span><span>function</span> trigger(<span>$class</span>, <span>$name</span>, <span>$event</span> = <span>null</span><span>)
    {
        </span><span>if</span> (<span>empty</span>(self::<span>$_events</span>[<span>$name</span><span>])) {
            </span><span>return</span><span>;
        }
        </span><span>if</span> (<span>$event</span> === <span>null</span><span>) {
            </span><span>//</span><span> 事件不存在,就创建一个 Event 对象</span><span>$event</span> = <span>new</span><span>static</span><span>;
        }
        </span><span>//</span><span> 设置event对象的属性,默认是未被处理的</span><span>$event</span>->handled = <span>false</span><span>;
        </span><span>$event</span>->name = <span>$name</span><span>;

        </span><span>if</span> (<span>is_object</span>(<span>$class</span><span>)) {
            </span><span>if</span> (<span>$event</span>->sender === <span>null</span><span>) {
                </span><span>//</span><span> 如果 $class 是个对象,并且是 sender 为空,就将 $class 赋给 sender,即 $class 就是触发事件的对象</span><span>$event</span>->sender = <span>$class</span><span>;
            }
            </span><span>$class</span> = <span>get_class</span>(<span>$class</span><span>);
        } </span><span>else</span><span> {
            </span><span>$class</span> = <span>ltrim</span>(<span>$class</span>, '\\'<span>);
        }
        </span><span>//</span><span> 循环类的 $_event,直到遇到 $event->handled 为真或者没有父类了为止</span><span>do</span><span> {
            </span><span>if</span> (!<span>empty</span>(self::<span>$_events</span>[<span>$name</span>][<span>$class</span><span>])) {
                </span><span>foreach</span> (self::<span>$_events</span>[<span>$name</span>][<span>$class</span>] <span>as</span><span>$handler</span><span>) {
                    </span><span>//</span><span> 将参数赋到 event 对象的 data 属性上</span><span>$event</span>->data = <span>$handler</span>[1<span>];
                    </span><span>//</span><span> 调用 $handler 方法
                    // 在方法中,可以用 $this->data 取到相应的参数
                    // 也可以在其中设置 $this->handled 的值,中断后续事件的触发</span><span>call_user_func</span>(<span>$handler</span>[0], <span>$event</span><span>);
                    </span><span>//</span><span> 当某个 handled 被设置为 true 时,执行到这个事件的时候,会停止,并忽略剩下的事件</span><span>if</span> (<span>$event</span>-><span>handled) {
                        </span><span>return</span><span>;
                    }
                }
            }
        } </span><span>while</span> ((<span>$class</span> = <span>get_parent_class</span>(<span>$class</span>)) !== <span>false</span><span>);
    }
}</span>
登入後複製

通过上面代码可以看出,类级别的 Event,其本质就是在 Event 类中的 $_events 变量中存储事件,触发事件的时候,只需将其取出,执行即可。

$_events里面的数据结构大概如下:

<span>[
    </span>'add' =><span> [
        </span>'Child' =><span> [
            [</span><span>function</span> (<span>$event</span>) { ... }, <span>$data</span>],<span>            [[</span><span>$object</span>, 'handleAdd'], <span>null</span>],<span>            [[</span>'ChildClass', 'handleAdd'], <span>$data</span>],<span>            [</span>'handleAdd', <span>$data</span><span>]
        ]</span>,
        'ChildClass' =><span> [
            </span>...<span>        ]
    ]</span>,
    'delete' =><span> [
        </span>...<span>    ]
]</span>
登入後複製

之后讲到yii\base\Component类时,我们会再来说一下实例级别的事件。

对 Yii2 源码有兴趣的同学可以关注项目 yii2-2.0.3-annotated,现在在上面已经添加了不少关于 Yii2 源码的注释,之后还会继续添加~

有兴趣的同学也可以参与进来,提交 Yii2 源码的注释。

 

以上就介绍了Yii2的深入学习--yii\base\Event 类,包括了方面的内容,希望对PHP教程有兴趣的朋友有所帮助。

本網站聲明
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn

熱AI工具

Undresser.AI Undress

Undresser.AI Undress

人工智慧驅動的應用程序,用於創建逼真的裸體照片

AI Clothes Remover

AI Clothes Remover

用於從照片中去除衣服的線上人工智慧工具。

Undress AI Tool

Undress AI Tool

免費脫衣圖片

Clothoff.io

Clothoff.io

AI脫衣器

Video Face Swap

Video Face Swap

使用我們完全免費的人工智慧換臉工具,輕鬆在任何影片中換臉!

熱門文章

<🎜>:泡泡膠模擬器無窮大 - 如何獲取和使用皇家鑰匙
3 週前 By 尊渡假赌尊渡假赌尊渡假赌
北端:融合系統,解釋
3 週前 By 尊渡假赌尊渡假赌尊渡假赌
Mandragora:巫婆樹的耳語 - 如何解鎖抓鉤
3 週前 By 尊渡假赌尊渡假赌尊渡假赌

熱工具

記事本++7.3.1

記事本++7.3.1

好用且免費的程式碼編輯器

SublimeText3漢化版

SublimeText3漢化版

中文版,非常好用

禪工作室 13.0.1

禪工作室 13.0.1

強大的PHP整合開發環境

Dreamweaver CS6

Dreamweaver CS6

視覺化網頁開發工具

SublimeText3 Mac版

SublimeText3 Mac版

神級程式碼編輯軟體(SublimeText3)

熱門話題

Java教學
1664
14
CakePHP 教程
1423
52
Laravel 教程
1321
25
PHP教程
1269
29
C# 教程
1249
24
Python中的class類別和method方法的使用方法 Python中的class類別和method方法的使用方法 Apr 21, 2023 pm 02:28 PM

類別和方法的概念和實例類別(Class):用來描述具有相同的屬性和方法的物件的集合。它定義了該集合中每個物件所共有的屬性和方法。物件是類別的實例。方法:類別中定義的函數。類別的建構方法__init__():類別有一個名為init()的特殊方法(建構方法),該方法在類別實例化時會自動呼叫。實例變數:在類別的宣告中,屬性是用變數來表示的,這種變數就稱為實例變量,實例變數就是用self修飾的變數。實例化:建立一個類別的實例,類別的具體物件。繼承:即一個派生類別(derivedclass)繼承基底類別(baseclass)的

2 個月不見,人形機器人 Walker S 會摺衣服了 2 個月不見,人形機器人 Walker S 會摺衣服了 Apr 03, 2024 am 08:01 AM

機器之能報道編輯:吳昕國內版的人形機器人+大模型組隊,首次完成疊衣服這類複雜柔性材料的操作任務。隨著融合了OpenAI多模態大模型的Figure01揭開神秘面紗,國內同行的相關進展一直備受關注。就在昨天,國內"人形機器人第一股"優必選發布了人形機器人WalkerS深入融合百度文心大模型後的首個Demo,展示了一些有趣的新功能。現在,得到百度文心大模型能力加持的WalkerS是這個樣子的。和Figure01一樣,WalkerS沒有走動,而是站在桌子後面完成一系列任務。它可以聽從人類的命令,折疊衣物

python中class是什麼意思 python中class是什麼意思 May 21, 2019 pm 05:10 PM

class是python中的一個關鍵字,用來定義一個類,定義類別的方法:class後面加一個空格然後加類名;類名規則:首字母大寫,如果多個單字用駝峰命名法,如【class Dog()】。

使用jQuery替換元素的class名稱 使用jQuery替換元素的class名稱 Feb 24, 2024 pm 11:03 PM

jQuery是一種經典的JavaScript庫,被廣泛應用於網頁開發中,它簡化了在網頁上處理事件、操作DOM元素和執行動畫等操作。在使用jQuery時,常會遇到需要取代元素的class名稱的情況,本文將介紹一些實用的方法,以及具體的程式碼範例。 1.使用removeClass()和addClass()方法jQuery提供了removeClass()方法來刪除

PHP Class用法詳解:讓你的程式碼更清楚易讀 PHP Class用法詳解:讓你的程式碼更清楚易讀 Mar 10, 2024 pm 12:03 PM

在編寫PHP程式碼時,使用類別(Class)是一個非常常見的做法。透過使用類,我們可以將相關的功能和資料封裝在一個單獨的單元中,使程式碼更加清晰、易於閱讀和易於維護。本文將詳細介紹PHPClass的用法,並提供具體的程式碼範例,幫助讀者更好地理解如何在實際專案中應用類別來優化程式碼。 1.建立和使用類別在PHP中,可以使用關鍵字class來定義一個類,並在類別中定義屬性和方法。

Vue報錯:無法正確使用v-bind綁定class和style,怎麼解決? Vue報錯:無法正確使用v-bind綁定class和style,怎麼解決? Aug 26, 2023 pm 10:58 PM

Vue報錯:無法正確使用v-bind綁定class和style,怎麼解決?在Vue開發中,我們常常會用到v-bind指令來動態綁定class和style,但是有時候我們可能會遇到一些問題,如無法正確使用v-bind綁定class和style。在本篇文章中,我將為你解釋這個問題的原因,並提供解決方案。首先,讓我們先來了解v-bind指令。 v-bind用於將V

PHP8.0中的事件處理庫:Event PHP8.0中的事件處理庫:Event May 14, 2023 pm 05:40 PM

PHP8.0中的事件處理庫:Event隨著互聯網的不斷發展,PHP作為一門流行的後台程式語言,被廣泛應用於各種Web應用程式的開發中。在這個過程中,事件驅動機製成為了非常重要的一環。 PHP8.0中的事件處理函式庫Event將為我們提供一個更有效率和彈性的事件處理方式。什麼是事件處理在網路應用程式的開發中,事件處理是一個非常重要的概念。事件可以是任何一種使用者行

jquery怎麼判斷元素是否有class jquery怎麼判斷元素是否有class Mar 21, 2023 am 10:47 AM

jquery判斷元素是否有class的方法:1、透過「hasClass('classname')」方法判斷元素是否具有某個class;2、透過「is('.classname')」方法判斷元素是否具有某個class。

See all articles