Design Class Reference

Inheritance diagram for Design:

Public Member Functions
	__construct (\Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\View\Design\Theme\FlyweightFactory $flyweightFactory, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Theme\Model\ThemeFactory $themeFactory, \Magento\Framework\ObjectManagerInterface $objectManager, \Magento\Framework\App\State $appState, array $themes)
	setArea ($area)
	getArea ()
	setDesignTheme ($theme, $area=null)
	getConfigurationDesignTheme ($area=null, array $params=[])
	setDefaultDesignTheme ()
	getDesignTheme ()
	getThemePath (\Magento\Framework\View\Design\ThemeInterface $theme)
	getLocale ()
	setLocale (\Magento\Framework\Locale\ResolverInterface $locale)
	getDesignParams ()
Public Member Functions inherited from DesignInterface
	getThemePath (Design\ThemeInterface $theme)

Protected Attributes
	$_area
	$_theme
	$_callbackFileDir
	$_storeManager
	$_flyweightFactory
	$_themeFactory
	$_locale
	$objectManager
	$_appState

Additional Inherited Members
Data Fields inherited from DesignInterface
const	DEFAULT_AREA = 'frontend'
const	PUBLIC_VIEW_DIR = '_view'
const	PUBLIC_THEME_DIR = '_theme'
const	XML_PATH_THEME_ID = 'design/theme/theme_id'

Detailed Description

Keeps design settings for current request

Definition at line 15 of file Design.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Framework\View\Design\Theme\FlyweightFactory	$flyweightFactory,
		\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		\Magento\Theme\Model\ThemeFactory	$themeFactory,
		\Magento\Framework\ObjectManagerInterface	$objectManager,
		\Magento\Framework\App\State	$appState,
		array	$themes
	)

Parameters

\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Framework\View\Design\Theme\FlyweightFactory	$flyweightFactory
\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
\Magento\Theme\Model\ThemeFactory	$themeFactory
\Magento\Framework\ObjectManagerInterface	$objectManager
\Magento\Framework\App\State	$appState
array	$themes

Definition at line 85 of file Design.php.

      {
        $this->_storeManager = $storeManager;
        $this->_flyweightFactory = $flyweightFactory;
        $this->_themeFactory = $themeFactory;
        $this->_scopeConfig = $scopeConfig;
        $this->_appState = $appState;
        $this->_themes = $themes;
        $this->objectManager = $objectManager;
    }

Member Function Documentation

getArea()

getArea

(

)

Retrieve package area

Returns

string

Implements DesignInterface.

Definition at line 121 of file Design.php.

    {
        // In order to support environment emulation of area, if area is set, return it
        if ($this->_area && !$this->_appState->isAreaCodeEmulated()) {
            return $this->_area;
        }
        return $this->_appState->getAreaCode();
    }

getConfigurationDesignTheme()

getConfigurationDesignTheme	(		$area = null,
		array	$params = []
	)

Get default theme which declared in configuration

Write default theme to core_config_data

Parameters

string | null	$area
array	$params

Returns

string|int

Implements DesignInterface.

Definition at line 163 of file Design.php.

    {
        if (!$area) {
            $area = $this->getArea();
        }

        $theme = null;
        $store = isset($params['store']) ? $params['store'] : null;

        if ($this->_isThemePerStoreView($area)) {
            if ($this->_storeManager->isSingleStoreMode()) {
                $theme = $this->_scopeConfig->getValue(
                    self::XML_PATH_THEME_ID,
                    ScopeInterface::SCOPE_WEBSITES
                );
            } else {
                $theme = (string) $this->_scopeConfig->getValue(
                    self::XML_PATH_THEME_ID,
                    ScopeInterface::SCOPE_STORE,
                    $store
                );
            }
        }

        if (!$theme && isset($this->_themes[$area])) {
            $theme = $this->_themes[$area];
        }

        return $theme;
    }

getDesignParams()

getDesignParams

(

)

{Get design settings for current request

Returns

array

}

Implements DesignInterface.

Definition at line 272 of file Design.php.

    {
        $params = [
            'area' => $this->getArea(),
            'themeModel' => $this->getDesignTheme(),
            'locale'     => $this->getLocale(),
        ];

        return $params;
    }

getDesignTheme()

getDesignTheme

(

)

Design theme model getter

Returns

\Magento\Theme\Model\Theme

Implements DesignInterface.

Definition at line 221 of file Design.php.

    {
        if ($this->_theme === null) {
            $this->_theme = $this->_themeFactory->create();
        }
        return $this->_theme;
    }

getLocale()

getLocale

(

)

Get locale

Returns

string

Implements DesignInterface.

Definition at line 251 of file Design.php.

    {
        if (null === $this->_locale) {
            $this->_locale = $this->objectManager->get(\Magento\Framework\Locale\ResolverInterface::class);
        }
        return $this->_locale->getLocale();
    }

getThemePath()

getThemePath

(

\Magento\Framework\View\Design\ThemeInterface

$theme

)

{}

Definition at line 232 of file Design.php.

    {
        $themePath = $theme->getThemePath();
        if (!$themePath) {
            $themeId = $theme->getId();
            if ($themeId) {
                $themePath = self::PUBLIC_THEME_DIR . $themeId;
            } else {
                $themePath = self::PUBLIC_VIEW_DIR;
            }
        }
        return $themePath;
    }

setArea()

setArea

(

$area

)

Set package area

Parameters

string

$area

Returns

$this

Implements DesignInterface.

Definition at line 109 of file Design.php.

    {
        $this->_area = $area;
        $this->_theme = null;
        return $this;
    }

setDefaultDesignTheme()

setDefaultDesignTheme

(

)

Set default design theme

Returns

$this

Implements DesignInterface.

Definition at line 210 of file Design.php.

    {
        $this->setDesignTheme($this->getConfigurationDesignTheme());
        return $this;
    }

setDesignTheme()

setDesignTheme	(		$theme,
			$area = null
	)

Set theme path

Parameters

\Magento\Framework\View\Design\ThemeInterface | string	$theme
string	$area

Returns

$this

Implements DesignInterface.

Definition at line 137 of file Design.php.

    {
        if ($area) {
            $this->setArea($area);
        } else {
            $area = $this->getArea();
        }

        if ($theme instanceof \Magento\Framework\View\Design\ThemeInterface) {
            $this->_theme = $theme;
        } else {
            $this->_theme = $this->_flyweightFactory->create($theme, $area);
        }

        return $this;
    }

setLocale()

setLocale

(

\Magento\Framework\Locale\ResolverInterface

$locale

)

Parameters

\Magento\Framework\Locale\ResolverInterface

$locale

Returns

$this

Definition at line 263 of file Design.php.

    {
        $this->_locale = $locale;
        return $this;
    }

Field Documentation

$_appState

$_appState

protected

Definition at line 74 of file Design.php.

$_area

$_area

protected

Definition at line 22 of file Design.php.

$_callbackFileDir

$_callbackFileDir

protected

Definition at line 37 of file Design.php.

$_flyweightFactory

$_flyweightFactory

protected

Definition at line 49 of file Design.php.

$_locale

$_locale

protected

Definition at line 64 of file Design.php.

$_storeManager

$_storeManager

protected

Definition at line 44 of file Design.php.

$_theme

$_theme

protected

Definition at line 29 of file Design.php.

$_themeFactory

$_themeFactory

protected

Definition at line 54 of file Design.php.

$objectManager

$objectManager

protected

Definition at line 69 of file Design.php.

---

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

• vendor/magento/module-theme/Model/View/Design.php