Implement AsDoctrineListener and AutoconfigureTag doctrine.event_listener (#258)

Author: janedbal

README.md

@@ -52,10 +52,13 @@ $ vendor/bin/phpstan
 - `onKernelResponse`, `onKernelRequest`, etc
 - `!php const` references in `config` yamls
 - `defaultIndexMethod` in `#[AutowireLocator]` and `#[AutowireIterator]`
-- Workflow event listener attributes: `#[AsAnnounceListener]`, `#[AsCompletedListener]`, `#[AsEnterListener]`, `#[AsEnteredListener]`, `#[AsGuardListener]`, `#[AsLeaveListener]`, `#[AsTransitionListener]`
+- Workflow event listener attributes: `#[AsAnnounceListener]`, ...
+- `#[AutoconfigureTag('doctrine.event_listener')]` attribute
+
 
 #### Doctrine:
 - `#[AsEntityListener]` attribute
+- `#[AsDoctrineListener]` attribute
 - `Doctrine\ORM\Events::*` events
 - `Doctrine\Common\EventSubscriber` methods
 - `repositoryMethod` in `#[UniqueEntity]` attribute

src/Provider/DoctrineUsageProvider.php

@@ -164,6 +164,14 @@ protected function shouldMarkMethodAsUsed(ReflectionMethod $method): ?string
             return 'Is part of AsEntityListener methods';
         }
 
+        if ($this->isPartOfAsDoctrineListener($class, $methodName)) {
+            return 'Is part of AsDoctrineListener methods';
+        }
+
+        if ($this->isPartOfAutoconfigureTagDoctrineListener($class, $methodName)) {
+            return 'Is part of AutoconfigureTag doctrine.event_listener methods';
+        }
+
         if ($this->isProbablyDoctrineListener($methodName)) {
             return 'Is probable listener method';
         }
@@ -227,6 +235,55 @@ protected function isPartOfAsEntityListener(
         return false;
     }
 
+    protected function isPartOfAsDoctrineListener(
+        ReflectionClass $class,
+        string $methodName
+    ): bool
+    {
+        foreach ($class->getAttributes('Doctrine\Bundle\DoctrineBundle\Attribute\AsDoctrineListener') as $attribute) {
+            $eventName = $attribute->getArguments()['event'] ?? $attribute->getArguments()[0] ?? null;
+
+            // AsDoctrineListener doesn't have a 'method' parameter
+            // Symfony looks for a method named after the event, or falls back to __invoke
+            if ($eventName === $methodName || $methodName === '__invoke') {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    protected function isPartOfAutoconfigureTagDoctrineListener(
+        ReflectionClass $class,
+        string $methodName
+    ): bool
+    {
+        foreach ($class->getAttributes('Symfony\Component\DependencyInjection\Attribute\AutoconfigureTag') as $attribute) {
+            $arguments = $attribute->getArguments();
+            $tagName = $arguments[0] ?? $arguments['name'] ?? null;
+
+            // Only handle doctrine.event_listener tags
+            if ($tagName !== 'doctrine.event_listener') {
+                continue;
+            }
+
+            $listenerMethodName = $arguments['method'] ?? null;
+
+            // If no method is specified, the listener method name is inferred from the event name
+            if ($listenerMethodName === null) {
+                $eventName = $arguments['event'] ?? null;
+
+                if ($eventName === $methodName) {
+                    return true;
+                }
+            } elseif ($listenerMethodName === $methodName) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
     protected function isEntityRepositoryConstructor(
         ReflectionClass $class,
         ReflectionMethod $method

tests/Rule/data/providers/doctrine.php

@@ -70,3 +70,68 @@ public function someMethod(): void {}
     public function someMethod2(): void {} // error: Unused Doctrine\MySubscriber::someMethod2
 
 }
+
+#[\Doctrine\Bundle\DoctrineBundle\Attribute\AsDoctrineListener(event: 'postGenerateSchema')]
+class FixDoctrineMigrationTableSchema {
+
+    public function postGenerateSchema(): void {}
+
+    public function unusedMethod(): void {} // error: Unused Doctrine\FixDoctrineMigrationTableSchema::unusedMethod
+
+}
+
+#[\Doctrine\Bundle\DoctrineBundle\Attribute\AsDoctrineListener(event: 'postLoad')]
+class AsDoctrineListenerWithInvoke {
+
+    public function __invoke(): void {}
+
+    public function unusedMethod(): void {} // error: Unused Doctrine\AsDoctrineListenerWithInvoke::unusedMethod
+
+}
+
+#[\Symfony\Component\DependencyInjection\Attribute\AutoconfigureTag('doctrine.event_listener', event: 'postGenerateSchema')]
+class FixDoctrineMigrationTableSchemaWithAutoconfigureTag {
+
+    public function postGenerateSchema(): void {}
+
+    public function unusedMethod(): void {} // error: Unused Doctrine\FixDoctrineMigrationTableSchemaWithAutoconfigureTag::unusedMethod
+
+}
+
+#[\Symfony\Component\DependencyInjection\Attribute\AutoconfigureTag('doctrine.event_listener', event: 'postGenerateSchema', method: 'onPostGenerateSchema')]
+class FixDoctrineMigrationTableSchemaWithAutoconfigureTagAndMethod {
+
+    public function onPostGenerateSchema(): void {}
+
+    public function unusedMethod(): void {} // error: Unused Doctrine\FixDoctrineMigrationTableSchemaWithAutoconfigureTagAndMethod::unusedMethod
+
+}
+
+// Test multiple AsDoctrineListener attributes on same class (IS_REPEATABLE)
+#[\Doctrine\Bundle\DoctrineBundle\Attribute\AsDoctrineListener(event: 'postPersist')]
+#[\Doctrine\Bundle\DoctrineBundle\Attribute\AsDoctrineListener(event: 'postUpdate')]
+#[\Doctrine\Bundle\DoctrineBundle\Attribute\AsDoctrineListener(event: 'preRemove')]
+class MultipleAsDoctrineListeners {
+
+    public function postPersist(): void {}
+
+    public function postUpdate(): void {}
+
+    public function preRemove(): void {}
+
+    public function unusedMethod(): void {} // error: Unused Doctrine\MultipleAsDoctrineListeners::unusedMethod
+
+}
+
+// Test multiple AutoconfigureTag attributes
+#[\Symfony\Component\DependencyInjection\Attribute\AutoconfigureTag('doctrine.event_listener', event: 'postPersist')]
+#[\Symfony\Component\DependencyInjection\Attribute\AutoconfigureTag('doctrine.event_listener', event: 'postUpdate', method: 'afterUpdate')]
+class MultipleAutoconfigureTags {
+
+    public function postPersist(): void {}
+
+    public function afterUpdate(): void {}
+
+    public function unusedMethod(): void {} // error: Unused Doctrine\MultipleAutoconfigureTags::unusedMethod
+
+}