Skip to content

Add #[ExposeInTemplate], #[PreMount], and #[PostMount] attribute completions for Twig component methods and properties. #2507

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Haehnchen merged 1 commit into from
Dec 18, 2025
+396 −37
Merged

Add #[ExposeInTemplate], #[PreMount], and #[PostMount] attribute completions for Twig component methods and properties. #2507

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
162 changes: 131 additions & 31 deletions ...ava/fr/adrienbrault/idea/symfony2plugin/completion/PhpAttributeCompletionContributor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
import com.intellij.psi.util.PsiTreeUtil;
import com.intellij.util.ProcessingContext;
import com.jetbrains.php.lang.PhpLanguage;
import com.jetbrains.php.lang.psi.elements.Field;
import com.jetbrains.php.lang.psi.elements.Method;
import com.jetbrains.php.lang.psi.elements.PhpAttribute;
import com.jetbrains.php.lang.psi.elements.PhpClass;
Expand All @@ -30,11 +31,12 @@
/**
* Provides completion for Symfony PHP attributes like #[Route()] and #[AsController]
*
* Triggers when typing "#<caret>" before a public method or class
* Triggers when typing "#<caret>" before a public method, class, or property
*
* Supports:
* - Class-level attributes: #[Route], #[AsController], #[IsGranted], #[AsTwigComponent]
* - Method-level attributes: #[Route], #[IsGranted], #[Cache]
* - Method-level attributes: #[Route], #[IsGranted], #[Cache], #[ExposeInTemplate], #[PreMount], #[PostMount]
* - Property-level attributes: #[ExposeInTemplate]
* - Twig extension attributes: #[AsTwigFilter], #[AsTwigFunction], #[AsTwigTest]
*
* @author Daniel Espendiller <daniel@espendiller.net>
Expand All @@ -49,6 +51,9 @@ public class PhpAttributeCompletionContributor extends CompletionContributor {
private static final String AS_TWIG_FUNCTION_ATTRIBUTE_FQN = "\\Twig\\Attribute\\AsTwigFunction";
private static final String AS_TWIG_TEST_ATTRIBUTE_FQN = "\\Twig\\Attribute\\AsTwigTest";
private static final String AS_TWIG_COMPONENT_ATTRIBUTE_FQN = "\\Symfony\\UX\\TwigComponent\\Attribute\\AsTwigComponent";
private static final String EXPOSE_IN_TEMPLATE_ATTRIBUTE_FQN = "\\Symfony\\UX\\TwigComponent\\Attribute\\ExposeInTemplate";
private static final String PRE_MOUNT_ATTRIBUTE_FQN = "\\Symfony\\UX\\TwigComponent\\Attribute\\PreMount";
private static final String POST_MOUNT_ATTRIBUTE_FQN = "\\Symfony\\UX\\TwigComponent\\Attribute\\PostMount";
private static final String TWIG_EXTENSION_FQN = "\\Twig\\Extension\\AbstractExtension";

public PhpAttributeCompletionContributor() {
Expand Down Expand Up @@ -90,17 +95,31 @@ protected void addCompletions(@NotNull CompletionParameters parameters, @NotNull
if (containingClass != null && isTwigExtensionClass(containingClass)) {
lookupElements.addAll(getTwigExtensionCompletions(project));
}

if (containingClass != null && hasAsTwigComponentAttribute(containingClass)) {
lookupElements.addAll(getTwigComponentMethodCompletions(project));
}
} else {
// Check if we're before a class
PhpClass phpClass = PhpAttributeCompletionPopupHandlerCompletionConfidence.getPhpClass(position);
if (phpClass != null) {
// Class-level attribute completions
if (AddRouteAttributeIntention.isControllerClass(phpClass)) {
lookupElements.addAll(getControllerClassCompletions(project));
// Check if we're before a property/field
Field field = PhpAttributeCompletionPopupHandlerCompletionConfidence.getField(position);
if (field != null) {
// Property-level attribute completions
PhpClass containingClass = field.getContainingClass();
if (containingClass != null && hasAsTwigComponentAttribute(containingClass)) {
lookupElements.addAll(getTwigComponentPropertyCompletions(project));
}
} else {
// Check if we're before a class
PhpClass phpClass = PhpAttributeCompletionPopupHandlerCompletionConfidence.getPhpClass(position);
if (phpClass != null) {
// Class-level attribute completions
if (AddRouteAttributeIntention.isControllerClass(phpClass)) {
lookupElements.addAll(getControllerClassCompletions(project));
}

if (isTwigComponentClass(project, phpClass)) {
lookupElements.addAll(getTwigComponentClassCompletions(project));
if (isTwigComponentClass(project, phpClass)) {
lookupElements.addAll(getTwigComponentClassCompletions(project));
}
}
}
}
Expand Down Expand Up @@ -256,7 +275,7 @@ private Collection<LookupElement> getTwigComponentClassCompletions(@NotNull Proj
.create("#[AsTwigComponent]")
.withIcon(Symfony2Icons.SYMFONY_ATTRIBUTE)
.withTypeText(StringUtils.stripStart(AS_TWIG_COMPONENT_ATTRIBUTE_FQN, "\\"), true)
.withInsertHandler(new PhpAttributeInsertHandler(AS_TWIG_COMPONENT_ATTRIBUTE_FQN, CursorPosition.INSIDE_QUOTES))
.withInsertHandler(new PhpAttributeInsertHandler(AS_TWIG_COMPONENT_ATTRIBUTE_FQN, CursorPosition.NONE))
.bold();

lookupElements.add(lookupElement);
Expand Down Expand Up @@ -352,6 +371,81 @@ private boolean isTwigExtensionClass(@NotNull PhpClass phpClass) {
return false;
}

/**
* Get attribute completions for public methods in AsTwigComponent classes
* Includes: ExposeInTemplate, PreMount, PostMount
*/
private Collection<LookupElement> getTwigComponentMethodCompletions(@NotNull Project project) {
Collection<LookupElement> lookupElements = new ArrayList<>();

// Add ExposeInTemplate attribute completion
if (PhpElementsUtil.hasClassOrInterface(project, EXPOSE_IN_TEMPLATE_ATTRIBUTE_FQN)) {
LookupElement lookupElement = LookupElementBuilder
.create("#[ExposeInTemplate]")
.withIcon(Symfony2Icons.SYMFONY_ATTRIBUTE)
.withTypeText(StringUtils.stripStart(EXPOSE_IN_TEMPLATE_ATTRIBUTE_FQN, "\\"), true)
.withInsertHandler(new PhpAttributeInsertHandler(EXPOSE_IN_TEMPLATE_ATTRIBUTE_FQN, CursorPosition.NONE))
.bold();

lookupElements.add(lookupElement);
}

// Add PreMount attribute completion
if (PhpElementsUtil.hasClassOrInterface(project, PRE_MOUNT_ATTRIBUTE_FQN)) {
LookupElement lookupElement = LookupElementBuilder
.create("#[PreMount]")
.withIcon(Symfony2Icons.SYMFONY_ATTRIBUTE)
.withTypeText(StringUtils.stripStart(PRE_MOUNT_ATTRIBUTE_FQN, "\\"), true)
.withInsertHandler(new PhpAttributeInsertHandler(PRE_MOUNT_ATTRIBUTE_FQN, CursorPosition.NONE))
.bold();

lookupElements.add(lookupElement);
}

// Add PostMount attribute completion
if (PhpElementsUtil.hasClassOrInterface(project, POST_MOUNT_ATTRIBUTE_FQN)) {
LookupElement lookupElement = LookupElementBuilder
.create("#[PostMount]")
.withIcon(Symfony2Icons.SYMFONY_ATTRIBUTE)
.withTypeText(StringUtils.stripStart(POST_MOUNT_ATTRIBUTE_FQN, "\\"), true)
.withInsertHandler(new PhpAttributeInsertHandler(POST_MOUNT_ATTRIBUTE_FQN, CursorPosition.NONE))
.bold();

lookupElements.add(lookupElement);
}

return lookupElements;
}

/**
* Get attribute completions for properties in AsTwigComponent classes
* Includes: ExposeInTemplate
*/
private Collection<LookupElement> getTwigComponentPropertyCompletions(@NotNull Project project) {
Collection<LookupElement> lookupElements = new ArrayList<>();

// Add ExposeInTemplate attribute completion
if (PhpElementsUtil.hasClassOrInterface(project, EXPOSE_IN_TEMPLATE_ATTRIBUTE_FQN)) {
LookupElement lookupElement = LookupElementBuilder
.create("#[ExposeInTemplate]")
.withIcon(Symfony2Icons.SYMFONY_ATTRIBUTE)
.withTypeText(StringUtils.stripStart(EXPOSE_IN_TEMPLATE_ATTRIBUTE_FQN, "\\"), true)
.withInsertHandler(new PhpAttributeInsertHandler(EXPOSE_IN_TEMPLATE_ATTRIBUTE_FQN, CursorPosition.INSIDE_QUOTES))
.bold();

lookupElements.add(lookupElement);
}

return lookupElements;
}

/**
* Check if the class has the #[AsTwigComponent] attribute
*/
private boolean hasAsTwigComponentAttribute(@NotNull PhpClass phpClass) {
return !phpClass.getAttributes(AS_TWIG_COMPONENT_ATTRIBUTE_FQN).isEmpty();
}

/**
* Check if we're in a context where typing "#" for attributes makes sense
* (i.e., after "#" character with whitespace before it)
Expand Down Expand Up @@ -410,40 +504,46 @@ public void handleInsert(@NotNull InsertionContext context, @NotNull LookupEleme
return;
}

// Determine the target context (method or class) dynamically
// Determine the target context (method, field, or class) dynamically
PhpClass phpClass;
Method targetMethod = PhpAttributeCompletionPopupHandlerCompletionConfidence.getMethod(originalElement);
if (targetMethod != null) {
// We're in a method context
phpClass = targetMethod.getContainingClass();
} else {
// Try class context
phpClass = PhpAttributeCompletionPopupHandlerCompletionConfidence.getPhpClass(originalElement);
if (phpClass == null) {
return;
// Try field context
Field targetField = PhpAttributeCompletionPopupHandlerCompletionConfidence.getField(originalElement);
if (targetField != null) {
phpClass = targetField.getContainingClass();
} else {
// Try class context
phpClass = PhpAttributeCompletionPopupHandlerCompletionConfidence.getPhpClass(originalElement);
if (phpClass == null) {
return;
}
}
}

// Store the original insertion offset (where user typed "#")
int originalInsertionOffset = startOffset;

// Check if there's a "#" before the completion position
// If yes, we need to delete it to avoid "##[Attribute()]"
if (startOffset > 0) {
CharSequence text = document.getCharsSequence();
if (text.charAt(startOffset - 1) == '#') {
// Delete the "#" that was typed
document.deleteString(startOffset - 1, tailOffset);
originalInsertionOffset = startOffset - 1;
} else {
// Delete just the dummy identifier
document.deleteString(startOffset, tailOffset);
}
} else {
// Delete just the dummy identifier
document.deleteString(startOffset, tailOffset);
// Find and delete the "#" before the completion position to avoid "##[Attribute()]"
// Check the 1-2 positions immediately before startOffset
CharSequence text = document.getCharsSequence();
int deleteStart = startOffset;

// Check startOffset - 1 and startOffset - 2 for the "#" character
if (startOffset > 0 && text.charAt(startOffset - 1) == '#') {
deleteStart = startOffset - 1;
} else if (startOffset > 1 && text.charAt(startOffset - 2) == '#') {
// Handle case where there might be a single whitespace between # and dummy identifier
deleteStart = startOffset - 2;
}

// Delete from the "#" (or startOffset if no "#" found) to tailOffset
document.deleteString(deleteStart, tailOffset);
originalInsertionOffset = deleteStart;

// Commit after deletion
PsiDocumentManager.getInstance(project).commitDocument(document);

Expand Down
46 changes: 40 additions & 6 deletions ...dea/symfony2plugin/completion/PhpAttributeCompletionPopupHandlerCompletionConfidence.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@
import com.intellij.psi.PsiElement;
import com.intellij.psi.PsiFile;
import com.intellij.psi.PsiWhiteSpace;
import com.intellij.psi.util.PsiTreeUtil;
import com.intellij.util.ThreeState;
import com.jetbrains.php.lang.psi.PhpFile;
import com.jetbrains.php.lang.psi.PhpPsiUtil;
import com.jetbrains.php.lang.psi.elements.Method;
import com.jetbrains.php.lang.psi.elements.PhpClass;
import com.jetbrains.php.lang.psi.elements.*;
import fr.adrienbrault.idea.symfony2plugin.Symfony2ProjectComponent;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
Expand All @@ -32,8 +32,8 @@ public ThreeState shouldSkipAutopopup(@NotNull Editor editor, @NotNull PsiElemen
return ThreeState.UNSURE;
}

// Check if we're before a method or a class
if (getMethod(contextElement) == null && getPhpClass(contextElement) == null) {
// Check if we're before a method, class, or field
if (getMethod(contextElement) == null && getPhpClass(contextElement) == null && getField(contextElement) == null) {
return ThreeState.UNSURE;
}

Expand Down Expand Up @@ -71,8 +71,8 @@ public static class PhpAttributeAutoPopupHandler extends TypedHandlerDelegate {
return Result.CONTINUE;
}

// Check if we're before a method or a class
if (getMethod(element) == null && getPhpClass(element) == null) {
// Check if we're before a method, class, or field
if (getMethod(element) == null && getPhpClass(element) == null && getField(element) == null) {
return Result.CONTINUE;
}

Expand Down Expand Up @@ -119,4 +119,38 @@ public static class PhpAttributeAutoPopupHandler extends TypedHandlerDelegate {

return null;
}

/**
* Finds a Field (property) associated with the given element.
* Returns the field if the element is a child of a field or if the next sibling is a field.
*
* @param element The PSI element to check
* @return The Field if found, null otherwise
*/
public static @Nullable Field getField(@NotNull PsiElement element) {
PsiElement nextSiblingIgnoreWhitespace = PhpPsiUtil.getNextSiblingIgnoreWhitespace(element, true);
if (nextSiblingIgnoreWhitespace instanceof PhpModifierList phpModifierList && phpModifierList.hasPublic()) {
if (phpModifierList.getNextPsiSibling() instanceof Field field) {
return field;
}
}

if (nextSiblingIgnoreWhitespace instanceof PhpPsiElement phpPsiElement) {
PhpPsiElement firstPsiChild = phpPsiElement.getFirstPsiChild();
if (firstPsiChild instanceof PhpModifierList phpModifierList && phpModifierList.hasPublic()) {
PhpPsiElement nextPsiSibling = phpModifierList.getNextPsiSibling();

if (nextPsiSibling instanceof Field field) {
return field;
} else if(nextPsiSibling instanceof PhpFieldType phpFieldType) {
PhpPsiElement nextPsiSibling1 = phpFieldType.getNextPsiSibling();
if (nextPsiSibling1 instanceof Field field1) {
return field1;
}
}
}
}

return null;
}
}
Loading