Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions
LocaleResolver Class Reference
Inheritance diagram for LocaleResolver:
ResolverInterface

Public Member Functions

 __construct (ResolverInterface $resolver, Config $config)
 
 getDefaultLocalePath ()
 
 setDefaultLocale ($locale)
 
 getDefaultLocale ()
 
 setLocale ($locale=null)
 
 getLocale ()
 
 emulate ($scopeId)
 
 revert ()
 

Detailed Description

Definition at line 11 of file LocaleResolver.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( ResolverInterface  $resolver,
Config  $config 
)
Parameters
ResolverInterface$resolver
Config$config

Definition at line 27 of file LocaleResolver.php.

28  {
29  $this->resolver = $resolver;
30  $this->config = $config;
31  }

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 81 of file LocaleResolver.php.

82  {
83  return $this->resolver->emulate($scopeId);
84  }

◆ getDefaultLocale()

getDefaultLocale ( )

Retrieve default locale code

Returns
string

Implements ResolverInterface.

Definition at line 52 of file LocaleResolver.php.

53  {
54  return $this->resolver->getDefaultLocale();
55  }

◆ getDefaultLocalePath()

getDefaultLocalePath ( )

Return path to default locale

Returns
string

Implements ResolverInterface.

Definition at line 36 of file LocaleResolver.php.

37  {
38  return $this->resolver->getDefaultLocalePath();
39  }

◆ getLocale()

getLocale ( )

Gets store's locale or the en_US locale if store's locale does not supported by PayPal.

Returns
string

Implements ResolverInterface.

Definition at line 70 of file LocaleResolver.php.

71  {
72  $locale = $this->resolver->getLocale();
73  $allowedLocales = $this->config->getValue('supported_locales');
74 
75  return strpos($allowedLocales, $locale) !== false ? $locale : 'en_US';
76  }

◆ revert()

revert ( )

Get last locale, used before last emulation

Returns
string|null

Implements ResolverInterface.

Definition at line 89 of file LocaleResolver.php.

90  {
91  return $this->resolver->revert();
92  }

◆ setDefaultLocale()

setDefaultLocale (   $locale)

Set default locale code

Parameters
string$locale
Returns
self

Implements ResolverInterface.

Definition at line 44 of file LocaleResolver.php.

45  {
46  return $this->resolver->setDefaultLocale($locale);
47  }

◆ setLocale()

setLocale (   $locale = null)

Set locale

Parameters
string$locale
Returns
self

Implements ResolverInterface.

Definition at line 60 of file LocaleResolver.php.

61  {
62  return $this->resolver->setLocale($locale);
63  }

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