Area Class Reference

Inheritance diagram for Area:

Public Member Functions
	__construct (\Psr\Log\LoggerInterface $logger, \Magento\Framework\Event\ManagerInterface $eventManager, \Magento\Framework\TranslateInterface $translator, \Magento\Framework\ObjectManagerInterface $objectManager, ConfigLoaderInterface $diConfigLoader, \Magento\Framework\App\DesignInterface $design, \Magento\Framework\App\ScopeResolverInterface $scopeResolver, \Magento\Framework\View\DesignExceptions $designExceptions, $areaCode)
	load ($part=null)
	detectDesign ($request=null)

Data Fields
const	AREA_GLOBAL = 'global'
const	AREA_FRONTEND = 'frontend'
const	AREA_ADMINHTML = 'adminhtml'
const	AREA_DOC = 'doc'
const	AREA_CRONTAB = 'crontab'
const	AREA_WEBAPI_REST = 'webapi_rest'
const	AREA_WEBAPI_SOAP = 'webapi_soap'
const	AREA_GRAPHQL = 'graphql'
const	AREA_ADMIN = 'admin'
const	PARAM_AREA = 'area'
Data Fields inherited from AreaInterface
const	PART_CONFIG = 'config'
const	PART_TRANSLATE = 'translate'
const	PART_DESIGN = 'design'

Protected Member Functions
	_applyUserAgentDesignException ($request)
	_getDesign ()
	_loadPart ($part)
	_initConfig ()
	_initTranslate ()
	_initDesign ()

Protected Attributes
	$_loadedParts
	$_code
	$_eventManager
	$_translator
	$_objectManager
	$_diConfigLoader
	$_logger
	$_design
	$_scopeResolver
	$_designExceptions

Detailed Description

Application area model

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 16 of file Area.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Psr\Log\LoggerInterface	$logger,
		\Magento\Framework\Event\ManagerInterface	$eventManager,
		\Magento\Framework\TranslateInterface	$translator,
		\Magento\Framework\ObjectManagerInterface	$objectManager,
		ConfigLoaderInterface	$diConfigLoader,
		\Magento\Framework\App\DesignInterface	$design,
		\Magento\Framework\App\ScopeResolverInterface	$scopeResolver,
		\Magento\Framework\View\DesignExceptions	$designExceptions,
			$areaCode
	)

Parameters

\Psr\Log\LoggerInterface	$logger
\Magento\Framework\Event\ManagerInterface	$eventManager
\Magento\Framework\TranslateInterface	$translator
\Magento\Framework\ObjectManagerInterface	$objectManager
ConfigLoaderInterface	$diConfigLoader
\Magento\Framework\App\DesignInterface	$design
\Magento\Framework\App\ScopeResolverInterface	$scopeResolver
\Magento\Framework\View\DesignExceptions	$designExceptions
string	$areaCode

Definition at line 110 of file Area.php.

      {
        $this->_code = $areaCode;
        $this->_objectManager = $objectManager;
        $this->_diConfigLoader = $diConfigLoader;
        $this->_eventManager = $eventManager;
        $this->_translator = $translator;
        $this->_logger = $logger;
        $this->_design = $design;
        $this->_scopeResolver = $scopeResolver;
        $this->_designExceptions = $designExceptions;
    }

Member Function Documentation

_applyUserAgentDesignException()

_applyUserAgentDesignException (   $request )

protected

Analyze user-agent information to override custom design settings

Parameters

\Magento\Framework\App\RequestInterface

$request

Returns

bool

Definition at line 174 of file Area.php.

    {
        try {
            $theme = $this->_designExceptions->getThemeByRequest($request);
            if (false !== $theme) {
                $this->_getDesign()->setDesignTheme($theme);
                return true;
            }
        } catch (\Exception $e) {
            $this->_logger->critical($e);
        }
        return false;
    }

_getDesign()

_getDesign ( )

protected

Returns

\Magento\Framework\View\DesignInterface

Definition at line 191 of file Area.php.

    {
        return $this->_objectManager->get(\Magento\Framework\View\DesignInterface::class);
    }

_initConfig()

_initConfig ( )

protected

Load area configuration

Returns

$this

Definition at line 232 of file Area.php.

    {
        $this->_objectManager->configure($this->_diConfigLoader->load($this->_code));
        return $this;
    }

_initDesign()

_initDesign ( )

protected

Initialize design

Returns

$this

Definition at line 259 of file Area.php.

    {
        $this->_getDesign()->setArea($this->_code)->setDefaultDesignTheme();
        return $this;
    }

_initTranslate()

_initTranslate ( )

protected

Initialize translate object.

Returns

$this

Definition at line 243 of file Area.php.

    {
        $this->_translator->loadData(null, false);

        \Magento\Framework\Phrase::setRenderer(
            $this->_objectManager->get(\Magento\Framework\Phrase\RendererInterface::class)
        );

        return $this;
    }

_loadPart()

_loadPart (   $part )

protected

Loading part of area

Parameters

string

$part

Returns

$this

Definition at line 202 of file Area.php.

    {
        if (isset($this->_loadedParts[$part])) {
            return $this;
        }
        \Magento\Framework\Profiler::start(
            'load_area:' . $this->_code . '.' . $part,
            ['group' => 'load_area', 'area_code' => $this->_code, 'part' => $part]
        );
        switch ($part) {
            case self::PART_CONFIG:
                $this->_initConfig();
                break;
            case self::PART_TRANSLATE:
                $this->_initTranslate();
                break;
            case self::PART_DESIGN:
                $this->_initDesign();
                break;
        }
        $this->_loadedParts[$part] = true;
        \Magento\Framework\Profiler::stop('load_area:' . $this->_code . '.' . $part);
        return $this;
    }

detectDesign()

detectDesign

(

$request = null

)

Detect and apply design for the area

Parameters

\Magento\Framework\App\RequestInterface

$request

Returns

void

Definition at line 154 of file Area.php.

    {
        if ($this->_code == self::AREA_FRONTEND) {
            $isDesignException = $request && $this->_applyUserAgentDesignException($request);
            if (!$isDesignException) {
                $this->_design->loadChange(
                    $this->_scopeResolver->getScope()->getId()
                )->changeDesign(
                    $this->_getDesign()
                );
            }
        }
    }

load()

load

(

$part = null

)

Load area data

Parameters

string | null

$part

Returns

$this

Implements AreaInterface.

Definition at line 138 of file Area.php.

    {
        if ($part === null) {
            $this->_loadPart(self::PART_CONFIG)->_loadPart(self::PART_DESIGN)->_loadPart(self::PART_TRANSLATE);
        } else {
            $this->_loadPart($part);
        }
        return $this;
    }

Field Documentation

$_code

$_code

protected

Definition at line 49 of file Area.php.

$_design

$_design

protected

Definition at line 87 of file Area.php.

$_designExceptions

$_designExceptions

protected

Definition at line 97 of file Area.php.

$_diConfigLoader

$_diConfigLoader

protected

Definition at line 75 of file Area.php.

$_eventManager

$_eventManager

protected

Definition at line 56 of file Area.php.

$_loadedParts

$_loadedParts

protected

Definition at line 42 of file Area.php.

$_logger

$_logger

protected

Definition at line 80 of file Area.php.

$_objectManager

$_objectManager

protected

Definition at line 70 of file Area.php.

$_scopeResolver

$_scopeResolver

protected

Definition at line 92 of file Area.php.

$_translator

$_translator

protected

Definition at line 63 of file Area.php.

AREA_ADMIN

const AREA_ADMIN = 'admin'

Deprecated:

Definition at line 30 of file Area.php.

AREA_ADMINHTML

const AREA_ADMINHTML = 'adminhtml'

Definition at line 20 of file Area.php.

AREA_CRONTAB

const AREA_CRONTAB = 'crontab'

Definition at line 22 of file Area.php.

AREA_DOC

const AREA_DOC = 'doc'

Definition at line 21 of file Area.php.

AREA_FRONTEND

const AREA_FRONTEND = 'frontend'

Definition at line 19 of file Area.php.

AREA_GLOBAL

const AREA_GLOBAL = 'global'

Definition at line 18 of file Area.php.

AREA_GRAPHQL

const AREA_GRAPHQL = 'graphql'

Definition at line 25 of file Area.php.

AREA_WEBAPI_REST

const AREA_WEBAPI_REST = 'webapi_rest'

Definition at line 23 of file Area.php.

AREA_WEBAPI_SOAP

const AREA_WEBAPI_SOAP = 'webapi_soap'

Definition at line 24 of file Area.php.

PARAM_AREA

const PARAM_AREA = 'area'

Area parameter.

Definition at line 35 of file Area.php.

---

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

• vendor/magento/framework/App/Area.php