ScopeResolver Class Reference

Inheritance diagram for ScopeResolver:

Public Member Functions
	__construct (\Magento\Framework\App\ScopeResolverInterface $scopeResolver, $areaCode=null)
	getScope ($scopeId=null)
	getScopes ()
	getAreaCode ()

Protected Attributes
	$scopeResolver
	$areaCode

Detailed Description

Class ScopeResolver

URL scope resolver.

Definition at line 14 of file ScopeResolver.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\ScopeResolverInterface	$scopeResolver,
			$areaCode = null
	)

Parameters

\Magento\Framework\App\ScopeResolverInterface	$scopeResolver
string | null	$areaCode

Definition at line 30 of file ScopeResolver.php.

    {
        $this->scopeResolver = $scopeResolver;
        $this->areaCode = $areaCode;
    }

Member Function Documentation

getAreaCode()

getAreaCode

(

)

{Retrieve area code

Returns

string|null

}

Implements ScopeResolverInterface.

Definition at line 64 of file ScopeResolver.php.

    {
        return $this->areaCode;
    }

getScope()

getScope

(

$scopeId = null

)

{Retrieve application scope object

Parameters

null | int

$scopeId

Returns

\Magento\Framework\App\ScopeInterface

}

Implements ScopeResolverInterface.

Definition at line 39 of file ScopeResolver.php.

    {
        $scope = $this->scopeResolver->getScope($scopeId);
        if (!$scope instanceof \Magento\Framework\Url\ScopeInterface) {
            throw new \Magento\Framework\Exception\LocalizedException(
                new \Magento\Framework\Phrase('The scope object is invalid. Verify the scope object and try again.')
            );
        }

        return $scope;
    }

getScopes()

getScopes

(

)

Retrieve array of URL scopes.

Returns

\Magento\Framework\Url\ScopeInterface[]

Implements ScopeResolverInterface.

Definition at line 56 of file ScopeResolver.php.

    {
        return $this->scopeResolver->getScopes();
    }

Field Documentation

$areaCode

$areaCode

protected

Definition at line 24 of file ScopeResolver.php.

$scopeResolver

$scopeResolver

protected

Definition at line 19 of file ScopeResolver.php.

---

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

• vendor/magento/framework/Url/ScopeResolver.php