Use event subscriber instead of listener

GaryPEGEOT · GaryPEGEOT · commit afa4a091bf89 · 2019-03-04T18:33:40.000Z
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -63,7 +63,6 @@
 use Symfony\Component\HttpKernel\DataCollector\DataCollectorInterface;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 use Symfony\Component\HttpKernel\EventListener\DisallowRobotsIndexingListener;
-use Symfony\Component\HttpKernel\KernelEvents;
 use Symfony\Component\Lock\Factory;
 use Symfony\Component\Lock\Lock;
 use Symfony\Component\Lock\LockInterface;
@@ -398,8 +397,7 @@ public function load(array $configs, ContainerBuilder $container)
         }
 
         if ($config['disallow_search_engine_index'] ?? false) {
-            $container->register(DisallowRobotsIndexingListener::class)
-                ->addTag('kernel.event_listener', ['event' => KernelEvents::RESPONSE, 'priority' => -255]);
+            $container->register(DisallowRobotsIndexingListener::class)->addTag('kernel.event_subscriber');
         }
     }
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php
@@ -1336,11 +1336,7 @@ public function testRobotsTagListenerIsRegisteredInDebugMode()
         $this->assertTrue($container->has(DisallowRobotsIndexingListener::class), 'DisallowRobotsIndexingListener should be registered');
 
         $definition = $container->getDefinition(DisallowRobotsIndexingListener::class);
-        $this->assertTrue($definition->hasTag('kernel.event_listener'), 'DisallowRobotsIndexingListener should have the correct tag');
-        $this->assertSame(
-            [['event' => KernelEvents::RESPONSE, 'priority' => -255]],
-            $definition->getTag('kernel.event_listener')
-        );
+        $this->assertTrue($definition->hasTag('kernel.event_subscriber'), 'DisallowRobotsIndexingListener should have the correct tag');
 
         $container = $this->createContainer(['kernel.debug' => true]);
         (new FrameworkExtension())->load([['disallow_search_engine_index' => false]], $container);
diff --git a/src/Symfony/Component/HttpKernel/EventListener/DisallowRobotsIndexingListener.php b/src/Symfony/Component/HttpKernel/EventListener/DisallowRobotsIndexingListener.php
@@ -11,14 +11,16 @@
 
 namespace Symfony\Component\HttpKernel\EventListener;
 
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
+use Symfony\Component\HttpKernel\KernelEvents;
 
 /**
  * When enabled, ensures that the application is not indexed by search engines.
  *
  * @author Gary PEGEOT <garypegeot@gmail.com>
  */
-class DisallowRobotsIndexingListener
+class DisallowRobotsIndexingListener implements EventSubscriberInterface
 {
     private const HEADER_NAME = 'X-Robots-Tag';
 
@@ -28,4 +30,14 @@ public function __invoke(FilterResponseEvent $event): void
             $event->getResponse()->headers->set(static::HEADER_NAME, 'noindex');
         }
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public static function getSubscribedEvents()
+    {
+        return [
+            KernelEvents::RESPONSE => ['__invoke', -255],
+        ];
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,6 @@`
`63`	`63`	`use Symfony\Component\HttpKernel\DataCollector\DataCollectorInterface;`
`64`	`64`	`use Symfony\Component\HttpKernel\DependencyInjection\Extension;`
`65`	`65`	`use Symfony\Component\HttpKernel\EventListener\DisallowRobotsIndexingListener;`
`66`		`-use Symfony\Component\HttpKernel\KernelEvents;`
`67`	`66`	`use Symfony\Component\Lock\Factory;`
`68`	`67`	`use Symfony\Component\Lock\Lock;`
`69`	`68`	`use Symfony\Component\Lock\LockInterface;`
`@@ -398,8 +397,7 @@ public function load(array $configs, ContainerBuilder $container)`
`398`	`397`	`}`
`399`	`398`
`400`	`399`	`if ($config['disallow_search_engine_index'] ?? false) {`
`401`		`- $container->register(DisallowRobotsIndexingListener::class)`
`402`		`- ->addTag('kernel.event_listener', ['event' => KernelEvents::RESPONSE, 'priority' => -255]);`
	`400`	`+ $container->register(DisallowRobotsIndexingListener::class)->addTag('kernel.event_subscriber');`
`403`	`401`	`}`
`404`	`402`	`}`
`405`	`403`
Original file line number	Diff line number	Diff line change
`@@ -11,14 +11,16 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\HttpKernel\EventListener;`
`13`	`13`
	`14`	`+use Symfony\Component\EventDispatcher\EventSubscriberInterface;`
`14`	`15`	`use Symfony\Component\HttpKernel\Event\FilterResponseEvent;`
	`16`	`+use Symfony\Component\HttpKernel\KernelEvents;`
`15`	`17`
`16`	`18`	`/**`
`17`	`19`	`* When enabled, ensures that the application is not indexed by search engines.`
`18`	`20`	`*`
`19`	`21`	`* @author Gary PEGEOT <[email protected]>`
`20`	`22`	`*/`
`21`		`-class DisallowRobotsIndexingListener`
	`23`	`+class DisallowRobotsIndexingListener implements EventSubscriberInterface`
`22`	`24`	`{`
`23`	`25`	`private const HEADER_NAME = 'X-Robots-Tag';`
`24`	`26`
`@@ -28,4 +30,14 @@ public function __invoke(FilterResponseEvent $event): void`
`28`	`30`	`$event->getResponse()->headers->set(static::HEADER_NAME, 'noindex');`
`29`	`31`	`}`
`30`	`32`	`}`
	`33`	`+`
	`34`	`+ /**`
	`35`	`+ * {@inheritdoc}`
	`36`	`+ */`
	`37`	`+ public static function getSubscribedEvents()`
	`38`	`+ {`
	`39`	`+ return [`
	`40`	`+ KernelEvents::RESPONSE => ['__invoke', -255],`
	`41`	`+ ];`
	`42`	`+ }`
`31`	`43`	`}`