minor #17970 [EventDispatcher] Add example of #[AsEventListener] on methods (alexandre-daubois)

javiereguiluz · javiereguiluz · commit 68ac60a13056 · 2023-03-03T13:04:17.000+01:00
This PR was merged into the 5.4 branch. Discussion ---------- [EventDispatcher] Add example of ``#[AsEventListener]`` on methods Commits ------- e41d827 [EventDispatcher] Add example of ``#[AsEventListener]`` on methods
diff --git a/event_dispatcher.rst b/event_dispatcher.rst
@@ -191,6 +191,40 @@ You can add multiple ``#[AsEventListener()]`` attributes to configure different
         }
     }
 
+:class:`Symfony\\Component\\EventDispatcher\\Attribute\\AsEventListener`
+can also be applied to methods directly::
+
+    namespace App\EventListener;
+
+    use Symfony\Component\EventDispatcher\Attribute\AsEventListener;
+
+    final class MyMultiListener
+    {
+        #[AsEventListener()]
+        public function onCustomEvent(CustomEvent $event): void
+        {
+            // ...
+        }
+
+        #[AsEventListener(event: 'foo', priority: 42)]
+        public function onFoo(): void
+        {
+            // ...
+        }
+
+        #[AsEventListener(event: 'bar')]
+        public function onBarEvent(): void
+        {
+            // ...
+        }
+    }
+
+.. note::
+
+    You can notice that the attribute doesn't require its ``event``
+    parameter to be set if the method already type-hints the
+    expected event.
+
 .. _events-subscriber:
 
 Creating an Event Subscriber
