TranslatedLists Class Reference

Inheritance diagram for TranslatedLists:

Public Member Functions
	__construct (\Magento\Framework\Locale\ConfigInterface $config, \Magento\Framework\Locale\ResolverInterface $localeResolver, $locale=null)
	getOptionLocales ()
	getTranslatedOptionLocales ()
	getOptionTimezones ()
	getOptionWeekdays ($preserveCodes=false, $ucFirstCode=false)
	getOptionCountries ()
	getOptionCurrencies ()
	getOptionAllCurrencies ()
	getCountryTranslation ($value, $locale=null)

Protected Member Functions
	_getOptionLocales ($translatedName=false)
	_sortOptionArray ($option)

Protected Attributes
	$_config
	$localeResolver

Detailed Description

Definition at line 14 of file TranslatedLists.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\Locale\ConfigInterface	$config,
		\Magento\Framework\Locale\ResolverInterface	$localeResolver,
			$locale = null
	)

Parameters

\Magento\Framework\Locale\ConfigInterface	$config
\Magento\Framework\Locale\ResolverInterface	$localeResolver
string	$locale

Definition at line 31 of file TranslatedLists.php.

      {
        $this->_config = $config;
        $this->localeResolver = $localeResolver;
        if ($locale !== null) {
            $this->localeResolver->setLocale($locale);
        }
    }

Member Function Documentation

_getOptionLocales()

_getOptionLocales (   $translatedName = false )

protected

Get options array for locale dropdown

Parameters

bool

$translatedName

translation flag

Returns

array @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 66 of file TranslatedLists.php.

    {
        $currentLocale = $this->localeResolver->getLocale();
        $locales = \ResourceBundle::getLocales('') ?: [];
        $languages = (new LanguageBundle())->get($currentLocale)['Languages'];
        $countries = (new RegionBundle())->get($currentLocale)['Countries'];

        $options = [];
        $allowedLocales = $this->_config->getAllowedLocales();
        foreach ($locales as $locale) {
            if (!in_array($locale, $allowedLocales)) {
                continue;
            }
            $language = \Locale::getPrimaryLanguage($locale);
            $country = \Locale::getRegion($locale);
            if (!$languages[$language] || !$countries[$country]) {
                continue;
            }
            if ($translatedName) {
                $label = ucwords(\Locale::getDisplayLanguage($locale, $locale))
                    . ' (' . \Locale::getDisplayRegion($locale, $locale) . ') / '
                    . $languages[$language]
                    . ' (' . $countries[$country] . ')';
            } else {
                $label = $languages[$language]
                    . ' (' . $countries[$country] . ')';
            }
            $options[] = ['value' => $locale, 'label' => $label];
        }
        return $this->_sortOptionArray($options);
    }

_sortOptionArray()

_sortOptionArray (   $option )

protected

Parameters

array

$option

Returns

array

Definition at line 182 of file TranslatedLists.php.

    {
        $data = [];
        foreach ($option as $item) {
            $data[$item['value']] = $item['label'];
        }
        asort($data);
        $option = [];
        foreach ($data as $key => $label) {
            $option[] = ['value' => $key, 'label' => $label];
        }
        return $option;
    }

getCountryTranslation()

getCountryTranslation	(		$value,
			$locale = null
	)

Returns the localized country name

Parameters

string	$value	Name to get detailed information about
string	$locale	Optional locale string

Returns

string

Implements ListsInterface.

Definition at line 199 of file TranslatedLists.php.

    {
        if ($locale == null) {
            return (new RegionBundle())->get($this->localeResolver->getLocale())['Countries'][$value];
        } else {
            return (new RegionBundle())->get($locale)['Countries'][$value];
        }
    }

getOptionAllCurrencies()

getOptionAllCurrencies

(

)

Retrieve all currency option list

Returns

array

Implements ListsInterface.

Definition at line 165 of file TranslatedLists.php.

    {
        $currencyBundle = new \Magento\Framework\Locale\Bundle\CurrencyBundle();
        $locale = $this->localeResolver->getLocale();
        $currencies = $currencyBundle->get($locale)['Currencies'] ?: [];

        $options = [];
        foreach ($currencies as $code => $data) {
            $options[] = ['label' => $data[1], 'value' => $code];
        }
        return $this->_sortOptionArray($options);
    }

getOptionCountries()

getOptionCountries

(

)

Retrieve country option list

Returns

array

Implements ListsInterface.

Definition at line 135 of file TranslatedLists.php.

    {
        $options = [];
        $countries = (new RegionBundle())->get($this->localeResolver->getLocale())['Countries'] ?: [];
        foreach ($countries as $code => $name) {
            $options[] = ['label' => $name, 'value' => $code];
        }
        return $this->_sortOptionArray($options);
    }

getOptionCurrencies()

getOptionCurrencies

(

)

Retrieve currency option list

Returns

array

Implements ListsInterface.

Definition at line 148 of file TranslatedLists.php.

    {
        $currencies = (new CurrencyBundle())->get($this->localeResolver->getLocale())['Currencies'] ?: [];
        $options = [];
        $allowed = $this->_config->getAllowedCurrencies();
        foreach ($currencies as $code => $data) {
            if (!in_array($code, $allowed)) {
                continue;
            }
            $options[] = ['label' => $data[1], 'value' => $code];
        }
        return $this->_sortOptionArray($options);
    }

getOptionLocales()

getOptionLocales

(

)

Get array of deployed locales.Function result has next format:

 [
    0 => [
       'value' => 'de_DE'
       'label' => 'German (Germany)'
    ],
    1 => [
       'value' => 'en_GB'
       'label' => 'English (United Kingdom)'
    ],
]

Returns

array

Implements OptionInterface.

Definition at line 46 of file TranslatedLists.php.

    {
        return $this->_getOptionLocales();
    }

getOptionTimezones()

getOptionTimezones

(

)

Retrieve timezone option list

Returns

array

Implements ListsInterface.

Definition at line 101 of file TranslatedLists.php.

    {
        $options = [];
        $locale = $this->localeResolver->getLocale();
        $zones = \DateTimeZone::listIdentifiers(\DateTimeZone::ALL) ?: [];
        foreach ($zones as $code) {
            $options[] = [
                'label' => \IntlTimeZone::createTimeZone($code)
                    ->getDisplayName(false, \IntlTimeZone::DISPLAY_LONG, $locale) . ' (' . $code . ')',
                'value' => $code,
            ];
        }
        return $this->_sortOptionArray($options);
    }

getOptionWeekdays()

getOptionWeekdays	(		$preserveCodes = false,
			$ucFirstCode = false
	)

Retrieve days of week option list

Parameters

bool	$preserveCodes
bool	$ucFirstCode

Returns

array

Implements ListsInterface.

Definition at line 119 of file TranslatedLists.php.

    {
        $options = [];
        $days = (new DataBundle())
            ->get($this->localeResolver->getLocale())['calendar']['gregorian']['dayNames']['format']['wide'] ?: [];
        $englishDays = (new DataBundle())->get('en_US')['calendar']['gregorian']['dayNames']['format']['abbreviated'];
        foreach ($days as $code => $name) {
            $code = $preserveCodes ? $englishDays[$code] : $code;
            $options[] = ['label' => $name, 'value' => $ucFirstCode ? ucfirst($code) : $code];
        }
        return $options;
    }

getTranslatedOptionLocales()

getTranslatedOptionLocales

(

)

Get array of deployed locales with translation.Function result has next format:

 [
    0 => [
       'value' => 'de_DE'
       'label' => 'Deutsch (Deutschland) / German (Germany)'
    ],
    1 => [
       'value' => 'en_GB'
       'label' => 'English (United Kingdom) / English (United Kingdom)'
    ],
]

Returns

array

Implements OptionInterface.

Definition at line 54 of file TranslatedLists.php.

    {
        return $this->_getOptionLocales(true);
    }

Field Documentation

$_config

$_config

protected

Definition at line 19 of file TranslatedLists.php.

$localeResolver

$localeResolver

protected

Definition at line 24 of file TranslatedLists.php.

---

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

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