implement ImplicitUsage for method inside "AsEventListener" attribute

Author: Haehnchen

src/main/java/fr/adrienbrault/idea/symfony2plugin/codeInsight/SymfonyImplicitUsageProvider.java

@@ -5,16 +5,21 @@
 import com.intellij.psi.util.PsiTreeUtil;
 import com.jetbrains.php.lang.parser.PhpElementTypes;
 import com.jetbrains.php.lang.psi.elements.*;
+import com.jetbrains.php.lang.psi.stubs.indexes.expectedArguments.PhpExpectedFunctionScalarArgument;
 import de.espend.idea.php.annotation.dict.PhpDocCommentAnnotation;
 import de.espend.idea.php.annotation.util.AnnotationUtil;
 import fr.adrienbrault.idea.symfony2plugin.doctrine.metadata.util.DoctrineMetadataUtil;
 import fr.adrienbrault.idea.symfony2plugin.routing.RouteHelper;
 import fr.adrienbrault.idea.symfony2plugin.util.PhpElementsUtil;
+import fr.adrienbrault.idea.symfony2plugin.util.PsiElementUtils;
 import fr.adrienbrault.idea.symfony2plugin.util.dict.ServiceUtil;
 import org.apache.commons.lang.StringUtils;
 import org.jetbrains.annotations.NotNull;
 
-import java.util.*;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.HashSet;
+import java.util.Set;
 import java.util.stream.Collectors;
 
 /**
@@ -28,18 +33,19 @@ public class SymfonyImplicitUsageProvider implements ImplicitUsageProvider {
 
     @Override
     public boolean isImplicitUsage(@NotNull PsiElement element) {
-        if (element instanceof Method && ((Method) element).getAccess() == PhpModifier.Access.PUBLIC) {
-            return isMethodARoute((Method) element)
-                || isSubscribedEvent((Method) element);
-        } else if (element instanceof PhpClass) {
-            return isRouteClass((PhpClass) element)
-                || isCommandAndService((PhpClass) element)
-                || isSubscribedEvent((PhpClass) element)
-                || isVoter((PhpClass) element)
-                || isTwigExtension((PhpClass) element)
-                || isEntityRepository((PhpClass) element)
-                || isConstraint((PhpClass) element)
-                || isKernelEventListener((PhpClass) element);
+        if (element instanceof Method method && method.getAccess() == PhpModifier.Access.PUBLIC) {
+            return isMethodARoute(method)
+                || isSubscribedEvent(method)
+                || isAsEventListenerMethodPhpAttribute(method);
+        } else if (element instanceof PhpClass phpClass) {
+            return isRouteClass(phpClass)
+                || isCommandAndService(phpClass)
+                || isSubscribedEvent(phpClass)
+                || isVoter(phpClass)
+                || isTwigExtension(phpClass)
+                || isEntityRepository(phpClass)
+                || isConstraint(phpClass)
+                || isKernelEventListener(phpClass);
         }
 
         return false;
@@ -176,4 +182,25 @@ private boolean isSubscribedEvent(@NotNull Method method) {
 
         return false;
     }
+
+    private boolean isAsEventListenerMethodPhpAttribute(@NotNull Method method) {
+        PhpClass containingClass = method.getContainingClass();
+        if (containingClass == null || !PhpElementsUtil.isInstanceOf(containingClass, "\\Symfony\\Component\\EventDispatcher\\EventSubscriberInterface")) {
+            return false;
+        }
+
+        for (PhpAttribute attribute : containingClass.getAttributes("\\Symfony\\Component\\EventDispatcher\\Attribute\\AsEventListener")) {
+            for (PhpAttribute.PhpAttributeArgument argument : attribute.getArguments()) {
+                if ("method".equals(argument.getName()) && argument.getArgument() instanceof PhpExpectedFunctionScalarArgument scalarArgument) {
+                    String value = PsiElementUtils.trimQuote(scalarArgument.getNormalizedValue());
+
+                    if (method.getName().equals(value)) {
+                        return true;
+                    }
+                }
+            }
+        }
+
+        return false;
+    }
 }

src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/codeInsight/SymfonyImplicitUsageProviderTest.java

@@ -221,6 +221,27 @@ public void testEventSubscriberGetSubscribedEventsArray() {
         assertTrue(new SymfonyImplicitUsageProvider().isImplicitUsage(phpClass));
     }
 
+
+    public void testEventSubscriberGetAsEventListener() {
+        PsiFile psiFile = myFixture.configureByText(PhpFileType.INSTANCE, "<?php\n" +
+                "namespace App\\EventListener;\n" +
+                "\n" +
+                "use Symfony\\Component\\EventDispatcher\\Attribute\\AsEventListener;\n" +
+                "\n" +
+                "#[AsEventListener(event: 'bar', method: 'onFoo')]\n" +
+                "final class MyMultiListener implements \\Symfony\\Component\\EventDispatcher\\EventSubscriberInterface\n" +
+                "{\n" +
+                "    public function onFoo(): void\n" +
+                "    {\n" +
+                "    }\n" +
+                "\n" +
+                "}"
+        );
+
+        PhpClass phpClass = PhpElementsUtil.getFirstClassFromFile((PhpFile) psiFile.getContainingFile());
+
+        assertTrue(new SymfonyImplicitUsageProvider().isImplicitUsage(phpClass.findOwnMethodByName("onFoo")));
+    }
     public void testTwigExtensionRegisteredAsServiceWithFunctionMethodImplementedIsMarkedUsed() {
         PsiFile psiFile = myFixture.configureByText(PhpFileType.INSTANCE, "<?php\n" +
             "\n" +