lib/internal/Magento/Framework/App/ActionFlag.php - 2.4-develop - githubmirror/magento2

lib/internal/Magento/Framework/App/ActionFlag.php

101 строка2 KB

Oleksandr Iegorov

Merge remote-tracking branch 'act4/2.4-develop' into ACP2E-4751

08 апр 2026, 23:15

08 апр 2026, 23:1527f89aa

<?php
/**
 * Copyright 2014 Adobe
 * All Rights Reserved.
 */
namespace Magento\Framework\App;

use Magento\Framework\ObjectManager\ResetAfterRequestInterface;

/**
 * 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
 */
class ActionFlag implements ResetAfterRequestInterface
{
    /**
     * @var RequestInterface
     */
    protected $_request;

    /**
     * @var array
     */
    protected $_flags = [];

    /**
     * @param RequestInterface $request
     */
    public function __construct(\Magento\Framework\App\RequestInterface $request)
    {
        $this->_request = $request;
    }

    /**
     * Setting flag value
     *
     * @param string|null $action
     * @param string|null $flag
     * @param string $value
     * @return void
     */
    public function set($action, $flag, $value)
    {
        if ('' === $action) {
            $action = $this->_request->getActionName() ?? '';
        }
        $actionKey = is_string($action) ? $action : '';
        $flagKey = is_string($flag) ? $flag : '';
        $this->_flags[$this->_getControllerKey()][$actionKey][$flagKey] = $value;
    }

    /**
     * Retrieve flag value
     *
     * @param string|null $action
     * @param string|null $flag
     * @return bool
     *
     * @SuppressWarnings(PHPMD.BooleanGetMethodName)
     */
    public function get($action, $flag = '')
    {
        if ('' === $action) {
            $action = $this->_request->getActionName() ?? '';
        }
        $actionKey = is_string($action) ? $action : '';
        if ('' === $flag) {
            return $this->_flags[$this->_getControllerKey()] ?? [];
        }
        $flagKey = is_string($flag) ? $flag : '';
        if (isset($this->_flags[$this->_getControllerKey()][$actionKey][$flagKey])) {
            return $this->_flags[$this->_getControllerKey()][$actionKey][$flagKey];
        } else {
            return false;
        }
    }

    /**
     * Get controller key
     *
     * @return string
     */
    protected function _getControllerKey()
    {
        return $this->_request->getRouteName() . '_' . $this->_request->getControllerName();
    }

    /**
     * @inheritDoc
     */
    public function _resetState(): void
    {
        $this->_flags = [];
    }
}