feat: route parameters references #27

Author: xepozz

src/main/kotlin/com/github/tempest/framework/common/utils/StringUtils.kt

@@ -0,0 +1,8 @@
+package com.github.tempest.framework.common.utils
+
+object StringUtils {
+    fun findTextBetweenParenthesis(text: String): List<MatchResult> =
+        Regex("\\{([^}/]+)(?:[}/]|$)")
+            .findAll(text)
+            .toList()
+}

src/main/kotlin/com/github/tempest/framework/php/patterns/AttributeFqnCondition.kt

@@ -0,0 +1,12 @@
+package com.github.tempest.framework.php.patterns
+
+import com.intellij.patterns.ElementPattern
+import com.intellij.patterns.PropertyPatternCondition
+import com.jetbrains.php.lang.psi.elements.PhpAttribute
+
+class AttributeFqnCondition<T : PhpAttribute>(namePattern: ElementPattern<String>) :
+    PropertyPatternCondition<T?, String?>("withFqn", namePattern) {
+    override fun getPropertyValue(o: Any): String? {
+        return if (o is PhpAttribute) o.fqn else null
+    }
+}

src/main/kotlin/com/github/tempest/framework/router/references/ParameterReference.kt

@@ -0,0 +1,22 @@
+package com.github.tempest.framework.router.references
+
+import com.intellij.openapi.util.TextRange
+import com.intellij.psi.PsiElement
+import com.intellij.psi.PsiReferenceBase
+import com.jetbrains.php.completion.PhpLookupElement
+import com.jetbrains.php.lang.psi.elements.Parameter
+import com.jetbrains.php.lang.psi.elements.StringLiteralExpression
+
+class ParameterReference(
+    element: StringLiteralExpression,
+    textRange: TextRange,
+    val parameters: Array<Parameter>,
+    val resolvedParameter: Parameter? = null
+) : PsiReferenceBase<PsiElement>(element, textRange) {
+    override fun resolve() = resolvedParameter
+
+    override fun getVariants() =
+        parameters
+            .map { PhpLookupElement(it) }
+            .toTypedArray()
+}

src/main/kotlin/com/github/tempest/framework/router/references/RouteParametersReferenceContributor.kt

@@ -0,0 +1,57 @@
+package com.github.tempest.framework.router.references
+
+import com.github.tempest.framework.TempestFrameworkClasses
+import com.github.tempest.framework.common.utils.StringUtils
+import com.github.tempest.framework.php.patterns.AttributeFqnCondition
+import com.intellij.openapi.util.TextRange
+import com.intellij.patterns.PlatformPatterns
+import com.intellij.patterns.StandardPatterns
+import com.intellij.psi.PsiElement
+import com.intellij.psi.PsiReference
+import com.intellij.psi.PsiReferenceContributor
+import com.intellij.psi.PsiReferenceProvider
+import com.intellij.psi.PsiReferenceRegistrar
+import com.intellij.util.ProcessingContext
+import com.jetbrains.php.lang.psi.elements.Method
+import com.jetbrains.php.lang.psi.elements.ParameterList
+import com.jetbrains.php.lang.psi.elements.PhpAttribute
+import com.jetbrains.php.lang.psi.elements.StringLiteralExpression
+
+class RouteParametersReferenceContributor : PsiReferenceContributor() {
+    override fun registerReferenceProviders(registrar: PsiReferenceRegistrar) {
+        registrar.registerReferenceProvider(
+            PlatformPatterns.psiElement(StringLiteralExpression::class.java)
+                .withParent(PlatformPatterns.psiElement(ParameterList::class.java))
+                .withSuperParent(
+                    2,
+                    PlatformPatterns.psiElement(PhpAttribute::class.java)
+                        .with(AttributeFqnCondition(StandardPatterns.string().oneOf(TempestFrameworkClasses.ROUTES)))
+                ),
+            object : PsiReferenceProvider() {
+                override fun getReferencesByElement(
+                    element: PsiElement,
+                    context: ProcessingContext
+                ): Array<out PsiReference> {
+                    val element = element as? StringLiteralExpression ?: return emptyArray()
+                    val attribute = element.parent.parent as? PhpAttribute ?: return emptyArray()
+                    val method = attribute.owner as? Method ?: return emptyArray()
+                    val parameters = method.parameters
+                    if (parameters.isEmpty()) return emptyArray()
+
+                    return StringUtils.findTextBetweenParenthesis(element.text)
+                        .map { alias ->
+                            val rangeInElement = TextRange(
+                                alias.range.first + 1,
+                                alias.range.last
+                            )
+
+                            val parameter = method.getParameter(alias.groupValues[1])
+                            ParameterReference(element, rangeInElement, parameters, parameter)
+                        }
+                        .toTypedArray()
+                }
+
+            }
+        )
+    }
+}

src/main/resources/META-INF/plugin.xml

@@ -30,6 +30,9 @@
                 order="first"
                 language="HTML"
                 implementation="com.github.tempest.framework.views.references.ComponentReferenceContributor"/>
+        <psi.referenceContributor
+                language="PHP"
+                implementation="com.github.tempest.framework.router.references.RouteParametersReferenceContributor"/>
         <spellchecker.bundledDictionaryProvider
                 implementation="com.github.tempest.framework.SpellcheckingDictionaryProvider"/>
         <lang.inspectionSuppressor