Merge pull request #2351 from Haehnchen/feature/2261-template-attribute

#2261 whitelist "Symfony\Bridge\Twig\Attribute\Template" for template usages to fix render detection
Haehnchen · Apr 17, 2024 · a6099a3 · a6099a3
2 parents 7a38bc3 + d295f25
commit a6099a3
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 14 deletions.
diff --git a/...ony2plugin/templating/inspection/TemplateExistsAnnotationPhpAttributeLocalInspection.java b/...ony2plugin/templating/inspection/TemplateExistsAnnotationPhpAttributeLocalInspection.java
@@ -38,7 +38,7 @@ public void visitElement(@NotNull PsiElement element) {
 
                 if (element instanceof PhpAttribute) {
                     String fqn = ((PhpAttribute) element).getFQN();
-                    if (fqn != null && PhpElementsUtil.isInstanceOf(element.getProject(), fqn, TwigUtil.TEMPLATE_ANNOTATION_CLASS)) {
+                    if (fqn != null && Arrays.stream(TwigUtil.TEMPLATE_ANNOTATION_CLASS).anyMatch(s -> PhpElementsUtil.isInstanceOf(element.getProject(), fqn, s))) {
                         annotate((PhpAttribute) element, holder);
                     }
                 }

diff --git a/...ava/fr/adrienbrault/idea/symfony2plugin/templating/util/PhpMethodVariableResolveUtil.java b/...ava/fr/adrienbrault/idea/symfony2plugin/templating/util/PhpMethodVariableResolveUtil.java
@@ -269,17 +269,19 @@ public boolean processPhpCallInstruction(PhpCallInstruction instruction) {
 
     public static class TemplateRenderVisitor {
         public static void processMethodAttributes(@NotNull Method method, Consumer<Triple<String, PhpNamedElement, FunctionReference>> consumer) {
-            Collection<@NotNull PhpAttribute> attributes = method.getAttributes(TwigUtil.TEMPLATE_ANNOTATION_CLASS);
-            for (PhpAttribute attribute : attributes) {
-                if (attribute.getArguments().isEmpty()) {
-                    // #[@Template()]
-                    visitMethodForGuessing(method, consumer);
-                } else {
-                    // [@Template("foobar.html.twig")]
-                    // #[@Template(template: "foobar.html.twig")]
-                    String template = PhpPsiAttributesUtil.getAttributeValueByNameAsStringWithDefaultParameterFallback(attribute, "template");
-                    if (StringUtils.isNotBlank(template)) {
-                        addTemplateWithScope(template, method, null, consumer);
+            for (String templateAnnotationClass : TwigUtil.TEMPLATE_ANNOTATION_CLASS) {
+                Collection<@NotNull PhpAttribute> attributes = method.getAttributes(templateAnnotationClass);
+                for (PhpAttribute attribute : attributes) {
+                    if (attribute.getArguments().isEmpty()) {
+                        // #[@Template()]
+                        visitMethodForGuessing(method, consumer);
+                    } else {
+                        // [@Template("foobar.html.twig")]
+                        // #[@Template(template: "foobar.html.twig")]
+                        String template = PhpPsiAttributesUtil.getAttributeValueByNameAsStringWithDefaultParameterFallback(attribute, "template");
+                        if (StringUtils.isNotBlank(template)) {
+                            addTemplateWithScope(template, method, null, consumer);
+                        }
                     }
                 }
             }
@@ -414,7 +416,7 @@ public static void processDocTag(@NotNull PhpDocTag phpDocTag, Consumer<Triple<S
             }
 
             String annotationFqnName = AnnotationBackportUtil.getClassNameReference(phpDocTag, fileImports);
-            if(!StringUtils.stripStart(TwigUtil.TEMPLATE_ANNOTATION_CLASS, "\\").equals(StringUtils.stripStart(annotationFqnName, "\\"))) {
+            if (Arrays.stream(TwigUtil.TEMPLATE_ANNOTATION_CLASS).noneMatch(s -> s.equals(annotationFqnName))) {
                 return;
             }
 

diff --git a/src/main/java/fr/adrienbrault/idea/symfony2plugin/templating/util/TwigUtil.java b/src/main/java/fr/adrienbrault/idea/symfony2plugin/templating/util/TwigUtil.java
@@ -125,7 +125,10 @@ public enum NamespaceType {
 
     public static final String[] IMG_FILES_EXTENSIONS = new String[] { "png", "jpg", "jpeg", "gif", "svg"};
 
-    public static final String TEMPLATE_ANNOTATION_CLASS = "\\Sensio\\Bundle\\FrameworkExtraBundle\\Configuration\\Template";
+    public static final String[] TEMPLATE_ANNOTATION_CLASS = new String[] {
+        "\\Sensio\\Bundle\\FrameworkExtraBundle\\Configuration\\Template",
+        "\\Symfony\\Bridge\\Twig\\Attribute\\Template",
+    };
 
     public static class TwigPathNamespaceComparator implements Comparator<TwigPath> {
         @Override