Magento 2: удалить блок в зависимости от настроек конфигурации

13

Я пытаюсь удалить блок с определенной страницы (будь то интерфейс или бэкэнд), но только если установлен определенный флаг конфигурации true.
Давайте возьмем пример.
Я хочу удалить блок с именем dashboardиз панели администратора.

Блок определяется в adminhtml_dashboard_index.xmlфайле из Magento_Backendмодуля:

<referenceContainer name="content">
    <block class="Magento\Backend\Block\Dashboard" name="dashboard"/>
</referenceContainer>

Благодаря ответу Адама я могу сделать это вadminhtml_dashboard_index.xml

<body>
    <referenceBlock name="dashboard" remove="true"  />
</body>

Но я хочу взять его на себя и удалить этот блок только в том случае, если значение параметра config с путем dashboard/settings/removeимеет значение 1.
Подход макета xml был бы замечательным, но я также буду подходить наблюдателем.

magento2 layout blocks Мариус
источник

Мариус, вы знаете, что то же самое доступно для events.xml? Я имею в виду, что я хочу запустить своего наблюдателя, если конфигурация

включена

Если вы хотите пойти с helperклассом, см. Https://stackoverflow.com/questions/47237179/magento-2-i-want-to-add-ifconfig-in-override-block-xml?rq=1

Asrar

17

Я не смог найти способ сделать это с помощью макета, но вот пример того, как вы можете сделать это с наблюдателями (при условии, что они расширяют блок Template) ...

Создайте ваш файл events.xml в etc / events.xml

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
    <event name="view_block_abstract_to_html_before">
        <observer name="remove_block" instance="[Vendor]\[ModuleName]\Model\Observer\RemoveBlock" />
    </event>
</config>

Создать наблюдателя

<?php

namespace [Vendor]\[ModuleName]\Model\Observer;

use Magento\Framework\Event\Observer;
use Magento\Framework\Event\ObserverInterface;

class RemoveBlock implements ObserverInterface
{
    protected $_scopeConfig;

    public function __construct(
        \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
    ) {
        $this->_scopeConfig = $scopeConfig;
    }

    public function execute(Observer $observer)
    {
        /** @var \Magento\Framework\View\Element\Template $block */
        $block = $observer->getBlock();
        if ($block->getType() == 'Magento\Backend\Block\Dashboard') {
            $remove = $this->_scopeConfig->getValue(
                'dashboard/settings/remove',
                \Magento\Store\Model\ScopeInterface::SCOPE_STORE
            );

            if ($remove) {
                $block->setTemplate(false);
            }
        }
    }
}

В основном _toHtml проверяет, есть ли шаблон. Если нет, он возвращает ''.

РЕДАКТИРОВАТЬ

После еще нескольких копаний я нашел способ сделать это дальше по цепочке.

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
    <event name="layout_generate_blocks_after">
        <observer name="remove_block" instance="[Vendor]\[ModuleName]\Model\Observer\RemoveBlock" />
    </event>
</config>

И наблюдатель ...

<?php

namespace [Vendor]\[ModuleName]\Model\Observer;

use Magento\Framework\Event\Observer;
use Magento\Framework\Event\ObserverInterface;

class RemoveBlock implements ObserverInterface
{
    protected $_scopeConfig;

    public function __construct(
        \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
    ) {
        $this->_scopeConfig = $scopeConfig;
    }

    public function execute(Observer $observer)
    {
        /** @var \Magento\Framework\View\Layout $layout */
        $layout = $observer->getLayout();
        $block = $layout->getBlock('dashboard');
        if ($block) {
            $remove = $this->_scopeConfig->getValue(
                'dashboard/settings/remove',
                \Magento\Store\Model\ScopeInterface::SCOPE_STORE
            );

            if ($remove) {
                $layout->unsetElement('dashboard');
            }
        }
    }
}

Smartie
источник

Это может работать, но только для блоков, которые используют шаблоны. Это относится к приведенному мною примеру, но, тем не менее, если есть блоки, расширяющие AbstractBlock, а не блок Template, это не будет работать. +1 за хорошую отправную точку.

Мариус

Ты прав. После еще нескольких копаний я обнаружил, что вы можете сделать это раньше в процессе. Ответ обновлен. Я оставил свой оригинал там для справки.

Смарти

Спасибо, это полезный ответ. Проблема в том, что это означает, что логика будет срабатывать при каждой загрузке страницы, поскольку она использует событие "layout_generate_blocks_after". Знаете ли вы, как запустить его только при определенных загрузках страницы, например при загрузке страницы категории (событие «catalog_controller_category_init_after», но макет недоступен)?

Алекс

2

В самом деле?! Надо сделать наблюдателя, чтобы снять или нет условно блок? это просто смешно

slayerbleast

1

Я думаю, что наблюдатели не должны манипулировать данными ...

Алекс

5

Обычно это должно быть сделано с <action />тегом:

<referenceContainer name="content">
    <action method="unsetChild" ifconfig="dashboard/settings/remove">
        <argument xsi:type="string">dashboard</argument>
    </action>
</referenceContainer>

РЕДАКТИРОВАТЬ :

Единственная проблема - unsetChild принимает только псевдоним. Вы не можете использовать имя блока.

Другое решение: переписать Magento Framework, чтобы иметь возможность использовать ifconfig с remove = "true"

1- Создайте свой собственный модуль.

2 Добавить новый файл , чтобы переопределить Magento Framework (например: /Vendor/Module/Override/Magento/Framework/View/Layout/Reader/Block.php)

namespace Vendor\Module\Override\Magento\Framework\View\Layout\Reader;

use Magento\Framework\App;
use Magento\Framework\Data\Argument\InterpreterInterface;
use Magento\Framework\View\Layout;

/**
 * Block structure reader
 */
class Block extends \Magento\Framework\View\Layout\Reader\Block
{
    /**
     * @var \Magento\Framework\App\ScopeResolverInterface
     */
    protected $scopeResolver;

    /**
     * @var \Magento\Framework\App\Config\ScopeConfigInterface
     */
    protected $scopeConfig;

    /**
     * Constructor
     *
     * @param Layout\ScheduledStructure\Helper $helper
     * @param Layout\Argument\Parser $argumentParser
     * @param Layout\ReaderPool $readerPool
     * @param InterpreterInterface $argumentInterpreter
     * @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
     * @param \Magento\Framework\App\ScopeResolverInterface $scopeResolver
     * @param string|null $scopeType
     */
    public function __construct(
        Layout\ScheduledStructure\Helper $helper,
        Layout\Argument\Parser $argumentParser,
        Layout\ReaderPool $readerPool,
        InterpreterInterface $argumentInterpreter,
        \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig,
        \Magento\Framework\App\ScopeResolverInterface $scopeResolver,
        $scopeType = null
    ) {
        parent::__construct($helper,
            $argumentParser,
            $readerPool,
            $argumentInterpreter,
            $scopeType
        );
        $this->scopeConfig = $scopeConfig;
        $this->scopeResolver = $scopeResolver;
    }

    protected function scheduleReference(
        Layout\ScheduledStructure $scheduledStructure,
        Layout\Element $currentElement
    ) {
        $elementName = $currentElement->getAttribute('name');
        $elementRemove = filter_var($currentElement->getAttribute('remove'), FILTER_VALIDATE_BOOLEAN);
        if ($elementRemove) {
            $configPath = (string)$currentElement->getAttribute('ifconfig');
            if (empty($configPath)
                || $this->scopeConfig->isSetFlag($configPath, $this->scopeType, $this->scopeResolver->getScope())
            ) {
                $scheduledStructure->setElementToRemoveList($elementName);
            }
        } else {
            $data = $scheduledStructure->getStructureElementData($elementName, []);
            $data['attributes'] = $this->mergeBlockAttributes($data, $currentElement);
            $this->updateScheduledData($currentElement, $data);
            $this->evaluateArguments($currentElement, $data);
            $scheduledStructure->setStructureElementData($elementName, $data);
        }
    }
}

3- Добавьте файл di.xml для переопределения файла magento:

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
    <preference for="Magento\Framework\View\Layout\Reader\Block"
       type="Vendor\Module\Override\Magento\Framework\View\Layout\Reader\Block" />    
</config>

4- Теперь вы можете использовать ifconfig в макете в сочетании с remove:

<referenceBlock name="content" remove="true" ifconfig="path/to/myconfig" />

Этот пример для блока, но вы можете сделать то же самое для контейнера, если вы переопределите метод containerReference () из /Magento/Framework/View/Layout/Reader/Container.php

eInyzant
источник

Я думаю, что переписать Framework - лучшее решение, не знаю, почему у magento этого нет по умолчанию.

slayerbleast

3

Из технического руководства :

14.1. Все значения (включая объекты), переданные событию, НЕ ДОЛЖНЫ быть изменены в наблюдателе события. Вместо этого плагины ДОЛЖНЫ БЫТЬ использованы для изменения входа или выхода функции.

14.3. События НЕ ДОЛЖНЫ изменять состояние наблюдаемых объектов.

Вот плагин для этого:

Объявите плагин:

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
    <type name="Magento\Framework\View\Element\AbstractBlock">
        <plugin name="remove_block" type="[Vendor]\[Module]\Plugin\RemoveBlock" />
    </type>
</config>

Определите плагин:

<?php

namespace Vendor\Module\Plugin;


use Magento\Framework\App\Config\ScopeConfigInterface;
use Magento\Framework\View\Element\AbstractBlock;

class RemoveBlock
{
    const BLOCK_NAME = 'block_to_be_removed';

    const CONFIG_PATH = 'your/path';

    private $_scopeConfig;

    public function __construct(ScopeConfigInterface $scopeConfig) {
        $this->_scopeConfig = $scopeConfig;
    }

    public function afterToHtml(AbstractBlock $subject, $result)
    {
        if ($subject->getNameInLayout() === self::BLOCK_NAME && $this->_scopeConfig->getValue(self::class)) {
            return '';
        }

        return $result;
    }
}

Как и в ответ от Smartie я попытался дальше плагин вверх по цепочке в \Magento\Framework\View\Layout\Builder::buildс afterBuild()методом , но это приведет к бесконечной рекурсии , потому что \Magento\Framework\View\Layout::getBlockи \Magento\Framework\View\Layout::unsetElementоба вызова \Magento\Framework\View\Layout\Builder::buildснова.

Даниил
источник

2

Атрибут «ifconfig» узла «блок» в макете позволяет связать блок со значением в конфигурации магазина.

обработка ifconfig происходит в \Magento\Framework\View\Layout\GeneratorPool::buildStructure

Антон Криль
источник

Это не будет работать с "referenceBlock", хотя. Это будет работать только при добавлении нового блока.

Никита Абрашнев

Magento 2: удалить блок в зависимости от настроек конфигурации

Ответы:

Вот плагин для этого: