Leaps/Events - 事件管理器


Apache
跨平台
PHP

软件简介

温馨提示:项目为开源软件,已停止维护。

Events ——简单的事件管理器。
Leaps/Events事件为建立松耦合应用提供了极大的灵活性,它允许扩展包参与到应用的核心执行流程中而无需修改程序代码。

安装

"require" : {
    "php" : ">=5.4.0",
    "leaps/events": "1.0.*"
}

基本使用

这个组件极易使用:

<?php
//Create an instance
$d = new \Leaps\Events\Dispatcher();
$d->listen('foo',function(){
    return 'hello';
});
$response = $d->trigger('foo');
echo $response;

触发事件

只要把你要触发的事件名告诉 Dispatcher 类就可以触发一个事件:

触发一个事件:

<?php
 //Create an instance 
 $d = new \Leaps\Events\Dispatcher(); 
 $response = $d->trigger('loaded');

注意,我们将 trigger 方法的执行结果赋予了一个变量。这个方法将返回一个数组,数组中包含所有监听这一事件的监听器执行后的返回数据。

如果只是要获取第一条返回数据的话,可以这样:

触发一个事件并获取第一条返回值:

<?php
//Create an instance
$d = new \Leaps\Events\Dispatcher();
$response = $d->trigger('loaded');

注意: first 方法会触发所有监听某一事件的监听器,但是最后只返回第一条数据。

触发一个事件,并直到有一个事件监听器返回非null数据为止:

<?php
//Create an instance
$d = new \Leaps\Events\Dispatcher();
$response = $d->first('loaded');

注意: until 方法在获取到第一条非null的返回数据之前将按顺序执行所有监听某一事件的监听器。

监听事件

光有事件,没人监听也是白搭。下面演示为事件注册一个事件处理器:

注册一个事件处理器:

<?php
//Create an instance
$d = new \Leaps\Events\Dispatcher();
$response = $d->listen('loaded'function()
    {
        // I'm executed on the "loaded" event!
    });

传递个这个方法的闭包函数会在 “loaded” 事件每次 触发时执行。

事件队列

有时候你会希望将需要触发的事件 放到“队列”里存储起来,而不要立即触发。这就需要使用 queue 和flush
方法了。首先,向事件队列中注册一个带有唯一标识符的事件:

向事件队列注册一个事件:

<?php
//Create an instance
$d = new \Leaps\Events\Dispatcher();
$response = $d->queue('loaded', $user->id, array($user));

这个方法接受3个参数。第一个参数是事件队列的名称,第二个参数是事件的唯一标识符,第三个参数是用来传递给事件清理器的数组,这一数组携带了有用的数据。

接下来,我们为 foo 事件注册一个事件处理器:

注册一个事件处理器:

<?php
//Create an instance
$d = new \Leaps\Events\Dispatcher();
$response = $d->flusher('loaded', function($key, $user)
    {
        //
    });

注意,flusher方法接受两个参数。第一个事存放在事件队列中的某个事件的唯一标识符,在上面的例子中就是用户ID;第二个参数(其后还可以有更多参数)是这个事件所携带的数据。

最后,我们调用 flush 方法将队列中的所有事件交由事件处理器处理掉:

<?php
//Create an instance
$d = new \Leaps\Events\Dispatcher();
$response = $d->flush('foo', function($key, $user)
    {
        //
    });