ExtendsMapper.php

Go to the documentation of this file.

<?php
namespace Magento\Config\Model\Config\Structure\Mapper;

class ExtendsMapper extends \Magento\Config\Model\Config\Structure\AbstractMapper
{
    protected $_systemConfiguration;

    protected $_extendedNodesList = [];

    protected $_pathConverter;

    public function __construct(
        \Magento\Config\Model\Config\Structure\Mapper\Helper\RelativePathConverter $pathConverted
    ) {
        $this->_pathConverter = $pathConverted;
    }

    public function map(array $data)
    {
        if (!isset($data['config']['system']['sections']) || !is_array($data['config']['system']['sections'])) {
            return $data;
        }

        $this->_systemConfiguration = & $data['config']['system']['sections'];

        foreach (array_keys($this->_systemConfiguration) as $nodeName) {
            $this->_traverseAndExtend($nodeName);
        }

        return $data;
    }

    protected function _traverseAndExtend($path)
    {
        $node = $this->_getDataByPath($path);

        if (!is_array($node)) {
            return;
        }

        if (!empty($node['extends'])) {
            $node = $this->_extendNode($path, $node['extends']);
        }

        if (!empty($node['children'])) {
            foreach (array_keys($node['children']) as $childName) {
                $this->_traverseAndExtend($path . '/' . $childName);
            }
        }
    }

    protected function _getDataByPath($path)
    {
        $result = $this->_systemConfiguration;
        $pathParts = $this->_transformPathToKeysList($path);

        foreach ($pathParts as $part) {
            $result = isset($result[$part]) ? $result[$part] : null;
            if ($result === null) {
                return $result;
            }
        }

        return $result;
    }

    protected function _extendNode($path, $extendSourceNode)
    {
        $currentNodeData = $this->_getDataByPath($path);

        if (in_array($path, $this->_extendedNodesList)) {
            return $currentNodeData;
        }

        $extendSourcePath = $this->_pathConverter->convert($path, $extendSourceNode);
        $data = $this->_getDataByPath($extendSourcePath);

        if (!$data) {
            throw new \InvalidArgumentException(
                sprintf('Invalid path in extends attribute of config/system/sections/%s node', $path)
            );
        }

        if (isset($data['extends'])) {
            $data = $this->_extendNode($extendSourcePath, $data['extends']);
        }

        $resultingData = $this->_mergeData($data, $currentNodeData);

        $this->_replaceData($path, $resultingData);
        $this->_extendedNodesList[] = $path;

        return $resultingData;
    }

    protected function _mergeData($arr1, $arr2)
    {
        foreach ($arr2 as $key => $value) {
            if (isset($arr1[$key]) && is_array($arr1[$key]) && is_array($value)) {
                $arr1[$key] = $this->_mergeData($arr1[$key], $value);
            } else {
                $arr1[$key] = $value;
            }
        }

        return $arr1;
    }

    protected function _replaceData($path, $newData)
    {
        $pathParts = $this->_transformPathToKeysList($path);
        $result = & $this->_systemConfiguration;

        foreach ($pathParts as $part) {
            if (!isset($result[$part])) {
                return;
            }
            $result = & $result[$part];
        }

        $result = $newData;
    }

    protected function _transformPathToKeysList($path)
    {
        $path = str_replace('/', '/children/', $path);
        return explode('/', $path);
    }
}