Add quickfix to migrate legacy classes

Author: cedricziel

src/main/java/com/cedricziel/idea/typo3/codeInspection/LegacyClassesForIDEInspection.java

@@ -0,0 +1,56 @@
+package com.cedricziel.idea.typo3.codeInspection;
+
+import com.cedricziel.idea.typo3.codeInspection.quickfix.LegacyClassesForIdeQuickFix;
+import com.cedricziel.idea.typo3.index.php.LegacyClassesForIDEIndex;
+import com.intellij.codeInsight.daemon.GroupNames;
+import com.intellij.codeInspection.ProblemHighlightType;
+import com.intellij.codeInspection.ProblemsHolder;
+import com.intellij.psi.PsiElementVisitor;
+import com.jetbrains.php.lang.inspections.PhpInspection;
+import com.jetbrains.php.lang.psi.elements.ClassConstantReference;
+import com.jetbrains.php.lang.psi.elements.ClassReference;
+import com.jetbrains.php.lang.psi.visitors.PhpElementVisitor;
+import org.jetbrains.annotations.Nls;
+import org.jetbrains.annotations.NotNull;
+
+public class LegacyClassesForIDEInspection extends PhpInspection {
+    @Nls
+    @NotNull
+    @Override
+    public String getDisplayName() {
+        return "Legacy class used";
+    }
+
+    @Nls
+    @NotNull
+    @Override
+    public String getGroupDisplayName() {
+        return GroupNames.BUGS_GROUP_NAME;
+    }
+
+    @NotNull
+    @Override
+    public String getShortName() {
+        return "LegacyClassesForIDE";
+    }
+
+    @NotNull
+    @Override
+    public PsiElementVisitor buildVisitor(@NotNull ProblemsHolder problemsHolder, boolean b) {
+        return new PhpElementVisitor() {
+            @Override
+            public void visitPhpClassReference(ClassReference classReference) {
+                if (classReference.getFQN() != null && LegacyClassesForIDEIndex.isLegacyClass(classReference.getProject(), classReference.getFQN())) {
+                    problemsHolder.registerProblem(classReference, "Legacy class usage", ProblemHighlightType.LIKE_DEPRECATED, new LegacyClassesForIdeQuickFix());
+                }
+
+                super.visitPhpClassReference(classReference);
+            }
+
+            @Override
+            public void visitPhpClassConstantReference(ClassConstantReference constantReference) {
+                super.visitPhpClassConstantReference(constantReference);
+            }
+        };
+    }
+}

src/main/java/com/cedricziel/idea/typo3/codeInspection/TYPO3InspectionToolProvider.java

@@ -18,6 +18,8 @@ public Class[] getInspectionClasses() {
                 MissingRenderTypeInspection.class,
                 MissingTableInspection.class,
                 InvalidQuantityInspection.class,
+                // Code Migration
+                LegacyClassesForIDEInspection.class,
                 // Extension Scanner
                 ClassConstantMatcherInspection.class,
                 ClassNameMatcherInspection.class,

src/main/java/com/cedricziel/idea/typo3/codeInspection/quickfix/LegacyClassesForIdeQuickFix.java

@@ -0,0 +1,54 @@
+package com.cedricziel.idea.typo3.codeInspection.quickfix;
+
+import com.cedricziel.idea.typo3.index.php.LegacyClassesForIDEIndex;
+import com.intellij.codeInspection.ProblemDescriptor;
+import com.intellij.openapi.project.DumbService;
+import com.intellij.openapi.project.Project;
+import com.intellij.psi.PsiElement;
+import com.intellij.util.IncorrectOperationException;
+import com.jetbrains.php.lang.inspections.quickfix.PhpQuickFixBase;
+import com.jetbrains.php.lang.psi.PhpPsiElementFactory;
+import com.jetbrains.php.lang.psi.elements.ClassReference;
+import org.jetbrains.annotations.Nls;
+import org.jetbrains.annotations.NotNull;
+
+public class LegacyClassesForIdeQuickFix extends PhpQuickFixBase {
+    @Nls
+    @NotNull
+    @Override
+    public String getFamilyName() {
+        return getName();
+    }
+
+    @Nls
+    @NotNull
+    @Override
+    public String getName() {
+        return "Migrate class usage";
+    }
+
+    @Override
+    public void applyFix(@NotNull Project project, @NotNull ProblemDescriptor descriptor) {
+
+        PsiElement psiElement = descriptor.getPsiElement();
+        if (DumbService.isDumb(project)) {
+            showIsInDumpModeMessage(project, psiElement);
+            return;
+        }
+
+        if (psiElement instanceof ClassReference) {
+            ClassReference classReference = (ClassReference) psiElement;
+            String fqn = classReference.getFQN();
+            if (fqn != null) {
+                String replacementFQN = LegacyClassesForIDEIndex.findReplacementClass(project, fqn);
+                if (replacementFQN != null) {
+                    try {
+                        classReference.replace(PhpPsiElementFactory.createClassReference(project, replacementFQN));
+                    } catch (IncorrectOperationException e) {
+                        showErrorMessage(project, "Could not replace class reference", psiElement);
+                    }
+                }
+            }
+        }
+    }
+}

src/main/resources/inspectionDescriptions/LegacyClassesForIDE.html

@@ -0,0 +1,7 @@
+<html>
+<body>
+<p>The class used is aliased for backwards compatibility. Migrate the usage to be on top of the changes.</p>
+<!-- tooltip end -->
+<p></p>
+</body>
+</html>