merged branch Seldaek/event_listener (PR symfony#1374)

Commits ------- 58b6403 Adjusted UPDATE 7350109 Renamed core.* events to kernel.* and CoreEvents to KernelEvents edbdf7b Rename kernel.listener to kernel.event_listener Discussion ---------- Rename kernel.listener to kernel.event_listener Better consistency with doctrine.event_listener --------------------------------------------------------------------------- by schmittjoh at 2011/06/20 07:39:18 -0700 I think "symfony.event_listener" would be even better then, or just short "event_listener". There are some more inconsistencies: - "core.response" -> "kernel.response" / "http_kernel.response" - "core.request" -> "kernel.request" / "http_kernel.request" - "core.controller" -> "kernel.controller" / "http_kernel.controller" - "core.view" -> "kernel.view" / "http_kernel.view" --------------------------------------------------------------------------- by Seldaek at 2011/06/20 07:45:53 -0700 I proposed `event_listener` but @fabpot didn't like it, `symfony.event_listener` could do, but usual we refer to global stuff as framework more than symfony, so `framework.event_listener`? The point is that the kernel "owns" the event dispatcher, even if anyone can dispatch his stuff through it. You still listen on the kernel dispatcher. So it's not that wrong imo. As for the others. I agree that the "core" name is a bit strange. kernel would be more suitable imo. @fabpot? --------------------------------------------------------------------------- by stof at 2011/06/20 07:50:35 -0700 @Seldaek the issue with having ``kernel`` in the tag name is that some user think that they need to define their own tag when they want to dispatch their own events (I faced it a few times on #symfony and it was also the case in symfony#1298) --------------------------------------------------------------------------- by Seldaek at 2011/06/20 07:51:55 -0700 Well yeah that's why I liked the idea of having only `event_listener`. IMO even with `framework.event_listener` the confusion can still happen. --------------------------------------------------------------------------- by fabpot at 2011/06/20 08:00:23 -0700 Renaming `core.response` to `kernel.response` is fine with me. --------------------------------------------------------------------------- by Seldaek at 2011/06/21 07:53:13 -0700 Ok, added another commit that does that renaming. Updated the two related PRs in -docs and -standard as well.

Author: fabpot

UPDATE.md

@@ -21,6 +21,25 @@ beta5 to RC1
  * `attributes` to `widget_attributes`
  * `options` to `widget_choice_options`
 
+* Event changes:
+ * All listeners must now be tagged with `kernel.event_listener` instead of
+ `kernel.listener`:
+ * Kernel events are now properly prefixed with `kernel` instead of `core`:
+
+ * Before:
+
+  <tag name="kernel.listener" event="core.request" method="onCoreRequest" />
+
+ * After:
+
+  <tag name="kernel.event_listener" event="kernel.request" method="onKernelRequest" />
+
+ Note: the method can of course remain as `onCoreRequest`, but renaming it
+ as well for consistency with future projects makes sense.
+
+ * The `Symfony\Component\HttpKernel\CoreEvents` class has been renamed to
+ `Symfony\Component\HttpKernel\KernelEvents`
+
 beta4 to beta5
 --------------
 

src/Symfony/Bridge/Monolog/Handler/FirePHPHandler.php

@@ -36,7 +36,7 @@ class FirePHPHandler extends BaseFirePHPHandler
  /**
  * Adds the headers to the response once it's created
  */
- public function onCoreResponse(FilterResponseEvent $event)
+ public function onKernelResponse(FilterResponseEvent $event)
  {
  if (HttpKernelInterface::MASTER_REQUEST !== $event->getRequestType()) {
  return;

src/Symfony/Bundle/FrameworkBundle/DataCollector/RequestDataCollector.php

@@ -59,7 +59,7 @@ public function collect(Request $request, Response $response, \Exception $except
  }
  }
 
- public function onCoreController(FilterControllerEvent $event)
+ public function onKernelController(FilterControllerEvent $event)
  {
  $this->controllers[$event->getRequest()] = $event->getController();
  }

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/RegisterKernelListenersPass.php

@@ -25,12 +25,12 @@ public function process(ContainerBuilder $container)
 
  $definition = $container->getDefinition('event_dispatcher');
 
- foreach ($container->findTaggedServiceIds('kernel.listener') as $id => $events) {
+ foreach ($container->findTaggedServiceIds('kernel.event_listener') as $id => $events) {
  foreach ($events as $event) {
  $priority = isset($event['priority']) ? $event['priority'] : 0;
 
  if (!isset($event['event'])) {
- throw new \InvalidArgumentException(sprintf('Service "%s" must define the "event" attribute on "kernel.listener" tags.', $id));
+ throw new \InvalidArgumentException(sprintf('Service "%s" must define the "event" attribute on "kernel.event_listener" tags.', $id));
  }
 
  if (!isset($event['method'])) {

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php

@@ -127,7 +127,7 @@ public function load(array $configs, ContainerBuilder $container)
  'Symfony\\Component\\HttpKernel\\Event\\GetResponseEvent',
  'Symfony\\Component\\HttpKernel\\Event\\GetResponseForControllerResultEvent',
  'Symfony\\Component\\HttpKernel\\Event\\GetResponseForExceptionEvent',
- 'Symfony\\Component\\HttpKernel\\CoreEvents',
+ 'Symfony\\Component\\HttpKernel\\KernelEvents',
 
  'Symfony\\Bundle\\FrameworkBundle\\EventListener\\RouterListener',
  'Symfony\\Bundle\\FrameworkBundle\\Controller\\ControllerNameParser',

src/Symfony/Bundle/FrameworkBundle/EventListener/RouterListener.php

@@ -42,7 +42,7 @@ public function __construct(RouterInterface $router, $httpPort = 80, $httpsPort
  $this->logger = $logger;
  }
 
- public function onEarlyCoreRequest(GetResponseEvent $event)
+ public function onEarlyKernelRequest(GetResponseEvent $event)
  {
  if (HttpKernelInterface::MASTER_REQUEST !== $event->getRequestType()) {
  return;
@@ -64,7 +64,7 @@ public function onEarlyCoreRequest(GetResponseEvent $event)
  $this->router->setContext($context);
  }
 
- public function onCoreRequest(GetResponseEvent $event)
+ public function onKernelRequest(GetResponseEvent $event)
  {
  $request = $event->getRequest();
 

src/Symfony/Bundle/FrameworkBundle/EventListener/SessionListener.php

@@ -33,7 +33,7 @@ public function __construct(ContainerInterface $container)
  $this->container = $container;
  }
 
- public function onCoreRequest(GetResponseEvent $event)
+ public function onKernelRequest(GetResponseEvent $event)
  {
  if (HttpKernelInterface::MASTER_REQUEST !== $event->getRequestType()) {
  return;

src/Symfony/Bundle/FrameworkBundle/EventListener/TestSessionListener.php

@@ -36,7 +36,7 @@ public function __construct(ContainerInterface $container)
  $this->container = $container;
  }
 
- public function onCoreRequest(GetResponseEvent $event)
+ public function onKernelRequest(GetResponseEvent $event)
  {
  if (HttpKernelInterface::MASTER_REQUEST !== $event->getRequestType()) {
  return;
@@ -55,11 +55,11 @@ public function onCoreRequest(GetResponseEvent $event)
 
  /**
  * Checks if session was initialized and saves if current request is master
- * Runs on 'core.response' in test environment
+ * Runs on 'kernel.response' in test environment
  *
  * @param FilterResponseEvent $event
  */
- public function onCoreResponse(FilterResponseEvent $event)
+ public function onKernelResponse(FilterResponseEvent $event)
  {
  if (HttpKernelInterface::MASTER_REQUEST !== $event->getRequestType()) {
  return;

src/Symfony/Bundle/FrameworkBundle/Resources/config/collectors.xml

@@ -21,7 +21,7 @@
  </service>
 
  <service id="data_collector.request" class="%data_collector.request.class%">
- <tag name="kernel.listener" event="core.controller" method="onCoreController"/>
+ <tag name="kernel.event_listener" event="kernel.controller" method="onKernelController"/>
  <tag name="data_collector" template="WebProfilerBundle:Collector:request" id="request" priority="255" />
  </service>
 

src/Symfony/Bundle/FrameworkBundle/Resources/config/esi.xml

@@ -13,7 +13,7 @@
  <service id="esi" class="%esi.class%" />
 
  <service id="esi_listener" class="%esi_listener.class%">
- <tag name="kernel.listener" event="core.response" method="onCoreResponse" />
+ <tag name="kernel.event_listener" event="kernel.response" method="onKernelResponse" />
  <argument type="service" id="esi" on-invalid="ignore" />
  </service>
  </services>