Public Member Functions
	__construct (Request $request, ManagerInterface $eventManager, UrlInterface $urlBuilder, TranslateInterface $translator, Cache $cache, DesignInterface $design, SessionManager $session, ScopeConfigInterface $scopeConfig, FrontControllerInterface $frontController, ViewConfig $viewConfig, CacheState $cacheState, Logger $logger, AppState $appState, LayoutInterface $layout)

	getCache ()

	getDesignPackage ()

	getEventManager ()

	getFrontController ()

	getLayout ()

	getRequest ()

	getSession ()

	getScopeConfig ()

	getTranslator ()

	getUrlBuilder ()

	getViewConfig ()

	getCacheState ()

	getLogger ()

	getArea ()

	getModuleName ()

	getFrontName ()

	getControllerName ()

	getActionName ()

	getFullActionName ()

	getAcceptType ()

	getPost ($key=null, $default=null)

	getQuery ($key=null, $default=null)

	getParam ($key=null, $default=null)

	getParams ()

	getHeader ($header)

	getContent ()

	getAppState ()

Protected Member Functions
	getPhysicalTheme (Design\ThemeInterface $theme)

Protected Attributes
	$request

	$eventManager

	$urlBuilder

	$translator

	$cache

	$design

	$session

	$scopeConfig

	$frontController

	$layout

	$viewConfig

	$cacheState

	$logger

	$appState

Detailed Description

Application Runtime Context

Todo:

Reduce fields number

Reduce class dependencies

@SuppressWarnings(PHPMD.TooManyFields) @SuppressWarnings(PHPMD.CouplingBetweenObjects) @api

Since: 100.0.2

Definition at line 32 of file Context.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	Request	$request,
		ManagerInterface	$eventManager,
		UrlInterface	$urlBuilder,
		TranslateInterface	$translator,
		Cache	$cache,
		DesignInterface	$design,
		SessionManager	$session,
		ScopeConfigInterface	$scopeConfig,
		FrontControllerInterface	$frontController,
		ViewConfig	$viewConfig,
		CacheState	$cacheState,
		Logger	$logger,
		AppState	$appState,
		LayoutInterface	$layout
	)

Constructor

Parameters

Request	$request
ManagerInterface	$eventManager
UrlInterface	$urlBuilder
TranslateInterface	$translator
Cache	$cache
DesignInterface	$design
SessionManager	$session
ScopeConfigInterface	$scopeConfig
FrontControllerInterface	$frontController
ViewConfig	$viewConfig
CacheState	$cacheState
Logger	$logger
AppState	$appState
LayoutInterface	$layout

Todo:: reduce parameter number

@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 153 of file Context.php.

       {
         $this->request = $request;
         $this->eventManager = $eventManager;
         $this->urlBuilder = $urlBuilder;
         $this->translator = $translator;
         $this->cache = $cache;
         $this->design = $design;
         $this->session = $session;
         $this->scopeConfig = $scopeConfig;
         $this->frontController = $frontController;
         $this->viewConfig      = $viewConfig;
         $this->cacheState      = $cacheState;
         $this->logger          = $logger;
         $this->appState        = $appState;
         $this->layout          = $layout;
     }

Member Function Documentation

◆ getAcceptType()

getAcceptType ( )

Retrieve acceptance type

Returns: string

Definition at line 378 of file Context.php.

     {
         // TODO: do intelligence here
         $type = $this->getHeader('Accept', 'html');
         if (strpos($type, 'json') !== false) {
             return 'json';
         } elseif (strpos($type, 'soap') !== false) {
             return 'soap';
         } elseif (strpos($type, 'text/html') !== false) {
             return 'html';
         } else {
             return 'xml';
         }
     }

◆ getActionName()

getActionName ( )

Retrieve the action name

Returns: string

Definition at line 358 of file Context.php.

     {
         return $this->getRequest()->getActionName();
     }

◆ getAppState()

getAppState ( )

Retrieve application state

Returns: \Magento\Framework\App\State

Definition at line 465 of file Context.php.

     {
         return $this->appState;
     }

◆ getArea()

getArea ( )

Retrieve layout area

Returns: string

Definition at line 320 of file Context.php.

     {
         return $this->appState->getAreaCode();
     }

◆ getCache()

getCache ( )

Retrieve cache

Returns: \Magento\Framework\App\CacheInterface

Definition at line 190 of file Context.php.

     {
         return $this->cache;
     }

◆ getCacheState()

getCacheState ( )

Retrieve cache state

Returns: \Magento\Framework\App\Cache\StateInterface

Definition at line 300 of file Context.php.

     {
         return $this->cacheState;
     }

◆ getContent()

getContent ( )

Return the raw body of the request, if present

Returns: string|false Raw body, or false if not present

Definition at line 455 of file Context.php.

     {
         return $this->getRequest()->getContent();
     }

◆ getControllerName()

getControllerName ( )

Retrieve the controller name

Returns: string

Definition at line 348 of file Context.php.

     {
         return $this->getRequest()->getControllerName();
     }

◆ getDesignPackage()

getDesignPackage ( )

Retrieve design package

Returns: \Magento\Framework\View\DesignInterface

Definition at line 200 of file Context.php.

     {
         return $this->design;
     }

◆ getEventManager()

getEventManager ( )

Retrieve event manager

Returns: ManagerInterface

Definition at line 210 of file Context.php.

     {
         return $this->eventManager;
     }

◆ getFrontController()

getFrontController ( )

Retrieve front controller

Returns: FrontControllerInterface

Definition at line 220 of file Context.php.

     {
         return $this->frontController;
     }

◆ getFrontName()

getFrontName ( )

See also: getModuleName

Definition at line 338 of file Context.php.

     {
         return $this->getModuleName();
     }

◆ getFullActionName()

getFullActionName ( )

Retrieve the full action name

Returns: string

Definition at line 368 of file Context.php.

     {
         return strtolower($this->getFrontName() . '_' . $this->getControllerName() . '_' . $this->getActionName());
     }

◆ getHeader()

getHeader ( $header )

Return the value of the given HTTP header.

Parameters

string $header

Returns: string|false HTTP header value, or false if not found

Definition at line 445 of file Context.php.

     {
         return $this->getRequest()->getHeader($header);
     }

◆ getLayout()

getLayout ( )

Retrieve layout

Returns: \Magento\Framework\View\LayoutInterface

Definition at line 230 of file Context.php.

     {
         return $this->layout;
     }

◆ getLogger()

getLogger ( )

Retrieve logger

Returns: \Psr\Log\LoggerInterface

Definition at line 310 of file Context.php.

     {
         return $this->logger;
     }

◆ getModuleName()

getModuleName ( )

Retrieve the module name

Returns: string

Definition at line 330 of file Context.php.

     {
         return $this->getRequest()->getModuleName();
     }

◆ getParam()

getParam	(	$key = `null`,
		$default = `null`
	)

Retrieve a parameter

Parameters

string \| null	$key
mixed	$default	Default value to use if key not found

Returns: mixed

Definition at line 424 of file Context.php.

     {
         return $this->getRequest()->getParam($key, $default);
     }

◆ getParams()

getParams ( )

Retrieve an array of parameters

Returns: array

Definition at line 434 of file Context.php.

     {
         return $this->getRequest()->getParams();
     }

◆ getPhysicalTheme()

getPhysicalTheme ( Design\ThemeInterface $theme )

protected

Retrieve parent theme instance

Parameters

Design\ThemeInterface $theme

Returns: Design\ThemeInterface

Exceptions

Definition at line 477 of file Context.php.

     {
         $result = $theme;
         while ($result->getId() && !$result->isPhysical()) {
             $result = $result->getParentTheme();
         }
         if (!$result) {
             throw new \Exception("Unable to find a physical ancestor for a theme '{$theme->getThemeTitle()}'.");
         }
         return $result;
     }

◆ getPost()

getPost	(	$key = `null`,
		$default = `null`
	)

Retrieve a member of the $_POST superglobal

Parameters

string	$key
mixed	$default	Default value to use if key not found

Returns: mixed|null if key does not exist

Definition at line 400 of file Context.php.

     {
         return $this->getRequest()->getPost($key, $default);
     }

◆ getQuery()

getQuery	(	$key = `null`,
		$default = `null`
	)

Retrieve a member of the $_POST superglobal

Parameters

string \| null	$key
mixed	$default	Default value to use if key not found

Returns: mixed alias of getPost

Definition at line 412 of file Context.php.

     {
         return $this->getRequest()->getPost($key, $default);
     }

◆ getRequest()

getRequest ( )

Retrieve request

Returns: Request

Definition at line 240 of file Context.php.

     {
         return $this->request;
     }

◆ getScopeConfig()

getScopeConfig ( )

Retrieve scope config

Returns: \Magento\Framework\App\Config\ScopeConfigInterface

Definition at line 260 of file Context.php.

     {
         return $this->scopeConfig;
     }

◆ getSession()

getSession ( )

Retrieve session

Returns: \Magento\Framework\Session\SessionManagerInterface

Definition at line 250 of file Context.php.

     {
         return $this->session;
     }

◆ getTranslator()

getTranslator ( )

Retrieve translator

Returns: \Magento\Framework\TranslateInterface

Definition at line 270 of file Context.php.

     {
         return $this->translator;
     }

◆ getUrlBuilder()

getUrlBuilder ( )

Retrieve URL builder

Returns: \Magento\Framework\UrlInterface

Definition at line 280 of file Context.php.

     {
         return $this->urlBuilder;
     }

◆ getViewConfig()

getViewConfig ( )

Retrieve view config

Returns: \Magento\Framework\View\ConfigInterface

Definition at line 290 of file Context.php.

     {
         return $this->viewConfig;
     }

Field Documentation

◆ $appState

$appState

protected

Definition at line 129 of file Context.php.

◆ $cache

$cache

protected

Definition at line 66 of file Context.php.

◆ $cacheState

$cacheState

protected

Definition at line 115 of file Context.php.

◆ $design

$design

protected

Definition at line 73 of file Context.php.

◆ $eventManager

$eventManager

protected

Definition at line 46 of file Context.php.

◆ $frontController

$frontController

protected

Definition at line 94 of file Context.php.

◆ $layout

$layout

protected

Definition at line 101 of file Context.php.

◆ $logger

$logger

protected

Definition at line 122 of file Context.php.

◆ $request

$request

protected

Definition at line 39 of file Context.php.

◆ $scopeConfig

$scopeConfig

protected

Definition at line 87 of file Context.php.

◆ $session

$session

protected

Definition at line 80 of file Context.php.

◆ $translator

$translator

protected

Definition at line 59 of file Context.php.

◆ $urlBuilder

$urlBuilder

protected

Definition at line 52 of file Context.php.

◆ $viewConfig

$viewConfig

protected

Definition at line 108 of file Context.php.

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

vendor/magento/framework/View/Context.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getAcceptType()

◆ getActionName()

◆ getAppState()

◆ getArea()

◆ getCache()

◆ getCacheState()

◆ getContent()

◆ getControllerName()

◆ getDesignPackage()

◆ getEventManager()

◆ getFrontController()

◆ getFrontName()

◆ getFullActionName()

◆ getHeader()

◆ getLayout()

◆ getLogger()

◆ getModuleName()

◆ getParam()

◆ getParams()

◆ getPhysicalTheme()

◆ getPost()

◆ getQuery()

◆ getRequest()

◆ getScopeConfig()

◆ getSession()

◆ getTranslator()

◆ getUrlBuilder()

◆ getViewConfig()

Field Documentation

◆ $appState

◆ $cache

◆ $cacheState

◆ $design

◆ $eventManager

◆ $frontController

◆ $layout

◆ $logger

◆ $request

◆ $scopeConfig

◆ $session

◆ $translator

◆ $urlBuilder

◆ $viewConfig