Inheritance diagram for Switcher:

Public Member Functions
	__construct (\Magento\Backend\Block\Template\Context $context, \Magento\Store\Model\WebsiteFactory $websiteFactory, \Magento\Store\Model\GroupFactory $storeGroupFactory, \Magento\Store\Model\StoreFactory $storeFactory, array $data=[])

	getWebsiteCollection ()

	getWebsites ()

	isWebsiteSwitchEnabled ()

	setWebsiteVarName ($varName)

	getWebsiteVarName ()

	isWebsiteSelected (\Magento\Store\Model\Website $website)

	getWebsiteId ()

	getGroupCollection ($website)

	getStoreGroups ($website)

	isStoreGroupSwitchEnabled ()

	setStoreGroupVarName ($varName)

	getStoreGroupVarName ()

	isStoreGroupSelected (\Magento\Store\Model\Group $group)

	getStoreGroupId ()

	getStoreCollection ($group)

	getStores ($group)

	getStoreId ()

	isStoreSelected (\Magento\Store\Model\Store $store)

	isStoreSwitchEnabled ()

	setStoreVarName ($varName)

	getStoreVarName ()

	getSwitchUrl ()

	hasScopeSelected ()

	getCurrentSelectionName ()

	getCurrentWebsiteName ()

	getCurrentStoreGroupName ()

	getCurrentStoreName ()

	setStoreIds ($storeIds)

	getStoreIds ()

	isShow ()

	hasDefaultOption ($hasDefaultOption=null)

	getHintUrl ()

	getHintHtml ()

	isUsingIframe ()

Public Member Functions inherited from Template
	__construct (\Magento\Backend\Block\Template\Context $context, array $data=[])

	getFormKey ()

	isOutputEnabled ($moduleName=null)

	getAuthorization ()

	getToolbar ()

Public Member Functions inherited from Template
	__construct (Template\Context $context, array $data=[])

	setTemplateContext ($templateContext)

	getTemplate ()

	setTemplate ($template)

	getTemplateFile ($template=null)

	getArea ()

	assign ($key, $value=null)

	fetchView ($fileName)

	getBaseUrl ()

	getObjectData (\Magento\Framework\DataObject $object, $key)

	getCacheKeyInfo ()

Public Member Functions inherited from AbstractBlock
	__construct (\Magento\Framework\View\Element\Context $context, array $data=[])

	getJsLayout ()

	getRequest ()

	getParentBlock ()

	setLayout (\Magento\Framework\View\LayoutInterface $layout)

	getLayout ()

	setNameInLayout ($name)

	getChildNames ()

	setAttribute ($name, $value=null)

	setChild ($alias, $block)

	addChild ($alias, $block, $data=[])

	unsetChild ($alias)

	unsetCallChild ($alias, $callback, $result, $params)

	unsetChildren ()

	getChildBlock ($alias)

	getChildHtml ($alias='', $useCache=true)

	getChildChildHtml ($alias, $childChildAlias='', $useCache=true)

	getBlockHtml ($name)

	insert ($element, $siblingName=0, $after=true, $alias='')

	append ($element, $alias='')

	getGroupChildNames ($groupName)

	getChildData ($alias, $key='')

	getUiId ($arg1=null, $arg2=null, $arg3=null, $arg4=null, $arg5=null)

	getJsId ($arg1=null, $arg2=null, $arg3=null, $arg4=null, $arg5=null)

	getUrl ($route='', $params=[])

	getViewFileUrl ($fileId, array $params=[])

	formatDate ( $date=null, $format=\IntlDateFormatter::SHORT, $showTime=false, $timezone=null)

	formatTime ( $time=null, $format=\IntlDateFormatter::SHORT, $showDate=false)

	getModuleName ()

	escapeHtml ($data, $allowedTags=null)

	escapeJs ($string)

	escapeHtmlAttr ($string, $escapeSingleQuote=true)

	escapeCss ($string)

	stripTags ($data, $allowableTags=null, $allowHtmlEntities=false)

	escapeUrl ($string)

	escapeXssInUrl ($data)

	escapeQuote ($data, $addSlashes=false)

	escapeJsQuote ($data, $quote='\'')

	getNameInLayout ()

	getCacheKeyInfo ()

	getCacheKey ()

	getVar ($name, $module=null)

	isScopePrivate ()

Public Member Functions inherited from DataObject
	__construct (array $data=[])

	addData (array $arr)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	getDataByPath ($path)

	getDataByKey ($key)

	setDataUsingMethod ($key, $args=[])

	getDataUsingMethod ($key, $args=null)

	hasData ($key='')

	toArray (array $keys=[])

	convertToArray (array $keys=[])

	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	toJson (array $keys=[])

	convertToJson (array $keys=[])

	toString ($format='')

	__call ($method, $args)

	isEmpty ()

	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')

	debug ($data=null, &$objects=[])

	offsetSet ($offset, $value)

	offsetExists ($offset)

	offsetUnset ($offset)

	offsetGet ($offset)

Public Member Functions inherited from BlockInterface
	toHtml ()

Data Fields
const	HINT_URL = 'http://docs.magento.com/m2/ce/user_guide/configuration/scope.html'

Data Fields inherited from Template
const	XML_PATH_TEMPLATE_ALLOW_SYMLINK = 'dev/template/allow_symlink'

Data Fields inherited from AbstractBlock
const	CACHE_GROUP = \Magento\Framework\App\Cache\Type\Block::TYPE_IDENTIFIER

const	CACHE_KEY_PREFIX = 'BLOCK_'

Protected Member Functions
	_construct ()

	_toHtml ()

Protected Member Functions inherited from Template
	_toHtml ()

Protected Member Functions inherited from Template
	_construct ()

	_toHtml ()

	getRootDirectory ()

	getMediaDirectory ()

Protected Member Functions inherited from AbstractBlock
	_construct ()

	_prepareLayout ()

	_beforeToHtml ()

	_afterToHtml ($html)

	_toHtml ()

	_getNotFoundUrl ($route='', $params=['_direct'=> 'core/index/notFound'])

	getCacheTags ()

	getCacheLifetime ()

	_loadCache ()

	_saveCache ($data)

	_getSidPlaceholder ($cacheKey=null)

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$_defaultWebsiteVarName = 'website'

	$_defaultStoreGroupVarName = 'group'

	$_defaultStoreVarName = 'store'

	$_storeIds

	$_hintUrl

	$_hasDefaultOption = true

	$_template = 'Magento_Backend::store/switcher.phtml'

	$_websiteFactory

	$_storeGroupFactory

	$_storeFactory

Protected Attributes inherited from Template
	$_authorization

	$mathRandom

	$_backendSession

	$formKey

	$nameBuilder

Protected Attributes inherited from Template
	$_viewVars = []

	$_baseUrl

	$_jsUrl

	$_allowSymlinks

	$_filesystem

	$_template

	$templateEnginePool

	$_storeManager

	$_appState

	$directory

	$templateContext

	$pageConfig

	$resolver

	$validator

Protected Attributes inherited from AbstractBlock
	$_design

	$_session

	$_sidResolver

	$_nameInLayout

	$_layout

	$jsLayout = []

	$_request

	$_urlBuilder

	$_eventManager

	$_frontController

	$_assetRepo

	$_viewConfig

	$_cacheState

	$_logger

	$_escaper

	$filterManager

	$_localeDate

	$inlineTranslation

	$_isScopePrivate = false

	$_scopeConfig

	$_cache

Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Public Member Functions inherited from AbstractBlock
static	extractModuleName ($className)

Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Store switcher block

@api

Since: 100.0.2

Definition at line 15 of file Switcher.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Backend\Block\Template\Context	$context,
		\Magento\Store\Model\WebsiteFactory	$websiteFactory,
		\Magento\Store\Model\GroupFactory	$storeGroupFactory,
		\Magento\Store\Model\StoreFactory	$storeFactory,
		array	$data = `[]`
	)

Parameters

\Magento\Backend\Block\Template\Context	$context
\Magento\Store\Model\WebsiteFactory	$websiteFactory
\Magento\Store\Model\GroupFactory	$storeGroupFactory
\Magento\Store\Model\StoreFactory	$storeFactory
array	$data

Definition at line 95 of file Switcher.php.

       {
         parent::__construct($context, $data);
         $this->_websiteFactory = $websiteFactory;
         $this->_storeGroupFactory = $storeGroupFactory;
         $this->_storeFactory = $storeFactory;
     }

Member Function Documentation

◆ _construct()

_construct ( )

protected

Returns: void

Definition at line 111 of file Switcher.php.

     {
         parent::_construct();
 
         $this->setUseConfirm(true);
         $this->setUseAjax(true);
 
         $this->setShowManageStoresLink(0);
 
         if (!$this->hasData('switch_websites')) {
             $this->setSwitchWebsites(false);
         }
         if (!$this->hasData('switch_store_groups')) {
             $this->setSwitchStoreGroups(false);
         }
         if (!$this->hasData('switch_store_views')) {
             $this->setSwitchStoreViews(true);
         }
         $this->setDefaultSelectionName(__('All Store Views'));
     }

◆ _toHtml()

_toHtml ( )

protected

Returns: string

Definition at line 503 of file Switcher.php.

     {
         if ($this->isShow()) {
             return parent::_toHtml();
         }
         return '';
     }

◆ getCurrentSelectionName()

getCurrentSelectionName ( )

Get current selection name

Returns: string

Definition at line 414 of file Switcher.php.

     {
         if (!($name = $this->getCurrentStoreName())) {
             if (!($name = $this->getCurrentStoreGroupName())) {
                 if (!($name = $this->getCurrentWebsiteName())) {
                     $name = $this->getDefaultSelectionName();
                 }
             }
         }
         return $name;
     }

◆ getCurrentStoreGroupName()

getCurrentStoreGroupName ( )

Get current store group name

Returns: string

Definition at line 447 of file Switcher.php.

     {
         if ($this->getStoreGroupId() !== null) {
             $group = $this->_storeGroupFactory->create();
             $group->load($this->getStoreGroupId());
             if ($group->getId()) {
                 return $group->getName();
             }
         }
     }

◆ getCurrentStoreName()

getCurrentStoreName ( )

Get current store view name

Returns: string

Definition at line 463 of file Switcher.php.

     {
         if ($this->getStoreId() !== null) {
             $store = $this->_storeFactory->create();
             $store->load($this->getStoreId());
             if ($store->getId()) {
                 return $store->getName();
             }
         }
     }

◆ getCurrentWebsiteName()

getCurrentWebsiteName ( )

Get current website name

Returns: string

Definition at line 431 of file Switcher.php.

     {
         if ($this->getWebsiteId() !== null) {
             $website = $this->_websiteFactory->create();
             $website->load($this->getWebsiteId());
             if ($website->getId()) {
                 return $website->getName();
             }
         }
     }

◆ getGroupCollection()

getGroupCollection ( $website )

Parameters

int | \Magento\Store\Model\Website $website

Returns: \Magento\Store\Model\ResourceModel\Group\Collection

Definition at line 217 of file Switcher.php.

     {
         if (!$website instanceof \Magento\Store\Model\Website) {
             $website = $this->_websiteFactory->create()->load($website);
         }
         return $website->getGroupCollection();
     }

◆ getHintHtml()

getHintHtml ( )

Return store switcher hint html

Returns: string

Definition at line 540 of file Switcher.php.

     {
         $html = '';
         $url = $this->getHintUrl();
         if ($url) {
             $html = '<div class="admin__field-tooltip tooltip">' . '<a' . ' href="' . $this->escapeUrl(
                 $url
             ) . '"' . ' onclick="this.target=\'_blank\'"' . ' title="' . __(
                 'What is this?'
             ) . '"' . ' class="admin__field-tooltip-action action-help"><span>' . __(
                 'What is this?'
             ) . '</span></a></span>' . ' </div>';
         }
         return $html;
     }

◆ getHintUrl()

getHintUrl ( )

Return url for store switcher hint

Returns: string

Definition at line 530 of file Switcher.php.

     {
         return self::HINT_URL;
     }

◆ getStoreCollection()

getStoreCollection ( $group )

Parameters

\Magento\Store\Model\Group | int $group

Returns: \Magento\Store\Model\ResourceModel\Store\Collection

Definition at line 295 of file Switcher.php.

     {
         if (!$group instanceof \Magento\Store\Model\Group) {
             $group = $this->_storeGroupFactory->create()->load($group);
         }
         $stores = $group->getStoreCollection();
         $_storeIds = $this->getStoreIds();
         if (!empty($_storeIds)) {
             $stores->addIdFilter($_storeIds);
         }
         return $stores;
     }

◆ getStoreGroupId()

getStoreGroupId ( )

Returns: int|null

Definition at line 283 of file Switcher.php.

     {
         if (!$this->hasData('store_group_id')) {
             $this->setData('store_group_id', (int)$this->getRequest()->getParam($this->getStoreGroupVarName()));
         }
         return $this->getData('store_group_id');
     }

◆ getStoreGroups()

getStoreGroups ( $website )

Get store groups for specified website

Parameters

\Magento\Store\Model\Website | int $website

Returns: array

Definition at line 231 of file Switcher.php.

     {
         if (!$website instanceof \Magento\Store\Model\Website) {
             $website = $this->_storeManager->getWebsite($website);
         }
         return $website->getGroups();
     }

◆ getStoreGroupVarName()

getStoreGroupVarName ( )

Returns: string

Definition at line 262 of file Switcher.php.

     {
         if ($this->hasData('store_group_var_name')) {
             return (string)$this->getData('store_group_var_name');
         } else {
             return (string)$this->_defaultStoreGroupVarName;
         }
     }

◆ getStoreId()

getStoreId ( )

Returns: int|null

Definition at line 333 of file Switcher.php.

     {
         if (!$this->hasData('store_id')) {
             $this->setData('store_id', (int)$this->getRequest()->getParam($this->getStoreVarName()));
         }
         return $this->getData('store_id');
     }

◆ getStoreIds()

getStoreIds ( )

Returns: array

Definition at line 487 of file Switcher.php.

     {
         return $this->_storeIds;
     }

◆ getStores()

getStores ( $group )

Get store views for specified store group

Parameters

\Magento\Store\Model\Group | int $group

Returns: \Magento\Store\Model\Store[]

Definition at line 314 of file Switcher.php.

     {
         if (!$group instanceof \Magento\Store\Model\Group) {
             $group = $this->_storeManager->getGroup($group);
         }
         $stores = $group->getStores();
         if ($storeIds = $this->getStoreIds()) {
             foreach (array_keys($stores) as $storeId) {
                 if (!in_array($storeId, $storeIds)) {
                     unset($stores[$storeId]);
                 }
             }
         }
         return $stores;
     }

◆ getStoreVarName()

getStoreVarName ( )

Returns: mixed|string

Definition at line 373 of file Switcher.php.

     {
         if ($this->hasData('store_var_name')) {
             return (string)$this->getData('store_var_name');
         } else {
             return (string)$this->_defaultStoreVarName;
         }
     }

◆ getSwitchUrl()

getSwitchUrl ( )

Returns: string

Definition at line 385 of file Switcher.php.

     {
         if ($url = $this->getData('switch_url')) {
             return $url;
         }
         return $this->getUrl(
             '*/*/*',
             [
                 '_current' => true,
                 $this->getStoreVarName() => null,
                 $this->getStoreGroupVarName() => null,
                 $this->getWebsiteVarName() => null,
             ]
         );
     }

◆ getWebsiteCollection()

getWebsiteCollection ( )

Returns: \Magento\Store\Model\ResourceModel\Website\Collection

Definition at line 135 of file Switcher.php.

     {
         $collection = $this->_websiteFactory->create()->getResourceCollection();
 
         $websiteIds = $this->getWebsiteIds();
         if ($websiteIds !== null) {
             $collection->addIdFilter($this->getWebsiteIds());
         }
 
         return $collection->load();
     }

◆ getWebsiteId()

getWebsiteId ( )

Returns: int|null

Definition at line 205 of file Switcher.php.

     {
         if (!$this->hasData('website_id')) {
             $this->setData('website_id', (int)$this->getRequest()->getParam($this->getWebsiteVarName()));
         }
         return $this->getData('website_id');
     }

◆ getWebsites()

getWebsites ( )

Get websites

Returns: \Magento\Store\Model\Website[]

Definition at line 152 of file Switcher.php.

     {
         $websites = $this->_storeManager->getWebsites();
         if ($websiteIds = $this->getWebsiteIds()) {
             $websites = array_intersect_key($websites, array_flip($websiteIds));
         }
         return $websites;
     }

◆ getWebsiteVarName()

getWebsiteVarName ( )

Returns: string

Definition at line 184 of file Switcher.php.

     {
         if ($this->hasData('website_var_name')) {
             return (string)$this->getData('website_var_name');
         } else {
             return (string)$this->_defaultWebsiteVarName;
         }
     }

◆ hasDefaultOption()

hasDefaultOption ( $hasDefaultOption = null )

Set/Get whether the switcher should show default option

Parameters

bool $hasDefaultOption

Returns: bool

Definition at line 517 of file Switcher.php.

     {
         if (null !== $hasDefaultOption) {
             $this->_hasDefaultOption = $hasDefaultOption;
         }
         return $this->_hasDefaultOption;
     }

◆ hasScopeSelected()

hasScopeSelected ( )

Returns: bool

Definition at line 404 of file Switcher.php.

     {
         return $this->getStoreId() !== null || $this->getStoreGroupId() !== null || $this->getWebsiteId() !== null;
     }

◆ isShow()

isShow ( )

Returns: bool

Definition at line 495 of file Switcher.php.

     {
         return !$this->_storeManager->isSingleStoreMode();
     }

◆ isStoreGroupSelected()

isStoreGroupSelected ( \Magento\Store\Model\Group $group )

Parameters

\Magento\Store\Model\Group $group

Returns: bool

Definition at line 275 of file Switcher.php.

     {
         return $this->getStoreGroupId() === $group->getId() && $this->getStoreGroupId() === null;
     }

◆ isStoreGroupSwitchEnabled()

isStoreGroupSwitchEnabled ( )

Check if can switch to store group

Returns: bool

Definition at line 244 of file Switcher.php.

     {
         return (bool)$this->getData('switch_store_groups');
     }

◆ isStoreSelected()

isStoreSelected ( \Magento\Store\Model\Store $store )

Parameters

\Magento\Store\Model\Store $store

Returns: bool

Definition at line 345 of file Switcher.php.

     {
         return $this->getStoreId() !== null && (int)$this->getStoreId() === (int)$store->getId();
     }

◆ isStoreSwitchEnabled()

isStoreSwitchEnabled ( )

Check if can switch to store views

Returns: bool

Definition at line 355 of file Switcher.php.

     {
         return (bool)$this->getData('switch_store_views');
     }

◆ isUsingIframe()

isUsingIframe ( )

Get whether iframe is being used

Returns: bool

Definition at line 561 of file Switcher.php.

     {
         if ($this->hasData('is_using_iframe')) {
             return (bool)$this->getData('is_using_iframe');
         }
         return false;
     }

◆ isWebsiteSelected()

isWebsiteSelected ( \Magento\Store\Model\Website $website )

Parameters

\Magento\Store\Model\Website $website

Returns: bool

Definition at line 197 of file Switcher.php.

     {
         return $this->getWebsiteId() === $website->getId() && $this->getStoreId() === null;
     }

◆ isWebsiteSwitchEnabled()

isWebsiteSwitchEnabled ( )

Check if can switch to websites

Returns: bool

Definition at line 166 of file Switcher.php.

     {
         return (bool)$this->getData('switch_websites');
     }

◆ setStoreGroupVarName()

setStoreGroupVarName ( $varName )

Parameters

string $varName

Returns: $this

Definition at line 253 of file Switcher.php.

     {
         $this->setData('store_group_var_name', $varName);
         return $this;
     }

◆ setStoreIds()

setStoreIds ( $storeIds )

Parameters

array $storeIds

Returns: $this

Definition at line 478 of file Switcher.php.

     {
         $this->_storeIds = $storeIds;
         return $this;
     }

◆ setStoreVarName()

setStoreVarName ( $varName )

Parameters

string $varName

Returns: $this

Definition at line 364 of file Switcher.php.

     {
         $this->setData('store_var_name', $varName);
         return $this;
     }

◆ setWebsiteVarName()

setWebsiteVarName ( $varName )

Parameters

string $varName

Returns: $this

Definition at line 175 of file Switcher.php.

     {
         $this->setData('website_var_name', $varName);
         return $this;
     }

Field Documentation

◆ $_defaultStoreGroupVarName

$_defaultStoreGroupVarName = 'group'

protected

Definition at line 34 of file Switcher.php.

◆ $_defaultStoreVarName

$_defaultStoreVarName = 'store'

protected

Definition at line 41 of file Switcher.php.

◆ $_defaultWebsiteVarName

$_defaultWebsiteVarName = 'website'

protected

Definition at line 27 of file Switcher.php.

◆ $_hasDefaultOption

$_hasDefaultOption = true

protected

Definition at line 58 of file Switcher.php.

◆ $_hintUrl

$_hintUrl

protected

Definition at line 53 of file Switcher.php.

◆ $_storeFactory

$_storeFactory

protected

Definition at line 86 of file Switcher.php.

◆ $_storeGroupFactory

$_storeGroupFactory

protected

Definition at line 79 of file Switcher.php.

◆ $_storeIds

$_storeIds

protected

Definition at line 46 of file Switcher.php.

◆ $_template

$_template = 'Magento_Backend::store/switcher.phtml'

protected

Definition at line 65 of file Switcher.php.

◆ $_websiteFactory

$_websiteFactory

protected

Definition at line 72 of file Switcher.php.

◆ HINT_URL

const HINT_URL = 'http://docs.magento.com/m2/ce/user_guide/configuration/scope.html'

URL for store switcher hint

Definition at line 20 of file Switcher.php.

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

vendor/magento/module-backend/Block/Store/Switcher.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _construct()

◆ _toHtml()

◆ getCurrentSelectionName()

◆ getCurrentStoreGroupName()

◆ getCurrentStoreName()

◆ getCurrentWebsiteName()

◆ getGroupCollection()

◆ getHintHtml()

◆ getHintUrl()

◆ getStoreCollection()

◆ getStoreGroupId()

◆ getStoreGroups()

◆ getStoreGroupVarName()

◆ getStoreId()

◆ getStoreIds()

◆ getStores()

◆ getStoreVarName()

◆ getSwitchUrl()

◆ getWebsiteCollection()

◆ getWebsiteId()

◆ getWebsites()

◆ getWebsiteVarName()

◆ hasDefaultOption()

◆ hasScopeSelected()

◆ isShow()

◆ isStoreGroupSelected()

◆ isStoreGroupSwitchEnabled()

◆ isStoreSelected()

◆ isStoreSwitchEnabled()

◆ isUsingIframe()

◆ isWebsiteSelected()

◆ isWebsiteSwitchEnabled()

◆ setStoreGroupVarName()

◆ setStoreIds()

◆ setStoreVarName()

◆ setWebsiteVarName()

Field Documentation

◆ $_defaultStoreGroupVarName

◆ $_defaultStoreVarName

◆ $_defaultWebsiteVarName

◆ $_hasDefaultOption

◆ $_hintUrl

◆ $_storeFactory

◆ $_storeGroupFactory

◆ $_storeIds

◆ $_template

◆ $_websiteFactory

◆ HINT_URL