UiComponent.php

Go to the documentation of this file.

<?php
namespace Magento\Framework\View\Layout\Reader;

use Magento\Framework\View\Layout\ScheduledStructure\Helper;
use Magento\Framework\View\Layout\ReaderInterface;
use Magento\Framework\View\Layout\Element;
use Magento\Framework\View\Layout\Reader\Visibility\Condition;
use Magento\Framework\View\Layout\ReaderPool;
use Magento\Framework\Config\DataInterfaceFactory;

class UiComponent implements ReaderInterface
{
    const TYPE_UI_COMPONENT = 'uiComponent';

    protected $attributes = ['group', 'component', 'aclResource'];

    protected $layoutHelper;

    private $conditionReader;

    private $uiConfigFactory;

    private $readerPool;

    public function __construct(
        Helper $helper,
        Condition $conditionReader,
        DataInterfaceFactory $uiConfigFactory,
        ReaderPool $readerPool
    ) {
        $this->layoutHelper = $helper;
        $this->conditionReader = $conditionReader;
        $this->uiConfigFactory = $uiConfigFactory;
        $this->readerPool = $readerPool;
    }

    public function getSupportedNodes()
    {
        return [self::TYPE_UI_COMPONENT];
    }

    public function interpret(Context $readerContext, Element $currentElement)
    {
        $attributes = $this->getAttributes($currentElement);
        $scheduledStructure = $readerContext->getScheduledStructure();
        $referenceName = $this->layoutHelper->scheduleStructure(
            $scheduledStructure,
            $currentElement,
            $currentElement->getParent(),
            ['attributes' => $attributes]
        );
        $attributes = array_merge(
            $attributes,
            ['visibilityConditions' => $this->conditionReader->parseConditions($currentElement)]
        );
        $scheduledStructure->setStructureElementData($referenceName, ['attributes' => $attributes]);

        $elements = [];
        $config = $this->uiConfigFactory->create(['componentName' => $referenceName])->get($referenceName);
        $this->getLayoutElementsFromUiConfiguration([$referenceName => $config], $elements);
        foreach ($elements as $layoutElement) {
            $layoutElement = simplexml_load_string(
                $layoutElement,
                Element::class
            );
            $this->readerPool->interpret($readerContext, $layoutElement);
        }

        return $this;
    }

    private function getLayoutElementsFromUiConfiguration(array $config, array &$elements = [])
    {
        foreach ($config as $data) {
            if (isset($data['arguments']['block']['layout'])) {
                $elements[] = $data['arguments']['block']['layout'];
            }
            if (isset($data['children']) && !empty($data['children'])) {
                $this->getLayoutElementsFromUiConfiguration($data['children'], $elements);
            }
        }
    }

    protected function getAttributes(Element $element)
    {
        $attributes = [];
        foreach ($this->attributes as $attributeName) {
            $attributes[$attributeName] = (string)$element->getAttribute($attributeName);
        }

        return $attributes;
    }
}