Scope Class Reference

Inheritance diagram for Scope:

Public Member Functions
	__construct (\Magento\Framework\App\AreaList $areaList, $defaultScope='primary')
	getCurrentScope ()
	setCurrentScope ($scope)
	getAllScopes ()

Protected Attributes
	$_defaultScope
	$_currentScope
	$_areaList

Detailed Description

Definition at line 8 of file Scope.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\AreaList	$areaList,
			$defaultScope = 'primary'
	)

Constructor

Parameters

\Magento\Framework\App\AreaList	$areaList
string	$defaultScope

Definition at line 37 of file Scope.php.

    {
        $this->_defaultScope = $this->_currentScope = $defaultScope;
        $this->_areaList = $areaList;
    }

Member Function Documentation

getAllScopes()

getAllScopes

(

)

Retrieve list of available config scopes

Returns

string[]

Implements ScopeListInterface.

Definition at line 69 of file Scope.php.

    {
        $codes = $this->_areaList->getCodes();
        array_unshift($codes, $this->_defaultScope);
        return $codes;
    }

getCurrentScope()

getCurrentScope

(

)

Get current configuration scope identifier

Returns

string

Implements ScopeInterface.

Definition at line 48 of file Scope.php.

    {
        return $this->_currentScope;
    }

setCurrentScope()

setCurrentScope

(

$scope

)

Set current configuration scope

Parameters

string

$scope

Returns

void

Implements ScopeInterface.

Definition at line 59 of file Scope.php.

    {
        $this->_currentScope = $scope;
    }

Field Documentation

$_areaList

$_areaList

protected

Definition at line 29 of file Scope.php.

$_currentScope

$_currentScope

protected

Definition at line 22 of file Scope.php.

$_defaultScope

$_defaultScope

protected

Definition at line 15 of file Scope.php.

---

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

• vendor/magento/framework/Config/Scope.php