Add support for enum Twig function with completion, navigation, and insert handler for enum classes

Haehnchen · Haehnchen · commit 8584cd4369fa · 2025-12-10T19:40:26.000+01:00
diff --git a/src/main/java/fr/adrienbrault/idea/symfony2plugin/completion/insertHandler/TwigEscapedSlashInsertHandler.java b/src/main/java/fr/adrienbrault/idea/symfony2plugin/completion/insertHandler/TwigEscapedSlashInsertHandler.java
@@ -6,10 +6,13 @@
 import com.intellij.openapi.editor.Document;
 import com.intellij.psi.PsiElement;
 import com.intellij.psi.SmartPsiElementPointer;
+import com.jetbrains.php.lang.psi.elements.PhpClass;
 import com.jetbrains.php.lang.psi.elements.PhpClassMember;
 import org.apache.commons.lang3.StringUtils;
 import org.jetbrains.annotations.NotNull;
 
+import java.util.Objects;
+
 /**
  * "Foo\Foo" => "Foo\\Foo"
  *
@@ -24,27 +27,29 @@ public void handleInsert(@NotNull InsertionContext context, @NotNull LookupEleme
             return;
         }
 
-        String classFqn = null;
-        String fieldName = null;
+        String insertString = "";
+        PsiElement element = smartPsiElementPointer.getElement();
+        if (element instanceof PhpClassMember phpClassMember) {
+            String classFqn = Objects.requireNonNull(phpClassMember.getContainingClass()).getFQN();
+            String fieldName = phpClassMember.getName();
 
-        if (smartPsiElementPointer.getElement() instanceof PhpClassMember phpClassMember) {
-            classFqn = phpClassMember.getContainingClass().getFQN();
-            fieldName = phpClassMember.getName();
+            insertString = StringUtils.stripStart(classFqn, "\\").replace("\\", "\\\\") + "::" + fieldName;
+        } else if (element instanceof PhpClass phpClass) {
+            insertString = StringUtils.stripStart(phpClass.getFQN(), "\\").replace("\\", "\\\\");
         }
 
         Document document = context.getDocument();
         document.deleteString(context.getStartOffset(), context.getTailOffset());
 
-        String s = StringUtils.stripStart(classFqn, "\\").replace("\\", "\\\\") + "::" + fieldName;
-        document.insertString(context.getStartOffset(), s);
+        document.insertString(context.getStartOffset(), insertString);
         context.commitDocument();
 
         PsiElement elementAt = context.getFile().findElementAt(context.getEditor().getCaretModel().getOffset());
         if (elementAt == null) {
             return;
         }
 
-        context.getEditor().getCaretModel().moveCaretRelatively(s.length(), 0, false, false, true);
+        context.getEditor().getCaretModel().moveCaretRelatively(insertString.length(), 0, false, false, true);
     }
 
     public static TwigEscapedSlashInsertHandler getInstance(){
diff --git a/src/main/java/fr/adrienbrault/idea/symfony2plugin/templating/TwigTemplateCompletionContributor.java b/src/main/java/fr/adrienbrault/idea/symfony2plugin/templating/TwigTemplateCompletionContributor.java
@@ -437,6 +437,13 @@ public void addCompletions(@NotNull CompletionParameters parameters, @NotNull Pr
             new ConstantCompletionParametersCompletionProvider()
         );
 
+        // {{ enum('App\\Config\\SomeOption') }}
+        extend(
+            CompletionType.BASIC,
+            TwigPattern.getPrintBlockOrTagFunctionPattern("enum"),
+            new EnumCompletionParametersCompletionProvider()
+        );
+
         // {% e => {% extends '...'
         extend(
             CompletionType.BASIC,
@@ -1632,6 +1639,73 @@ public void addCompletions(@NotNull CompletionParameters parameters, @NotNull Pr
         }
     }
 
+    /**
+     * {{ enum('<caret>') }}
+     * {{ enum('Foo\\<caret>') }}
+     */
+    private static class EnumCompletionParametersCompletionProvider extends CompletionProvider<CompletionParameters> {
+        public void addCompletions(@NotNull CompletionParameters parameters, @NotNull ProcessingContext context, @NotNull CompletionResultSet resultSet) {
+            PsiElement position = parameters.getPosition();
+            if (!Symfony2ProjectComponent.isEnabled(position)) {
+                return;
+            }
+
+            Project project = position.getProject();
+            PhpIndex instance = PhpIndex.getInstance(project);
+
+            PrefixMatcher prefixMatcher = resultSet.getPrefixMatcher();
+            String prefix = prefixMatcher.getPrefix();
+
+            if (prefix.contains("\\")) {
+                // 'FOO\\Foo<caret>'
+                int i = prefix.lastIndexOf("\\");
+                String substring = "\\" + StringUtils.stripStart(prefix.substring(0, i).replace("\\\\", "\\"), "\\");
+                String pre = prefix.substring(prefix.lastIndexOf("\\") + 1);
+                CompletionResultSet completionResultSet = resultSet.withPrefixMatcher(pre);
+
+                for (PhpClass phpClass: PhpIndexUtil.getPhpClassInsideNamespace(project, substring)) {
+                    // Only include enum classes
+                    if (!phpClass.isEnum()) {
+                        continue;
+                    }
+
+                    String fqn = phpClass.getFQN().substring(substring.length());
+                    String fqnNoLeadingSlash = StringUtils.stripStart(phpClass.getFQN(), "\\");
+
+                    LookupElementBuilder element = LookupElementBuilder
+                        .create(fqn.replace("\\", "\\\\"))
+                        .withInsertHandler(TwigEscapedSlashInsertHandler.getInstance())
+                        .withTypeText(fqnNoLeadingSlash, true)
+                        .withIcon(phpClass.getIcon());
+
+                    completionResultSet.addElement(element);
+                }
+            } else {
+                // '<caret>'
+                Collection<PhpClass> phpClasses = new ArrayList<>();
+                for (String className : instance.getAllClassNames(resultSet.getPrefixMatcher())) {
+                    phpClasses.addAll(instance.getClassesByName(className));
+                }
+
+                for (PhpClass phpClass : phpClasses) {
+                    // Only include enum classes
+                    if (!phpClass.isEnum()) {
+                        continue;
+                    }
+
+                    String fqnNoLeadingSlash = StringUtils.stripStart(phpClass.getFQN(), "\\");
+                    LookupElementBuilder element = LookupElementBuilder
+                        .createWithSmartPointer(phpClass.getName(), phpClass)
+                        .withInsertHandler(TwigEscapedSlashInsertHandler.getInstance())
+                        .withTypeText(fqnNoLeadingSlash, true)
+                        .withIcon(phpClass.getIcon());
+
+                    resultSet.addElement(element);
+                }
+            }
+        }
+    }
+
     @NotNull
     private Collection<LookupElement> processVariables(@NotNull PsiElement psiElement, @NotNull Predicate<PhpType> filter, @NotNull Function<Map.Entry<String, Pair<String, LookupElement>>, String> map) {
         Project project = psiElement.getProject();
diff --git a/src/main/java/fr/adrienbrault/idea/symfony2plugin/templating/TwigTemplateGoToDeclarationHandler.java b/src/main/java/fr/adrienbrault/idea/symfony2plugin/templating/TwigTemplateGoToDeclarationHandler.java
@@ -168,6 +168,11 @@ public PsiElement[] getGotoDeclarationTargets(PsiElement psiElement, int offset,
             targets.addAll(getConstantGoto(psiElement));
         }
 
+        // enum('App\\Config\\SomeOption')
+        if (TwigPattern.getPrintBlockOrTagFunctionPattern("enum").accepts(psiElement)) {
+            targets.addAll(getEnumGoto(psiElement));
+        }
+
         // {# @var user \Foo #}
         if (TwigPattern.getTwigTypeDocBlockPattern().accepts(psiElement)) {
             targets.addAll(getVarClassGoto(psiElement));
@@ -378,6 +383,21 @@ private Collection<PsiElement> getConstantGoto(@NotNull PsiElement psiElement) {
         return targetPsiElements;
     }
 
+    @NotNull
+    private Collection<PsiElement> getEnumGoto(@NotNull PsiElement psiElement) {
+        String contents = psiElement.getText();
+        if(StringUtils.isBlank(contents)) {
+            return Collections.emptyList();
+        }
+
+        PhpClass phpClass = PhpElementsUtil.getClassInterface(psiElement.getProject(), contents.replace("\\\\", "\\"));
+        if (phpClass == null || !phpClass.isEnum()) {
+            return Collections.emptyList();
+        }
+
+        return Collections.singletonList(phpClass);
+    }
+
     /**
      * Extract class from inline variables
      *
diff --git a/src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/templating/TwigTemplateCompletionContributorTest.java b/src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/templating/TwigTemplateCompletionContributorTest.java
@@ -15,6 +15,7 @@ public void setUp() throws Exception {
         myFixture.copyFileToProject("classes.php");
         myFixture.copyFileToProject("TwigTemplateCompletionContributorTest.php");
         myFixture.copyFileToProject("routing.xml");
+        myFixture.copyFileToProject("TwigFilterExtension.php");
     }
 
     public String getTestDataPath() {
@@ -128,4 +129,25 @@ public void testSelfMacroImport() {
             "foobar"
         );
     }
+
+    public void testThatEnumProvidesCompletionForEnumClasses() {
+        // Test basic completion - enum should be available
+        assertCompletionContains(TwigFileType.INSTANCE, "{{ enum('<caret>') }}", "FooEnum");
+
+        // Ensure non-enum classes are NOT included
+        assertCompletionNotContains(TwigFileType.INSTANCE, "{{ enum('<caret>') }}", "FooConst");
+
+        // Test namespace-based completion
+        assertCompletionContains(TwigFileType.INSTANCE, "{{ enum('App\\<caret>') }}", "\\\\Bike\\\\FooEnum");
+        assertCompletionNotContains(TwigFileType.INSTANCE, "{{ enum('App\\<caret>') }}", "\\\\Bike\\\\FooConst");
+
+        // Test sub-namespace completion
+        assertCompletionContains(TwigFileType.INSTANCE, "{{ enum('App\\\\Bike\\\\<caret>') }}", "FooEnum");
+        assertCompletionNotContains(TwigFileType.INSTANCE, "{{ enum('App\\\\Bike\\\\<caret>') }}", "FooConst");
+
+        // Test that the insert handler properly escapes backslashes
+        assertCompletionResultEquals(TwigFileType.INSTANCE, "{{ enum('<caret>') }}", "{{ enum('App\\\\Bike\\\\FooEnum') }}", l -> "FooEnum".equals(l.getLookupString()));
+        assertCompletionResultEquals(TwigFileType.INSTANCE, "{{ enum('App\\<caret>') }}", "{{ enum('App\\\\\\Bike\\\\FooEnum') }}", l -> "\\\\Bike\\\\FooEnum".equals(l.getLookupString()));
+        assertCompletionResultEquals(TwigFileType.INSTANCE, "{{ enum('App\\\\Bike\\\\Foo<caret>') }}", "{{ enum('App\\\\Bike\\\\FooEnum') }}", l -> "FooEnum".equals(l.getLookupString()));
+    }
 }
diff --git a/src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/templating/TwigTemplateGoToDeclarationHandlerTest.java b/src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/templating/TwigTemplateGoToDeclarationHandlerTest.java
@@ -251,4 +251,15 @@ public void testFoo() {
             PlatformPatterns.psiElement(Method.class)
         );
     }
+
+    public void testThatEnumProvidesNavigationToEnumClass() {
+        assertNavigationMatch(TwigFileType.INSTANCE, "{{ enum('App\\\\Bike\\\\Foo<caret>Enum') }}", PlatformPatterns.psiElement(PhpClass.class).withName("FooEnum"));
+        assertNavigationMatch(TwigFileType.INSTANCE, "{{ enum('\\\\App\\\\Bike\\\\Foo<caret>Enum') }}", PlatformPatterns.psiElement(PhpClass.class).withName("FooEnum"));
+
+        assertNavigationMatch(TwigFileType.INSTANCE, "{% if foo == enum('App\\\\Bike\\\\Foo<caret>Enum') %}", PlatformPatterns.psiElement(PhpClass.class).withName("FooEnum"));
+        assertNavigationMatch(TwigFileType.INSTANCE, "{% set foo == enum('\\\\App\\\\Bike\\\\Foo<caret>Enum') %}", PlatformPatterns.psiElement(PhpClass.class).withName("FooEnum"));
+
+        // Should not navigate to non-enum classes
+        assertNavigationIsEmpty(TwigFileType.INSTANCE, "{{ enum('App\\\\Bike\\\\Foo<caret>Const') }}");
+    }
 }
diff --git a/src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/templating/fixtures/TwigFilterExtension.php b/src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/templating/fixtures/TwigFilterExtension.php
@@ -3,6 +3,8 @@
 namespace{
     function my_json_decode() {}
     function twig_test_even() {}
+    function constant($name) {}
+    function enum($name) {}
 
     interface Twig_ExtensionInterface {}
     interface Twig_Environment {}
@@ -43,6 +45,8 @@ public function getFunctions()
         return array(
             new \Twig_SimpleFunction('foobar', array($this, 'foobar')),
             new \Twig_SimpleFunction('json_bar', 'my_json_decode'),
+            new \Twig_SimpleFunction('constant', 'constant'),
+            new \Twig_SimpleFunction('enum', 'enum'),
         );
     }
 
diff --git a/src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/templating/fixtures/classes.php b/src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/templating/fixtures/classes.php
@@ -81,3 +81,9 @@ class Request
         public function isMethod(string $method) {}
     }
 }
+
+
+namespace App\Bike
+{
+    enum FooEnum {}
+}

Original file line number	Diff line number	Diff line change
`@@ -81,3 +81,9 @@ class Request`
`81`	`81`	`public function isMethod(string $method) {}`
`82`	`82`	`}`
`83`	`83`	`}`
	`84`	`+`
	`85`	`+`
	`86`	`+namespace App\Bike`
	`87`	`+{`
	`88`	`+ enum FooEnum {}`
	`89`	`+}`