Merge pull request #1416 from Haehnchen/feature/user-implementation-twig

support user implementation resolving for Twig "app.user" usages

Author: Haehnchen

src/main/java/fr/adrienbrault/idea/symfony2plugin/templating/util/TwigTypeResolveUtil.java

@@ -23,6 +23,7 @@
 import fr.adrienbrault.idea.symfony2plugin.templating.variable.TwigFileVariableCollector;
 import fr.adrienbrault.idea.symfony2plugin.templating.variable.TwigFileVariableCollectorParameter;
 import fr.adrienbrault.idea.symfony2plugin.templating.variable.TwigTypeContainer;
+import fr.adrienbrault.idea.symfony2plugin.templating.variable.collector.StaticVariableCollector;
 import fr.adrienbrault.idea.symfony2plugin.templating.variable.dict.PsiVariable;
 import fr.adrienbrault.idea.symfony2plugin.templating.variable.resolver.FormFieldResolver;
 import fr.adrienbrault.idea.symfony2plugin.templating.variable.resolver.FormVarsResolver;
@@ -34,7 +35,6 @@
 import org.jetbrains.annotations.NotNull;
 
 import java.util.*;
-import java.util.function.BiConsumer;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 import java.util.stream.Collectors;
@@ -442,10 +442,18 @@ private static Collection<TwigTypeContainer> resolveTwigMethodName(Collection<Tw
             if(phpNamedElement.getPhpNamedElement() != null) {
                 for(PhpNamedElement target : getTwigPhpNameTargets(phpNamedElement.getPhpNamedElement(), typeName)) {
                     PhpType phpType = target.getType();
-                    for(String typeString: phpType.getTypes()) {
-                        PhpNamedElement phpNamedElement1 = PhpElementsUtil.getClassInterface(phpNamedElement.getPhpNamedElement().getProject(), typeString);
-                        if(phpNamedElement1 != null) {
-                            phpNamedElements.add(new TwigTypeContainer(phpNamedElement1));
+
+                    // @TODO: provide extension
+                    // custom resolving for Twig here: "app.user" => can also be a general solution just support the "getToken()->getUser()"
+                    if (target instanceof Method && StaticVariableCollector.isUserMethod((Method) target)) {
+                        phpNamedElements.addAll(getApplicationUserImplementations(target.getProject()));
+                    }
+
+                    // @TODO: use full resolving for object, that would allow using TypeProviders and core PhpStorm feature
+                    for (String typeString: phpType.filterPrimitives().getTypes()) {
+                        PhpClass phpClass = PhpElementsUtil.getClassInterface(phpNamedElement.getPhpNamedElement().getProject(), typeString);
+                        if(phpClass != null) {
+                            phpNamedElements.add(new TwigTypeContainer(phpClass));
                         }
                     }
                 }
@@ -460,6 +468,19 @@ private static Collection<TwigTypeContainer> resolveTwigMethodName(Collection<Tw
         return phpNamedElements;
     }
 
+    /**
+     * Get possible suitable UserInterface implementation from the application scope
+     */
+    @NotNull
+    private static Collection<TwigTypeContainer> getApplicationUserImplementations(@NotNull Project project) {
+        return PhpIndex.getInstance(project)
+            .getAllSubclasses("\\Symfony\\Component\\Security\\Core\\User\\UserInterface")
+            .stream()
+            .filter(phpClass -> !phpClass.isInterface()) // filter out implementation like AdvancedUserInterface
+            .map(TwigTypeContainer::new)
+            .collect(Collectors.toList());
+    }
+
     private static Set<String> resolveTwigMethodName(Project project, Collection<String> previousElement, String typeName) {
 
         Set<String> types = new HashSet<>();

src/main/java/fr/adrienbrault/idea/symfony2plugin/templating/variable/collector/StaticVariableCollector.java

@@ -1,17 +1,36 @@
 package fr.adrienbrault.idea.symfony2plugin.templating.variable.collector;
 
+import com.jetbrains.php.lang.psi.elements.Method;
 import fr.adrienbrault.idea.symfony2plugin.templating.variable.TwigFileVariableCollector;
 import fr.adrienbrault.idea.symfony2plugin.templating.variable.TwigFileVariableCollectorParameter;
+import fr.adrienbrault.idea.symfony2plugin.util.PhpElementsUtil;
 import org.jetbrains.annotations.NotNull;
 
-import java.util.*;
+import java.util.Arrays;
+import java.util.HashSet;
+import java.util.Map;
+import java.util.Set;
 
 /**
+ * Provide support for Twig global "app".
+ *
+ * Its just a static fallback if no other implementation is able to catch up
+ *
  * @author Daniel Espendiller <[email protected]>
  */
 public class StaticVariableCollector implements TwigFileVariableCollector {
+    private static final HashSet<String> APP_CLASSES = new HashSet<>(Arrays.asList(
+        "\\Symfony\\Bundle\\FrameworkBundle\\Templating\\GlobalVariables", // valid inside Symfony < 5
+        "\\Symfony\\Bridge\\Twig\\AppVariable"
+    ));
+
     @Override
     public void collect(@NotNull TwigFileVariableCollectorParameter parameter, @NotNull Map<String, Set<String>> variables) {
-        variables.put("app", new HashSet<>(Collections.singletonList("\\Symfony\\Bundle\\FrameworkBundle\\Templating\\GlobalVariables")));
+        variables.put("app", new HashSet<>(APP_CLASSES)); // const must be a copy
+    }
+
+    public static boolean isUserMethod(@NotNull Method method) {
+        return APP_CLASSES.stream()
+            .anyMatch(phpClass -> PhpElementsUtil.isMethodInstanceOf(method, phpClass, "getUser"));
     }
 }