[EventDispatcher] Allow AsEventListener on methods

ruudk · ruudk · commit ccc99fe01144 · 2021-07-09T12:57:31.000+02:00
Proof of concept on how this works.
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -20,6 +20,8 @@
 use Psr\EventDispatcher\EventDispatcherInterface as PsrEventDispatcherInterface;
 use Psr\Http\Client\ClientInterface;
 use Psr\Log\LoggerAwareInterface;
+use ReflectionMethod;
+use Reflector;
 use Symfony\Bridge\Monolog\Processor\DebugProcessor;
 use Symfony\Bridge\Twig\Extension\CsrfExtension;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
@@ -551,8 +553,12 @@ public function load(array $configs, ContainerBuilder $container)
         $container->registerForAutoconfiguration(LoggerAwareInterface::class)
             ->addMethodCall('setLogger', [new Reference('logger')]);
 
-        $container->registerAttributeForAutoconfiguration(AsEventListener::class, static function (ChildDefinition $definition, AsEventListener $attribute): void {
-            $definition->addTag('kernel.event_listener', get_object_vars($attribute));
+        $container->registerAttributeForAutoconfiguration(AsEventListener::class, static function (ChildDefinition $definition, AsEventListener $attribute, Reflector $reflector): void {
+            $tagAttributes = get_object_vars($attribute);
+            if ($reflector instanceof ReflectionMethod) {
+                $tagAttributes['method'] = $reflector->getName();
+            }
+            $definition->addTag('kernel.event_listener', $tagAttributes);
         });
         $container->registerAttributeForAutoconfiguration(AsController::class, static function (ChildDefinition $definition, AsController $attribute): void {
             $definition->addTag('controller.service_arguments');
diff --git a/src/Symfony/Component/EventDispatcher/Attribute/AsEventListener.php b/src/Symfony/Component/EventDispatcher/Attribute/AsEventListener.php
@@ -16,7 +16,7 @@
  *
  * @author Alexander M. Turek <me@derrabus.de>
  */
-#[\Attribute(\Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
+#[\Attribute(\Attribute::TARGET_CLASS | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
 class AsEventListener
 {
     public function __construct(
diff --git a/src/Symfony/Component/EventDispatcher/CHANGELOG.md b/src/Symfony/Component/EventDispatcher/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+5.4
+---
+
+ * Allow `#[AsEventListener]` attribute on methods
+
 5.3
 ---
 
diff --git a/src/Symfony/Component/EventDispatcher/Tests/DependencyInjection/RegisterListenersPassTest.php b/src/Symfony/Component/EventDispatcher/Tests/DependencyInjection/RegisterListenersPassTest.php
@@ -12,6 +12,8 @@
 namespace Symfony\Component\EventDispatcher\Tests\DependencyInjection;
 
 use PHPUnit\Framework\TestCase;
+use ReflectionMethod;
+use Reflector;
 use Symfony\Component\DependencyInjection\Argument\ServiceClosureArgument;
 use Symfony\Component\DependencyInjection\ChildDefinition;
 use Symfony\Component\DependencyInjection\Compiler\AttributeAutoconfigurationPass;
@@ -291,8 +293,12 @@ public function testTaggedMultiEventListener()
         }
 
         $container = new ContainerBuilder();
-        $container->registerAttributeForAutoconfiguration(AsEventListener::class, static function (ChildDefinition $definition, AsEventListener $attribute): void {
-            $definition->addTag('kernel.event_listener', get_object_vars($attribute));
+        $container->registerAttributeForAutoconfiguration(AsEventListener::class, static function (ChildDefinition $definition, AsEventListener $attribute, Reflector $reflector): void {
+            $tagAttributes = get_object_vars($attribute);
+            if ($reflector instanceof ReflectionMethod) {
+                $tagAttributes['method'] = $reflector->getName();
+            }
+            $definition->addTag('kernel.event_listener', $tagAttributes);
         });
         $container->register('foo', TaggedMultiListener::class)->setAutoconfigured(true);
         $container->register('event_dispatcher', \stdClass::class);
@@ -327,6 +333,14 @@ public function testTaggedMultiEventListener()
                     0,
                 ],
             ],
+            [
+                'addListener',
+                [
+                    'baz',
+                    [new ServiceClosureArgument(new Reference('foo')), 'onBazEvent'],
+                    0,
+                ],
+            ],
         ];
         $this->assertEquals($expectedCalls, $definition->getMethodCalls());
     }
diff --git a/src/Symfony/Component/EventDispatcher/Tests/Fixtures/TaggedMultiListener.php b/src/Symfony/Component/EventDispatcher/Tests/Fixtures/TaggedMultiListener.php
@@ -29,4 +29,9 @@ public function onFoo(): void
     public function onBarEvent(): void
     {
     }
+
+    #[AsEventListener(event: 'baz')]
+    public function onBazEvent(): void
+    {
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`*`
`17`	`17`	`* @author Alexander M. Turek <me@derrabus.de>`
`18`	`18`	`*/`
`19`		`-#[\Attribute(\Attribute::TARGET_CLASS \| \Attribute::IS_REPEATABLE)]`
	`19`	`+#[\Attribute(\Attribute::TARGET_CLASS \| \Attribute::TARGET_METHOD \| \Attribute::IS_REPEATABLE)]`
`20`	`20`	`class AsEventListener`
`21`	`21`	`{`
`22`	`22`	`public function __construct(`
Original file line number	Diff line number	Diff line change
`@@ -29,4 +29,9 @@ public function onFoo(): void`
`29`	`29`	`public function onBarEvent(): void`
`30`	`30`	`{`
`31`	`31`	`}`
	`32`	`+`
	`33`	`+ #[AsEventListener(event: 'baz')]`
	`34`	`+ public function onBazEvent(): void`
	`35`	`+ {`
	`36`	`+ }`
`32`	`37`	`}`