Action Class Reference

Inheritance diagram for Action:

Public Member Functions
	__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 ()

Protected Member Functions
	_forward ($action, $controller=null, $module=null, array $params=null)
	_redirect ($path, $arguments=[])

Protected Attributes
	$_objectManager
	$_sessionNamespace
	$_eventManager
	$_actionFlag
	$_redirect
	$_view
	$_url
	$messageManager
Protected Attributes inherited from AbstractAction
	$_request
	$_response
	$resultRedirectFactory
	$resultFactory

Additional Inherited Members
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'

Detailed Description

Extend from this class to create actions controllers in frontend area of your application. It contains standard action behavior (event dispatching, flag checks) Action classes that do not extend from this class will lose this behavior and might not function correctly

TODO: Remove this class. Allow implementation of Action Controllers by just implementing Action Interface.

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

Since

100.0.2

Definition at line 25 of file Action.php.

Constructor & Destructor Documentation

__construct()

__construct

(

Context

$context

)

Parameters

Context

$context

Definition at line 73 of file Action.php.

    {
        parent::__construct($context);
        $this->_objectManager = $context->getObjectManager();
        $this->_eventManager = $context->getEventManager();
        $this->_url = $context->getUrl();
        $this->_actionFlag = $context->getActionFlag();
        $this->_redirect = $context->getRedirect();
        $this->_view = $context->getView();
        $this->messageManager = $context->getMessageManager();
    }

Member Function Documentation

_forward()

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

protected

Throw control to different action (control and module if was specified).

Parameters

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

Returns

void

Definition at line 137 of file Action.php.

    {
        $request = $this->getRequest();

        $request->initForward();

        if (isset($params)) {
            $request->setParams($params);
        }

        if (isset($controller)) {
            $request->setControllerName($controller);

            // Module should only be reset if controller has been specified
            if (isset($module)) {
                $request->setModuleName($module);
            }
        }

        $request->setActionName($action);
        $request->setDispatched(false);
    }

_redirect()

_redirect (   $path,   $arguments = []  )

protected

Set redirect into response

Parameters

string	$path
array	$arguments

Returns

ResponseInterface

Definition at line 167 of file Action.php.

    {
        $this->_redirect->redirect($this->getResponse(), $path, $arguments);
        return $this->getResponse();
    }

dispatch()

dispatch

(

RequestInterface

$request

)

Dispatch request

Parameters

RequestInterface

$request

Returns

ResponseInterface

Exceptions

NotFoundException

Definition at line 92 of file Action.php.

    {
        $this->_request = $request;
        $profilerKey = 'CONTROLLER_ACTION:' . $request->getFullActionName();
        $eventParameters = ['controller_action' => $this, 'request' => $request];
        $this->_eventManager->dispatch('controller_action_predispatch', $eventParameters);
        $this->_eventManager->dispatch('controller_action_predispatch_' . $request->getRouteName(), $eventParameters);
        $this->_eventManager->dispatch(
            'controller_action_predispatch_' . $request->getFullActionName(),
            $eventParameters
        );
        \Magento\Framework\Profiler::start($profilerKey);

        $result = null;
        if ($request->isDispatched() && !$this->_actionFlag->get('', self::FLAG_NO_DISPATCH)) {
            \Magento\Framework\Profiler::start('action_body');
            $result = $this->execute();
            \Magento\Framework\Profiler::start('postdispatch');
            if (!$this->_actionFlag->get('', self::FLAG_NO_POST_DISPATCH)) {
                $this->_eventManager->dispatch(
                    'controller_action_postdispatch_' . $request->getFullActionName(),
                    $eventParameters
                );
                $this->_eventManager->dispatch(
                    'controller_action_postdispatch_' . $request->getRouteName(),
                    $eventParameters
                );
                $this->_eventManager->dispatch('controller_action_postdispatch', $eventParameters);
            }
            \Magento\Framework\Profiler::stop('postdispatch');
            \Magento\Framework\Profiler::stop('action_body');
        }
        \Magento\Framework\Profiler::stop($profilerKey);
        return $result ?: $this->_response;
    }

getActionFlag()

getActionFlag

(

)

Returns

\Magento\Framework\App\ActionFlag

Definition at line 176 of file Action.php.

    {
        return $this->_actionFlag;
    }

Field Documentation

$_actionFlag

$_actionFlag

protected

Definition at line 48 of file Action.php.

$_eventManager

$_eventManager

protected

Definition at line 43 of file Action.php.

$_objectManager

$_objectManager

protected

Definition at line 30 of file Action.php.

$_redirect

$_redirect

protected

Definition at line 53 of file Action.php.

$_sessionNamespace

$_sessionNamespace

protected

Definition at line 38 of file Action.php.

$_url

$_url

protected

Definition at line 63 of file Action.php.

$_view

$_view

protected

Definition at line 58 of file Action.php.

$messageManager

$messageManager

protected

Definition at line 68 of file Action.php.

---

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

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