Add inspection for available / missing renderTypes

cedricziel · cedricziel · commit 80406bd018ce · 2017-10-30T14:49:35.000+01:00
diff --git a/src/main/java/com/cedricziel/idea/typo3/codeInspection/MissingRenderTypeInspection.java b/src/main/java/com/cedricziel/idea/typo3/codeInspection/MissingRenderTypeInspection.java
@@ -0,0 +1,63 @@
+package com.cedricziel.idea.typo3.codeInspection;
+
+import com.cedricziel.idea.typo3.psi.PhpElementsUtil;
+import com.cedricziel.idea.typo3.util.TCAUtil;
+import com.cedricziel.idea.typo3.util.TableUtil;
+import com.intellij.codeInsight.daemon.GroupNames;
+import com.intellij.codeInspection.ProblemsHolder;
+import com.intellij.psi.PsiElementVisitor;
+import com.jetbrains.php.lang.inspections.PhpInspection;
+import com.jetbrains.php.lang.psi.elements.PhpPsiElement;
+import com.jetbrains.php.lang.psi.elements.StringLiteralExpression;
+import com.jetbrains.php.lang.psi.visitors.PhpElementVisitor;
+import org.jetbrains.annotations.Nls;
+import org.jetbrains.annotations.NotNull;
+
+import static com.cedricziel.idea.typo3.psi.PhpElementsUtil.extractArrayIndexFromValue;
+
+public class MissingRenderTypeInspection extends PhpInspection {
+    @Nls
+    @NotNull
+    @Override
+    public String getGroupDisplayName() {
+        return GroupNames.BUGS_GROUP_NAME;
+    }
+
+    @NotNull
+    public String getDisplayName() {
+        return "Missing renderType definition";
+    }
+
+    @NotNull
+    public String getShortName() {
+        return "MissingRenderType";
+    }
+
+    @NotNull
+    @Override
+    public PsiElementVisitor buildVisitor(@NotNull ProblemsHolder problemsHolder, boolean b) {
+        return new PhpElementVisitor() {
+            @Override
+            public void visitPhpElement(PhpPsiElement element) {
+
+                boolean isArrayStringValue = PhpElementsUtil.isStringArrayValue().accepts(element);
+                if (!isArrayStringValue) {
+                    return;
+                }
+
+
+                String arrayIndex = extractArrayIndexFromValue(element);
+                if (arrayIndex != null && arrayIndex.equals("renderType")) {
+                    if (element instanceof StringLiteralExpression) {
+                        String tableName = ((StringLiteralExpression) element).getContents();
+                        boolean isValidRenderType = TCAUtil.getAvailableRenderTypes(element).contains(tableName);
+
+                        if (!isValidRenderType) {
+                            problemsHolder.registerProblem(element, "Missing renderType definition");
+                        }
+                    }
+                }
+            }
+        };
+    }
+}
diff --git a/src/main/java/com/cedricziel/idea/typo3/codeInspection/TYPO3InspectionToolProvider.java b/src/main/java/com/cedricziel/idea/typo3/codeInspection/TYPO3InspectionToolProvider.java
@@ -9,6 +9,7 @@ public Class[] getInspectionClasses() {
 
         return new Class[]{
                 ExtbasePropertyInjectionInspection.class,
+                MissingRenderTypeInspection.class,
                 MissingTableInspection.class,
         };
     }
diff --git a/src/main/resources/META-INF/plugin.xml b/src/main/resources/META-INF/plugin.xml
@@ -110,6 +110,7 @@ It is a great inspiration for possible solutions and parts of the code.</p>
 <h2>0.2.10</h2>
 <ul>
   <li>Autocompletion for TCA renderTypes</li>
+  <li>Inspection for valid renderTypes</li>
 </ul>
 
 <h2>0.2.9</h2>
diff --git a/src/main/resources/inspectionDescriptions/MissingRenderType.html b/src/main/resources/inspectionDescriptions/MissingRenderType.html
@@ -0,0 +1,5 @@
+<html>
+<body>
+<p>The renderType you want to use is not registered.</p>
+</body>
+</html>

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@ public Class[] getInspectionClasses() {`
`9`	`9`
`10`	`10`	`return new Class[]{`
`11`	`11`	`ExtbasePropertyInjectionInspection.class,`
	`12`	`+ MissingRenderTypeInspection.class,`
`12`	`13`	`MissingTableInspection.class,`
`13`	`14`	`};`
`14`	`15`	`}`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +<html>
 +<body>
 +<p>The renderType you want to use is not registered.</p>
 +</body>
 +</html>