ActionFlag Class Reference

Public Member Functions
	__construct (\Magento\Framework\App\RequestInterface $request)
	set ($action, $flag, $value)
	get ($action, $flag='')

Protected Member Functions
	_getControllerKey ()

Protected Attributes
	$_request
	$_flags = []

Detailed Description

Request processing flag that allows to stop request dispatching in action controller from an observer Downside of this approach is temporal coupling and global communication. Will be deprecated when Action Component is decoupled.

Please use plugins to prevent action dispatching instead.

@api

Since

100.0.2

Definition at line 18 of file ActionFlag.php.

Constructor & Destructor Documentation

__construct()

__construct

(

\Magento\Framework\App\RequestInterface

$request

)

Parameters

RequestInterface

$request

Definition at line 33 of file ActionFlag.php.

    {
        $this->_request = $request;
    }

Member Function Documentation

_getControllerKey()

_getControllerKey ( )

protected

Get controller key

Returns

string

Definition at line 82 of file ActionFlag.php.

    {
        return $this->_request->getRouteName() . '_' . $this->_request->getControllerName();
    }

get()

get	(		$action,
			$flag = ''
	)

Retrieve flag value

Parameters

string	$action
string	$flag

Returns

bool

@SuppressWarnings(PHPMD.BooleanGetMethodName)

Definition at line 63 of file ActionFlag.php.

    {
        if ('' === $action) {
            $action = $this->_request->getActionName();
        }
        if ('' === $flag) {
            return $this->_flags[$this->_getControllerKey()] ?? [];
        } elseif (isset($this->_flags[$this->_getControllerKey()][$action][$flag])) {
            return $this->_flags[$this->_getControllerKey()][$action][$flag];
        } else {
            return false;
        }
    }

set()

set	(		$action,
			$flag,
			$value
	)

Setting flag value

Parameters

string	$action
string	$flag
string	$value

Returns

void

Definition at line 46 of file ActionFlag.php.

    {
        if ('' === $action) {
            $action = $this->_request->getActionName();
        }
        $this->_flags[$this->_getControllerKey()][$action][$flag] = $value;
    }

Field Documentation

$_flags

$_flags = []

protected

Definition at line 28 of file ActionFlag.php.

$_request

$_request

protected

Definition at line 23 of file ActionFlag.php.

---

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

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