Reader.php

Go to the documentation of this file.

<?php
namespace Magento\Ui\Config;

use Magento\Framework\Config\ConverterInterface as ConfigConverter;
use Magento\Framework\Config\Dom\ValidationException;
use Magento\Framework\Config\FileResolverInterface;
use Magento\Framework\Config\ReaderInterface;
use Magento\Framework\Exception\LocalizedException;
use Magento\Framework\Phrase;

class Reader implements ReaderInterface
{
    private $idAttributes = ['/' => 'name'];

    private $definitionReader;

    private $readerFactory;

    private $fileResolver;

    private $converter;

    private $readerDomFactory;

    private $fileName;

    public function __construct(
        $fileName,
        FileResolverInterface $fileResolver,
        ConfigConverter $converter,
        Reader\Definition $definitionReader,
        ReaderFactory $readerFactory,
        Reader\DomFactory $readerDomFactory,
        array $idAttributes = []
    ) {
        $this->fileName = $fileName;
        $this->fileResolver = $fileResolver;
        $this->converter = $converter;
        $this->definitionReader = $definitionReader;
        $this->readerFactory = $readerFactory;
        $this->readerDomFactory = $readerDomFactory;
        $this->idAttributes = array_replace($this->idAttributes, $idAttributes);
    }

    public function read($scope = null)
    {
        $scope = $scope ?: 'global';
        $fileList = $this->fileResolver->get($this->fileName, $scope);
        if (!count($fileList)) {
            return [];
        }
        $output = $this->readFiles($fileList);

        return $output;
    }

    private function readFiles($fileList)
    {
        $configMerger = null;
        $output = [];
        foreach ($fileList as $key => $content) {
            try {
                $configMerger = $this->readerDomFactory->create(
                    [
                        'xml' => $content,
                        'idAttributes' => $this->idAttributes,
                    ]
                );
                $output = array_replace_recursive($output, $this->converter->convert($configMerger->getDom()));
            } catch (ValidationException $e) {
                throw new LocalizedException(
                    new Phrase(
                        'The XML in file "%1" is invalid:' . "\n%2\nVerify the XML and try again.",
                        [$key, $e->getMessage()]
                    )
                );
            }
        }

        $definitionData = $this->definitionReader->read();

        if (isset($output['attributes']['extends'])) {
            $extendsReader = $this->readerFactory->create(
                [
                    'fileName' => sprintf(
                        Data::SEARCH_PATTERN,
                        $output['attributes']['extends']
                    )
                ]
            );
            $extendsData = $extendsReader->read();
            $output = array_replace_recursive($extendsData, $output);
        }

        $output = $this->mergeDefinition($output, $definitionData);

        return $output;
    }

    private function mergeDefinition(array $component, array $definitions)
    {
        foreach ($component['children'] as $name => $child) {
            $component['children'][$name] = $this->mergeDefinition($child, $definitions);
        }
        if (isset($component['uiComponentType'])) {
            $definition = isset($definitions[$component['uiComponentType']])
                ? $definitions[$component['uiComponentType']]
                : [];
            $component = array_replace_recursive($definition, $component);
            unset($component['uiComponentType']);
        }

        return $component;
    }
}