Improved event references for Observeres resolution

Author: dkvashninbay

Diff for: src/com/magento/idea/magento2plugin/php/inspections/ObjectManagerInspection.java

@@ -1,7 +1,79 @@
 package com.magento.idea.magento2plugin.php.inspections;
 
+import com.intellij.codeInspection.ProblemHighlightType;
+import com.intellij.codeInspection.ProblemsHolder;
+import com.intellij.psi.PsiElement;
+import com.intellij.psi.PsiElementVisitor;
+import com.intellij.psi.PsiReference;
+import com.jetbrains.php.lang.inspections.PhpInspection;
+import com.jetbrains.php.lang.psi.elements.ClassReference;
+import com.jetbrains.php.lang.psi.elements.Method;
+import com.jetbrains.php.lang.psi.elements.MethodReference;
+import com.jetbrains.php.lang.psi.elements.PhpClass;
+import com.jetbrains.php.lang.psi.visitors.PhpElementVisitor;
+import com.magento.idea.magento2plugin.php.module.ModuleManager;
+import com.magento.idea.magento2plugin.php.util.MagentoTypes;
+import org.jetbrains.annotations.NotNull;
+
 /**
  * Created by dkvashnin on 12/18/15.
  */
-public class ObjectManagerInspection {
+public class ObjectManagerInspection extends PhpInspection {
+    @NotNull
+    @Override
+    public PsiElementVisitor buildVisitor(ProblemsHolder problemsHolder, boolean b) {
+        return new PhpElementVisitor() {
+            @Override
+            public void visitPhpMethodReference(MethodReference reference) {
+                PsiElement referencedElement = reference.resolve();
+
+                if(referencedElement instanceof Method) {
+                    ModuleManager moduleManager = ModuleManager.getInstance(referencedElement.getProject());
+                    if (moduleManager.getModuleForFile(reference.getContainingFile()) == null) {
+                        return;
+                    }
+
+                    PhpClass phpClass = ((Method) referencedElement).getContainingClass();
+
+                    verifyPhpClass(phpClass, reference);
+                }
+            }
+
+            @Override
+            public void visitPhpClassReference(ClassReference reference) {
+                PsiElement referencedElement = reference.resolve();
+
+                if(referencedElement instanceof PhpClass) {
+                    ModuleManager moduleManager = ModuleManager.getInstance(referencedElement.getProject());
+                    if (moduleManager.getModuleForFile(reference.getContainingFile()) == null) {
+                        return;
+                    }
+
+                    verifyPhpClass((PhpClass)referencedElement, reference);
+                }
+            }
+
+            private void verifyPhpClass(PhpClass phpClass, PsiReference reference) {
+                if (phpClass == null) {
+                    return;
+                }
+
+                if (phpClass.getPresentableFQN().equals(MagentoTypes.OBJECT_MANAGER_TYPE)) {
+                    registerProblem(reference);
+                    return;
+                }
+
+                for (PhpClass implementedInterface : phpClass.getImplementedInterfaces()) {
+                    if (implementedInterface.getPresentableFQN().equals(MagentoTypes.OBJECT_MANAGER_TYPE)) {
+                        registerProblem(reference);
+                        return;
+                    }
+                }
+            }
+
+            private void registerProblem(PsiReference reference) {
+                problemsHolder.registerProblem(reference, "ObjectManager is not recommended to use in module", ProblemHighlightType.GENERIC_ERROR_OR_WARNING);
+            }
+        };
+    }
 }

Diff for: src/com/magento/idea/magento2plugin/php/util/MagentoTypes.java

@@ -7,4 +7,5 @@ public class MagentoTypes {
     public static final String BLOCK_TYPE = "Magento\\Framework\\View\\Element\\BlockInterface";
     public static final String OBSERVER_TYPE = "Magento\\Framework\\Event\\ObserverInterface";
     public static final String OBJECT_MANAGER_TYPE = "Magento\\Framework\\ObjectManagerInterface";
+    public static final String EVENT_MANAGER_TYPE = "Magento\\Framework\\Event\\ManagerInterface";
 }

Diff for: src/com/magento/idea/magento2plugin/xml/observer/reference/EventReferenceProvider.java

@@ -5,8 +5,12 @@
 import com.intellij.psi.PsiReferenceProvider;
 import com.intellij.psi.util.PsiTreeUtil;
 import com.intellij.util.ProcessingContext;
+import com.jetbrains.php.lang.psi.elements.Method;
 import com.jetbrains.php.lang.psi.elements.MethodReference;
 import com.jetbrains.php.lang.psi.elements.ParameterList;
+import com.jetbrains.php.lang.psi.elements.PhpClass;
+import com.magento.idea.magento2plugin.php.util.MagentoTypes;
+import com.magento.idea.magento2plugin.xml.observer.PhpPatternsHelper;
 import com.magento.idea.magento2plugin.xml.reference.TypeReference;
 import com.magento.idea.magento2plugin.xml.reference.util.ReferenceResultsFiller;
 import org.jetbrains.annotations.NotNull;
@@ -16,6 +20,7 @@
 */
 class EventReferenceProvider extends PsiReferenceProvider {
     private final ReferenceResultsFiller[] resultsFillers;
+    private static final String DISPATCH_METHOD = "dispatch";
 
     public EventReferenceProvider(ReferenceResultsFiller[] resultsFillers) {
         this.resultsFillers = resultsFillers;
@@ -35,11 +40,20 @@ public PsiReference[] getReferencesByElement(@NotNull PsiElement psiElement, @No
         }
 
         MethodReference methodReference = (MethodReference)parameterList.getContext();
-        if (!methodReference.getName().equals("dispatch")) {
+        if (!DISPATCH_METHOD.equals(methodReference.getName())) {
             return new PsiReference[0];
         }
 
+        PsiElement resolvedElement = methodReference.resolve();
+        if (resolvedElement != null && resolvedElement instanceof Method) {
+            PhpClass containingClass = ((Method) resolvedElement).getContainingClass();
 
-        return new PsiReference[]{new TypeReference(psiElement, this.resultsFillers, true)};
+            if (containingClass != null && MagentoTypes.EVENT_MANAGER_TYPE.equals(containingClass.getPresentableFQN())) {
+                return new PsiReference[]{new TypeReference(psiElement, this.resultsFillers, true)};
+            }
+        }
+
+
+        return new PsiReference[0];
     }
 }

Diff for: src/inspectionDescriptions/ObjectManagerInspection.html

@@ -0,0 +1,5 @@
+<html>
+<body>
+ObjectManager usage in Module scope
+</body>
+</html>