Switcher Class Reference

Inheritance diagram for Switcher:

Public Member Functions
	__construct (\Magento\Framework\View\Element\Template\Context $context, \Magento\Framework\Data\Helper\PostHelper $postDataHelper, array $data=[], UrlHelper $urlHelper=null)
	getCurrentWebsiteId ()
	getCurrentGroupId ()
	getCurrentStoreId ()
	getRawGroups ()
	getRawStores ()
	getGroups ()
	getStores ()
	getCurrentStoreCode ()
	isStoreInUrl ()
	getStoreCode ()
	getStoreName ()
	getTargetStorePostData (Store $store, $data=[])
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 ()

Protected Attributes
	$_storeInUrl
	$_postDataHelper
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)
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 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)
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Switcher block

@api

Since

100.0.2

Definition at line 25 of file Switcher.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\View\Element\Template\Context	$context,
		\Magento\Framework\Data\Helper\PostHelper	$postDataHelper,
		array	$data = [],
		UrlHelper	$urlHelper = null
	)

Parameters

\Magento\Framework\View\Element\Template\Context	$context
\Magento\Framework\Data\Helper\PostHelper	$postDataHelper
array	$data
UrlHelper	$urlHelper

Definition at line 48 of file Switcher.php.

      {
        $this->_postDataHelper = $postDataHelper;
        parent::__construct($context, $data);
        $this->urlHelper = $urlHelper ?: ObjectManager::getInstance()->get(UrlHelper::class);
    }

Member Function Documentation

getCurrentGroupId()

getCurrentGroupId

(

)

Get current group Id.

Returns

int|null|string

Definition at line 74 of file Switcher.php.

    {
        return $this->_storeManager->getStore()->getGroupId();
    }

getCurrentStoreCode()

getCurrentStoreCode

(

)

Get current store code.

Returns

string

Definition at line 207 of file Switcher.php.

    {
        return $this->_storeManager->getStore()->getCode();
    }

getCurrentStoreId()

getCurrentStoreId

(

)

Get current Store Id.

Returns

int

Definition at line 84 of file Switcher.php.

    {
        return $this->_storeManager->getStore()->getId();
    }

getCurrentWebsiteId()

getCurrentWebsiteId

(

)

Get current website Id.

Returns

int|null|string

Definition at line 64 of file Switcher.php.

    {
        return $this->_storeManager->getStore()->getWebsiteId();
    }

getGroups()

getGroups

(

)

Retrieve list of store groups with default urls set

Returns

Group[]

Definition at line 148 of file Switcher.php.

    {
        if (!$this->hasData('groups')) {
            $rawGroups = $this->getRawGroups();
            $rawStores = $this->getRawStores();

            $groups = [];
            $localeCode = $this->_scopeConfig->getValue(
                Data::XML_PATH_DEFAULT_LOCALE,
                \Magento\Store\Model\ScopeInterface::SCOPE_STORE
            );
            foreach ($rawGroups as $group) {
                /* @var $group Group */
                if (!isset($rawStores[$group->getId()])) {
                    continue;
                }
                if ($group->getId() == $this->getCurrentGroupId()) {
                    $groups[] = $group;
                    continue;
                }

                $store = $group->getDefaultStoreByLocale($localeCode);

                if ($store) {
                    $group->setHomeUrl($store->getHomeUrl());
                    $groups[] = $group;
                }
            }
            $this->setData('groups', $groups);
        }
        return $this->getData('groups');
    }

getRawGroups()

getRawGroups

(

)

Get raw groups.

Returns

array

Definition at line 94 of file Switcher.php.

    {
        if (!$this->hasData('raw_groups')) {
            $websiteGroups = $this->_storeManager->getWebsite()->getGroups();

            $groups = [];
            foreach ($websiteGroups as $group) {
                $groups[$group->getId()] = $group;
            }
            $this->setData('raw_groups', $groups);
        }
        return $this->getData('raw_groups');
    }

getRawStores()

getRawStores

(

)

Get raw stores.

Returns

array

Definition at line 113 of file Switcher.php.

    {
        if (!$this->hasData('raw_stores')) {
            $websiteStores = $this->_storeManager->getWebsite()->getStores();
            $stores = [];
            foreach ($websiteStores as $store) {
                /* @var $store \Magento\Store\Model\Store */
                if (!$store->isActive()) {
                    continue;
                }
                $localeCode = $this->_scopeConfig->getValue(
                    Data::XML_PATH_DEFAULT_LOCALE,
                    \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
                    $store
                );
                $store->setLocaleCode($localeCode);
                $params = ['_query' => []];
                if (!$this->isStoreInUrl()) {
                    $params['_query']['___store'] = $store->getCode();
                }
                $baseUrl = $store->getUrl('', $params);

                $store->setHomeUrl($baseUrl);
                $stores[$store->getGroupId()][$store->getId()] = $store;
            }
            $this->setData('raw_stores', $stores);
        }
        return $this->getData('raw_stores');
    }

getStoreCode()

getStoreCode

(

)

Get store code.

Returns

string

Definition at line 230 of file Switcher.php.

    {
        return $this->_storeManager->getStore()->getCode();
    }

getStoreName()

getStoreName

(

)

Get store name.

Returns

null|string

Definition at line 240 of file Switcher.php.

    {
        return $this->_storeManager->getStore()->getName();
    }

getStores()

getStores

(

)

Get stores.

Returns

\Magento\Store\Model\Store[]

Definition at line 186 of file Switcher.php.

    {
        if (!$this->getData('stores')) {
            $rawStores = $this->getRawStores();

            $groupId = $this->getCurrentGroupId();
            if (!isset($rawStores[$groupId])) {
                $stores = [];
            } else {
                $stores = $rawStores[$groupId];
            }
            $this->setData('stores', $stores);
        }
        return $this->getData('stores');
    }

getTargetStorePostData()

getTargetStorePostData	(	Store	$store,
			$data = []
	)

Returns target store post data.

Parameters

Store	$store
array	$data

Returns

string

Exceptions

Definition at line 253 of file Switcher.php.

    {
        $data[\Magento\Store\Model\StoreManagerInterface::PARAM_NAME] = $store->getCode();
        $data['___from_store'] = $this->_storeManager->getStore()->getCode();

        $urlOnTargetStore = $store->getCurrentUrl(false);
        $data[ActionInterface::PARAM_NAME_URL_ENCODED] = $this->urlHelper->getEncodedUrl($urlOnTargetStore);

        $url = $this->getUrl('stores/store/redirect');

        return $this->_postDataHelper->getPostData(
            $url,
            $data
        );
    }

isStoreInUrl()

isStoreInUrl

(

)

Is store in url.

Returns

bool

Definition at line 217 of file Switcher.php.

    {
        if ($this->_storeInUrl === null) {
            $this->_storeInUrl = $this->_storeManager->getStore()->isUseStoreInUrl();
        }
        return $this->_storeInUrl;
    }

Field Documentation

$_postDataHelper

$_postDataHelper

protected

Definition at line 35 of file Switcher.php.

$_storeInUrl

$_storeInUrl

protected

Definition at line 30 of file Switcher.php.

---

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

• vendor/magento/module-store/Block/Switcher.php