Inheritance diagram for AbstractAction:

Public Member Functions
	__construct (Action\Context $context)

	dispatch (\Magento\Framework\App\RequestInterface $request)

	_processUrlKeys ()

	getUrl ($route='', $params=[])

Public Member Functions inherited from Action
	__construct (Context $context)

	dispatch (RequestInterface $request)

	getActionFlag ()

Public Member Functions inherited from AbstractAction
	__construct (Context $context)

	dispatch (RequestInterface $request)

	getRequest ()

	getResponse ()

Public Member Functions inherited from ActionInterface
	execute ()

Data Fields
const	FLAG_IS_URLS_CHECKED = 'check_url_settings'

const	SESSION_NAMESPACE = 'adminhtml'

const	ADMIN_RESOURCE = 'Magento_Backend::admin'

Data Fields inherited from ActionInterface
const	FLAG_NO_DISPATCH = 'no-dispatch'

const	FLAG_NO_POST_DISPATCH = 'no-postDispatch'

const	FLAG_NO_DISPATCH_BLOCK_EVENT = 'no-beforeGenerateLayoutBlocksDispatch'

const	PARAM_NAME_BASE64_URL = 'r64'

const	PARAM_NAME_URL_ENCODED = 'uenc'

Protected Member Functions
	_isAllowed ()

	_getSession ()

	getMessageManager ()

	_addBreadcrumb ($label, $title, $link=null)

	_addContent (\Magento\Framework\View\Element\AbstractBlock $block)

	_addLeft (\Magento\Framework\View\Element\AbstractBlock $block)

	_addJs (\Magento\Framework\View\Element\AbstractBlock $block)

	_isUrlChecked ()

	_processLocaleSettings ()

	_redirect ($path, $arguments=[])

	_forward ($action, $controller=null, $module=null, array $params=null)

	_validateSecretKey ()

Protected Member Functions inherited from Action
	_forward ($action, $controller=null, $module=null, array $params=null)

	_redirect ($path, $arguments=[])

Protected Attributes
	$_publicActions = []

	$_sessionNamespace = self::SESSION_NAMESPACE

	$_helper

	$_session

	$_authorization

	$_auth

	$_backendUrl

	$_localeResolver

	$_canUseBaseUrl

	$_formKeyValidator

Protected Attributes inherited from Action
	$_objectManager

	$_sessionNamespace

	$_eventManager

	$_actionFlag

	$_redirect

	$_view

	$_url

	$messageManager

Protected Attributes inherited from AbstractAction
	$_request

	$_response

	$resultRedirectFactory

	$resultFactory

Detailed Description

Generic backend controller

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

Since: 100.0.2

Definition at line 16 of file AbstractAction.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( Action\Context $context )

Parameters

\Magento\Backend\App\Action\Context $context

Definition at line 90 of file AbstractAction.php.

     {
         parent::__construct($context);
         $this->_authorization = $context->getAuthorization();
         $this->_auth = $context->getAuth();
         $this->_helper = $context->getHelper();
         $this->_backendUrl = $context->getBackendUrl();
         $this->_formKeyValidator = $context->getFormKeyValidator();
         $this->_localeResolver = $context->getLocaleResolver();
         $this->_canUseBaseUrl = $context->getCanUseBaseUrl();
         $this->_session = $context->getSession();
     }

Member Function Documentation

◆ _addBreadcrumb()

_addBreadcrumb	(	$label,
		$title,
		$link = `null`
	)

protected

Parameters

string	$label
string	$title
string \| null	$link

Returns: $this

Definition at line 154 of file AbstractAction.php.

     {
         $this->_view->getLayout()->getBlock('breadcrumbs')->addLink($label, $title, $link);
         return $this;
     }

◆ _addContent()

_addContent ( \Magento\Framework\View\Element\AbstractBlock $block )

protected

Parameters

\Magento\Framework\View\Element\AbstractBlock $block

Returns: $this

Definition at line 164 of file AbstractAction.php.

     {
         return $this->_moveBlockToContainer($block, 'content');
     }

◆ _addJs()

_addJs ( \Magento\Framework\View\Element\AbstractBlock $block )

protected

Parameters

\Magento\Framework\View\Element\AbstractBlock $block

Returns: $this

Definition at line 182 of file AbstractAction.php.

     {
         return $this->_moveBlockToContainer($block, 'js');
     }

◆ _addLeft()

_addLeft ( \Magento\Framework\View\Element\AbstractBlock $block )

protected

Parameters

\Magento\Framework\View\Element\AbstractBlock $block

Returns: $this

Definition at line 173 of file AbstractAction.php.

     {
         return $this->_moveBlockToContainer($block, 'left');
     }

◆ _forward()

_forward	(		$action,
			$controller = `null`,
			$module = `null`,
		array	$params = `null`
	)

protected

Forward to action

@TODO MAGETWO-28356: Refactor controller actions to new ResultInterface

Parameters

string	$action
string \| null	$controller
string \| null	$module
array \| null	$params

Returns: void

Definition at line 333 of file AbstractAction.php.

     {
         $this->_getSession()->setIsUrlNotice($this->_actionFlag->get('', self::FLAG_IS_URLS_CHECKED));
         return parent::_forward($action, $controller, $module, $params);
     }

◆ _getSession()

_getSession ( )

protected

Retrieve adminhtml session model object

Returns: \Magento\Backend\Model\Session

Definition at line 116 of file AbstractAction.php.

     {
         return $this->_session;
     }

◆ _isAllowed()

_isAllowed ( )

protected

Returns: bool

Definition at line 106 of file AbstractAction.php.

     {
         return $this->_authorization->isAllowed(static::ADMIN_RESOURCE);
     }

◆ _isUrlChecked()

_isUrlChecked ( )

protected

Check whether url is checked

Returns: bool

Definition at line 239 of file AbstractAction.php.

     {
         return !$this->_actionFlag->get('', self::FLAG_IS_URLS_CHECKED)
         && !$this->getRequest()->isForwarded()
         && !$this->_getSession()->getIsUrlNotice(true)
         && !$this->_canUseBaseUrl;
     }

◆ _processLocaleSettings()

_processLocaleSettings ( )

protected

Set session locale, process force locale set through url params

Returns: $this

Definition at line 294 of file AbstractAction.php.

     {
         $forceLocale = $this->getRequest()->getParam('locale', null);
         if ($this->_objectManager->get(\Magento\Framework\Validator\Locale::class)->isValid($forceLocale)) {
             $this->_getSession()->setSessionLocale($forceLocale);
         }
 
         if ($this->_getSession()->getLocale() === null) {
             $this->_getSession()->setLocale($this->_localeResolver->getLocale());
         }
 
         return $this;
     }

◆ _processUrlKeys()

_processUrlKeys ( )

Check url keys. If non valid - redirect

Returns: bool

See also: \Magento\Backend\App\Request\BackendValidator for default request validation.

Definition at line 255 of file AbstractAction.php.

     {
         $_isValidFormKey = true;
         $_isValidSecretKey = true;
         $_keyErrorMsg = '';
         if ($this->_auth->isLoggedIn()) {
             if ($this->getRequest()->isPost()) {
                 $_isValidFormKey = $this->_formKeyValidator->validate($this->getRequest());
                 $_keyErrorMsg = __('Invalid Form Key. Please refresh the page.');
             } elseif ($this->_backendUrl->useSecretKey()) {
                 $_isValidSecretKey = $this->_validateSecretKey();
                 $_keyErrorMsg = __('You entered an invalid Secret Key. Please refresh the page.');
             }
         }
         if (!$_isValidFormKey || !$_isValidSecretKey) {
             $this->_actionFlag->set('', self::FLAG_NO_DISPATCH, true);
             $this->_actionFlag->set('', self::FLAG_NO_POST_DISPATCH, true);
             if ($this->getRequest()->getQuery('isAjax', false) || $this->getRequest()->getQuery('ajax', false)) {
                 $this->getResponse()->representJson(
                     $this->_objectManager->get(
                         \Magento\Framework\Json\Helper\Data::class
                     )->jsonEncode(
                         ['error' => true, 'message' => $_keyErrorMsg]
                     )
                 );
             } else {
                 $this->_redirect($this->_backendUrl->getStartupPageUrl());
             }
             return false;
         }
         return true;
     }

◆ _redirect()

_redirect	(	$path,
		$arguments = `[]`
	)

protected

Set redirect into response

@TODO MAGETWO-28356: Refactor controller actions to new ResultInterface

Parameters

string	$path
array	$arguments

Returns: \Magento\Framework\App\ResponseInterface

Definition at line 316 of file AbstractAction.php.

     {
         $this->_getSession()->setIsUrlNotice($this->_actionFlag->get('', self::FLAG_IS_URLS_CHECKED));
         $this->getResponse()->setRedirect($this->getUrl($path, $arguments));
         return $this->getResponse();
     }

◆ _validateSecretKey()

_validateSecretKey ( )

protected

Validate Secret Key

Returns: bool

Definition at line 356 of file AbstractAction.php.

     {
         if (is_array($this->_publicActions) && in_array($this->getRequest()->getActionName(), $this->_publicActions)) {
             return true;
         }
 
         $secretKey = $this->getRequest()->getParam(\Magento\Backend\Model\UrlInterface::SECRET_KEY_PARAM_NAME, null);
         if (!$secretKey || $secretKey != $this->_backendUrl->getSecretKey()) {
             return false;
         }
         return true;
     }

◆ dispatch()

dispatch ( \Magento\Framework\App\RequestInterface $request )

Parameters

\Magento\Framework\App\RequestInterface $request

Returns: \Magento\Framework\App\ResponseInterface

Definition at line 206 of file AbstractAction.php.

     {
         if ($request->isDispatched() && $request->getActionName() !== 'denied' && !$this->_isAllowed()) {
             $this->_response->setStatusHeader(403, '1.1', 'Forbidden');
             if (!$this->_auth->isLoggedIn()) {
                 return $this->_redirect('*/auth/login');
             }
             $this->_view->loadLayout(['default', 'adminhtml_denied'], true, true, false);
             $this->_view->renderLayout();
             $this->_request->setDispatched(true);
 
             return $this->_response;
         }
 
         if ($this->_isUrlChecked()) {
             $this->_actionFlag->set('', self::FLAG_IS_URLS_CHECKED, true);
         }
 
         $this->_processLocaleSettings();
 
         // Need to preload isFirstPageAfterLogin (see https://github.com/magento/magento2/issues/15510)
         if ($this->_auth->isLoggedIn()) {
             $this->_auth->getAuthStorage()->isFirstPageAfterLogin();
         }
 
         return parent::dispatch($request);
     }

◆ getMessageManager()

getMessageManager ( )

protected

Returns: \Magento\Framework\Message\ManagerInterface

Definition at line 124 of file AbstractAction.php.

     {
         return $this->messageManager;
     }

◆ getUrl()

getUrl	(	$route = `''`,
		$params = `[]`
	)

Generate url by route and parameters

Parameters

string	$route
array	$params

Returns: string

Definition at line 346 of file AbstractAction.php.

     {
         return $this->_helper->getUrl($route, $params);
     }

Field Documentation

◆ $_auth

$_auth

protected

Definition at line 65 of file AbstractAction.php.

◆ $_authorization

$_authorization

protected

Definition at line 60 of file AbstractAction.php.

◆ $_backendUrl

$_backendUrl

protected

Definition at line 70 of file AbstractAction.php.

◆ $_canUseBaseUrl

$_canUseBaseUrl

protected

Definition at line 80 of file AbstractAction.php.

◆ $_formKeyValidator

$_formKeyValidator

protected

Definition at line 85 of file AbstractAction.php.

◆ $_helper

$_helper

protected

Definition at line 50 of file AbstractAction.php.

◆ $_localeResolver

$_localeResolver

protected

Definition at line 75 of file AbstractAction.php.

◆ $_publicActions

$_publicActions = []

protected

Definition at line 38 of file AbstractAction.php.

◆ $_session

$_session

protected

Definition at line 55 of file AbstractAction.php.

◆ $_sessionNamespace

$_sessionNamespace = self::SESSION_NAMESPACE

protected

Definition at line 45 of file AbstractAction.php.

◆ ADMIN_RESOURCE

const ADMIN_RESOURCE = 'Magento_Backend::admin'

Authorization level of a basic admin session

Definition at line 31 of file AbstractAction.php.

◆ FLAG_IS_URLS_CHECKED

const FLAG_IS_URLS_CHECKED = 'check_url_settings'

Name of "is URLs checked" flag

Definition at line 21 of file AbstractAction.php.

◆ SESSION_NAMESPACE

const SESSION_NAMESPACE = 'adminhtml'

Session namespace to refer in other places

Definition at line 26 of file AbstractAction.php.

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

vendor/magento/module-backend/App/AbstractAction.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _addBreadcrumb()

◆ _addContent()

◆ _addJs()

◆ _addLeft()

◆ _forward()

◆ _getSession()

◆ _isAllowed()

◆ _isUrlChecked()

◆ _processLocaleSettings()

◆ _processUrlKeys()

◆ _redirect()

◆ _validateSecretKey()

◆ dispatch()

◆ getMessageManager()

◆ getUrl()

Field Documentation

◆ $_auth

◆ $_authorization

◆ $_backendUrl

◆ $_canUseBaseUrl

◆ $_formKeyValidator

◆ $_helper

◆ $_localeResolver

◆ $_publicActions

◆ $_session

◆ $_sessionNamespace

◆ ADMIN_RESOURCE

◆ FLAG_IS_URLS_CHECKED

◆ SESSION_NAMESPACE