Add AsEventListener attribute

doctrine · Oct 16, 2022 · a0e247a · a0e247a
1 parent e781f9c
commit a0e247a
Show file tree

Hide file tree

Showing 4 changed files with 80 additions and 0 deletions.
diff --git a/Attribute/AsEventListener.php b/Attribute/AsEventListener.php
@@ -0,0 +1,19 @@
+<?php
+
+namespace Doctrine\Bundle\DoctrineBundle\Attribute;
+
+use Attribute;
+
+/**
+ * Service tag to autoconfigure event listeners.
+ */
+#[Attribute(Attribute::TARGET_CLASS | Attribute::IS_REPEATABLE)]
+class AsEventListener
+{
+    public function __construct(
+        public string $event,
+        public ?int $priority = null,
+        public ?string $connection = null,
+    ) {
+    }
+}
diff --git a/DependencyInjection/DoctrineExtension.php b/DependencyInjection/DoctrineExtension.php
@@ -3,6 +3,7 @@
 namespace Doctrine\Bundle\DoctrineBundle\DependencyInjection;
 
 use Doctrine\Bundle\DoctrineBundle\Attribute\AsEntityListener;
+use Doctrine\Bundle\DoctrineBundle\Attribute\AsEventListener;
 use Doctrine\Bundle\DoctrineBundle\Attribute\AsMiddleware;
 use Doctrine\Bundle\DoctrineBundle\CacheWarmer\DoctrineMetadataCacheWarmer;
 use Doctrine\Bundle\DoctrineBundle\Command\Proxy\ImportDoctrineCommand;
@@ -652,6 +653,13 @@ protected function ormLoad(array $config, ContainerBuilder $container)
                     'entity'         => $attribute->entity,
                 ]);
             });
+            $container->registerAttributeForAutoconfiguration(AsEventListener::class, static function (ChildDefinition $definition, AsEventListener $attribute) {
+                $definition->addTag('doctrine.event_listener', [
+                    'event'      => $attribute->event,
+                    'priority'   => $attribute->priority,
+                    'connection' => $attribute->connection,
+                ]);
+            });
         }
 
         /** @see DoctrineBundle::boot() */

diff --git a/Tests/DependencyInjection/DoctrineExtensionTest.php b/Tests/DependencyInjection/DoctrineExtensionTest.php
@@ -4,11 +4,13 @@
 
 use Closure;
 use Doctrine\Bundle\DoctrineBundle\Attribute\AsEntityListener;
+use Doctrine\Bundle\DoctrineBundle\Attribute\AsEventListener;
 use Doctrine\Bundle\DoctrineBundle\CacheWarmer\DoctrineMetadataCacheWarmer;
 use Doctrine\Bundle\DoctrineBundle\DependencyInjection\Compiler\CacheCompatibilityPass;
 use Doctrine\Bundle\DoctrineBundle\DependencyInjection\DoctrineExtension;
 use Doctrine\Bundle\DoctrineBundle\Tests\Builder\BundleConfigurationBuilder;
 use Doctrine\Bundle\DoctrineBundle\Tests\DependencyInjection\Fixtures\Php8EntityListener;
+use Doctrine\Bundle\DoctrineBundle\Tests\DependencyInjection\Fixtures\Php8EventListener;
 use Doctrine\Common\Cache\ApcCache;
 use Doctrine\Common\Cache\ArrayCache;
 use Doctrine\Common\Cache\Cache;
@@ -29,6 +31,7 @@
 use Doctrine\ORM\Configuration;
 use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\ORM\Events;
 use Doctrine\ORM\Mapping\Driver\AnnotationDriver;
 use Doctrine\ORM\Mapping\Driver\AttributeDriver;
 use Doctrine\ORM\Mapping\Driver\SimplifiedXmlDriver;
@@ -1166,6 +1169,42 @@ public function testAsEntityListenerAttribute()
         $this->assertSame([$expected], $definition->getTag('doctrine.orm.entity_listener'));
     }
 
+    /**
+     * @requires PHP 8
+     */
+    public function testAsEventListenerAttribute()
+    {
+        if (! method_exists(ContainerBuilder::class, 'getAutoconfiguredAttributes')) {
+            $this->markTestSkipped('symfony/dependency-injection 5.3.0 needed');
+        }
+
+        $container = $this->getContainer();
+        $extension = new DoctrineExtension();
+
+        $config = BundleConfigurationBuilder::createBuilder()
+            ->addBaseConnection()
+            ->addBaseEntityManager()
+            ->build();
+
+        $extension->load([$config], $container);
+
+        $attributes = $container->getAutoconfiguredAttributes();
+        $this->assertInstanceOf(Closure::class, $attributes[AsEventListener::class]);
+
+        $reflector  = new ReflectionClass(Php8EventListener::class);
+        $definition = new ChildDefinition('');
+        $attribute  = $reflector->getAttributes(AsEventListener::class)[0]->newInstance();
+
+        $attributes[AsEventListener::class]($definition, $attribute);
+
+        $expected = [
+            'event'      => Events::postFlush,
+            'priority'   => null,
+            'connection' => null,
+        ];
+        $this->assertSame([$expected], $definition->getTag('doctrine.event_listener'));
+    }
+
     /** @return bool[][] */
     public function provideRegistrationsWithoutMiddlewares(): array
     {

diff --git a/Tests/DependencyInjection/Fixtures/Php8EventListener.php b/Tests/DependencyInjection/Fixtures/Php8EventListener.php
@@ -0,0 +1,14 @@
+<?php
+
+namespace Doctrine\Bundle\DoctrineBundle\Tests\DependencyInjection\Fixtures;
+
+use Doctrine\Bundle\DoctrineBundle\Attribute\AsEventListener;
+use Doctrine\ORM\Events;
+
+#[AsEventListener(Events::postFlush)]
+final class Php8EventListener
+{
+    public function postFlush(): void
+    {
+    }
+}