DesignInterface Interface Reference

Inheritance diagram for DesignInterface:

Public Member Functions
	setArea ($area)
	getArea ()
	setDesignTheme ($theme, $area=null)
	getConfigurationDesignTheme ($area=null, array $params=[])
	setDefaultDesignTheme ()
	getDesignTheme ()
	getThemePath (Design\ThemeInterface $theme)
	getLocale ()
	getDesignParams ()

Data Fields
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

Design Interface

Definition at line 11 of file DesignInterface.php.

Member Function Documentation

getArea()

getArea

(

)

Retrieve package area

Returns

string

Implemented in Design.

getConfigurationDesignTheme()

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

Get default theme which declared in configuration

Parameters

string | null	$area
array	$params

Returns

string

Implemented in Design.

getDesignParams()

getDesignParams

(

)

Get design settings for current request

Returns

array

Implemented in Design.

getDesignTheme()

getDesignTheme

(

)

Design theme model getter

Returns

Design\ThemeInterface

Implemented in Design.

getLocale()

getLocale

(

)

Get locale

Returns

string

Implemented in Design.

getThemePath()

getThemePath

(

Design\ThemeInterface

$theme

)

Convert theme model into a theme path literal

Parameters

Design\ThemeInterface

$theme

Returns

string

setArea()

setArea

(

$area

)

Set package area

Parameters

string

$area

Returns

DesignInterface @TODO MAGETWO-31474: Remove deprecated method setArea

Implemented in Design.

setDefaultDesignTheme()

setDefaultDesignTheme

(

)

Set default design theme

Returns

DesignInterface

Implemented in Design.

setDesignTheme()

setDesignTheme	(		$theme,
			$area = null
	)

Set theme path

Parameters

Design\ThemeInterface | int | string	$theme
string | null	$area

Returns

DesignInterface

Implemented in Design.

Field Documentation

DEFAULT_AREA

const DEFAULT_AREA = 'frontend'

Default design area

Definition at line 16 of file DesignInterface.php.

PUBLIC_THEME_DIR

const PUBLIC_THEME_DIR = '_theme'

Definition at line 22 of file DesignInterface.php.

PUBLIC_VIEW_DIR

const PUBLIC_VIEW_DIR = '_view'

#+ Public directories prefix group

Definition at line 21 of file DesignInterface.php.

XML_PATH_THEME_ID

const XML_PATH_THEME_ID = 'design/theme/theme_id'

#- Common node path to theme design configuration

Definition at line 28 of file DesignInterface.php.

---

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

• vendor/magento/framework/View/DesignInterface.php