SwitchAction Class Reference

Inheritance diagram for SwitchAction:

Public Member Functions
	__construct (ActionContext $context, StoreCookieManagerInterface $storeCookieManager, HttpContext $httpContext, StoreRepositoryInterface $storeRepository, StoreManagerInterface $storeManager, StoreSwitcherInterface $storeSwitcher=null)
	execute ()
Public Member Functions inherited from Action
	__construct (Context $context)
	dispatch (RequestInterface $request)
	getActionFlag ()
Public Member Functions inherited from AbstractAction
	__construct (Context $context)
	dispatch (RequestInterface $request)
	getRequest ()
	getResponse ()

Protected Attributes
	$storeCookieManager
	$httpContext
	$storeRepository
	$storeManager
Protected Attributes inherited from Action
	$_objectManager
	$_sessionNamespace
	$_eventManager
	$_actionFlag
	$_redirect
	$_view
	$_url
	$messageManager
Protected Attributes inherited from AbstractAction
	$_request
	$_response
	$resultRedirectFactory
	$resultFactory

Additional Inherited Members
Data Fields inherited from ActionInterface
const	FLAG_NO_DISPATCH = 'no-dispatch'
const	FLAG_NO_POST_DISPATCH = 'no-postDispatch'
const	FLAG_NO_DISPATCH_BLOCK_EVENT = 'no-beforeGenerateLayoutBlocksDispatch'
const	PARAM_NAME_BASE64_URL = 'r64'
const	PARAM_NAME_URL_ENCODED = 'uenc'
Protected Member Functions inherited from Action
	_forward ($action, $controller=null, $module=null, array $params=null)
	_redirect ($path, $arguments=[])

Detailed Description

Handles store switching url and makes redirect.

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 27 of file SwitchAction.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ActionContext	$context,
		StoreCookieManagerInterface	$storeCookieManager,
		HttpContext	$httpContext,
		StoreRepositoryInterface	$storeRepository,
		StoreManagerInterface	$storeManager,
		StoreSwitcherInterface	$storeSwitcher = null
	)

Initialize dependencies.

Parameters

ActionContext	$context
StoreCookieManagerInterface	$storeCookieManager
HttpContext	$httpContext
StoreRepositoryInterface	$storeRepository
StoreManagerInterface	$storeManager
StoreSwitcherInterface	$storeSwitcher

Definition at line 66 of file SwitchAction.php.

      {
        parent::__construct($context);
        $this->storeCookieManager = $storeCookieManager;
        $this->httpContext = $httpContext;
        $this->storeRepository = $storeRepository;
        $this->storeManager = $storeManager;
        $this->messageManager = $context->getMessageManager();
        $this->storeSwitcher = $storeSwitcher ?: ObjectManager::getInstance()->get(StoreSwitcherInterface::class);
    }

Member Function Documentation

execute()

execute

(

)

Execute action

Returns

void

Exceptions

StoreSwitcher

Implements ActionInterface.

Definition at line 89 of file SwitchAction.php.

    {
        $targetStoreCode = $this->_request->getParam(
            \Magento\Store\Model\StoreManagerInterface::PARAM_NAME,
            $this->storeCookieManager->getStoreCodeFromCookie()
        );
        $fromStoreCode = $this->_request->getParam('___from_store');

        $requestedUrlToRedirect = $this->_redirect->getRedirectUrl();
        $redirectUrl = $requestedUrlToRedirect;

        $error = null;
        try {
            $fromStore = $this->storeRepository->get($fromStoreCode);
            $targetStore = $this->storeRepository->getActiveStoreByCode($targetStoreCode);
        } catch (StoreIsInactiveException $e) {
            $error = __('Requested store is inactive');
        } catch (NoSuchEntityException $e) {
            $error = __("The store that was requested wasn't found. Verify the store and try again.");
        }
        if ($error !== null) {
            $this->messageManager->addErrorMessage($error);
        } else {
            $redirectUrl = $this->storeSwitcher->switch($fromStore, $targetStore, $requestedUrlToRedirect);
        }

        $this->getResponse()->setRedirect($redirectUrl);
    }

Field Documentation

$httpContext

$httpContext

protected

Definition at line 38 of file SwitchAction.php.

$storeCookieManager

$storeCookieManager

protected

Definition at line 32 of file SwitchAction.php.

$storeManager

$storeManager

protected

Definition at line 49 of file SwitchAction.php.

$storeRepository

$storeRepository

protected

Definition at line 43 of file SwitchAction.php.

---

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

• vendor/magento/module-store/Controller/Store/SwitchAction.php