ConfigFactory.php 5.05 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
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */

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;

/**
 * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
 */
class ConfigFactory
{
    /**
     * @var DesignConfigInterfaceFactory
     */
    protected $designConfigFactory;

    /**
     * @var MetadataProviderInterface
     */
    protected $metadataProvider;

    /**
     * @var DesignConfigDataInterfaceFactory
     */
    protected $designConfigDataFactory;

    /**
     * @var DesignConfigExtensionFactory
     */
    protected $configExtensionFactory;

    /**
     * @var ScopeValidatorInterface
     */
    protected $scopeValidator;

    /**
     * @var StoreManagerInterface
     */
    protected $storeManager;

    /**
     * @param DesignConfigInterfaceFactory $designConfigFactory
     * @param MetadataProviderInterface $metadataProvider
     * @param DesignConfigDataInterfaceFactory $designConfigDataFactory
     * @param DesignConfigExtensionFactory $configExtensionFactory
     * @param ScopeValidatorInterface $scopeValidator
     * @param StoreManagerInterface $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;
    }

    /**
     * Create Design Configuration for scope
     *
     * @param mixed $scope
     * @param int $scopeId
     * @param array $data
     * @return DesignConfigInterface
     * @throws LocalizedException
     */
    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;
            /** @var DesignConfigDataInterface $configDataObject */
            $configDataObject = $this->designConfigDataFactory->create();
            $configDataObject->setPath($metadata['path']);
            $configDataObject->setFieldConfig($metadata);
            if (isset($data[$name])) {
                $configDataObject->setValue($data[$name]);
            }
            $configData[] = $configDataObject;
        }
        /** @var DesignConfigExtension $designConfigExtension */
        $designConfigExtension = $this->configExtensionFactory->create();
        $designConfigExtension->setDesignConfigData($configData);
        $designConfigData->setExtensionAttributes($designConfigExtension);

        return $designConfigData;
    }

    /**
     * Retrieve design config data with correct scope
     *
     * @param string $scope
     * @param string $scopeId
     * @return DesignConfigInterface
     */
    protected function getDesignConfigData($scope, $scopeId)
    {
        /** @var DesignConfigInterface $designConfigData */
        $designConfigData = $this->designConfigFactory->create();

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

        return $designConfigData;
    }

    /**
     * Retrieve correct scope corresponding single store mode configuration
     *
     * @param string $scope
     * @param string $scopeId
     * @return array
     */
    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
        ];
    }
}