Converter.php 5.34 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 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
namespace Magento\Ui\Config\Reader\DefinitionMap;

use Magento\Framework\Config\ConverterInterface;
use Magento\Framework\View\Layout\Argument\Parser;

/**
 * Converter for definition.map.xml
 */
class Converter implements ConverterInterface
{
    /**
     * The key of the argument node
     */
    const ARGUMENT_KEY = 'argument';

    /**
     * The key of the include component
     */
    const INCLUDE_KEY = 'include';

    /**
     * The array key sub components
     */
    const CURRENT_SCHEMA_KEY = 'current';

    /**
     * Key name attribute value
     */
    const NAME_ATTRIBUTE_KEY = 'name';

    /**
     * @var Parser
     */
    private $argumentParser;

    /**
     * Converter constructor.
     *
     * @param Parser $argumentParser
     */
    public function __construct(Parser $argumentParser)
    {
        $this->argumentParser = $argumentParser;
    }

    /**
     * Transform Xml to array
     *
     * @param \DOMNode $node
     * @return array|string
     */
    private function toArray(\DOMNode $node)
    {
        $result = [];
        $attributes = [];
        // Collect data from attributes
        if ($node->hasAttributes()) {
            foreach ($node->attributes as $attribute) {
                $attributes[$attribute->name] = $attribute->value;
            }
        }

        if (isset($attributes[static::INCLUDE_KEY])) {
            $result[static::INCLUDE_KEY] = $attributes[static::INCLUDE_KEY];
            unset($attributes[static::INCLUDE_KEY]);
        }

        switch ($node->nodeType) {
            case XML_TEXT_NODE:
            case XML_COMMENT_NODE:
            case XML_CDATA_SECTION_NODE:
                break;
            default:
                if ($node->localName === static::ARGUMENT_KEY) {
                    if (!isset($attributes[static::NAME_ATTRIBUTE_KEY])) {
                        throw new \InvalidArgumentException(
                            'Attribute "' . static::NAME_ATTRIBUTE_KEY . '" is absent in the attributes node.'
                        );
                    }
                    $result[ $attributes[static::NAME_ATTRIBUTE_KEY] ] = $this->argumentParser->parse($node);
                } else {
                    list($arguments, $childResult) = $this->convertChildNodes($node);

                    $result += $this->processArguments($arguments);
                    $result += $childResult;
                }
                break;
        }

        return $result;
    }

    /**
     * Retrieve component name
     *
     * @param \DOMNode $node
     * @return string
     */
    private function getComponentName(\DOMNode $node)
    {
        $result = $node->localName;
        if (!$node->hasAttributes()) {
            return $result;
        }
        foreach ($node->attributes as $attribute) {
            if ($attribute->name == static::NAME_ATTRIBUTE_KEY) {
                $result = $attribute->value;
                break;
            }
        }

        return $result;
    }

    /**
     * Convert configuration
     *
     * @param \DOMDocument|null $source
     * @return array
     */
    public function convert($source)
    {
        if ($source === null) {
            return [];
        }

        $result = $this->toArray($source);
        $result = empty($result) ? $result : reset($result);
        $schemaMap = [];
        foreach ($result as $componentName => $componentData) {
            $schemaMap[$componentName] = $this->processMap($componentData, $result);
        }
        return $schemaMap;
    }

    /**
     * Process include directives and return current schema
     *
     * @param array $componentData
     * @param array $sourceMap
     * @return array
     */
    private function processMap($componentData, $sourceMap)
    {
        $result = [];
        if (isset($componentData[static::INCLUDE_KEY])) {
            if (isset($sourceMap[$componentData[static::INCLUDE_KEY]])) {
                $result = array_replace_recursive(
                    $this->processMap($sourceMap[$componentData[static::INCLUDE_KEY]], $sourceMap),
                    $result
                );
            }
        }

        if (isset($componentData[static::CURRENT_SCHEMA_KEY])) {
            $result = array_replace_recursive($componentData[static::CURRENT_SCHEMA_KEY], $result);
        }

        return $result;
    }

    /**
     * Convert child nodes of $node
     *
     * @param \DOMNode $node
     * @return array
     */
    private function convertChildNodes(\DOMNode $node)
    {
        $arguments = [];
        $childResult = [];
        foreach ($node->childNodes as $itemNode) {
            if (empty($itemNode->localName)) {
                continue;
            }
            if ($itemNode->localName === static::ARGUMENT_KEY) {
                $arguments += $this->toArray($itemNode);
            } else {
                $childResult[$this->getComponentName($itemNode)] = $this->toArray($itemNode);
            }
        }

        return [$arguments, $childResult];
    }

    /**
     * Process component arguments
     *
     * @param array $arguments
     * @return array
     */
    private function processArguments(array $arguments)
    {
        $result = [];
        if (!empty($arguments)) {
            $result[static::ARGUMENT_KEY] = $arguments;
        }

        return $result;
    }
}