Question

我正在尝试使用CakePHP v2.1 +中的事件系统

它看起来非常强大，但文档有些模糊。触发事件看起来很简单，但我不知道如何注册相应的监听器来监听事件。相关部分为here，它提供以下示例代码：

App::uses('CakeEventListener', 'Event');
class UserStatistic implements CakeEventListener {

    public function implementedEvents() {
        return array(
            'Model.Order.afterPlace' => 'updateBuyStatistic',
        );
    }

    public function updateBuyStatistic($event) {
        // Code to update statistics
    }
}

// Attach the UserStatistic object to the Order's event manager
$statistics = new UserStatistic();
$this->Order->getEventManager()->attach($statistics);

但它没有说这个代码应该驻留在哪里。在特定的控制器内？在app控制器里面？

如果它是相关的，那么监听器将成为我正在编写的插件的一部分。

更新这听起来像一种流行的方法是将监听器注册代码放在插件的bootstrap.php文件中。但是，我无法弄清楚如何从那里调用getEventManager（），因为应用程序的控制器类等不可用。

更新2： 我还被告知，听众可以住在模特里面。

更新3： 终于有些牵引！以下代码将在MyPlugin / Config / bootstrap.php内部成功记录事件

App::uses('CakeEventManager', 'Event'); 
App::uses('CakeEventListener', 'Event');
class LegacyWsatListener implements CakeEventListener {

    public function implementedEvents() {
        return array(
            'Controller.Attempt.complete' => 'handleLegacyWsat',
        );
    }

    public static function handleLegacyWsat($event) { //method must be static if used by global EventManager
        // Code to update statistics
        error_log('event from bootstrap');
    }
}
 CakeEventManager::instance()->attach(array('LegacyWsatListener', 'handleLegacyWsat'), 'Controller.Attempt.complete');

我不知道为什么，但是当我尝试将两个App::uses()组合成一行时，我不会出错。

Answer 1

活动

事件是与字符串关联的回调。对象（如Model）将使用字符串触发事件，即使没有任何内容正在侦听该事件。

CakePHP预先构建了一些内部事件，例如Models。您可以将事件侦听器附加到模型并响应Model.beforeSave事件。

EventManager

Cake中的每个模型都有自己的EventManager，还有一个gobal singleton EventManager。这些并不是EventManager的所有实例，它们的工作方式略有不同。

当模型触发事件时，它使用它具有的EventManager引用。这意味着，您可以将事件侦听器附加到特定模型。优点是您的监听器只接收来自该模型的事件。

全局侦听器是附加到EventManager的单例实例的侦听器。可以在代码中的任何位置访问。当你在那里附加一个监听器时，无论是谁触发它，都会调用发生的每个事件。

当您在应用程序或插件的bootstrap.php中附加事件侦听器时，您可以使用全局管理器，否则您必须使用ClassRegistry获取所需模型的引用。

使用什么EventManager？

如果要处理的事件是针对特定模型的，则将侦听器附加到该模型的EventManager。要获得模型的参考，您可以调用ClassRegistry::init(...)。

如果要处理的事件可以在任何地方触发，则将侦听器附加到全局EventManager。

只有你知道应该如何使用你的听众。

听众内部

通常，您将业务逻辑放入模型中。您不需要从事件侦听器访问Controller。模型在Cake中更容易访问和使用。

这是一个用于创建CakeEventListener的模板。监听器负责监视何时发生事件，然后将该信息传递给另一个模型。您应该将业务逻辑放在模型中处理事件。

<?php

App::uses('CakeEventListener', 'Event');

class MyListener implements CakeEventListener
{
    /**
     *
     * @var Document The model.
     */
    protected $Document;

    /**
     * Constructor
     */
    public function __construct()
    {
        // get a reference to a Model that we'll use
        $this->Document = ClassRegistry::init('Agg.Document');
    }

    /**
     * Register the handlers.
     *
     * @see CakeEventListener::implementedEvents()
     */
    public function implementedEvents()
    {
        return array(
            'Model.User.afterSave'=>'UserChanged'
        );
    }

    /**
     * Use the Event to dispatch the work to a Model.
     *
     * @param CakeEvent $event
     *          The event object and data.
     */
    public function UserChanged(CakeEvent $event)
    {
        $data = $event->data;
        $subject = $event->subject();

        $this->Document->SomethingImportantHappened($data,$subject);
    }
}

我喜欢将所有活动放入Lib文件夹。这使得从源代码中的任何位置访问都非常容易。上面的代码会进入App/Lib/Event/MyListener.php。

附加EventListeners

同样，这取决于您需要监听的事件。您必须要了解的第一件事是必须创建一个对象才能触发事件。

例如;

当Document控制器显示索引时，Model.beforeSave模型无法触发Calendar事件，因为日历控制器从不使用Document模型。您是否需要在Document中向bootstrap.php添加一个侦听器，以便在保存时捕获它？不，如果Document模型仅在Documents控制器中使用，那么您只需要在那里附加监听器。

另一方面，User组件几乎每个都使用Auth模型。如果您要处理被删除的User。您可能必须在bootstrap.php中附加一个事件监听器，以确保您不会偷偷删除。

在上面的例子中，我们可以像这样直接附加到User模型。

App::uses('MyListener','Lib');
$user = ClassRegistry::init('App.User');
$user->getEventManager()->attach(new MyListener());

此行将导入您的侦听器类。

App::uses('MyListener','Lib');

此行将获取用户模型的实例。

$user = ClassRegistry::init('App.User');

此行创建一个侦听器，并将其附加到User模型。

$user->getEventManager()->attach(new MyListener());

如果在许多不同的地方使用User模型。您可能必须在bootstrap.php中执行此操作，但如果它仅由一个控制器使用。您可以将该代码放在beforeFilter或PHP文件的顶部。

Global EventManager怎么样？

假设我们需要倾听一般事件。就像什么时候保存任何的东西一样。我们希望附加到全局EventManager。它会像这样，放在bootstrap.php。

App::uses('MyListener','Lib');
CakeEventManager::instance()->attach(new MyListener());

Answer 2

如果你想在你的插件的bootstrap.php文件中附加一个事件监听器，一切都应该使用答案中发布的提示正常工作。这是我的代码（正常工作）：

为myplugin /配置/ bootstrap.php中：

App::uses('CakeEventManager', 'Event');
App::uses('MyEventListener', 'MyPlugin.Lib/Event');
CakeEventManager::instance()->attach(new MyEventListener());

为myplugin / LIB /活动/ MyEventListener.php：

App::uses('CakeEventListener', 'Event');
class MyEventListener implements CakeEventListener {
    ...
}

仅在加载插件时才注册与MyPlugin相关的事件侦听器。如果我不想使用该插件，则不会附加事件侦听器。我想当你想使用插件在应用程序的各个地方添加一些功能时，这是一个干净的解决方案。

Answer 3

它并不重要，代码所在的位置。只需确保其被执行并且您的活动已正确注册＆amp;连接。

我们使用单个文件来附加所有事件并将其包含在bootstrap.php中，这可以确保所有事件都可以从应用程序的所有位置获得。

当您发送事件时，例如来自控制器操作，就会发生魔力。

$event = new CakeEvent('Model.Order.afterPlace', $this, array('some'=>'data') ));
$this->getEventManager()->dispatch($event);

但是，您可以从可以到达EventManager的任何地方调度事件（默认情况下在模型，控制器和视图中）

在哪里注册事件监听器

3 个答案:

活动

EventManager

使用什么EventManager？

听众内部

附加EventListeners

例如;

Global EventManager怎么样？