Zend Framework - 事件管理器

所有现代应用程序都需要可靠且灵活的事件组件。Zend Framework 提供了一个这样的组件，即 zend-eventmanager。zend-eventmanager 有助于设计高级架构，并支持主题/观察者模式和面向方面编程。

安装事件管理器

可以使用 Composer 安装事件管理器，如下所示 −

composer require zendframework/zend-eventmanager

事件管理器的概念

事件管理器的核心概念如下 −

• Event −事件是任意命名的动作，例如 greet。

• Listener − 任何 PHP 回调。它们附加到事件并在触发事件时被调用。Listener 的默认签名是 −

function(EventInterface $e)

• EventInterface 类 − 用于指定事件本身。它具有设置和获取事件信息的方法，如名称 (set/getName)、目标 (get/setTarget) 和参数 (get/setParams)。

• EventManager 类 − EventManager 的实例跟踪应用程序中定义的所有事件及其相应的侦听器。 EventManager 提供了一种方法 attach，用于将侦听器附加到事件，并提供了一种方法 trigger，用于触发任何预定义事件。一旦调用触发器，EventManager 就会调用附加到它的侦听器。

• EventManagerAwareInterface − 对于支持基于事件的编程的类，它需要实现 EventManagerAwareInterface。它提供了两种方法，setEventManager 和 getEventManager 来获取和设置事件管理器。

示例

让我们编写一个简单的 PHP 控制台应用程序来了解事件管理器概念。按照以下步骤操作。

• 创建文件夹"eventapp"。

• 使用 Composer 安装 zend-eventmanager。

• 在"eventapp"文件夹中创建一个 PHP 文件 Greeter.php。

• 创建类 Greeter 并实现 EventManagerAwareInterface。

require __DIR__ . '/vendor/autoload.php'; 
class Greeter implements EventManagerAwareInterface { 
   // code 
}

此处，require 用于自动加载所有 Composer 安装的组件。

在 Greeter 类中编写 setEventManager 方法，如下所示 −

public function setEventManager(EventManagerInterface $events) { 
   $events->setIdentifiers([ __CLASS__, get_called_class(),]); 
   $this->events = $events; 
   return $this; 
}

此方法将当前类设置为给定的事件管理器($events 参数)，然后在局部变量 $events 中设置事件管理器。

下一步是在类 Greeter 中编写 getEventManager 方法，如下所示 −

public function getEventManager() { 
   if (null === $this->events) { 
      $this->setEventManager(new EventManager()); 
   } 
   return $this->events; 
}

该方法从局部变量获取事件管理器。如果不可用，则创建事件管理器的实例并返回它。

在类 Greeter 中编写方法 greet。

public function greet($message) { 
   printf("\"%s\" from class
", $message); 
   $this->getEventManager()->trigger(__FUNCTION__, $this, $message ]); 
} 

此方法获取事件管理器并触发附加到其上的事件。

下一步是创建 Greeter 类的实例，并将侦听器附加到其方法 greet。

$greeter = new Greeter();  
$greeter->getEventManager()->attach('greet', function($e) { 
   $event_name = $e->getName(); 
   $target_name = get_class($e->getTarget()); 
   $params_json = json_encode($e->getParams());  
   printf("\"%s\" event of class \"%s\" is called." . 
      " The parameter supplied is %s
",  
      $event_name,  
      $target_name,  
      $params_json); 
});

侦听器回调仅打印事件的名称、目标和提供的参数。

Greeter.php 的完整列表如下 −

<?php  
require __DIR__ . '/vendor/autoload.php';  

use Zend\EventManager\EventManagerInterface; 
use Zend\EventManager\EventManager; 
use Zend\EventManager\EventManagerAwareInterface; 

class Greeter implements EventManagerAwareInterface { 
   protected $events;
   public function setEventManager(EventManagerInterface $events) { 
      $events->setIdentifiers([__CLASS__, get_called_class(), ]); 
      $this->events = $events; 
      return $this; 
   }  
   public function getEventManager() { 
      if (null === $this->events) { 
         $this->setEventManager(new EventManager()); 
      } 
      return $this->events; 
   } 
   public function greet($message) { 
      printf("\"%s\" from class
", $message); 
      $this->getEventManager()->trigger(__FUNCTION__, $this, [$message ]); 
   } 
} 

$greeter = new Greeter(); 
$greeter->greet("Hello");  
$greeter->getEventManager()->attach('greet', function($e) { 
   $event_name = $e->getName(); 
   $target_name = get_class($e->getTarget()); 
   $params_json = json_encode($e->getParams()); 
   printf("\"%s\" event of class \"%s\" is called." . " The parameter supplied is %s
",
      $event_name,
      $target_name,  
      $params_json); 
});  
$greeter->greet("Hello"); 

现在，在命令提示符中运行应用程序 php Greeter.php，结果如下 −

"Hello" from class 
"Hello" from class 
"greet" event of class "Greeter" is called. The parameter supplied is ["Hello"] 

上述示例应用程序仅解释了事件管理器的基本知识。事件管理器提供了许多更高级的选项，例如侦听器优先级、自定义回调原型/签名、短路等。事件管理器在 Zend MVC 框架中得到广泛使用。