minor #17030 [EventDispatcher] Document the #AsEventListener attribute (94noni)

javiereguiluz · javiereguiluz · commit 206c3113d9d1 · 2022-08-09T17:26:02.000+02:00
This PR was submitted for the 6.0 branch but it was merged into the 5.4 branch instead. Discussion ---------- [EventDispatcher] Document the #AsEventListener attribute Document the AsEventListener attribute Ref symfony/symfony#47015 (did not found any doc thus opened an issue at first) For the code example, I've taken inspiration on the related PR: - symfony/symfony@2ab3caf#diff-57b112e725705bbbf01380b0d11c9a8fe16ea69d85d1d3e618eceeb8b58094ce - symfony/symfony@2ab3caf#diff-73a6a14d3288b358a21c0f47ecc1ec78c05e933b66e9a647e5013b2cab002b89 Commits ------- ff5032d Update event_dispatcher.rst
diff --git a/components/event_dispatcher.rst b/components/event_dispatcher.rst
@@ -402,6 +402,49 @@ Take the following example of a subscriber that subscribes to the
         }
     }
 
+You can also leverage the :class:`Symfony\\Component\\EventDispatcher\\Attribute\\AsEventListener`
+attribute to configure your class as a listener on event::
+
+    namespace App\EventListener;
+
+    use Symfony\Component\EventDispatcher\Attribute\AsEventListener;
+
+    #[AsEventListener]
+    final class MyListener
+    {
+        public function __invoke(CustomEvent $event): void
+        {
+            // ...
+        }
+    }
+
+or any of a class methods like so::
+
+    namespace App\EventListener;
+
+    use Symfony\Component\EventDispatcher\Attribute\AsEventListener;
+
+    #[AsEventListener(event: CustomEvent::class, method: 'onCustomEvent')]
+    #[AsEventListener(event: 'foo', priority: 42)]
+    #[AsEventListener(event: 'bar', method: 'onBarEvent')]
+    final class MyMultiListener
+    {
+        public function onCustomEvent(CustomEvent $event): void
+        {
+            // ...
+        }
+
+        public function onFoo(): void
+        {
+            // ...
+        }
+
+        public function onBarEvent(): void
+        {
+            // ...
+        }
+    }
+
 This is very similar to a listener class, except that the class itself can
 tell the dispatcher which events it should listen to. To register a subscriber
 with the dispatcher, use the
