magento · VitaliyBoyko · Mar 31, 2020 · Mar 31, 2020
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,7 +11,8 @@
     * Create a New Magento 2 Module action
     * Code Inspection: Duplicated Observer Usage in events XML
     * Create a Plugin class for a class public method action
-    * Code Inspection: Warning regarding Cacheable false attribute in default XML  
+    * Code Inspection: Warning regarding Cacheable false attribute in default XML
+    * Create a Preference for a class action
 
 0.3.0
 ============= 

diff --git a/resources/META-INF/plugin.xml b/resources/META-INF/plugin.xml
@@ -60,6 +60,9 @@
         <action id="MagentoCreateAPlugin.Menu" class="com.magento.idea.magento2plugin.actions.generation.CreateAPluginAction">
             <add-to-group group-id="EditorPopupMenu"/>
         </action>
+        <action id="OverrideClassByAPreference.Menu" class="com.magento.idea.magento2plugin.actions.generation.OverrideClassByAPreferenceAction">
+            <add-to-group group-id="EditorPopupMenu"/>
+        </action>
     </actions>
 
     <extensions defaultExtensionNs="com.intellij">
@@ -130,6 +133,7 @@
         <internalFileTemplate name="Magento Module Registration Php"/>
         <internalFileTemplate name="Magento Module Xml"/>
         <internalFileTemplate name="Magento Module DI Xml"/>
+        <internalFileTemplate name="Magento Php Preference Class"/>
     </extensions>
 
     <application-components>

diff --git a/resources/fileTemplates/code/Magento Module DI Xml Preference.xml.ft b/resources/fileTemplates/code/Magento Module DI Xml Preference.xml.ft
@@ -0,0 +1 @@
+<preference for="${FOR}" type="${TYPE}" />
diff --git a/resources/fileTemplates/code/Magento Module DI Xml Preference.xml.html b/resources/fileTemplates/code/Magento Module DI Xml Preference.xml.html
@@ -0,0 +1,10 @@
+<!--
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<html>
+<body>
+</body>
+</html>
diff --git a/resources/fileTemplates/internal/Magento Php Preference Class.php.ft b/resources/fileTemplates/internal/Magento Php Preference Class.php.ft
@@ -0,0 +1,14 @@
+<?php
+#parse("PHP File Header.php")
+#if (${NAMESPACE})
+
+namespace ${NAMESPACE};
+#end
+#if (${USE})
+
+use ${USE};
+#end
+
+class ${NAME} #if (${EXTENDS})extends ${EXTENDS}#end {
+
+}
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/OverrideClassByAPreferenceAction.java b/src/com/magento/idea/magento2plugin/actions/generation/OverrideClassByAPreferenceAction.java
@@ -0,0 +1,76 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+package com.magento.idea.magento2plugin.actions.generation;
+
+import com.intellij.openapi.actionSystem.AnActionEvent;
+import com.intellij.openapi.actionSystem.PlatformDataKeys;
+import com.intellij.openapi.project.DumbAwareAction;
+import com.intellij.openapi.project.Project;
+import com.intellij.openapi.util.Pair;
+import com.intellij.psi.PsiFile;
+import com.jetbrains.php.lang.psi.PhpFile;
+import com.jetbrains.php.lang.psi.elements.PhpClass;
+import com.magento.idea.magento2plugin.MagentoIcons;
+import com.magento.idea.magento2plugin.actions.generation.dialog.OverrideClassByAPreferenceDialog;
+import com.magento.idea.magento2plugin.project.Settings;
+import com.magento.idea.magento2plugin.util.GetFirstClassOfFile;
+import org.jetbrains.annotations.NotNull;
+
+public class OverrideClassByAPreferenceAction extends DumbAwareAction {
+    public static String ACTION_NAME = "Override Class By A Preference...";
+    public static String ACTION_DESCRIPTION = "Create a new Magento 2 preference for the class";
+    private final GetFirstClassOfFile getFirstClassOfFile;
+    private PhpClass targetClass;
+
+    public OverrideClassByAPreferenceAction() {
+        super(ACTION_NAME, ACTION_DESCRIPTION, MagentoIcons.MODULE);
+        this.getFirstClassOfFile = GetFirstClassOfFile.getInstance();
+    }
+
+    public void update(AnActionEvent event) {
+        targetClass = null;
+        Project project = event.getData(PlatformDataKeys.PROJECT);
+        if (Settings.isEnabled(project)) {
+            Pair<PsiFile, PhpClass> pair = this.findPhpClass(event);
+            PsiFile psiFile = pair.getFirst();
+            PhpClass phpClass = pair.getSecond();
+            targetClass = phpClass;
+            if (!(psiFile instanceof PhpFile) && phpClass != null) {
+                this.setStatus(event, false);
+                return;
+            }
+        } else {
+            this.setStatus(event, false);
+            return;
+        }
+        this.setStatus(event, true);
+    }
+
+    private void setStatus(AnActionEvent event, boolean status) {
+        event.getPresentation().setVisible(status);
+        event.getPresentation().setEnabled(status);
+    }
+
+    @Override
+    public void actionPerformed(@NotNull AnActionEvent e) {
+        OverrideClassByAPreferenceDialog.open(e.getProject(), this.targetClass);
+    }
+
+    @Override
+    public boolean isDumbAware() {
+        return false;
+    }
+
+    private Pair<PsiFile, PhpClass> findPhpClass(@NotNull AnActionEvent event) {
+        PsiFile psiFile = event.getData(PlatformDataKeys.PSI_FILE);
+
+        PhpClass phpClass = null;
+        if (psiFile instanceof PhpFile) {
+            phpClass = getFirstClassOfFile.execute((PhpFile) psiFile);
+        }
+
+        return Pair.create(psiFile, phpClass);
+    }
+}
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/data/PreferenceDiXmFileData.java b/src/com/magento/idea/magento2plugin/actions/generation/data/PreferenceDiXmFileData.java
@@ -0,0 +1,49 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+package com.magento.idea.magento2plugin.actions.generation.data;
+
+import com.jetbrains.php.lang.psi.elements.PhpClass;
+
+public class PreferenceDiXmFileData {
+    private String preferenceModule;
+    private PhpClass targetClass;
+    private String preferenceFqn;
+    private String namespace;
+    private String area;
+
+    public PreferenceDiXmFileData(
+            String preferenceModule,
+            PhpClass targetClass,
+            String preferenceFqn,
+            String namespace,
+            String area
+    ) {
+        this.preferenceModule = preferenceModule;
+        this.targetClass = targetClass;
+        this.preferenceFqn = preferenceFqn;
+        this.namespace = namespace;
+        this.area = area;
+    }
+
+    public String getPreferenceModule() {
+        return preferenceModule;
+    }
+
+    public PhpClass getTargetClass() {
+        return targetClass;
+    }
+
+    public String getPreferenceFqn() {
+        return preferenceFqn;
+    }
+
+    public String getNamespace() {
+        return namespace;
+    }
+
+    public String getArea() {
+        return area;
+    }
+}
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/data/PreferenceFileData.java b/src/com/magento/idea/magento2plugin/actions/generation/data/PreferenceFileData.java
@@ -0,0 +1,63 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+package com.magento.idea.magento2plugin.actions.generation.data;
+
+import com.jetbrains.php.lang.psi.elements.PhpClass;
+
+public class PreferenceFileData {
+    private String preferenceDirectory;
+    private String preferenceClassName;
+    private String preferenceModule;
+    private PhpClass targetClass;
+    private String preferenceFqn;
+    private String namespace;
+    private boolean inheritClass;
+
+    public PreferenceFileData(
+            String preferenceDirectory,
+            String preferenceClassName,
+            String preferenceModule,
+            PhpClass targetClass,
+            String preferenceFqn,
+            String namespace,
+            boolean inheritClass
+    ) {
+        this.preferenceDirectory = preferenceDirectory;
+        this.preferenceClassName = preferenceClassName;
+        this.preferenceModule = preferenceModule;
+        this.targetClass = targetClass;
+        this.preferenceFqn = preferenceFqn;
+        this.namespace = namespace;
+        this.inheritClass = inheritClass;
+    }
+
+    public String getPreferenceClassName() {
+        return preferenceClassName;
+    }
+
+    public String getPreferenceDirectory() {
+        return preferenceDirectory;
+    }
+
+    public String getPreferenceModule() {
+        return preferenceModule;
+    }
+
+    public PhpClass getTargetClass() {
+        return targetClass;
+    }
+
+    public String getPreferenceFqn() {
+        return preferenceFqn;
+    }
+
+    public String getNamespace() {
+        return namespace;
+    }
+
+    public boolean isInheritClass() {
+        return inheritClass;
+    }
+}
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/AbstractDialog.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/AbstractDialog.java
@@ -0,0 +1,19 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+package com.magento.idea.magento2plugin.actions.generation.dialog;
+
+import javax.swing.*;
+import java.awt.*;
+
+public abstract class AbstractDialog extends JDialog {
+    protected void pushToMiddle() {
+        Dimension dim = Toolkit.getDefaultToolkit().getScreenSize();
+        this.setLocation(dim.width / 2  -this.getSize().width / 2, dim.height / 2 - this.getSize().height / 2);
+    }
+
+    protected void onCancel() {
+        this.setVisible(false);
+    }
+}
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/CreateAPluginDialog.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/CreateAPluginDialog.java
@@ -24,7 +24,7 @@
 import java.io.File;
 import java.util.List;
 
-public class CreateAPluginDialog extends JDialog {
+public class CreateAPluginDialog extends AbstractDialog {
     @NotNull
     private final Project project;
     private Method targetMethod;
@@ -100,11 +100,6 @@ private void fillTargetAreaOptions() {
         }
     }
 
-    private void pushToMiddle() {
-        Dimension dim = Toolkit.getDefaultToolkit().getScreenSize();
-        this.setLocation(dim.width / 2  -this.getSize().width / 2, dim.height / 2 - this.getSize().height / 2);
-    }
-
     private void onOK() {
         if (!validator.validate(project)) {
             return;
@@ -160,10 +155,6 @@ public String getPluginModule() {
         return this.pluginModule.getSelectedItem().toString();
     }
 
-    private void onCancel() {
-        this.setVisible(false);
-    }
-
     public static void open(@NotNull Project project, Method targetMethod, PhpClass targetClass) {
         CreateAPluginDialog dialog = new CreateAPluginDialog(project, targetMethod, targetClass);
         dialog.pack();

diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewMagentoModuleDialog.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewMagentoModuleDialog.java
@@ -28,7 +28,7 @@
 import java.awt.*;
 import java.awt.event.*;
 
-public class NewMagentoModuleDialog extends JDialog {
+public class NewMagentoModuleDialog extends AbstractDialog {
     @NotNull
     private final Project project;
     @NotNull
@@ -109,11 +109,6 @@ private void detectPackageName(@NotNull PsiDirectory initialBaseDir) {
         }
     }
 
-    private void pushToMiddle() {
-        Dimension dim = Toolkit.getDefaultToolkit().getScreenSize();
-        this.setLocation(dim.width / 2  -this.getSize().width / 2, dim.height / 2 - this.getSize().height / 2);
-    }
-
     private void onOK() {
         if (!validator.validate()) {
             return;
@@ -185,10 +180,6 @@ public String getModuleVersion() {
         return this.moduleVersion.getText().trim();
     }
 
-    private void onCancel() {
-        this.setVisible(false);
-    }
-
     public static void open(@NotNull Project project, @NotNull PsiDirectory initialBaseDir, @Nullable PsiFile file, @Nullable IdeView view, @Nullable Editor editor) {
         NewMagentoModuleDialog dialog = new NewMagentoModuleDialog(project, initialBaseDir, file, view, editor);
         dialog.pack();