16

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

它似乎非常强大，但文档有些模糊。触发事件似乎很简单，但我不确定如何注册相应的侦听器来侦听事件。相关部分在这里，它提供了以下示例代码：

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);

但它没有说明这段代码应该放在哪里。在特定控制器内部？在应用程序控制器内部？

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

更新： 听起来很流行的方法是将侦听器注册代码放在插件的 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()我不知道为什么，但是当我尝试将两者组合成一行时我不会出错。

4

3 回答 3

24

活动

事件是与字符串关联的回调。一个对象，比如一个模型，将使用一个字符串触发一个事件，即使没有人在监听那个事件。

CakePHP 为模型之类的东西预先构建了内部事件。您可以将事件侦听器附加到模型并响应Model.beforeSave事件。

事件管理器

Cake 中的每个模型都有自己的 EventManager，此外还有一个全局单例 EventManager。这些都不是 EventManager 的同一个实例，它们的工作方式略有不同。

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

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

当您在bootstrap.php应用程序或插件中附加事件侦听器时，您可以使用全局管理器，否则您必须使用ClassRegistry.

使用什么事件管理器？

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

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

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

听者内部

通常，您将业务逻辑放入模型中。您不需要从事件侦听器访问控制器。模型在 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.

附加事件监听器

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

例如;

当控制器显示索引时，模型不可能Document触发Model.beforeSave事件，因为日历控制器从不使用模型。你需要在保存时添加一个监听器来捕获它吗？不，如果模型仅用于控制器，那么您只需要在此处附加侦听器。CalendarDocumentDocumentbootstrap.phpDocumentDocuments

另一方面，该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，但如果它仅由一个控制器使用。您可以将该代码放在beforeFilterPHP 文件的顶部或顶部。

全球事件管理器呢？

假设我们需要监听一般事件。就像任何东西都被保存一样。我们希望附加到全局 EventManager。它会像这样，并被放置在bootstrap.php.

App::uses('MyListener','Lib');
CakeEventManager::instance()->attach(new MyListener());
于 2013-06-04T20:11:33.897 回答
3

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

MyPlugin/Config/bootstrap.php：

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

MyPlugin/Lib/Event/MyEventListener.php：

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

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

于 2013-09-26T06:21:07.983 回答
0

代码所在的位置并不重要。只需确保它正在执行并且您的事件已正确注册和附加。

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

当你调度一个事件时，魔法就会发生，比如从一个控制器动作。

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

但是，您可以从任何可以到达 EventManager 的地方发送事件（默认在模型、控制器和视图中）

于 2013-06-04T18:16:07.250 回答