Merge pull request Haehnchen#1361 from Haehnchen/feature/template-var-context

support template name references resolve when complete / navigate to Twig variables on twig render() parameter

Author: Haehnchen

src/main/java/fr/adrienbrault/idea/symfony2plugin/templating/RenderParameterGotoCompletionRegistrar.java

@@ -172,11 +172,10 @@ public static Collection<String> getTemplatesForScope(@NotNull PsiElement psiEle
             // foobar('foo.html.twig', ['<caret>'])
             PsiElement prevSibling = arrayCreationElement.getPrevPsiSibling();
             if(prevSibling != null) {
-                String stringValue = PhpElementsUtil.getStringValue(prevSibling);
-                if(stringValue != null && stringValue.toLowerCase().endsWith(".twig")) {
-                    templates.add(
-                        TwigUtil.normalizeTemplateName(stringValue)
-                    );
+                for (String stringValue : PhpElementsUtil.StringResolver.findStringValues(prevSibling)) {
+                    if(stringValue != null && stringValue.toLowerCase().endsWith(".twig")) {
+                        templates.add(TwigUtil.normalizeTemplateName(stringValue));
+                    }
                 }
             }
         }

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

@@ -1458,4 +1458,84 @@ public static Set<Variable> visit(@NotNull PsiElement scope, @NotNull String nam
             return visitor.variables;
         }
     }
+
+
+    /**
+     * Find string values based on a given PsiElement and its references
+     *
+     * - render(true === true ? 'foo.twig.html' : 'foobar.twig.html')
+     * - foo(self::foo), foo($var), foo($this->foo), ...
+     * - render($foo ?? 'foo.twig.html')
+     */
+    public static class StringResolver {
+        public static Collection<String> findStringValues(@NotNull PsiElement psiElement) {
+            Collection<String> strings = new HashSet<>();
+
+            if (psiElement instanceof StringLiteralExpression) {
+                strings.add(resolveString((StringLiteralExpression) psiElement));
+            } else if(psiElement instanceof TernaryExpression) {
+                // render(true === true ? 'foo.twig.html' : 'foobar.twig.html')
+                for (PhpPsiElement phpPsiElement : new PhpPsiElement[]{((TernaryExpression) psiElement).getTrueVariant(), ((TernaryExpression) psiElement).getFalseVariant()}) {
+                    if (phpPsiElement == null) {
+                        continue;
+                    }
+
+                    if (phpPsiElement instanceof StringLiteralExpression) {
+                        strings.add(resolveString((StringLiteralExpression) phpPsiElement));
+                    } else if(phpPsiElement instanceof PhpReference) {
+                        strings.add(resolvePhpReference((PhpReference) phpPsiElement));
+                    }
+                }
+            } else if(psiElement instanceof PhpReference) {
+                // foo(self::foo)
+                // foo($this->foo)
+                // foo($var)
+                strings.add(resolvePhpReference((PhpReference) psiElement));
+            } else if(psiElement instanceof BinaryExpression) {
+                // render($foo ?? 'foo.twig.html')
+                PsiElement phpPsiElement = ((BinaryExpression) psiElement).getRightOperand();
+
+                if (phpPsiElement instanceof StringLiteralExpression) {
+                    strings.add(resolveString((StringLiteralExpression) phpPsiElement));
+                } else if(phpPsiElement instanceof PhpReference) {
+                    strings.add(resolvePhpReference((PhpReference) phpPsiElement));
+                }
+            }
+
+            return strings;
+        }
+
+        @Nullable
+        private static String resolveString(@NotNull StringLiteralExpression parameter) {
+            String contents = parameter.getContents();
+            return StringUtils.isBlank(contents) ? null : contents;
+        }
+
+        @Nullable
+        private static String resolvePhpReference(@NotNull PhpReference parameter) {
+            for (PhpNamedElement phpNamedElement : ((PhpReference) parameter).resolveLocal()) {
+                // foo(self::foo)
+                // foo($this->foo)
+                if (phpNamedElement instanceof Field) {
+                    PsiElement defaultValue = ((Field) phpNamedElement).getDefaultValue();
+                    if (defaultValue instanceof StringLiteralExpression) {
+                        return resolveString((StringLiteralExpression) defaultValue);
+                    }
+                }
+
+                // foo($var) => $var = 'test.html.twig'
+                if (phpNamedElement instanceof Variable) {
+                    PsiElement assignmentExpression = phpNamedElement.getParent();
+                    if (assignmentExpression instanceof AssignmentExpression) {
+                        PhpPsiElement value = ((AssignmentExpression) assignmentExpression).getValue();
+                        if (value instanceof StringLiteralExpression) {
+                            return resolveString((StringLiteralExpression) value);
+                        }
+                    }
+                }
+            }
+
+            return null;
+        }
+    }
 }

src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/templating/RenderParameterGotoCompletionRegistrarTest.java

@@ -36,6 +36,12 @@ public void testTemplateNameExtractionForFunctionForFunctions() {
         assertContainsElements(RenderParameterGotoCompletionRegistrar.getTemplatesForScope(psiElement), "foo.html.twig");
     }
 
+    public void testSpecialReferencesTemplateNameResolve() {
+        myFixture.configureByText(PhpFileType.INSTANCE, "<?php $var = 'foo.html.twig'; foo($var, ['<caret>']);");
+        PsiElement psiElement = myFixture.getFile().findElementAt(myFixture.getCaretOffset());
+        assertContainsElements(RenderParameterGotoCompletionRegistrar.getTemplatesForScope(psiElement), "foo.html.twig");
+    }
+
     public void testTemplateNameExtractionForFunctionForFunctionsAsReturn() {
         myFixture.configureByText(PhpFileType.INSTANCE, "" +
             "<?php\n" +

src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/util/PhpElementsUtilTest.java

@@ -4,9 +4,7 @@
 import com.intellij.util.containers.ContainerUtil;
 import com.jetbrains.php.lang.PhpFileType;
 import com.jetbrains.php.lang.psi.PhpPsiElementFactory;
-import com.jetbrains.php.lang.psi.elements.ArrayCreationExpression;
-import com.jetbrains.php.lang.psi.elements.PhpClass;
-import com.jetbrains.php.lang.psi.elements.Variable;
+import com.jetbrains.php.lang.psi.elements.*;
 import fr.adrienbrault.idea.symfony2plugin.tests.SymfonyLightCodeInsightFixtureTestCase;
 import fr.adrienbrault.idea.symfony2plugin.util.MethodMatcher;
 import fr.adrienbrault.idea.symfony2plugin.util.PhpElementsUtil;
@@ -293,4 +291,14 @@ public void testIsMethodInstanceOf() {
             new MethodMatcher.CallToSignature("FooBar\\Foo", "getBar"))
         );
     }
+
+    /**
+     * @see PhpElementsUtil.StringResolver#findStringValues
+     */
+    public void testThatPhpThatStringValueCanBeResolvedViaChainResolve() {
+        assertContainsElements(PhpElementsUtil.StringResolver.findStringValues(PhpPsiElementFactory.createPhpPsiFromText(getProject(), StringLiteralExpression.class, "<?php foo('test.html');")), "test.html");
+        assertContainsElements(PhpElementsUtil.StringResolver.findStringValues(PhpPsiElementFactory.createPhpPsiFromText(getProject(), BinaryExpression.class, "<?php foo($var ?? 'test.html');")), "test.html");
+        assertContainsElements(PhpElementsUtil.StringResolver.findStringValues(PhpPsiElementFactory.createPhpPsiFromText(getProject(), ParameterList.class, "<?php $var = 'test.html'; foo($var);").getFirstPsiChild()), "test.html");
+        assertContainsElements(PhpElementsUtil.StringResolver.findStringValues(PhpPsiElementFactory.createPhpPsiFromText(getProject(), TernaryExpression.class, "<?php $var = 'test.html'; $x = true == true ? $var : 'test2.html';")), "test.html", "test2.html");
+    }
 }