Exclude method with AsMessageHandler attribute

Author: Gaëtan Petit

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

composer.json

@@ -38,6 +38,7 @@
         "symfony/doctrine-bridge": "^5.4 || ^6.0 || ^7.0",
         "symfony/event-dispatcher": "^5.4 || ^6.0 || ^7.0",
         "symfony/http-kernel": "^5.4 || ^6.0 || ^7.0",
+        "symfony/messenger": "^5.4 || ^6.0 || ^7.0",
         "symfony/routing": "^5.4 || ^6.0 || ^7.0",
         "symfony/validator": "^5.4 || ^6.0 || ^7.0",
         "twig/twig": "^3.0"

composer.lock

@@ -363,6 +363,10 @@ protected function shouldMarkAsUsed(ReflectionMethod $method): ?string
             return 'Event listener method via #[AsEventListener] attribute';
         }
 
+        if ($this->isMethodWithMessageHandlerAttribute($method)) {
+            return 'Message Handler method via #[AsMessageHandler] attribute';
+        }
+
         if ($this->isAutowiredWithRequiredAttribute($method)) {
             return 'Autowired with #[Required] (called by DIC)';
         }
@@ -518,6 +522,14 @@ protected function isMethodWithRouteAttribute(ReflectionMethod $method): bool
             || $this->hasAttribute($method, 'Symfony\Component\Routing\Annotation\Route', $isInstanceOf);
     }
 
+    protected function isMethodWithMessageHandlerAttribute(ReflectionMethod $method): bool
+    {
+        $class = $method->getDeclaringClass();
+
+        return $this->hasAttribute($class, 'Symfony\Component\Messenger\Attribute\AsMessageHandler')
+            || $this->hasAttribute($method, 'Symfony\Component\Messenger\Attribute\AsMessageHandler');
+    }
+
     protected function isMethodWithCallbackConstraintAttribute(ReflectionMethod $method): bool
     {
         $attributes = $method->getDeclaringClass()->getAttributes('Symfony\Component\Validator\Constraints\Callback');

src/Provider/SymfonyUsageProvider.php

@@ -16,6 +16,7 @@
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 use Symfony\Component\HttpKernel\Event\FilterControllerEvent;
 use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent;
+use Symfony\Component\Messenger\Attribute\AsMessageHandler;
 use Symfony\Component\Routing\Attribute\Route;
 use Symfony\Contracts\Service\Attribute\Required;
 use Symfony\Component\Validator\Constraints as Assert;
@@ -47,6 +48,18 @@ public function __construct() {
 
 }
 
+#[AsMessageHandler]
+class SomeMessageHandler {
+}
+
+class SomeMessageHandlerClass
+{
+    #[AsMessageHandler]
+    public function onSomething(): void
+    {
+    }
+}
+
 class FooBundle extends Bundle {
     public function __construct() {
     }