Emulation Class Reference

Inheritance diagram for Emulation:

Public Member Functions
	__construct (\Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\View\DesignInterface $viewDesign, \Magento\Framework\App\DesignInterface $design, \Magento\Framework\TranslateInterface $translate, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, ConfigInterface $inlineConfig, \Magento\Framework\Translate\Inline\StateInterface $inlineTranslation, \Magento\Framework\Locale\ResolverInterface $localeResolver, \Psr\Log\LoggerInterface $logger, array $data=[])
	startEnvironmentEmulation ( $storeId, $area=\Magento\Framework\App\Area::AREA_FRONTEND, $force=false)
	stopEnvironmentEmulation ()
	storeCurrentEnvironmentInfo ()
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)

Protected Member Functions
	_restoreInitialInlineTranslation ($initialTranslate)
	_restoreInitialDesign (array $initialDesign)
	_restoreInitialLocale ( $initialLocaleCode, $initialArea=\Magento\Framework\App\Area::AREA_ADMINHTML)
Protected Member Functions inherited from DataObject
	_getData ($key)
	_underscore ($name)

Protected Attributes
	$_storeManager
	$_translate
	$_scopeConfig
	$_localeResolver
	$_design
	$inlineConfig
	$inlineTranslation
Protected Attributes inherited from DataObject
	$_data = []

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

Detailed Description

@api

Since

100.0.2

Definition at line 18 of file Emulation.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Framework\View\DesignInterface	$viewDesign,
		\Magento\Framework\App\DesignInterface	$design,
		\Magento\Framework\TranslateInterface	$translate,
		\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		ConfigInterface	$inlineConfig,
		\Magento\Framework\Translate\Inline\StateInterface	$inlineTranslation,
		\Magento\Framework\Locale\ResolverInterface	$localeResolver,
		\Psr\Log\LoggerInterface	$logger,
		array	$data = []
	)

Parameters

\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Framework\View\DesignInterface	$viewDesign
\Magento\Framework\App\DesignInterface	$design
\Magento\Framework\TranslateInterface	$translate
\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
ConfigInterface	$inlineConfig
\Magento\Framework\Translate\Inline\StateInterface	$inlineTranslation
\Magento\Framework\Locale\ResolverInterface	$localeResolver
\Psr\Log\LoggerInterface	$logger
array	$data	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 82 of file Emulation.php.

      {
        $this->_localeResolver = $localeResolver;
        parent::__construct($data);
        $this->_storeManager = $storeManager;
        $this->_viewDesign = $viewDesign;
        $this->_design = $design;
        $this->_translate = $translate;
        $this->_scopeConfig = $scopeConfig;
        $this->inlineConfig = $inlineConfig;
        $this->inlineTranslation = $inlineTranslation;
        $this->logger = $logger;
    }

Member Function Documentation

_restoreInitialDesign()

_restoreInitialDesign ( array  $initialDesign )

protected

Restore design of the initial store

Parameters

array

$initialDesign

Returns

$this

Definition at line 225 of file Emulation.php.

    {
        $this->_viewDesign->setDesignTheme($initialDesign['theme'], $initialDesign['area']);
        return $this;
    }

_restoreInitialInlineTranslation()

_restoreInitialInlineTranslation (   $initialTranslate )

protected

Restore initial inline translation state

Parameters

bool

$initialTranslate

Returns

$this

Definition at line 213 of file Emulation.php.

    {
        $this->inlineTranslation->resume($initialTranslate);
        return $this;
    }

_restoreInitialLocale()

_restoreInitialLocale (   $initialLocaleCode,   $initialArea = \Magento\Framework\App\Area::AREA_ADMINHTML  )

protected

Restore locale of the initial store

Parameters

string	$initialLocaleCode
string	$initialArea

Returns

$this

Definition at line 238 of file Emulation.php.

      {
        $this->_localeResolver->setLocale($initialLocaleCode);
        $this->_translate->setLocale($initialLocaleCode);
        $this->_translate->loadData($initialArea);

        return $this;
    }

startEnvironmentEmulation()

startEnvironmentEmulation	(		$storeId,
			$area = \Magento\Framework\App\Area::AREA_FRONTEND,
			$force = false
	)

Start environment emulation of the specified store

Function returns information about initial store environment and emulates environment of another store

Parameters

integer	$storeId
string	$area
bool	$force	A true value will ensure that environment is always emulated, regardless of current store

Returns

void

Definition at line 116 of file Emulation.php.

      {
        // Only allow a single level of emulation
        if ($this->initialEnvironmentInfo !== null) {
            $this->logger->error(__('Environment emulation nesting is not allowed.'));
            return;
        }

        if ($storeId == $this->_storeManager->getStore()->getStoreId() && !$force) {
            return;
        }
        $this->storeCurrentEnvironmentInfo();

        // emulate inline translations
        $this->inlineTranslation->suspend($this->inlineConfig->isActive($storeId));

        // emulate design
        $storeTheme = $this->_viewDesign->getConfigurationDesignTheme($area, ['store' => $storeId]);
        $this->_viewDesign->setDesignTheme($storeTheme, $area);

        if ($area == \Magento\Framework\App\Area::AREA_FRONTEND) {
            $designChange = $this->_design->loadChange($storeId);
            if ($designChange->getData()) {
                $this->_viewDesign->setDesignTheme($designChange->getDesign(), $area);
            }
        }

        // Current store needs to be changed right before locale change and after design change
        $this->_storeManager->setCurrentStore($storeId);

        // emulate locale
        $newLocaleCode = $this->_scopeConfig->getValue(
            $this->_localeResolver->getDefaultLocalePath(),
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
            $storeId
        );
        $this->_localeResolver->setLocale($newLocaleCode);
        $this->_translate->setLocale($newLocaleCode);
        $this->_translate->loadData($area);

        return;
    }

stopEnvironmentEmulation()

stopEnvironmentEmulation

(

)

Stop environment emulation

Function restores initial store environment

Returns

\Magento\Store\Model\App\Emulation

Definition at line 169 of file Emulation.php.

    {
        if ($this->initialEnvironmentInfo === null) {
            return $this;
        }

        $this->_restoreInitialInlineTranslation($this->initialEnvironmentInfo->getInitialTranslateInline());
        $initialDesign = $this->initialEnvironmentInfo->getInitialDesign();
        $this->_restoreInitialDesign($initialDesign);
        // Current store needs to be changed right before locale change and after design change
        $this->_storeManager->setCurrentStore($initialDesign['store']);
        $this->_restoreInitialLocale($this->initialEnvironmentInfo->getInitialLocaleCode(), $initialDesign['area']);

        $this->initialEnvironmentInfo = null;
        return $this;
    }

storeCurrentEnvironmentInfo()

storeCurrentEnvironmentInfo

(

)

Stores current environment info

Returns

void

Definition at line 191 of file Emulation.php.

    {
        $this->initialEnvironmentInfo = new \Magento\Framework\DataObject();
        $this->initialEnvironmentInfo->setInitialTranslateInline(
            $this->inlineTranslation->isEnabled()
        )->setInitialDesign(
            [
                'area' => $this->_viewDesign->getArea(),
                'theme' => $this->_viewDesign->getDesignTheme(),
                'store' => $this->_storeManager->getStore()->getStoreId(),
            ]
        )->setInitialLocaleCode(
            $this->_localeResolver->getLocale()
        );
    }

Field Documentation

$_design

$_design

protected

Definition at line 45 of file Emulation.php.

$_localeResolver

$_localeResolver

protected

Definition at line 40 of file Emulation.php.

$_scopeConfig

$_scopeConfig

protected

Definition at line 35 of file Emulation.php.

$_storeManager

$_storeManager

protected

Definition at line 23 of file Emulation.php.

$_translate

$_translate

protected

Definition at line 28 of file Emulation.php.

$inlineConfig

$inlineConfig

protected

Definition at line 50 of file Emulation.php.

$inlineTranslation

$inlineTranslation

protected

Definition at line 55 of file Emulation.php.

---

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

• vendor/magento/module-store/Model/App/Emulation.php