Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

992: Added sections.xml file in context generation. #997

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions resources/META-INF/plugin.xml
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@
<action id="MagentoCreateIndexerFile" class="com.magento.idea.magento2plugin.actions.context.xml.NewIndexerXmlAction"/>
<action id="MagentoCreateViewFile" class="com.magento.idea.magento2plugin.actions.context.xml.NewViewXmlAction"/>
<action id="MagentoCreateFieldsetFile" class="com.magento.idea.magento2plugin.actions.context.xml.NewFieldsetXmlAction"/>
<action id="MagentoCreateSectionsFile" class="com.magento.idea.magento2plugin.actions.context.xml.NewSectionsXmlAction"/>
<!-- Context dependent actions -->
<separator/>
<add-to-group group-id="NewGroup" anchor="before" relative-to-action="NewXml"/>
Expand Down Expand Up @@ -581,6 +582,7 @@
<internalFileTemplate name="Magento Indexer XML"/>
<internalFileTemplate name="Magento View XML"/>
<internalFileTemplate name="Magento Fieldset XML"/>
<internalFileTemplate name="Magento Sections XML"/>

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

Expand Down
5 changes: 5 additions & 0 deletions resources/fileTemplates/internal/Magento Sections XML.xml.ft
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
#parse("XML File Header.xml")
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Customer:etc/sections.xsd">
</config>
20 changes: 20 additions & 0 deletions resources/fileTemplates/internal/Magento Sections XML.xml.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<!--
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
-->
<html lang="en">
<body>
<font face="verdana" size="-1">
<p>
Specify actions that trigger cache invalidation for private content blocks in a sections.xml configuration file
in the Vendor/ModuleName/etc/frontend directory. Magento invalidates the cache on a POST or PUT request.
</p>
<p>
Read more about sections.xml in the
<a href="https://devdocs.magento.com/guides/v2.4/extension-dev-guide/cache/page-caching/private-content.html">DevDocs</a>.
</p>
</font>
</body>
</html>
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
/*
* 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.ModuleSectionsXmlFile;
import com.magento.idea.magento2plugin.magento.packages.Areas;
import com.magento.idea.magento2plugin.magento.packages.ComponentType;
import com.magento.idea.magento2plugin.util.magento.GetMagentoModuleUtil;
import org.jetbrains.annotations.NotNull;

public class NewSectionsXmlAction extends AbstractContextAction {

public static final String ACTION_NAME = "Magento 2 Sections File";
public static final String ACTION_DESCRIPTION = "Create a new Magento 2 sections.xml file";

/**
* New sections.xml file generation action constructor.
*/
public NewSectionsXmlAction() {
super(ACTION_NAME, ACTION_DESCRIPTION, new ModuleSectionsXmlFile());
}

@Override
protected boolean isVisible(
final @NotNull GetMagentoModuleUtil.MagentoModuleData moduleData,
final @NotNull PsiDirectory targetDirectory,
final PsiFile targetFile
) {
final PsiDirectory parentDir = targetDirectory.getParentDirectory();
final PsiDirectory configDir = moduleData.getConfigDir();

if (parentDir == null || configDir == null) {
return false;
}

return targetDirectory.getName().equals(Areas.frontend.toString())
&& parentDir.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;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
/*
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/

package com.magento.idea.magento2plugin.magento.files;

import com.intellij.lang.Language;
import com.intellij.lang.xml.XMLLanguage;

public final class ModuleSectionsXmlFile implements ModuleFileInterface {

public static final String FILE_NAME = "sections.xml";
public static final String TEMPLATE = "Magento Sections XML";

@Override
public String getFileName() {
return FILE_NAME;
}

@Override
public String getTemplate() {
return TEMPLATE;
}

@Override
public Language getLanguage() {
return XMLLanguage.INSTANCE;
}
}