ConfigFactory.php

Go to the documentation of this file.

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

use Magento\Framework\App\ScopeValidatorInterface;
use Magento\Framework\Exception\LocalizedException;
use Magento\Store\Model\StoreManagerInterface;
use Magento\Theme\Api\Data\DesignConfigDataInterface;
use Magento\Theme\Api\Data\DesignConfigExtension;
use Magento\Theme\Api\Data\DesignConfigInterfaceFactory;
use Magento\Theme\Model\Design\Config\MetadataProviderInterface;
use Magento\Theme\Api\Data\DesignConfigDataInterfaceFactory;
use Magento\Theme\Api\Data\DesignConfigExtensionFactory;
use Magento\Theme\Api\Data\DesignConfigInterface;
use Magento\Store\Model\ScopeInterface;

class ConfigFactory
{
    protected $designConfigFactory;

    protected $metadataProvider;

    protected $designConfigDataFactory;

    protected $configExtensionFactory;

    protected $scopeValidator;

    protected $storeManager;

    public function __construct(
        DesignConfigInterfaceFactory $designConfigFactory,
        MetadataProviderInterface $metadataProvider,
        DesignConfigDataInterfaceFactory $designConfigDataFactory,
        DesignConfigExtensionFactory $configExtensionFactory,
        ScopeValidatorInterface $scopeValidator,
        StoreManagerInterface $storeManager
    ) {
        $this->designConfigFactory = $designConfigFactory;
        $this->metadataProvider = $metadataProvider;
        $this->designConfigDataFactory = $designConfigDataFactory;
        $this->configExtensionFactory = $configExtensionFactory;
        $this->scopeValidator = $scopeValidator;
        $this->storeManager = $storeManager;
    }

    public function create($scope, $scopeId, array $data = [])
    {
        if (!$this->scopeValidator->isValidScope($scope, $scopeId)) {
            throw new LocalizedException(__('The scope or scope ID is invalid. Verify both and try again.'));
        }
        $designConfigData = $this->getDesignConfigData($scope, $scopeId);

        $configData = [];
        foreach ($this->metadataProvider->get() as $name => $metadata) {
            $metadata['field'] = $name;
            $configDataObject = $this->designConfigDataFactory->create();
            $configDataObject->setPath($metadata['path']);
            $configDataObject->setFieldConfig($metadata);
            if (isset($data[$name])) {
                $configDataObject->setValue($data[$name]);
            }
            $configData[] = $configDataObject;
        }
        $designConfigExtension = $this->configExtensionFactory->create();
        $designConfigExtension->setDesignConfigData($configData);
        $designConfigData->setExtensionAttributes($designConfigExtension);

        return $designConfigData;
    }

    protected function getDesignConfigData($scope, $scopeId)
    {
        $designConfigData = $this->designConfigFactory->create();

        $scopeInfo = $this->getCorrectScope($scope, $scopeId);
        $designConfigData->setScope($scopeInfo['scope']);
        $designConfigData->setScopeId($scopeInfo['scopeId']);

        return $designConfigData;
    }

    protected function getCorrectScope($scope, $scopeId)
    {
        $isSingleStoreMode = $this->storeManager->isSingleStoreMode();
        if ($isSingleStoreMode) {
            $websites = $this->storeManager->getWebsites();
            $singleStoreWebsite = array_shift($websites);
            $scope = ScopeInterface::SCOPE_WEBSITES;
            $scopeId = $singleStoreWebsite->getId();
        }
        return [
            'scope' => $scope,
            'scopeId' => $scopeId
        ];
    }
}