[212]_add reference navigation and completion for crontab.xml

Author: iamdylanngo

src/com/magento/idea/magento2plugin/completion/provider/PhpJobMethodCompletionContributor.java

@@ -0,0 +1,41 @@
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+package com.magento.idea.magento2plugin.completion.provider;
+
+import com.intellij.codeInsight.completion.CompletionParameters;
+import com.intellij.codeInsight.completion.CompletionProvider;
+import com.intellij.codeInsight.completion.CompletionResultSet;
+import com.intellij.codeInsight.lookup.LookupElementBuilder;
+import com.intellij.psi.PsiElement;
+import com.intellij.psi.xml.XmlElement;
+import com.intellij.util.ProcessingContext;
+import com.jetbrains.php.lang.psi.elements.Method;
+import com.jetbrains.php.lang.psi.elements.PhpClass;
+import com.magento.idea.magento2plugin.indexes.DiIndex;
+import org.jetbrains.annotations.NotNull;
+
+public class PhpJobMethodCompletionContributor extends CompletionProvider<CompletionParameters> {
+
+    @Override
+    protected void addCompletions(@NotNull CompletionParameters parameters,
+                                  ProcessingContext context,
+                                  @NotNull CompletionResultSet result) {
+        PsiElement position = parameters.getPosition().getOriginalElement();
+        if (position == null) {
+            return;
+        }
+
+        PhpClass phpClass = DiIndex.getPhpClassOfJobMethod((XmlElement) position);
+        if (phpClass != null) {
+            for (Method method : phpClass.getMethods()) {
+                result.addElement(
+                        LookupElementBuilder
+                                .create(method.getName())
+                                .withIcon(method.getIcon())
+                );
+            }
+        }
+    }
+}

src/com/magento/idea/magento2plugin/completion/xml/XmlCompletionContributor.java

@@ -63,6 +63,12 @@ public XmlCompletionContributor() {
                 new PhpClassCompletionProvider()
         );
 
+        // <randomTag instance="completion">
+        extend(CompletionType.BASIC, psiElement(XmlTokenType.XML_ATTRIBUTE_VALUE_TOKEN)
+                        .inside(XmlPatterns.xmlAttribute().withName(CommonXml.ATTR_INSTANCE)),
+                new PhpClassCompletionProvider()
+        );
+
         // <preference for="completion">
         extend(CompletionType.BASIC, psiElement(XmlTokenType.XML_ATTRIBUTE_VALUE_TOKEN)
                         .inside(XmlPatterns.xmlAttribute().withName(ModuleDiXml.PREFERENCE_ATTR_FOR)),
@@ -182,6 +188,14 @@ public XmlCompletionContributor() {
             new PhpServiceMethodCompletionContributor()
         );
 
+        // <job method="methodName"/>
+        extend(CompletionType.BASIC, psiElement(XmlTokenType.XML_ATTRIBUTE_VALUE_TOKEN)
+                .inside(XmlPatterns.xmlAttribute().withName("method")
+                    .withParent(XmlPatterns.xmlTag().withName("job"))
+                ).inFile(xmlFile().withName(string().endsWith("crontab.xml"))),
+            new PhpJobMethodCompletionContributor()
+        );
+
         extend(CompletionType.BASIC, psiElement(XmlTokenType.XML_ATTRIBUTE_VALUE_TOKEN)
             .inside(XmlPatterns.xmlAttribute().withName("name")
                 .withParent(XmlPatterns.xmlTag().withName("referenceContainer"))

src/com/magento/idea/magento2plugin/indexes/DiIndex.java

@@ -95,6 +95,35 @@ public static PhpClass getPhpClassOfServiceMethod(XmlElement psiMethodValueEleme
         return null;
     }
 
+    @Nullable
+    public static PhpClass getPhpClassOfJobMethod(XmlElement psiMethodValueElement) {
+        XmlTag serviceTag = PsiTreeUtil.getParentOfType(psiMethodValueElement, XmlTag.class);
+        if (serviceTag == null) {
+            return null;
+        }
+
+        XmlAttribute attribute = serviceTag.getAttribute("instance");
+        if (attribute == null) {
+            return null;
+        }
+
+        XmlAttributeValue valueElement = attribute.getValueElement();
+        if (valueElement == null) {
+            return null;
+        }
+
+        for (PsiReference reference : valueElement.getReferences()) {
+            if (reference != null) {
+                PsiElement element = reference.resolve();
+                if (element instanceof PhpClass) {
+                    return (PhpClass) element;
+                }
+            }
+        }
+
+        return null;
+    }
+
     public Collection<PsiElement> getVirtualTypeElements(final String name, final GlobalSearchScope scope) {
         Collection<PsiElement> result = new ArrayList<>();
 

src/com/magento/idea/magento2plugin/magento/files/CommonXml.java

@@ -11,5 +11,6 @@ public class CommonXml {
     public static String INIT_PARAMETER = "init_parameter";
     public static String OBJECT = "object";
     public static String ATTR_CLASS = "class";
+    public static String ATTR_INSTANCE = "instance";
     public static String ATTRIBUTE_ARGUMENTS = "arguments";
 }

src/com/magento/idea/magento2plugin/reference/provider/PhpJobMethodReferenceProvider.java

@@ -0,0 +1,45 @@
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+package com.magento.idea.magento2plugin.reference.provider;
+
+import com.intellij.openapi.util.text.StringUtil;
+import com.intellij.psi.PsiElement;
+import com.intellij.psi.PsiReference;
+import com.intellij.psi.PsiReferenceProvider;
+import com.intellij.psi.xml.XmlElement;
+import com.intellij.util.ProcessingContext;
+import com.jetbrains.php.lang.psi.elements.Method;
+import com.jetbrains.php.lang.psi.elements.PhpClass;
+import com.magento.idea.magento2plugin.indexes.DiIndex;
+import com.magento.idea.magento2plugin.reference.xml.PolyVariantReferenceBase;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+
+public class PhpJobMethodReferenceProvider extends PsiReferenceProvider {
+
+    @NotNull
+    @Override
+    public PsiReference[] getReferencesByElement(@NotNull PsiElement element, @NotNull ProcessingContext context) {
+        if (!(element instanceof XmlElement)) {
+            return PsiReference.EMPTY_ARRAY;
+        }
+
+        List<PsiReference> psiReferences = new ArrayList<>();
+
+        String methodName = StringUtil.unquoteString(element.getText());
+
+        PhpClass phpClass = DiIndex.getPhpClassOfJobMethod((XmlElement) element);
+        if (phpClass != null) {
+            Collection<Method> methods = phpClass.getMethods();
+            methods.removeIf(m -> !m.getName().equalsIgnoreCase(methodName));
+            psiReferences.add(new PolyVariantReferenceBase(element, methods));
+        }
+
+        return psiReferences.toArray(new PsiReference[psiReferences.size()]);
+    }
+}

src/com/magento/idea/magento2plugin/reference/xml/XmlReferenceContributor.java

@@ -87,6 +87,16 @@ public void registerReferenceProviders(@NotNull PsiReferenceRegistrar registrar)
             new PhpServiceMethodReferenceProvider()
         );
 
+        // <job method="methodName"/>
+        registrar.registerReferenceProvider(
+                XmlPatterns.xmlAttributeValue().withParent(
+                        XmlPatterns.xmlAttribute().withName("method").withParent(
+                                XmlPatterns.xmlTag().withName("job")
+                        )
+                ).inFile(xmlFile().withName(string().endsWith("crontab.xml"))),
+                new PhpJobMethodReferenceProvider()
+        );
+
         registrar.registerReferenceProvider(
             XmlPatterns.xmlAttributeValue().withParent(
                 XmlPatterns.xmlAttribute().withName("name").withParent(