事件和事件监听器

编辑该页面

警告:你浏览的文档欧宝体育电话欧宝娱乐app下载地址Symfony 5.0,不再维护。

这个页面的更新版本Symf欧宝娱乐app下载地址ony 6.2(当前的稳定版本)。

事件和事件监听器

Symfony应用程序执行期间,大量的触发事件通知。欧宝娱乐app下载地址您的应用程序可以听这些通知和应对他们通过执行任何代码。

欧宝娱乐app下载地址Symfony触发几个事件相关的内核在处理HTTP请求。第三方包也可能分派事件,你甚至可以派遣自定义事件从您自己的代码。

本文中所示的示例使用相同KernelEvents:异常事件的一致性的目的。在您自己的应用程序中,您可以使用任何事件,甚至混合其中几个在同一用户。

创建一个事件监听器

听一个事件最常见的方法是注册一个事件监听器:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17日18 19 20 21日22日23日24日25日26日27 28 29 30 31 32 33 34 35 36
/ / src / EventListener / ExceptionListener.php名称空间应用程序\EventListener;使用欧宝娱乐app下载地址\组件\HttpFoundation\响应;使用欧宝娱乐app下载地址\组件\HttpKernel\事件\ExceptionEvent;使用欧宝娱乐app下载地址\组件\HttpKernel\异常\HttpExceptionInterface;ExceptionListener{公共函数onKernelException(ExceptionEvent美元事件){/ /得到的异常对象接收到的事件美元异常=美元事件- >getThrowable ();美元消息= sprintf (我的错误说:% s代码:% s的,美元异常- >getMessage (),美元异常- >getCode ());/ /定制响应对象显示异常的细节美元响应=反应();美元响应- >setContent (美元消息);/ / HttpExceptionInterface是一种特殊类型的异常/ /保存状态代码和头的细节如果(美元异常运算符HttpExceptionInterface) {美元响应- >setStatusCode (美元异常- >getStatusCode ());美元响应- >- >替换(美元异常- >getHeaders ());}其他的{美元响应- >setStatusCode(响应::HTTP_INTERNAL_SERVER_ERROR);}/ /发送修改后的响应对象的事件美元事件- >setResponse (美元响应);}}

提示

每个事件接收一个稍微不同的类型的美元的事件对象。为kernel.exception事件,ExceptionEvent。检查欧宝娱乐app下载地址Symfony事件参考每个事件提供什么类型的对象。

现在创建了类,你需要注册一个服务并通知Symfony,它是一个“听众”欧宝娱乐app下载地址kernel.exception事件通过使用一个特殊的“标签”:

  • YAML
  • XML
  • PHP
1 2 3 4 5
#配置/ services.yaml服务:App \ EventListener \ ExceptionListener:标签:- - - - - -{名称:kernel.event_listener,事件:kernel.exception}

欧宝娱乐app下载地址Symfony遵循这种逻辑来决定哪个方法执行内部的事件侦听器类:

  1. 如果kernel.event_listener标签定义了方法属性,这是要执行的方法的名称;
  2. 如果没有方法定义属性,尝试执行方法的名字+”“骆峰式”事件名称”(如。onKernelException ()方法kernel.exception事件);
  3. 如果没有定义方法,尝试执行__invoke ()魔术方法(这使得事件监听器调用);
  4. 如果_invoke ()方法也不是定义,抛出一个异常。

请注意

有一个可选属性kernel.event_listener标签被称为优先级,这是一个积极或消极的整数,默认0和它控制的顺序执行侦听器(数字越高,越早一个侦听器执行)。这是有用的,当你需要保证一个侦听器之前执行另一个。内部的优先级Symfony听众通常范围从欧宝娱乐app下载地址-256年256年但自己的听众可以使用任何积极或消极的整数。

创建一个事件订阅者

听事件的另一种方法是通过一个事件订阅者,这是一个类,它定义了一个或多个方法,听一个或各种事件。事件监听器的主要区别是,用户总是知道他们正在听哪些事件。

如果不同的事件订阅者的方法听同样的事件,它们被定义的顺序优先级参数。这个值是默认为一个积极的还是消极的整数0。数越高,越早的方法。首要任务是聚合所有听众和订阅者,所以你的方法可以执行之前或之后在其他听众和用户定义的方法。了解更多关于事件订阅者,阅读EventDispatcher组件

下面的示例显示了一个事件订阅者,定义了一些方法,听一样的kernel.exception事件:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17日18 19 20 21日22日23日24日25日26日27 28 29 30 31 32 33 34 35 36
/ / src / EventSubscriber /交货