Merge pull request #1001 from doninAtwix/994-new-context-crontab-xml-…

…file-action 994: Added crontab.xml file in context generation.
magento · Feb 17, 2022 · 3f1a674 · 3f1a674
2 parents 7869627 + 04aabfa
commit 3f1a674
Show file tree

Hide file tree

Showing 3 changed files with 60 additions and 1 deletion.
diff --git a/resources/META-INF/plugin.xml b/resources/META-INF/plugin.xml
@@ -73,6 +73,7 @@
             <action id="MagentoCreateFieldsetFile" class="com.magento.idea.magento2plugin.actions.context.xml.NewFieldsetXmlAction"/>
             <action id="MagentoCreateSectionsFile" class="com.magento.idea.magento2plugin.actions.context.xml.NewSectionsXmlAction"/>
             <action id="MagentoCreateEmailTemplatesFile" class="com.magento.idea.magento2plugin.actions.context.xml.NewEmailTemplatesXmlAction"/>
+            <action id="MagentoCreateCrontabFile" class="com.magento.idea.magento2plugin.actions.context.xml.NewCrontabXmlAction"/>
             <!-- Context dependent actions -->
             <separator/>
             <add-to-group group-id="NewGroup" anchor="before" relative-to-action="NewXml"/>

diff --git a/resources/fileTemplates/internal/Magento Cron Tab XML.xml.ft b/resources/fileTemplates/internal/Magento Cron Tab XML.xml.ft
@@ -1,4 +1,5 @@
 <?xml version="1.0"?>
 #parse("XML File Header.xml")
-<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Cron:etc/crontab.xsd">
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Cron:etc/crontab.xsd">
 </config>
diff --git a/src/com/magento/idea/magento2plugin/actions/context/xml/NewCrontabXmlAction.java b/src/com/magento/idea/magento2plugin/actions/context/xml/NewCrontabXmlAction.java
@@ -0,0 +1,57 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2plugin.actions.context.xml;
+
+import com.intellij.ide.fileTemplates.actions.AttributesDefaults;
+import com.intellij.psi.PsiDirectory;
+import com.intellij.psi.PsiFile;
+import com.magento.idea.magento2plugin.actions.context.AbstractContextAction;
+import com.magento.idea.magento2plugin.magento.files.CrontabXmlTemplate;
+import com.magento.idea.magento2plugin.magento.packages.ComponentType;
+import com.magento.idea.magento2plugin.magento.packages.Package;
+import com.magento.idea.magento2plugin.util.magento.GetMagentoModuleUtil;
+import org.jetbrains.annotations.NotNull;
+
+public class NewCrontabXmlAction extends AbstractContextAction {
+
+    public static final String ACTION_NAME = "Magento 2 Crontab File";
+    public static final String ACTION_DESCRIPTION = "Create a new Magento 2 crontab.xml file";
+
+    /**
+     * New crontab.xml file generation action constructor.
+     */
+    public NewCrontabXmlAction() {
+        super(ACTION_NAME, ACTION_DESCRIPTION, new CrontabXmlTemplate());
+    }
+
+    @Override
+    protected boolean isVisible(
+            final @NotNull GetMagentoModuleUtil.MagentoModuleData moduleData,
+            final @NotNull PsiDirectory targetDirectory,
+            final PsiFile targetFile
+    ) {
+        final PsiDirectory configDir = moduleData.getConfigDir();
+
+        if (configDir == null) {
+            return false;
+        }
+
+        return targetDirectory.getName().equals(Package.moduleBaseAreaDir)
+                && targetDirectory.equals(configDir)
+                && moduleData.getType().equals(ComponentType.module);
+    }
+
+
+    @Override
+    protected AttributesDefaults getProperties(
+            final @NotNull AttributesDefaults defaults,
+            final @NotNull GetMagentoModuleUtil.MagentoModuleData moduleData,
+            final PsiDirectory targetDirectory,
+            final PsiFile targetFile
+    ) {
+        return defaults;
+    }
+}