SymfonyUsageProvider: Add AsMessageHandler Annotation for Symfony

Author: florianhofsaessC24

README.md

@@ -42,6 +42,7 @@ $ vendor/bin/phpstan
    - constructors, calls, factory methods
    - [`phpstan/phpstan-symfony`](https://github.com/phpstan/phpstan-symfony) with `containerXmlPath` must be used
 - `#[AsEventListener]` attribute
+- `#[AsMessageHandler]` attribute
 - `#[AsController]` attribute
 - `#[AsCommand]` attribute
 - `#[Required]` attribute

src/Provider/SymfonyUsageProvider.php

@@ -363,6 +363,10 @@ protected function shouldMarkAsUsed(ReflectionMethod $method): ?string
             return 'Event listener method via #[AsEventListener] attribute';
         }
 
+        if ($this->isMessageHandlerMethodWithAsMessageHandlerAttribute($method)) {
+            return 'Message handler method via #[AsMessageHandler] attribute';
+        }
+
         if ($this->isWorkflowEventListenerMethod($method)) {
             return 'Workflow event listener method via workflow attribute';
         }
@@ -500,6 +504,32 @@ protected function isEventListenerMethodWithAsEventListenerAttribute(ReflectionM
             || $this->hasAttribute($method, 'Symfony\Component\EventDispatcher\Attribute\AsEventListener');
     }
 
+    protected function isMessageHandlerMethodWithAsMessageHandlerAttribute(ReflectionMethod $method): bool
+    {
+        // Check if method has the attribute directly
+        if ($this->hasAttribute($method, 'Symfony\Component\Messenger\Attribute\AsMessageHandler')) {
+            return true;
+        }
+
+        $class = $method->getDeclaringClass();
+
+        // Check if class has the attribute and this method is the handler method
+        $attributes = $class->getAttributes('Symfony\Component\Messenger\Attribute\AsMessageHandler');
+
+        foreach ($attributes as $attribute) {
+            $arguments = $attribute->getArguments();
+
+            // Get the method from attribute arguments, default to '__invoke' if not specified
+            $handlerMethod = $arguments['method'] ?? $arguments[0] ?? '__invoke';
+
+            if ($handlerMethod === $method->getName()) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
     protected function isWorkflowEventListenerMethod(ReflectionMethod $method): bool
     {
         return $this->hasAttribute($method, 'Symfony\Component\Workflow\Attribute\AsAnnounceListener')

tests/Rule/data/providers/symfony-gte71.php

@@ -4,6 +4,7 @@
 
 use Symfony\Component\DependencyInjection\Attribute\AutowireIterator;
 use Symfony\Component\DependencyInjection\Attribute\AutowireLocator;
+use Symfony\Component\Messenger\Attribute\AsMessageHandler;
 use Symfony\Component\Routing\Attribute\Route;
 use Symfony\Component\Workflow\Attribute\AsAnnounceListener;
 use Symfony\Component\Workflow\Attribute\AsCompletedListener;
@@ -100,3 +101,42 @@ public function deadMethod(): void // error: Unused Symfony\WorkflowEventListene
     {
     }
 }
+
+// Test AsMessageHandler with default __invoke method
+#[AsMessageHandler]
+class MessageHandlerWithInvoke
+{
+    public function __invoke(): void
+    {
+    }
+
+    public function deadMethod(): void // error: Unused Symfony\MessageHandlerWithInvoke::deadMethod
+    {
+    }
+}
+
+// Test AsMessageHandler with custom method
+#[AsMessageHandler(method: 'handleMessage')]
+class MessageHandlerWithCustomMethod
+{
+    public function handleMessage(): void
+    {
+    }
+
+    public function deadMethod(): void // error: Unused Symfony\MessageHandlerWithCustomMethod::deadMethod
+    {
+    }
+}
+
+// Test AsMessageHandler on method level
+class MessageHandlerWithMethodAttribute
+{
+    #[AsMessageHandler]
+    public function handleDirectly(): void
+    {
+    }
+
+    public function deadMethod(): void // error: Unused Symfony\MessageHandlerWithMethodAttribute::deadMethod
+    {
+    }
+}