State Class Reference

Inheritance diagram for State:

Public Member Functions
	__construct (\Magento\Framework\Config\ScopeInterface $configScope, $mode=self::MODE_DEFAULT)
	getMode ()
	setIsDownloader ($flag=true)
	setAreaCode ($code)
	getAreaCode ()
	isAreaCodeEmulated ()
	emulateAreaCode ($areaCode, $callback, $params=[])

Data Fields
const	PARAM_MODE = 'MAGE_MODE'
const	MODE_DEVELOPER = 'developer'
const	MODE_PRODUCTION = 'production'
const	MODE_DEFAULT = 'default'

Protected Attributes
	$_appMode
	$_isDownloader = false
	$_updateMode = false
	$_configScope
	$_areaCode
	$_isAreaCodeEmulated = false

Detailed Description

Application state flags. Can be used to retrieve current application mode and current area.

Note: Area code communication and emulation will be removed from this class.

@api

Since

100.0.2

Definition at line 17 of file State.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\Config\ScopeInterface	$configScope,
			$mode = self::MODE_DEFAULT
	)

#-

Parameters

\Magento\Framework\Config\ScopeInterface	$configScope
string	$mode

Exceptions

Definition at line 87 of file State.php.

      {
        $this->_configScope = $configScope;
        switch ($mode) {
            case self::MODE_DEVELOPER:
            case self::MODE_PRODUCTION:
            case self::MODE_DEFAULT:
                $this->_appMode = $mode;
                break;
            default:
                throw new \InvalidArgumentException("Unknown application mode: {$mode}");
        }
    }

Member Function Documentation

emulateAreaCode()

emulateAreaCode	(		$areaCode,
			$callback,
			$params = []
	)

Emulate callback inside some area code

Parameters

string	$areaCode
callable	$callback
array	$params

Returns

mixed

Exceptions

Definition at line 179 of file State.php.

    {
        $this->checkAreaCode($areaCode);

        $currentArea = $this->_areaCode;
        $this->_areaCode = $areaCode;
        $this->_isAreaCodeEmulated = true;
        try {
            $result = call_user_func_array($callback, $params);
        } catch (\Exception $e) {
            $this->_areaCode = $currentArea;
            $this->_isAreaCodeEmulated = false;
            throw $e;
        }
        $this->_areaCode = $currentArea;
        $this->_isAreaCodeEmulated = false;
        return $result;
    }

getAreaCode()

getAreaCode

(

)

Get area code

Returns

string

Exceptions

Definition at line 150 of file State.php.

    {
        if (!isset($this->_areaCode)) {
            throw new \Magento\Framework\Exception\LocalizedException(
                new \Magento\Framework\Phrase('Area code is not set')
            );
        }
        return $this->_areaCode;
    }

getMode()

getMode

(

)

Return current app mode

Returns

string

Definition at line 108 of file State.php.

    {
        return $this->_appMode;
    }

isAreaCodeEmulated()

isAreaCodeEmulated

(

)

Checks whether area code is being emulated

Returns

bool

Definition at line 165 of file State.php.

    {
        return $this->_isAreaCodeEmulated;
    }

setAreaCode()

setAreaCode

(

$code

)

Set area code

Parameters

string

$code

Returns

void

Exceptions

Definition at line 131 of file State.php.

    {
        $this->checkAreaCode($code);

        if (isset($this->_areaCode)) {
            throw new \Magento\Framework\Exception\LocalizedException(
                new \Magento\Framework\Phrase('Area code is already set')
            );
        }
        $this->_configScope->setCurrentScope($code);
        $this->_areaCode = $code;
    }

setIsDownloader()

setIsDownloader

(

$flag = true

)

Set is downloader flag

Parameters

bool

$flag

Returns

void

Definition at line 119 of file State.php.

    {
        $this->_isDownloader = $flag;
    }

Field Documentation

$_appMode

$_appMode

protected

Definition at line 29 of file State.php.

$_areaCode

$_areaCode

protected

Definition at line 57 of file State.php.

$_configScope

$_configScope

protected

Definition at line 50 of file State.php.

$_isAreaCodeEmulated

$_isAreaCodeEmulated = false

protected

Definition at line 64 of file State.php.

$_isDownloader

$_isDownloader = false

protected

Definition at line 36 of file State.php.

$_updateMode

$_updateMode = false

protected

Definition at line 43 of file State.php.

MODE_DEFAULT

const MODE_DEFAULT = 'default'

Definition at line 78 of file State.php.

MODE_DEVELOPER

const MODE_DEVELOPER = 'developer'

#+ Application modes

Definition at line 74 of file State.php.

MODE_PRODUCTION

const MODE_PRODUCTION = 'production'

Definition at line 76 of file State.php.

PARAM_MODE

const PARAM_MODE = 'MAGE_MODE'

Application run code

Definition at line 22 of file State.php.

---

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

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