Skip to content

Commit b924a52

Browse files
bohdan-harniukbohdan-harniuk
authored
Merge pull request #983 from doninAtwix/980-new-context-widget-xml-file-action
980: Added widget.xml file in context generation
2 parents 92d1b14 + accf8b5 commit b924a52

File tree

5 files changed

+113
-0
lines changed

5 files changed

+113
-0
lines changed

‎resources/META-INF/plugin.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@
6666
<action id="MagentoCreateConfigFile" class="com.magento.idea.magento2plugin.actions.context.xml.NewConfigXmlAction"/>
6767
<action id="MagentoCreateSystemFile" class="com.magento.idea.magento2plugin.actions.context.xml.NewSystemXmlAction"/>
6868
<action id="MagentoCreateExtensionAttributesFile" class="com.magento.idea.magento2plugin.actions.context.xml.NewExtensionAttributesXmlAction"/>
69+
<action id="MagentoCreateWidgetFile" class="com.magento.idea.magento2plugin.actions.context.xml.NewWidgetXmlAction"/>
6970
<!-- Context dependent actions -->
7071
<separator/>
7172
<add-to-group group-id="NewGroup" anchor="before" relative-to-action="NewXml"/>
@@ -571,6 +572,7 @@
571572
<internalFileTemplate name="Web API Interface"/>
572573
<internalFileTemplate name="Magento Config XML"/>
573574
<internalFileTemplate name="Magento Extension Attributes XML"/>
575+
<internalFileTemplate name="Magento Widget XML"/>
574576

575577
<defaultLiveTemplates file="/liveTemplates/MagentoPWA.xml"/>
576578

‎resources/fileTemplates/internal/Magento Widget XML.xml.ft

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
#parse("XML File Header.xml")
3+
<widgets xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4+
xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Widget:etc/widget.xsd">
5+
</widgets>

‎resources/fileTemplates/internal/Magento Widget XML.xml.html

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<!--
2+
/**
3+
* Copyright © Magento, Inc. All rights reserved.
4+
* See COPYING.txt for license details.
5+
*/
6+
-->
7+
<html lang="en">
8+
<body>
9+
<font face="verdana" size="-1">
10+
<p>
11+
Widgets provide powerful features in Magento 2, that are used to add dynamic or static content to store’s pages.
12+
</p>
13+
<p>
14+
Read more about widget.xml in the
15+
<a href="https://devdocs.magento.com/guides/v2.4/ext-best-practices/tutorials/custom-widget.html">DevDocs</a>.
16+
</p>
17+
</font>
18+
</body>
19+
</html>

‎src/com/magento/idea/magento2plugin/actions/context/xml/NewWidgetXmlAction.java

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
/*
2+
* Copyright © Magento, Inc. All rights reserved.
3+
* See COPYING.txt for license details.
4+
*/
5+
6+
package com.magento.idea.magento2plugin.actions.context.xml;
7+
8+
import com.intellij.ide.fileTemplates.actions.AttributesDefaults;
9+
import com.intellij.psi.PsiDirectory;
10+
import com.intellij.psi.PsiFile;
11+
import com.magento.idea.magento2plugin.actions.context.AbstractContextAction;
12+
import com.magento.idea.magento2plugin.magento.files.ModuleWidgetXmlFile;
13+
import com.magento.idea.magento2plugin.magento.packages.ComponentType;
14+
import com.magento.idea.magento2plugin.magento.packages.Package;
15+
import com.magento.idea.magento2plugin.util.magento.GetMagentoModuleUtil;
16+
import org.jetbrains.annotations.NotNull;
17+
18+
public class NewWidgetXmlAction extends AbstractContextAction {
19+
20+
public static final String ACTION_NAME = "Magento 2 Widget File";
21+
public static final String ACTION_DESCRIPTION = "Create a new Magento 2 widget.xml file";
22+
23+
/**
24+
* New widget.xml file generation action constructor.
25+
*/
26+
public NewWidgetXmlAction() {
27+
super(ACTION_NAME, ACTION_DESCRIPTION, new ModuleWidgetXmlFile());
28+
}
29+
30+
@Override
31+
protected boolean isVisible(
32+
final @NotNull GetMagentoModuleUtil.MagentoModuleData moduleData,
33+
final @NotNull PsiDirectory targetDirectory,
34+
final PsiFile targetFile
35+
) {
36+
final PsiDirectory configDir = moduleData.getConfigDir();
37+
38+
if (configDir == null) {
39+
return false;
40+
}
41+
42+
return targetDirectory.getName().equals(Package.moduleBaseAreaDir)
43+
&& targetDirectory.equals(configDir)
44+
&& moduleData.getType().equals(ComponentType.module);
45+
}
46+
47+
48+
@Override
49+
protected AttributesDefaults getProperties(
50+
final @NotNull AttributesDefaults defaults,
51+
final @NotNull GetMagentoModuleUtil.MagentoModuleData moduleData,
52+
final PsiDirectory targetDirectory,
53+
final PsiFile targetFile
54+
) {
55+
return defaults;
56+
}
57+
}

‎src/com/magento/idea/magento2plugin/magento/files/ModuleWidgetXmlFile.java

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
/*
2+
* Copyright © Magento, Inc. All rights reserved.
3+
* See COPYING.txt for license details.
4+
*/
5+
6+
package com.magento.idea.magento2plugin.magento.files;
7+
8+
import com.intellij.lang.Language;
9+
import com.intellij.lang.xml.XMLLanguage;
10+
11+
public final class ModuleWidgetXmlFile implements ModuleFileInterface {
12+
13+
public static final String FILE_NAME = "widget.xml";
14+
public static final String TEMPLATE = "Magento Widget XML";
15+
16+
@Override
17+
public String getFileName() {
18+
return FILE_NAME;
19+
}
20+
21+
@Override
22+
public String getTemplate() {
23+
return TEMPLATE;
24+
}
25+
26+
@Override
27+
public Language getLanguage() {
28+
return XMLLanguage.INSTANCE;
29+
}
30+
}

0 commit comments

Comments
 (0)