Config Class Reference

Public Member Functions
	__construct (\Magento\Framework\App\Config\ValueInterface $configData, \Magento\Framework\App\Config\Storage\WriterInterface $configWriter, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\Event\ManagerInterface $eventManager, \Magento\Framework\Cache\FrontendInterface $configCache, \Magento\Framework\Cache\FrontendInterface $layoutCache)
	assignToStore ( $theme, array $stores=[], $scope=\Magento\Store\Model\ScopeInterface::SCOPE_STORES)

Protected Member Functions
	_getAssignedScopesCollection ($scope, $configPath)
	_unassignThemeFromStores ($themeId, $stores, $scope, &$isReassigned)
	_assignThemeToStores ($themeId, $stores, $scope, &$isReassigned)
	_assignThemeToDefaultScope ($themeId, &$isReassigned)

Protected Attributes
	$_configWriter
	$_configData
	$_storeManager
	$_eventManager
	$_configCache
	$_layoutCache

Detailed Description

Definition at line 14 of file Config.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Config\ValueInterface	$configData,
		\Magento\Framework\App\Config\Storage\WriterInterface	$configWriter,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Framework\Event\ManagerInterface	$eventManager,
		\Magento\Framework\Cache\FrontendInterface	$configCache,
		\Magento\Framework\Cache\FrontendInterface	$layoutCache
	)

Parameters

\Magento\Framework\App\Config\ValueInterface	$configData
\Magento\Framework\App\Config\Storage\WriterInterface	$configWriter
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Framework\Event\ManagerInterface	$eventManager
\Magento\Framework\Cache\FrontendInterface	$configCache
\Magento\Framework\Cache\FrontendInterface	$layoutCache

Definition at line 56 of file Config.php.

      {
        $this->_configData = $configData;
        $this->_configWriter = $configWriter;
        $this->_storeManager = $storeManager;
        $this->_eventManager = $eventManager;
        $this->_configCache = $configCache;
        $this->_layoutCache = $layoutCache;
    }

Member Function Documentation

_assignThemeToDefaultScope()

_assignThemeToDefaultScope (   $themeId, &  $isReassigned  )

protected

Assign theme to default scope

Parameters

string	$themeId
bool	&$isReassigned

Returns

$this

Definition at line 175 of file Config.php.

    {
        $configPath = \Magento\Framework\View\DesignInterface::XML_PATH_THEME_ID;
        $this->_configWriter->save($configPath, $themeId, ScopeConfigInterface::SCOPE_TYPE_DEFAULT);
        $isReassigned = true;
        return $this;
    }

_assignThemeToStores()

_assignThemeToStores (   $themeId,   $stores,   $scope, &  $isReassigned  )

protected

Assign given theme to stores

Parameters

string	$themeId
array	$stores
string	$scope
bool	&$isReassigned

Returns

$this

Definition at line 156 of file Config.php.

    {
        $configPath = \Magento\Framework\View\DesignInterface::XML_PATH_THEME_ID;
        if (count($stores) > 0) {
            foreach ($stores as $storeId) {
                $this->_configWriter->save($configPath, $themeId, $scope, $storeId);
                $isReassigned = true;
            }
        }
        return $this;
    }

_getAssignedScopesCollection()

_getAssignedScopesCollection (   $scope,   $configPath  )

protected

Get assigned scopes collection of a theme

Parameters

string	$scope
string	$configPath

Returns

\Magento\Config\Model\ResourceModel\Config\Data\Collection

Definition at line 115 of file Config.php.

    {
        return $this->_configData->getCollection()->addFieldToFilter(
            'scope',
            $scope
        )->addFieldToFilter(
            'path',
            $configPath
        );
    }

_unassignThemeFromStores()

_unassignThemeFromStores (   $themeId,   $stores,   $scope, &  $isReassigned  )

protected

Unassign given theme from stores that were unchecked

Parameters

string	$themeId
array	$stores
string	$scope
bool	&$isReassigned

Returns

$this

Definition at line 135 of file Config.php.

    {
        $configPath = \Magento\Framework\View\DesignInterface::XML_PATH_THEME_ID;
        foreach ($this->_getAssignedScopesCollection($scope, $configPath) as $config) {
            if ($config->getValue() == $themeId && !in_array($config->getScopeId(), $stores)) {
                $this->_configWriter->delete($configPath, $scope, $config->getScopeId());
                $isReassigned = true;
            }
        }
        return $this;
    }

assignToStore()

assignToStore	(		$theme,
		array	$stores = [],
			$scope = \Magento\Store\Model\ScopeInterface::SCOPE_STORES
	)

Assign theme to the stores

Parameters

\Magento\Framework\View\Design\ThemeInterface	$theme
array	$stores
string	$scope

Returns

$this

Definition at line 80 of file Config.php.

      {
        $isReassigned = false;

        $this->_unassignThemeFromStores($theme->getId(), $stores, $scope, $isReassigned);

        if ($this->_storeManager->isSingleStoreMode()) {
            $this->_assignThemeToDefaultScope($theme->getId(), $isReassigned);
        } else {
            $this->_assignThemeToStores($theme->getId(), $stores, $scope, $isReassigned);
        }

        if ($isReassigned) {
            $this->_configCache->clean();
            $this->_layoutCache->clean();
        }

        $this->_eventManager->dispatch(
            'assign_theme_to_stores_after',
            ['stores' => $stores, 'scope' => $scope, 'theme' => $theme]
        );

        return $this;
    }

Field Documentation

$_configCache

$_configCache

protected

Definition at line 41 of file Config.php.

$_configData

$_configData

protected

Definition at line 24 of file Config.php.

$_configWriter

$_configWriter

protected

Definition at line 19 of file Config.php.

$_eventManager

$_eventManager

protected

Definition at line 36 of file Config.php.

$_layoutCache

$_layoutCache

protected

Definition at line 46 of file Config.php.

$_storeManager

$_storeManager

protected

Definition at line 29 of file Config.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-theme/Model/Config.php