BackendModelFactory.php

Go to the documentation of this file.

<?php
namespace Magento\Theme\Model\Design;

use Magento\Framework\App\Config\Value;
use Magento\Framework\App\Config\ValueFactory;
use Magento\Framework\ObjectManagerInterface;
use Magento\Theme\Model\Design\Config\MetadataProvider;
use Magento\Theme\Model\ResourceModel\Design\Config\CollectionFactory;

class BackendModelFactory extends ValueFactory
{
    protected $storedData = [];

    protected $metadata = [];

    protected $metadataProvider;

    protected $collectionFactory;

    protected $backendTypes = [];

    public function __construct(
        ObjectManagerInterface $objectManager,
        MetadataProvider $metadataProvider,
        CollectionFactory $collectionFactory
    ) {
        $this->metadataProvider = $metadataProvider;
        $this->collectionFactory = $collectionFactory;
        parent::__construct($objectManager);
    }

    public function create(array $data = [])
    {
        $backendModelData = array_replace_recursive(
            $this->getStoredData($data['scope'], $data['scopeId'], $data['config']['path']),
            [
                'path' => $data['config']['path'],
                'scope' => $data['scope'],
                'scope_id' => $data['scopeId'],
                'field_config' => $data['config'],
            ]
        );

        $backendType = isset($data['config']['backend_model'])
            ? $data['config']['backend_model']
            : $this->_instanceName;

        $backendModel = $this->getNewBackendModel($backendType, $backendModelData);
        $backendModel->setValue($data['value']);

        return $backendModel;
    }

    protected function getNewBackendModel($backendType, array $data = [])
    {
        return $this->_objectManager->create($backendType, ['data' => $data]);
    }

    public function createByPath($path, array $data = [])
    {
        return $this->getNewBackendModel($this->getBackendTypeByPath($path), $data);
    }

    protected function getBackendTypeByPath($path)
    {
        if (!isset($this->backendTypes[$path])) {
            $metadata = $this->metadataProvider->get();
            $index = array_search($path, array_column($metadata, 'path'));
            $backendType = $this->_instanceName;
            if ($index !== false && isset(array_values($metadata)[$index]['backend_model'])) {
                $backendType = array_values($metadata)[$index]['backend_model'];
            }
            $this->backendTypes[$path] = $backendType;
        }
        return $this->backendTypes[$path];
    }

    protected function getStoredData($scope, $scopeId, $path)
    {
        $storedData = $this->getScopeData($scope, $scopeId);
        $dataKey = array_search($path, array_column($storedData, 'path'));
        return $dataKey !== false ? $storedData[$dataKey] : [];
    }

    protected function getScopeData($scope, $scopeId)
    {
        if (!isset($this->storedData[$scope][$scopeId])) {
            $collection = $this->collectionFactory->create();
            $collection->addPathsFilter($this->getMetadata());
            $collection->addFieldToFilter('scope', $scope);
            $collection->addScopeIdFilter($scopeId);
            $this->storedData[$scope][$scopeId] = $collection->getData();
        }
        return $this->storedData[$scope][$scopeId];
    }

    protected function getMetadata()
    {
        if (!$this->metadata) {
            $this->metadata = $this->metadataProvider->get();
            array_walk($this->metadata, function (&$value) {
                $value = $value['path'];
            });
        }
        return $this->metadata;
    }
}