minor #17472 [Doctrine] Add documentation about Doctrine AsEventListener (jderusse)

javiereguiluz · javiereguiluz · commit c51f1454f019 · 2023-03-03T13:16:46.000+01:00
This PR was merged into the 6.2 branch. Discussion ---------- [Doctrine] Add documentation about Doctrine `AsEventListener` Related to the **NOT YET MERGED** PR doctrine/DoctrineBundle#1583 Commits ------- e97a574 Add documentation about doctrine's AsEventListener
diff --git a/.doctor-rst.yaml b/.doctor-rst.yaml
@@ -81,6 +81,7 @@ whitelist:
         - '#. The most important config file is ``app/config/services.yml``, which now is'
         - 'The bin/console Command'
         - '.. _`LDAP injection`: http://projects.webappsec.org/w/page/13246947/LDAP%20Injection'
+        - '.. versionadded:: 2.7.2' # Doctrine
         - '.. versionadded:: 1.9.0' # Encore
         - '.. versionadded:: 1.11' # Messenger (Middleware / DoctrineBundle)
         - '.. versionadded:: 1.18' # Flex in setup/upgrade_minor.rst
diff --git a/doctrine/events.rst b/doctrine/events.rst
@@ -164,6 +164,23 @@ listener in the Symfony application by creating a new service for it and
 
 .. configuration-block::
 
+    .. code-block:: attribute
+
+        // src/App/EventListener/SearchIndexer.php
+        namespace App\EventListener;
+
+        use Doctrine\Bundle\DoctrineBundle\Attribute\AsEventListener;
+        use Doctrine\ORM\Event\LifecycleEventArgs;
+
+        #[AsEventListener('postPersist'/*, 500, 'default'*/)]
+        class SearchIndexer
+        {
+            public function postPersist(LifecycleEventArgs $event): void
+            {
+                // ...
+            }
+        }
+
     .. code-block:: yaml
 
         # config/services.yaml
@@ -234,6 +251,12 @@ listener in the Symfony application by creating a new service for it and
             ;
         };
 
+
+.. versionadded:: 2.7.2
+
+    The :class:`Doctrine\\Bundle\\DoctrineBundle\\Attribute\\AsEventListener` 
+    attribute was introduced in DoctrineBundle 2.7.2.
+
 .. tip::
 
     Symfony loads (and instantiates) Doctrine listeners only when the related
