Reader.php 2.53 KB
Newer Older
Ketan's avatar
Ketan committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
namespace Magento\Framework\View\Element\UiComponent\Config;

use Magento\Framework\Filesystem;
use Magento\Framework\Config\ConverterInterface;
use Magento\Framework\Config\FileIteratorFactory;
use Magento\Framework\App\Filesystem\DirectoryList;
use Magento\Framework\Filesystem\Directory\ReadInterface;

/**
 * Class Reader
 */
class Reader implements UiReaderInterface
{
    /**
     * DOM document merger
     *
     * @var DomMergerInterface
     */
    protected $domMerger;

    /**
     * XML converter
     *
     * @var ConverterInterface
     */
    protected $converter;

    /**
     * Constructor
     *
     * @param FileCollectorInterface $fileCollector
     * @param ConverterInterface $converter
     * @param DomMergerInterface $domMerger
     */
    public function __construct(
        FileCollectorInterface $fileCollector,
        ConverterInterface $converter,
        DomMergerInterface $domMerger
    ) {
        $this->converter = $converter;
        $this->domMerger = $domMerger;
        $this->readFiles($fileCollector->collectFiles());
    }

    /**
     * Read configuration files
     *
     * @param array $fileList
     * @return array
     * @throws \Magento\Framework\Exception\LocalizedException
     */
    protected function readFiles(array $fileList)
    {
        foreach ($fileList as $fileContent) {
            $this->domMerger->merge($fileContent);
        }
    }

    /**
     * Add xml content in the merged file
     *
     * @param string $xmlContent
     * @return void
     */
    public function addXMLContent($xmlContent)
    {
        $this->domMerger->merge($xmlContent);
    }

    /**
     * Add DOM node into DOM document
     *
     * @param \DOMNode $node
     * @return void
     */
    public function addNode(\DOMNode $node)
    {
        $this->domMerger->mergeNode($node);
    }

    /**
     * Load configuration scope
     *
     * @param string|null $scope
     * @return array
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    public function read($scope = null)
    {
        return $this->converter->convert($this->domMerger->getDom());
    }

    /**
     * Get content from the merged files
     *
     * @return string
     */
    public function getContent()
    {
        return $this->domMerger->getDom()->saveXML();
    }

    /**
     * Get DOM document
     *
     * @return \DOMDocument
     */
    public function getDOMDocument()
    {
        return $this->domMerger->getDom();
    }
}