Skip to content

Add class-level attribute completion for #[Route], #[AsController] and #[IsGranted] #2505

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
+383 −54
Merged

Add class-level attribute completion for #[Route], #[AsController] and #[IsGranted] #2505

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
186 changes: 138 additions & 48 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 @@ -26,9 +26,14 @@
import java.util.Collection;

/**
* Provides completion for Symfony PHP attributes like #[Route()]
* Provides completion for Symfony PHP attributes like #[Route()] and #[AsController]
*
* Triggers when typing "#<caret>" before a public method
* Triggers when typing "#<caret>" before a public method or class
*
* Supports:
* - Class-level attributes: #[Route], #[AsController], #[IsGranted]
* - Method-level attributes: #[Route], #[IsGranted], #[Cache]
* - Twig extension attributes: #[AsTwigFilter], #[AsTwigFunction], #[AsTwigTest]
*
* @author Daniel Espendiller <daniel@espendiller.net>
*/
Expand All @@ -37,6 +42,7 @@ public class PhpAttributeCompletionContributor extends CompletionContributor {
private static final String ROUTE_ATTRIBUTE_FQN = "\\Symfony\\Component\\Routing\\Attribute\\Route";
private static final String IS_GRANTED_ATTRIBUTE_FQN = "\\Symfony\\Component\\Security\\Http\\Attribute\\IsGranted";
private static final String CACHE_ATTRIBUTE_FQN = "\\Symfony\\Component\\HttpKernel\\Attribute\\Cache";
private static final String AS_CONTROLLER_ATTRIBUTE_FQN = "\\Symfony\\Component\\HttpKernel\\Attribute\\AsController";
private static final String AS_TWIG_FILTER_ATTRIBUTE_FQN = "\\Twig\\Attribute\\AsTwigFilter";
private static final String AS_TWIG_FUNCTION_ATTRIBUTE_FQN = "\\Twig\\Attribute\\AsTwigFunction";
private static final String AS_TWIG_TEST_ATTRIBUTE_FQN = "\\Twig\\Attribute\\AsTwigTest";
Expand Down Expand Up @@ -67,21 +73,29 @@ protected void addCompletions(@NotNull CompletionParameters parameters, @NotNull
return;
}

// Check if we're before a public method (using shared logic from PhpAttributeCompletionPopupHandlerCompletionConfidence)
Method method = PhpAttributeCompletionPopupHandlerCompletionConfidence.getMethod(position);
if (method == null) {
return;
}

Collection<LookupElement> lookupElements = new ArrayList<>();

PhpClass containingClass = method.getContainingClass();
if (containingClass != null && AddRouteAttributeIntention.isControllerClass(containingClass)) {
lookupElements.addAll(getControllerCompletions(project));
}
// Check if we're before a public method (using shared logic from PhpAttributeCompletionPopupHandlerCompletionConfidence)
Method method = PhpAttributeCompletionPopupHandlerCompletionConfidence.getMethod(position);
if (method != null) {
// Method-level attribute completions
PhpClass containingClass = method.getContainingClass();
if (containingClass != null && AddRouteAttributeIntention.isControllerClass(containingClass)) {
lookupElements.addAll(getControllerMethodCompletions(project));
}

if (containingClass != null && isTwigExtensionClass(containingClass)) {
lookupElements.addAll(getTwigExtensionCompletions(project));
if (containingClass != null && isTwigExtensionClass(containingClass)) {
lookupElements.addAll(getTwigExtensionCompletions(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));
}
}
}

// Stop here - don't show other completions when typing "#" for attributes
Expand All @@ -91,7 +105,10 @@ protected void addCompletions(@NotNull CompletionParameters parameters, @NotNull
}
}

private Collection<LookupElement> getControllerCompletions(@NotNull Project project) {
/**
* Get controller method-level attribute completions (for methods in controller classes)
*/
private Collection<LookupElement> getControllerMethodCompletions(@NotNull Project project) {
Collection<LookupElement> lookupElements = new ArrayList<>();

// Add Route attribute completion
Expand Down Expand Up @@ -133,6 +150,51 @@ private Collection<LookupElement> getControllerCompletions(@NotNull Project proj
return lookupElements;
}

/**
* Get controller class-level attribute completions (for controller classes)
*/
private Collection<LookupElement> getControllerClassCompletions(@NotNull Project project) {
Collection<LookupElement> lookupElements = new ArrayList<>();

// Add Route attribute completion (for class-level route prefix)
if (PhpElementsUtil.hasClassOrInterface(project, ROUTE_ATTRIBUTE_FQN)) {
LookupElement routeLookupElement = LookupElementBuilder
.create("#[Route]")
.withIcon(Symfony2Icons.SYMFONY_ATTRIBUTE)
.withTypeText(StringUtils.stripStart(ROUTE_ATTRIBUTE_FQN, "\\"), true)
.withInsertHandler(new PhpAttributeInsertHandler(ROUTE_ATTRIBUTE_FQN, CursorPosition.INSIDE_QUOTES))
.bold();

lookupElements.add(routeLookupElement);
}

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

lookupElements.add(asControllerLookupElement);
}

// Add IsGranted attribute completion (for class-level security)
if (PhpElementsUtil.hasClassOrInterface(project, IS_GRANTED_ATTRIBUTE_FQN)) {
LookupElement isGrantedLookupElement = LookupElementBuilder
.create("#[IsGranted]")
.withIcon(Symfony2Icons.SYMFONY_ATTRIBUTE)
.withTypeText(StringUtils.stripStart(IS_GRANTED_ATTRIBUTE_FQN, "\\"), true)
.withInsertHandler(new PhpAttributeInsertHandler(IS_GRANTED_ATTRIBUTE_FQN, CursorPosition.INSIDE_QUOTES))
.bold();

lookupElements.add(isGrantedLookupElement);
}

return lookupElements;
}

private Collection<LookupElement> getTwigExtensionCompletions(@NotNull Project project) {
Collection<LookupElement> lookupElements = new ArrayList<>();

Expand Down Expand Up @@ -245,7 +307,9 @@ private enum CursorPosition {
/** Position cursor inside quotes: #[Attribute("<caret>")] */
INSIDE_QUOTES,
/** Position cursor inside parentheses: #[Attribute(<caret>)] */
INSIDE_PARENTHESES
INSIDE_PARENTHESES,
/** No parentheses needed: #[Attribute]<caret> */
NONE
}

/**
Expand All @@ -262,6 +326,28 @@ public void handleInsert(@NotNull InsertionContext context, @NotNull LookupEleme
int startOffset = context.getStartOffset();
int tailOffset = context.getTailOffset();

// IMPORTANT: Find the target class/method BEFORE modifying the document
// because PSI structure might change after deletions
PsiFile file = context.getFile();
PsiElement originalElement = file.findElementAt(startOffset);
if (originalElement == null) {
return;
}

// Determine the target context (method 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;
}
}

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

Expand All @@ -282,28 +368,8 @@ public void handleInsert(@NotNull InsertionContext context, @NotNull LookupEleme
document.deleteString(startOffset, tailOffset);
}

// First commit to get proper PSI
// Commit after deletion
PsiDocumentManager.getInstance(project).commitDocument(document);
PsiFile file = context.getFile();

// Find the insertion position - look for the next method
PsiElement elementAt = file.findElementAt(originalInsertionOffset);
PhpClass phpClass = PsiTreeUtil.getParentOfType(elementAt, PhpClass.class);

// Find the method we're adding the attribute to
Method targetMethod = null;
if (phpClass != null) {
for (Method method : phpClass.getOwnMethods()) {
if (method.getTextOffset() > originalInsertionOffset) {
targetMethod = method;
break;
}
}
}

if (targetMethod == null) {
return; // Can't find target method
}

// Extract class name from FQN (get the last part after the last backslash)
String className = attributeFqn.substring(attributeFqn.lastIndexOf('\\') + 1);
Expand All @@ -329,8 +395,27 @@ public void handleInsert(@NotNull InsertionContext context, @NotNull LookupEleme
// Adjust insertion offset by the shift caused by import
int currentInsertionOffset = originalInsertionOffset + offsetShift;

// Check if there's already a newline at the current position
// to avoid adding double newlines
CharSequence currentText = document.getCharsSequence();
boolean hasNewlineAfter = false;
if (currentInsertionOffset < currentText.length()) {
char nextChar = currentText.charAt(currentInsertionOffset);
hasNewlineAfter = (nextChar == '\n' || nextChar == '\r');
}

// Build attribute text based on cursor position
String attributeText = "#[" + className + (cursorPosition == CursorPosition.INSIDE_QUOTES ? "(\"\")]\n" : "()]\n");
String attributeText;
String newline = hasNewlineAfter ? "" : "\n";

if (cursorPosition == CursorPosition.INSIDE_QUOTES) {
attributeText = "#[" + className + "(\"\")]" + newline;
} else if (cursorPosition == CursorPosition.INSIDE_PARENTHESES) {
attributeText = "#[" + className + "()]" + newline;
} else {
// CursorPosition.NONE - no parentheses
attributeText = "#[" + className + "]" + newline;
}

// Insert at the cursor position where user typed "#"
document.insertString(currentInsertionOffset, attributeText);
Expand All @@ -352,22 +437,27 @@ public void handleInsert(@NotNull InsertionContext context, @NotNull LookupEleme
PsiElement elementInsideAttribute = finalFile.findElementAt(currentInsertionOffset + 3);
if (elementInsideAttribute != null) {
// Find the PhpAttribute element
PhpAttribute phpAttribute =
PsiTreeUtil.getParentOfType(elementInsideAttribute, PhpAttribute.class);
PhpAttribute phpAttribute = PsiTreeUtil.getParentOfType(elementInsideAttribute, PhpAttribute.class);

if (phpAttribute != null) {
int attributeStart = phpAttribute.getTextRange().getStartOffset();
int attributeEnd = phpAttribute.getTextRange().getEndOffset();
CharSequence attributeContent = document.getCharsSequence().subSequence(attributeStart, attributeEnd);

// Find cursor position based on mode
String searchChar = cursorPosition == CursorPosition.INSIDE_QUOTES ? "\"" : "(";
int searchIndex = attributeContent.toString().indexOf(searchChar);

if (searchIndex >= 0) {
// Position cursor right after the search character
int caretOffset = attributeStart + searchIndex + 1;
editor.getCaretModel().moveToOffset(caretOffset);
if (cursorPosition == CursorPosition.NONE) {
// For attributes without parentheses, position cursor at the end of the line
// (after the closing bracket and newline)
editor.getCaretModel().moveToOffset(attributeEnd + 1);
} else {
// Find cursor position based on mode
String searchChar = cursorPosition == CursorPosition.INSIDE_QUOTES ? "\"" : "(";
int searchIndex = attributeContent.toString().indexOf(searchChar);

if (searchIndex >= 0) {
// Position cursor right after the search character
int caretOffset = attributeStart + searchIndex + 1;
editor.getCaretModel().moveToOffset(caretOffset);
}
}
}
}
Expand Down
31 changes: 25 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 @@ -12,6 +12,7 @@
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 fr.adrienbrault.idea.symfony2plugin.Symfony2ProjectComponent;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
Expand All @@ -31,8 +32,8 @@ public ThreeState shouldSkipAutopopup(@NotNull Editor editor, @NotNull PsiElemen
return ThreeState.UNSURE;
}

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

Expand All @@ -48,7 +49,7 @@ public ThreeState shouldSkipAutopopup(@NotNull Editor editor, @NotNull PsiElemen

/**
* Triggers auto-popup completion after typing '#' character in PHP files
* when positioned before a public method (for PHP attributes like #[Route()])
* when positioned before a public method or class (for PHP attributes like #[Route()])
*
* @author Daniel Espendiller <daniel@espendiller.net>
*/
Expand All @@ -61,7 +62,7 @@ public static class PhpAttributeAutoPopupHandler extends TypedHandlerDelegate {

// Check if we're in a class context
int offset = editor.getCaretModel().getOffset();
if (!(file.findElementAt(offset - 2) instanceof PsiWhiteSpace)) {
if (!(file.findElementAt(offset - 2) instanceof PsiWhiteSpace) && !(file.findElementAt(offset - 1) instanceof PsiWhiteSpace)) {
return Result.CONTINUE;
}

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

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

Expand Down Expand Up @@ -100,4 +101,22 @@ public static class PhpAttributeAutoPopupHandler extends TypedHandlerDelegate {
? foundMethod
: null;
}

/**
* Finds a PhpClass associated with the given element.
* Returns the class if the element is a child of a class or if the next sibling is a class.
* Also handles cases where we're in the middle of an attribute list.
*
* @param element The PSI element to check
* @return The PhpClass if found, null otherwise
*/
public static @Nullable PhpClass getPhpClass(@NotNull PsiElement element) {
if (element.getParent() instanceof PhpClass phpClass) {
return phpClass;
} else if (PhpPsiUtil.getNextSiblingIgnoreWhitespace(element, true) instanceof PhpClass phpClass) {
return phpClass;
}

return null;
}
}
Loading