DesignAbstraction.php

Go to the documentation of this file.

<?php
namespace Magento\Widget\Block\Adminhtml\Widget\Instance\Edit\Chooser;

class DesignAbstraction extends \Magento\Framework\View\Element\Html\Select
{
    protected $_layoutProcessorFactory;

    protected $_themesFactory;

    protected $_appState;

    public function __construct(
        \Magento\Framework\View\Element\Context $context,
        \Magento\Framework\View\Layout\ProcessorFactory $layoutProcessorFactory,
        \Magento\Theme\Model\ResourceModel\Theme\CollectionFactory $themesFactory,
        \Magento\Framework\App\State $appState,
        array $data = []
    ) {
        $this->_layoutProcessorFactory = $layoutProcessorFactory;
        $this->_themesFactory = $themesFactory;
        $this->_appState = $appState;
        parent::__construct($context, $data);
    }

    protected function _beforeToHtml()
    {
        if (!$this->getOptions()) {
            $this->addOption('', __('-- Please Select --'));
            $layoutUpdateParams = ['theme' => $this->_getThemeInstance($this->getTheme())];
            $designAbstractions = $this->_appState->emulateAreaCode(
                'frontend',
                [$this->_getLayoutProcessor($layoutUpdateParams), 'getAllDesignAbstractions']
            );
            $this->_addDesignAbstractionOptions($designAbstractions);
        }
        return parent::_beforeToHtml();
    }

    protected function _getThemeInstance($themeId)
    {
        $themeCollection = $this->_themesFactory->create();
        return $themeCollection->getItemById($themeId);
    }

    protected function _getLayoutProcessor(array $arguments)
    {
        return $this->_layoutProcessorFactory->create($arguments);
    }

    protected function _addDesignAbstractionOptions(array $designAbstractions)
    {
        $label = [];
        // Sort list of design abstractions by label
        foreach ($designAbstractions as $key => $row) {
            $label[$key] = $row['label'];
        }
        array_multisort($label, SORT_STRING, $designAbstractions);

        // Group the layout options
        $customLayouts = [];
        $pageLayouts = [];
        $layoutProcessor = $this->_layoutProcessorFactory->create();
        foreach ($designAbstractions as $pageTypeName => $pageTypeInfo) {
            if ($layoutProcessor->isPageLayoutDesignAbstraction($pageTypeInfo)) {
                $pageLayouts[] = ['value' => $pageTypeName, 'label' => $pageTypeInfo['label']];
            } else {
                $customLayouts[] = ['value' => $pageTypeName, 'label' => $pageTypeInfo['label']];
            }
        }
        $params = [];
        $this->addOption($customLayouts, __('Custom Layouts'), $params);
        $this->addOption($pageLayouts, __('Page Layouts'), $params);
    }
}