Resolver Class Reference

Inheritance diagram for Resolver:

Public Member Functions
	__construct (ScopeConfigInterface $scopeConfig, $defaultLocalePath, $scopeType, $locale=null)
	getDefaultLocalePath ()
	setDefaultLocale ($locale)
	getDefaultLocale ()
	setLocale ($locale=null)
	getLocale ()
	emulate ($scopeId)
	revert ()

Data Fields
const	DEFAULT_LOCALE = 'en_US'

Protected Attributes
	$defaultLocale
	$scopeType
	$locale
	$scopeConfig
	$emulatedLocales = []

Detailed Description

Definition at line 10 of file Resolver.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ScopeConfigInterface	$scopeConfig,
			$defaultLocalePath,
			$scopeType,
			$locale = null
	)

Parameters

ScopeConfigInterface	$scopeConfig
string	$defaultLocalePath
string	$scopeType
mixed	$locale

Definition at line 61 of file Resolver.php.

      {
        $this->scopeConfig = $scopeConfig;
        $this->defaultLocalePath = $defaultLocalePath;
        $this->scopeType = $scopeType;
        $this->setLocale($locale);
    }

Member Function Documentation

emulate()

emulate

(

$scopeId

)

{Push current locale to stack and replace with locale from specified scope

Parameters

int

$scopeId

Returns

string|null

}

Implements ResolverInterface.

Definition at line 132 of file Resolver.php.

    {
        $result = null;
        if ($scopeId) {
            $this->emulatedLocales[] = $this->getLocale();
            $this->locale = $this->scopeConfig->getValue(
                $this->getDefaultLocalePath(),
                $this->scopeType,
                $scopeId
            );
            $result = $this->locale;
        } else {
            $this->emulatedLocales[] = false;
        }
        return $result;
    }

getDefaultLocale()

getDefaultLocale

(

)

{Retrieve default locale code

Returns

string

}

Implements ResolverInterface.

Definition at line 93 of file Resolver.php.

    {
        if (!$this->defaultLocale) {
            $locale = $this->scopeConfig->getValue($this->getDefaultLocalePath(), $this->scopeType);
            if (!$locale) {
                $locale = self::DEFAULT_LOCALE;
            }
            $this->defaultLocale = $locale;
        }
        return $this->defaultLocale;
    }

getDefaultLocalePath()

getDefaultLocalePath

(

)

{Return path to default locale

Returns

string

}

Implements ResolverInterface.

Definition at line 76 of file Resolver.php.

    {
        return $this->defaultLocalePath;
    }

getLocale()

getLocale

(

)

{Retrieve locale

Returns

string

}

Implements ResolverInterface.

Definition at line 121 of file Resolver.php.

    {
        if ($this->locale === null) {
            $this->setLocale();
        }
        return $this->locale;
    }

revert()

revert

(

)

{Get last locale, used before last emulation

Returns

string|null

}

Implements ResolverInterface.

Definition at line 152 of file Resolver.php.

    {
        $result = null;
        $localeCode = array_pop($this->emulatedLocales);
        if ($localeCode) {
            $this->locale = $localeCode;
            $result = $this->locale;
        }
        return $result;
    }

setDefaultLocale()

setDefaultLocale

(

$locale

)

{Set default locale code

Parameters

string

$locale

Returns

self

}

Implements ResolverInterface.

Definition at line 84 of file Resolver.php.

    {
        $this->defaultLocale = $locale;
        return $this;
    }

setLocale()

setLocale

(

$locale = null

)

{Set locale

Parameters

string

$locale

Returns

self

}

Implements ResolverInterface.

Definition at line 108 of file Resolver.php.

    {
        if ($locale !== null && is_string($locale)) {
            $this->locale = $locale;
        } else {
            $this->locale = $this->getDefaultLocale();
        }
        return $this;
    }

Field Documentation

$defaultLocale

$defaultLocale

protected

Definition at line 22 of file Resolver.php.

$emulatedLocales

$emulatedLocales = []

protected

Definition at line 48 of file Resolver.php.

$locale

$locale

protected

Definition at line 36 of file Resolver.php.

$scopeConfig

$scopeConfig

protected

Definition at line 41 of file Resolver.php.

$scopeType

$scopeType

protected

Definition at line 29 of file Resolver.php.

DEFAULT_LOCALE

const DEFAULT_LOCALE = 'en_US'

Default locale

Definition at line 15 of file Resolver.php.

---

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

• vendor/magento/framework/Locale/Resolver.php