resolve php references in container type parameter to support "fields" like constants and properties #151

Author: Haehnchen

src/fr/adrienbrault/idea/symfony2plugin/dic/SymfonyContainerTypeProvider.java

@@ -39,7 +39,7 @@ public String getType(PsiElement e) {
         }
 
         // container calls are only on "get" methods
-        if(!(e instanceof MethodReference) || !PhpElementsUtil.isMethodWithFirstString(e, "get")) {
+        if(!(e instanceof MethodReference) || !PhpElementsUtil.isMethodWithFirstStringOrFieldReference(e, "get")) {
             return null;
         }
 
@@ -53,10 +53,19 @@ public String getType(PsiElement e) {
         PsiElement[] parameters = ((MethodReference)e).getParameters();
         if (parameters.length == 1) {
             PsiElement parameter = parameters[0];
-            if ((parameter instanceof StringLiteralExpression)) {
+            if (parameter instanceof StringLiteralExpression) {
                 String param = ((StringLiteralExpression)parameter).getContents();
-                if (StringUtil.isNotEmpty(param)) return refSignature + TRIM_KEY + param;
+                if (StringUtil.isNotEmpty(param)) {
+                    return refSignature + TRIM_KEY + param;
+                }
             }
+
+            // whitelist here; we can also provide some more but think of performance
+            // Service::NAME and $this->name;
+            if (parameter instanceof PhpReference && (parameter instanceof ClassConstantReference || parameter instanceof FieldReference)) {
+                return refSignature + TRIM_KEY + ((PhpReference) parameter).getSignature();
+            }
+
         }
 
         return null;
@@ -82,6 +91,20 @@ public Collection<? extends PhpNamedElement> getBySignature(String expression, P
             return Collections.emptySet();
         }
 
+        // we can also pipe php references signatures and resolve them here
+        // overwrite parameter to get string value
+        if(parameter.startsWith("#")) {
+            Collection<? extends PhpNamedElement> signTypes = phpIndex.getBySignature(parameter, null, 0);
+            if(signTypes.size() == 0) {
+                return Arrays.asList(phpNamedElement);
+            }
+
+            parameter = PhpElementsUtil.getStringValue(signTypes.iterator().next());
+            if(parameter == null) {
+                return Arrays.asList(phpNamedElement);
+            }
+        }
+
         // finally search the classes
         if(new Symfony2InterfacesUtil().isContainerGetCall((Method) phpNamedElement)) {
             ServiceMap serviceMap = ServiceXmlParserFactory.getInstance(project, XmlServiceParser.class).getServiceMap();

src/fr/adrienbrault/idea/symfony2plugin/util/PhpElementsUtil.java

@@ -5,10 +5,7 @@
 import com.intellij.patterns.ElementPattern;
 import com.intellij.patterns.PlatformPatterns;
 import com.intellij.patterns.PsiElementPattern;
-import com.intellij.psi.PsiElement;
-import com.intellij.psi.PsiElementResolveResult;
-import com.intellij.psi.PsiWhiteSpace;
-import com.intellij.psi.ResolveResult;
+import com.intellij.psi.*;
 import com.intellij.psi.util.PsiTreeUtil;
 import com.jetbrains.php.PhpIndex;
 import com.jetbrains.php.completion.PhpLookupElement;
@@ -190,6 +187,33 @@ static public boolean isMethodWithFirstString(PsiElement psiElement, String... m
         return null != methodRefName && Arrays.asList(methodName).contains(methodRefName);
     }
 
+    /**
+     * $this->methodName('service_name')
+     * $this->methodName(SERVICE::NAME)
+     * $this->methodName($this->name)
+     */
+    static public boolean isMethodWithFirstStringOrFieldReference(PsiElement psiElement, String... methodName) {
+
+        if(!PlatformPatterns
+            .psiElement(PhpElementTypes.METHOD_REFERENCE)
+            .withChild(PlatformPatterns
+                .psiElement(PhpElementTypes.PARAMETER_LIST)
+                .withFirstChild(PlatformPatterns.or(
+                    PlatformPatterns.psiElement(PhpElementTypes.STRING),
+                    PlatformPatterns.psiElement(PhpElementTypes.FIELD_REFERENCE),
+                    PlatformPatterns.psiElement(PhpElementTypes.CLASS_CONSTANT_REFERENCE)
+                ))
+            ).accepts(psiElement)) {
+
+            return false;
+        }
+
+        // cant we move it up to PlatformPatterns? withName condition dont looks working
+        String methodRefName = ((MethodReference) psiElement).getName();
+
+        return null != methodRefName && Arrays.asList(methodName).contains(methodRefName);
+    }
+
     static public PsiElementPattern.Capture<StringLiteralExpression> methodWithFirstStringPattern() {
         return PlatformPatterns
             .psiElement(StringLiteralExpression.class)
@@ -426,19 +450,28 @@ public static String getStringValue(PsiElement psiElement) {
     }
 
     @Nullable
-    private static String getStringValue(PsiElement psiElement, int depth) {
+    private static String getStringValue(@Nullable PsiElement psiElement, int depth) {
 
-        if(++depth > 5) {
+        if(psiElement == null || ++depth > 5) {
             return null;
         }
 
         if(psiElement instanceof StringLiteralExpression) {
             return ((StringLiteralExpression) psiElement).getContents();
         }
 
+        if(psiElement instanceof Field) {
+            return getStringValue(((Field) psiElement).getDefaultValue(), depth);
+        }
+
         if(psiElement instanceof PhpReference) {
-            PsiElement ref = psiElement.getReference().resolve();
 
+            PsiReference psiReference = psiElement.getReference();
+            if(psiReference == null) {
+                return null;
+            }
+
+            PsiElement ref = psiReference.resolve();
             if(ref instanceof PhpReference) {
                 return getStringValue(psiElement, depth);
             }
@@ -451,8 +484,6 @@ private static String getStringValue(PsiElement psiElement, int depth) {
                 }
             }
 
-
-
         }
 
         return null;