Add support for Enums (closes #8)

rixafy · rixafy · commit 6594d423e6e5 · 2025-07-30T00:32:04.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## [1.5.0] - 2025-07-30
+
+### Added
+
+- Enum support
+
 ## [1.4.1] - 2025-07-05
 
 ### Added
diff --git a/gradle.properties b/gradle.properties
@@ -4,7 +4,7 @@ pluginGroup = org.nette.latte
 pluginName = Latte Support
 pluginRepositoryUrl = https://github.com/Rixafy/LatteSupport
 # SemVer format -> https://semver.org
-pluginVersion = 1.4.1
+pluginVersion = 1.5.0
 
 # Supported build number ranges and IntelliJ Platform versions -> https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html
 pluginSinceBuild = 222
diff --git a/src/main/java/org/nette/latte/completion/providers/LattePhpCompletionProvider.java b/src/main/java/org/nette/latte/completion/providers/LattePhpCompletionProvider.java
@@ -5,21 +5,17 @@
 import com.intellij.codeInsight.lookup.LookupElementBuilder;
 import com.intellij.psi.PsiElement;
 import com.intellij.util.ProcessingContext;
+import com.jetbrains.php.lang.psi.elements.*;
 import org.nette.latte.completion.handlers.PhpVariableInsertHandler;
 import org.nette.latte.php.NettePhpType;
 import org.nette.latte.psi.*;
-import org.nette.latte.psi.*;
 import org.nette.latte.psi.elements.BaseLattePhpElement;
 import org.nette.latte.utils.LatteTagsUtil;
 import org.nette.latte.utils.LatteTypesUtil;
 import org.nette.latte.utils.LatteUtil;
 import com.jetbrains.php.completion.PhpLookupElement;
 import com.jetbrains.php.completion.insert.PhpFieldInsertHandler;
 import com.jetbrains.php.completion.insert.PhpMethodInsertHandler;
-import com.jetbrains.php.lang.psi.elements.Field;
-import com.jetbrains.php.lang.psi.elements.Method;
-import com.jetbrains.php.lang.psi.elements.PhpClass;
-import com.jetbrains.php.lang.psi.elements.PhpModifier;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -103,6 +99,14 @@ private void attachPhpCompletions(
 
 		boolean isMagicPrefixed = result.getPrefixMatcher().getPrefix().startsWith("__");
 		for (PhpClass phpClass : phpClasses) {
+			if (isStatic) {
+				for (PhpEnumCase enumCase : phpClass.getEnumCases()) {
+					PhpLookupElement lookupItem = getPhpLookupElement(enumCase, enumCase.getName());
+					lookupItem.handler = PhpFieldInsertHandler.getInstance();
+					result.addElement(lookupItem);
+				}
+			}
+
 			for (Method method : phpClass.getMethods()) {
 				PhpModifier modifier = method.getModifier();
 				if (modifier.isPublic() && canShowCompletionElement(isStatic, modifier)) {
diff --git a/src/main/java/org/nette/latte/inspections/ConstantUsagesInspection.java b/src/main/java/org/nette/latte/inspections/ConstantUsagesInspection.java
@@ -5,6 +5,7 @@
 import com.intellij.psi.PsiElement;
 import com.intellij.psi.PsiFile;
 import com.intellij.psi.PsiRecursiveElementWalkingVisitor;
+import com.jetbrains.php.lang.psi.elements.PhpEnumCase;
 import org.nette.latte.php.NettePhpType;
 import org.nette.latte.psi.LatteFile;
 import org.nette.latte.psi.LattePhpConstant;
@@ -63,6 +64,12 @@ public void visitElement(PsiElement element) {
 								isFound = true;
 							}
 						}
+
+						for (PhpEnumCase enumCase : phpClass.getEnumCases()) {
+							if (enumCase.getName().equals(constantName)) {
+								isFound = true;
+							}
+						}
 					}
 
 					if (!isFound) {
diff --git a/src/main/java/org/nette/latte/php/LattePhpTypeDetector.java b/src/main/java/org/nette/latte/php/LattePhpTypeDetector.java
@@ -156,6 +156,16 @@ private static class Detector {
                 return customFunction == null ? NettePhpType.MIXED : NettePhpType.create(customFunction.getFunctionReturnType());
             }
 
+            // Special handling for enum::cases() method
+            if (name.equals("cases")) {
+                for (PhpClass phpClass : phpClasses) {
+                    if (phpClass.isEnum()) {
+                        // Return array of the enum type instead of UnitEnum[]
+                        return NettePhpType.create(phpClass.getFQN() + "[]");
+                    }
+                }
+            }
+
             List<String> types = new ArrayList<>();
             for (PhpClass phpClass : phpClasses) {
                 for (Method phpMethod : phpClass.getMethods()) {
@@ -224,6 +234,17 @@ private static class Detector {
 
             List<String> types = new ArrayList<>();
             for (PhpClass phpClass : phpClasses) {
+                // Check for enum cases first
+                if (phpClass.isEnum()) {
+                    for (com.jetbrains.php.lang.psi.elements.PhpEnumCase enumCase : phpClass.getEnumCases()) {
+                        if (enumCase.getName().equals(name)) {
+                            // For enum cases, the type is the enum class itself
+                            types.add(phpClass.getFQN());
+                        }
+                    }
+                }
+
+                // Check for constants
                 for (Field field : phpClass.getFields()) {
                     if (field.isConstant() && field.getModifier().isPublic() && field.getName().equals(name)) {
                         String foundType = field.getType().toString();
@@ -338,4 +359,4 @@ public void visitElement(@NotNull PsiElement element) {
         }
     }
 
-}
+}
diff --git a/src/main/java/org/nette/latte/php/LattePhpUtil.java b/src/main/java/org/nette/latte/php/LattePhpUtil.java
@@ -140,6 +140,29 @@ public static List<Field> getFieldsForPhpElement(@NotNull BaseLattePhpElement ps
         return fields;
     }
 
+    public static List<PhpEnumCase> getEnumCasesForPhpElement(@NotNull BaseLattePhpElement psiElement, @NotNull Project project) {
+        List<PhpEnumCase> out = new ArrayList<>();
+        NettePhpType phpType = psiElement.getPrevReturnType();
+        String name = psiElement.getPhpElementName();
+
+        Collection<PhpClass> phpClasses = phpType.getPhpClasses(project);
+        if (phpClasses.size() == 0) {
+            return out;
+        }
+
+        List<PhpEnumCase> enumCases = new ArrayList<>();
+        for (PhpClass phpClass : phpClasses) {
+            if (phpClass.isEnum()) {
+                for (PhpEnumCase enumCase : phpClass.getEnumCases()) {
+                    if (enumCase.getName().equals(name)) {
+                        enumCases.add(enumCase);
+                    }
+                }
+            }
+        }
+        return enumCases;
+    }
+
     public static List<Method> getMethodsForPhpElement(@NotNull LattePhpMethod psiElement, Project project) {
         List<Method> out = new ArrayList<>();
         Collection<PhpClass> phpClasses = psiElement.getPrevReturnType().getPhpClasses(project);
@@ -239,4 +262,4 @@ public static String normalizeClassName(@Nullable String className) {
 
         return normalized;
     }
-}
+}
diff --git a/src/main/java/org/nette/latte/reference/references/LattePhpConstantReference.java b/src/main/java/org/nette/latte/reference/references/LattePhpConstantReference.java
@@ -9,6 +9,7 @@
 import org.nette.latte.php.LattePhpUtil;
 import com.jetbrains.php.lang.psi.elements.Field;
 import com.jetbrains.php.lang.psi.elements.PhpClass;
+import com.jetbrains.php.lang.psi.elements.PhpEnumCase;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -51,14 +52,26 @@ public ResolveResult[] multiResolve(boolean b) {
             }
         }
 
+        List<PhpEnumCase> enumCases = LattePhpUtil.getEnumCasesForPhpElement((BaseLattePhpElement) getElement(), project);
+        for (PhpEnumCase enumCase : enumCases) {
+            if (enumCase.getName().equals(name)) {
+                results.add(new PsiElementResolveResult(enumCase));
+            }
+        }
+
         return results.toArray(new ResolveResult[0]);
     }
 
     @Nullable
     @Override
     public PsiElement resolve() {
         List<Field> fields = LattePhpUtil.getFieldsForPhpElement((BaseLattePhpElement) getElement(), project);
-        return fields.size() > 0 ? fields.get(0) : null;
+        if (fields.size() > 0) {
+            return fields.get(0);
+        }
+
+        List<PhpEnumCase> enumCases = LattePhpUtil.getEnumCasesForPhpElement((BaseLattePhpElement) getElement(), project);
+        return enumCases.size() > 0 ? enumCases.get(0) : null;
     }
 
     @NotNull
@@ -80,14 +93,23 @@ public boolean isReferenceTo(@NotNull PsiElement element) {
             }
         }
 
-        if (!(element instanceof Field)) {
-            return false;
+        if (element instanceof Field) {
+            PhpClass originalClass = ((Field) element).getContainingClass();
+            if (originalClass == null) {
+                return false;
+            }
+            return LattePhpUtil.isReferenceTo(originalClass, multiResolve(false), project, ((Field) element).getName());
         }
-        PhpClass originalClass = ((Field) element).getContainingClass();
-        if (originalClass == null) {
-            return false;
+
+        if (element instanceof PhpEnumCase) {
+            PhpClass originalClass = ((PhpEnumCase) element).getContainingClass();
+            if (originalClass == null) {
+                return false;
+            }
+            return LattePhpUtil.isReferenceTo(originalClass, multiResolve(false), project, ((PhpEnumCase) element).getName());
         }
-        return LattePhpUtil.isReferenceTo(originalClass, multiResolve(false), project, ((Field) element).getName());
+
+        return false;
     }
 
     @Override
@@ -98,4 +120,4 @@ public PsiElement handleElementRename(@NotNull String newName) {
         return getElement();
     }
 
-}
+}
diff --git a/src/main/java/org/nette/latte/reference/references/LattePhpVariableReference.java b/src/main/java/org/nette/latte/reference/references/LattePhpVariableReference.java
@@ -5,7 +5,6 @@
 import com.intellij.psi.*;
 import org.nette.latte.php.LattePhpVariableUtil;
 import org.nette.latte.php.NettePhpType;
-import org.nette.latte.psi.*;
 import org.nette.latte.psi.elements.BaseLattePhpElement;
 import org.nette.latte.utils.LattePhpCachedVariable;
 import org.nette.latte.utils.LatteUtil;

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`	`import com.intellij.psi.PsiElement;`
`6`	`6`	`import com.intellij.psi.PsiFile;`
`7`	`7`	`import com.intellij.psi.PsiRecursiveElementWalkingVisitor;`
	`8`	`+import com.jetbrains.php.lang.psi.elements.PhpEnumCase;`
`8`	`9`	`import org.nette.latte.php.NettePhpType;`
`9`	`10`	`import org.nette.latte.psi.LatteFile;`
`10`	`11`	`import org.nette.latte.psi.LattePhpConstant;`
`@@ -63,6 +64,12 @@ public void visitElement(PsiElement element) {`
`63`	`64`	`isFound = true;`
`64`	`65`	`}`
`65`	`66`	`}`
	`67`	`+`
	`68`	`+ for (PhpEnumCase enumCase : phpClass.getEnumCases()) {`
	`69`	`+ if (enumCase.getName().equals(constantName)) {`
	`70`	`+ isFound = true;`
	`71`	`+ }`
	`72`	`+ }`
`66`	`73`	`}`
`67`	`74`
`68`	`75`	`if (!isFound) {`