Inheritance diagram for StoreManager:

Public Member Functions
	__construct (\Magento\Store\Api\StoreRepositoryInterface $storeRepository, \Magento\Store\Api\GroupRepositoryInterface $groupRepository, \Magento\Store\Api\WebsiteRepositoryInterface $websiteRepository, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, StoreResolverInterface $storeResolver, \Magento\Framework\Cache\FrontendInterface $cache, $isSingleStoreAllowed=true)

	setCurrentStore ($store)

	setIsSingleStoreModeAllowed ($value)

	hasSingleStore ()

	isSingleStoreMode ()

	getStore ($storeId=null)

	getStores ($withDefault=false, $codeKey=false)

	getWebsite ($websiteId=null)

	getWebsites ($withDefault=false, $codeKey=false)

	reinitStores ()

	getDefaultStoreView ()

	getGroup ($groupId=null)

	getGroups ($withDefault=false)

	getStoreByWebsiteId ($websiteId)

Data Fields
const	PARAM_RUN_CODE = 'MAGE_RUN_CODE'

const	PARAM_RUN_TYPE = 'MAGE_RUN_TYPE'

const	XML_PATH_SINGLE_STORE_MODE_ENABLED = 'general/single_store_mode/enabled'

Data Fields inherited from StoreManagerInterface
const	CONTEXT_STORE = 'store'

const	PARAM_NAME = '___store'

Protected Member Functions
	isSingleStoreModeEnabled ()

Protected Attributes
	$storeRepository

	$groupRepository

	$websiteRepository

	$scopeConfig

	$storeResolver

	$cache

	$currentStoreId = null

	$_hasSingleStore

	$isSingleStoreAllowed

Detailed Description

Service contract, which manage scopes

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 17 of file StoreManager.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Store\Api\StoreRepositoryInterface	$storeRepository,
		\Magento\Store\Api\GroupRepositoryInterface	$groupRepository,
		\Magento\Store\Api\WebsiteRepositoryInterface	$websiteRepository,
		\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		StoreResolverInterface	$storeResolver,
		\Magento\Framework\Cache\FrontendInterface	$cache,
			$isSingleStoreAllowed = `true`
	)

Parameters

\Magento\Store\Api\StoreRepositoryInterface	$storeRepository
\Magento\Store\Api\GroupRepositoryInterface	$groupRepository
\Magento\Store\Api\WebsiteRepositoryInterface	$websiteRepository
\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
StoreResolverInterface	$storeResolver
\Magento\Framework\Cache\FrontendInterface	$cache
bool	$isSingleStoreAllowed

Definition at line 98 of file StoreManager.php.

       {
         $this->storeRepository = $storeRepository;
         $this->websiteRepository = $websiteRepository;
         $this->groupRepository = $groupRepository;
         $this->scopeConfig = $scopeConfig;
         $this->storeResolver = $storeResolver;
         $this->cache = $cache;
         $this->isSingleStoreAllowed = $isSingleStoreAllowed;
     }

Member Function Documentation

◆ getDefaultStoreView()

getDefaultStoreView ( )

{Retrieve default store for default group and website

Returns: \Magento\Store\Api\Data\StoreInterface|null

}

Implements StoreManagerInterface.

Definition at line 247 of file StoreManager.php.

     {
         $defaultWebsite = $this->websiteRepository->getDefault();
         $defaultStore = $this->getGroup($defaultWebsite->getDefaultGroupId())->getDefaultStore();
         return $defaultStore ?: null;
     }

◆ getGroup()

getGroup ( $groupId = null )

{Retrieve application store group object

Parameters

null | \Magento\Store\Api\Data\GroupInterface | string $groupId

Returns: \Magento\Store\Api\Data\GroupInterface

}

Implements StoreManagerInterface.

Definition at line 257 of file StoreManager.php.

     {
         if (null === $groupId) {
             $group = $this->groupRepository->get($this->getStore()->getGroupId());
         } elseif ($groupId instanceof \Magento\Store\Api\Data\GroupInterface) {
             $group = $groupId;
         } else {
             $group = $this->groupRepository->get($groupId);
         }
         return $group;
     }

◆ getGroups()

getGroups ( $withDefault = false )

{Prepare array of store groups

Parameters

bool $withDefault

Returns: \Magento\Store\Api\Data\GroupInterface[]

}

Implements StoreManagerInterface.

Definition at line 272 of file StoreManager.php.

     {
         $groups = $this->groupRepository->getList();
 
         return $withDefault ? $groups : array_filter(
             $groups,
             function ($item) {
                 return $item->getId() != 0;
             }
         );
     }

◆ getStore()

getStore ( $storeId = null )

{Retrieve application store object

Parameters

null | string | bool | int | \Magento\Store\Api\Data\StoreInterface $storeId

Returns: \Magento\Store\Api\Data\StoreInterface

Exceptions

NoSuchEntityException If given store doesn't exist.

}

Implements StoreManagerInterface.

Definition at line 152 of file StoreManager.php.

     {
         if (!isset($storeId) || '' === $storeId || $storeId === true) {
             if (null === $this->currentStoreId) {
                 \Magento\Framework\Profiler::start('store.resolve');
                 $this->currentStoreId = $this->storeResolver->getCurrentStoreId();
                 \Magento\Framework\Profiler::stop('store.resolve');
             }
             $storeId = $this->currentStoreId;
         }
         if ($storeId instanceof \Magento\Store\Api\Data\StoreInterface) {
             return $storeId;
         }
 
         $store = is_numeric($storeId)
             ? $this->storeRepository->getById($storeId)
             : $this->storeRepository->get($storeId);
 
         return $store;
     }

◆ getStoreByWebsiteId()

getStoreByWebsiteId ( $websiteId )

Get assigned to website store

Parameters

int $websiteId

Returns: array

Since: 100.2.0

Implements StoreWebsiteRelationInterface.

Definition at line 312 of file StoreManager.php.

     {
         return $this->getStoreWebsiteRelation()->getStoreByWebsiteId($websiteId);
     }

◆ getStores()

getStores	(	$withDefault = `false`,
		$codeKey = `false`
	)

{Retrieve stores array

Parameters

bool	$withDefault
bool	$codeKey

Returns: \Magento\Store\Api\Data\StoreInterface[]

}

Implements StoreManagerInterface.

Definition at line 176 of file StoreManager.php.

     {
         $stores = [];
         foreach ($this->storeRepository->getList() as $store) {
             if (!$withDefault && $store->getId() == 0) {
                 continue;
             }
             if ($codeKey) {
                 $stores[$store->getCode()] = $store;
             } else {
                 $stores[$store->getId()] = $store;
             }
         }
         return $stores;
     }

◆ getWebsite()

getWebsite ( $websiteId = null )

{Retrieve application website object

Parameters

null | bool | int | string | \Magento\Store\Api\Data\WebsiteInterface $websiteId

Returns: \Magento\Store\Api\Data\WebsiteInterface

Exceptions

}

Implements StoreManagerInterface.

Definition at line 195 of file StoreManager.php.

     {
         if ($websiteId === null || $websiteId === '') {
             $website = $this->websiteRepository->getById($this->getStore()->getWebsiteId());
         } elseif ($websiteId instanceof Website) {
             $website = $websiteId;
         } elseif ($websiteId === true) {
             $website = $this->websiteRepository->getDefault();
         } elseif (is_numeric($websiteId)) {
             $website = $this->websiteRepository->getById($websiteId);
         } else {
             $website = $this->websiteRepository->get($websiteId);
         }
 
         return $website;
     }

◆ getWebsites()

getWebsites	(	$withDefault = `false`,
		$codeKey = `false`
	)

{Get loaded websites

Parameters

bool	$withDefault
bool	$codeKey

Returns: \Magento\Store\Api\Data\WebsiteInterface[]

}

Implements StoreManagerInterface.

Definition at line 215 of file StoreManager.php.

     {
         $websites = [];
         foreach ($this->websiteRepository->getList() as $website) {
             if (!$withDefault && $website->getId() == 0) {
                 continue;
             }
             if ($codeKey) {
                 $websites[$website->getCode()] = $website;
             } else {
                 $websites[$website->getId()] = $website;
             }
         }
         return $websites;
     }

◆ hasSingleStore()

hasSingleStore ( )

{Check if store has only one store view

Returns: bool

}

Implements StoreManagerInterface.

Definition at line 135 of file StoreManager.php.

     {
         // TODO: MAGETWO-39902 add cache, move value to consts
         return $this->isSingleStoreAllowed && count($this->getStores(true)) < 3;
     }

◆ isSingleStoreMode()

isSingleStoreMode ( )

{Check if system is run in the single store mode

Returns: bool

}

Implements StoreManagerInterface.

Definition at line 144 of file StoreManager.php.

     {
         return $this->isSingleStoreModeEnabled() && $this->hasSingleStore();
     }

◆ isSingleStoreModeEnabled()

isSingleStoreModeEnabled ( )

protected

Check if Single-Store mode is enabled in configuration

This flag only shows that admin does not want to show certain UI components at backend (like store switchers etc) if Magento has only one store view but it does not check the store view collection

Returns: bool

Definition at line 292 of file StoreManager.php.

     {
         return (bool)$this->scopeConfig->getValue(
             self::XML_PATH_SINGLE_STORE_MODE_ENABLED,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE
         );
     }

◆ reinitStores()

reinitStores ( )

{Reinitialize store list

Returns: void

}

Implements StoreManagerInterface.

Definition at line 234 of file StoreManager.php.

     {
         $this->currentStoreId = null;
         $this->cache->clean(\Zend_Cache::CLEANING_MODE_MATCHING_ANY_TAG, [StoreResolver::CACHE_TAG, Store::CACHE_TAG]);
         $this->scopeConfig->clean();
         $this->storeRepository->clean();
         $this->websiteRepository->clean();
         $this->groupRepository->clean();
     }

◆ setCurrentStore()

setCurrentStore ( $store )

{Set current default store

Parameters

string $store

Returns: void

}

Implements StoreManagerInterface.

Definition at line 119 of file StoreManager.php.

     {
         $this->currentStoreId = $store;
     }

◆ setIsSingleStoreModeAllowed()

setIsSingleStoreModeAllowed ( $value )

{Allow or disallow single store mode

Parameters

bool $value

Returns: void

}

Implements StoreManagerInterface.

Definition at line 127 of file StoreManager.php.

     {
         $this->isSingleStoreAllowed = $value;
     }

Field Documentation

◆ $_hasSingleStore

$_hasSingleStore

protected

Definition at line 80 of file StoreManager.php.

◆ $cache

$cache

protected

Definition at line 66 of file StoreManager.php.

◆ $currentStoreId

$currentStoreId = null

protected

Definition at line 73 of file StoreManager.php.

◆ $groupRepository

$groupRepository

protected

Definition at line 44 of file StoreManager.php.

◆ $isSingleStoreAllowed

$isSingleStoreAllowed

protected

Definition at line 87 of file StoreManager.php.

◆ $scopeConfig

$scopeConfig

protected

Definition at line 56 of file StoreManager.php.

◆ $storeRepository

$storeRepository

protected

Definition at line 39 of file StoreManager.php.

◆ $storeResolver

$storeResolver

protected

Definition at line 61 of file StoreManager.php.

◆ $websiteRepository

$websiteRepository

protected

Definition at line 49 of file StoreManager.php.

◆ PARAM_RUN_CODE

const PARAM_RUN_CODE = 'MAGE_RUN_CODE'

Application run code

Definition at line 24 of file StoreManager.php.

◆ PARAM_RUN_TYPE

const PARAM_RUN_TYPE = 'MAGE_RUN_TYPE'

Application run type (store|website)

Definition at line 29 of file StoreManager.php.

◆ XML_PATH_SINGLE_STORE_MODE_ENABLED

const XML_PATH_SINGLE_STORE_MODE_ENABLED = 'general/single_store_mode/enabled'

Whether single store mode enabled or not

Definition at line 34 of file StoreManager.php.

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

vendor/magento/module-store/Model/StoreManager.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getDefaultStoreView()

◆ getGroup()

◆ getGroups()

◆ getStore()

◆ getStoreByWebsiteId()

◆ getStores()

◆ getWebsite()

◆ getWebsites()

◆ hasSingleStore()

◆ isSingleStoreMode()

◆ isSingleStoreModeEnabled()

◆ reinitStores()

◆ setCurrentStore()

◆ setIsSingleStoreModeAllowed()

Field Documentation

◆ $_hasSingleStore

◆ $cache

◆ $currentStoreId

◆ $groupRepository

◆ $isSingleStoreAllowed

◆ $scopeConfig

◆ $storeRepository

◆ $storeResolver

◆ $websiteRepository

◆ PARAM_RUN_CODE

◆ PARAM_RUN_TYPE

◆ XML_PATH_SINGLE_STORE_MODE_ENABLED