The Intl Component

This component provides access to the localization data of the ICU library.It also provides a PHP replacement layer for the C intl extension.

Caution

The replacement layer is limited to the locale "en". If you want to useother locales, you should install the intl extension instead.

This article explains how to use the Intl features as an independent componentin any PHP application. Read the Translations article to learn abouthow to internationalize and manage the user locale in Symfony applications.

Installation

  1. $ composer require symfony/intl

Note

If you install this component outside of a Symfony application, you mustrequire the vendor/autoload.php file in your code to enable the classautoloading mechanism provided by Composer. Readthis article for more details.

If you install the component via Composer, the following classes and functionsof the intl extension will be automatically provided if the intl extension isnot loaded:

Accessing ICU Data

This component provides the following ICU data:

Language and Script Names

The Languages class provides access to the name of all languagesaccording to the ISO 639-1 alpha-2 list and the ISO 639-2 alpha-3 list:

  1. use Symfony\Component\Intl\Languages;
  2.  
  3. \Locale::setDefault('en');
  4.  
  5. $languages = Languages::getNames();
  6. // ('languageCode' => 'languageName')
  7. // => ['ab' => 'Abkhazian', 'ace' => 'Achinese', ...]
  8.  
  9. $language = Languages::getName('fr');
  10. // => 'French'

All methods accept the translation locale as the last, optional parameter,which defaults to the current default locale:

  1. $languages = Languages::getNames('de');
  2. // => ['ab' => 'Abchasisch', 'ace' => 'Aceh', ...]
  3.  
  4. $language = Languages::getName('fr', 'de');
  5. // => 'Französisch'

If the given locale doesn't exist, the methods trigger aMissingResourceException. In additionto catching the exception, you can also check if a given language code is valid:

  1. $isValidLanguage = Languages::exists($languageCode);

New in version 4.3: The Languages class was introduced in Symfony 4.3.

The Scripts class provides access to the optional four-letter script codethat can follow the language code according to the Unicode ISO 15924 Registry(e.g. HANS in zh_HANS for simplified Chinese and HANT in zh_HANTfor traditional Chinese):

  1. use Symfony\Component\Intl\Scripts;
  2.  
  3. \Locale::setDefault('en');
  4.  
  5. $scripts = Scripts::getNames();
  6. // ('scriptCode' => 'scriptName')
  7. // => ['Adlm' => 'Adlam', 'Afak' => 'Afaka', ...]
  8.  
  9. $script = Scripts::getName('Hans');
  10. // => 'Simplified'

All methods accept the translation locale as the last, optional parameter,which defaults to the current default locale:

  1. $scripts = Scripts::getNames('de');
  2. // => ['Adlm' => 'Adlam', 'Afak' => 'Afaka', ...]
  3.  
  4. $script = Scripts::getName('Hans', 'de');
  5. // => 'Vereinfacht'

If the given script code doesn't exist, the methods trigger aMissingResourceException. In additionto catching the exception, you can also check if a given script code is valid:

  1. $isValidScript = Scripts::exists($scriptCode);

New in version 4.3: The Scripts class was introduced in Symfony 4.3.

Country Names

The Countries class provides access to the name of all countries accordingto the ISO 3166-1 alpha-2 list of officially recognized countries andterritories:

  1. use Symfony\Component\Intl\Countries;
  2.  
  3. \Locale::setDefault('en');
  4.  
  5. $countries = Countries::getNames();
  6. // ('countryCode' => 'countryName')
  7. // => ['AF' => 'Afghanistan', 'AX' => 'Åland Islands', ...]
  8.  
  9. $country = Countries::getName('GB');
  10. // => 'United Kingdom'

All methods accept the translation locale as the last, optional parameter,which defaults to the current default locale:

  1. $countries = Countries::getNames('de');
  2. // => ['AF' => 'Afghanistan', 'EG' => 'Ägypten', ...]
  3.  
  4. $country = Countries::getName('GB', 'de');
  5. // => 'Vereinigtes Königreich'

If the given country code doesn't exist, the methods trigger aMissingResourceException. In additionto catching the exception, you can also check if a given country code is valid:

  1. $isValidCountry = Countries::exists($countryCode);

New in version 4.3: The Countries class was introduced in Symfony 4.3.

Locales

A locale is the combination of a language and a region. For example, "Chinese"is the language and zh_Hans_MO is the locale for "Chinese" (language) +"Simplified" (script) + "Macau SAR China" (region). The Locales classprovides access to the name of all locales:

  1. use Symfony\Component\Intl\Locales;
  2.  
  3. \Locale::setDefault('en');
  4.  
  5. $locales = Locales::getNames();
  6. // ('localeCode' => 'localeName')
  7. // => ['af' => 'Afrikaans', 'af_NA' => 'Afrikaans (Namibia)', ...]
  8.  
  9. $locale = Locales::getName('zh_Hans_MO');
  10. // => 'Chinese (Simplified, Macau SAR China)'

All methods accept the translation locale as the last, optional parameter,which defaults to the current default locale:

  1. $locales = Locales::getNames('de');
  2. // => ['af' => 'Afrikaans', 'af_NA' => 'Afrikaans (Namibia)', ...]
  3.  
  4. $locale = Locales::getName('zh_Hans_MO', 'de');
  5. // => 'Chinesisch (Vereinfacht, Sonderverwaltungsregion Macau)'

If the given locale code doesn't exist, the methods trigger aMissingResourceException. In additionto catching the exception, you can also check if a given locale code is valid:

  1. $isValidLocale = Locales::exists($localeCode);

New in version 4.3: The Locales class was introduced in Symfony 4.3.

Currencies

The Currencies class provides access to the name of all currencies as wellas some of their information (symbol, fraction digits, etc.):

  1. use Symfony\Component\Intl\Currencies;
  2.  
  3. \Locale::setDefault('en');
  4.  
  5. $currencies = Currencies::getNames();
  6. // ('currencyCode' => 'currencyName')
  7. // => ['AFN' => 'Afghan Afghani', 'ALL' => 'Albanian Lek', ...]
  8.  
  9. $currency = Currencies::getName('INR');
  10. // => 'Indian Rupee'
  11.  
  12. $symbol = Currencies::getSymbol('INR');
  13. // => '₹'
  14.  
  15. $fractionDigits = Currencies::getFractionDigits('INR');
  16. // => 2
  17.  
  18. $roundingIncrement = Currencies::getRoundingIncrement('INR');
  19. // => 0

All methods (except for getFractionDigits() and getRoundingIncrement())accept the translation locale as the last, optional parameter, which defaults tothe current default locale:

  1. $currencies = Currencies::getNames('de');
  2. // => ['AFN' => 'Afghanischer Afghani', 'EGP' => 'Ägyptisches Pfund', ...]
  3.  
  4. $currency = Currencies::getName('INR', 'de');
  5. // => 'Indische Rupie'

If the given currency code doesn't exist, the methods trigger aMissingResourceException. In additionto catching the exception, you can also check if a given currency code is valid:

  1. $isValidCurrency = Currencies::exists($currencyCode);

New in version 4.3: The Currencies class was introduced in Symfony 4.3.

Timezones

The Timezones class provides several utilities related to timezones. First,you can get the name and values of all timezones in all languages:

  1. use Symfony\Component\Intl\Timezones;
  2.  
  3. \Locale::setDefault('en');
  4.  
  5. $timezones = Timezones::getNames();
  6. // ('timezoneID' => 'timezoneValue')
  7. // => ['America/Eirunepe' => 'Acre Time (Eirunepe)', 'America/Rio_Branco' => 'Acre Time (Rio Branco)', ...]
  8.  
  9. $timezone = Timezones::getName('Africa/Nairobi');
  10. // => 'East Africa Time (Nairobi)'

All methods accept the translation locale as the last, optional parameter,which defaults to the current default locale:

  1. $timezones = Timezones::getNames('de');
  2. // => ['America/Eirunepe' => 'Acre-Zeit (Eirunepe)', 'America/Rio_Branco' => 'Acre-Zeit (Rio Branco)', ...]
  3.  
  4. $timezone = Timezones::getName('Africa/Nairobi', 'de');
  5. // => 'Ostafrikanische Zeit (Nairobi)'

You can also get all the timezones that exist in a given country. TheforCountryCode() method returns one or more timezone IDs, which you cantranslate into any locale with the getName() method shown earlier:

  1. // unlike language codes, country codes are always uppercase (CL = Chile)
  2. $timezones = Timezones::forCountryCode('CL');
  3. // => ['America/Punta_Arenas', 'America/Santiago', 'Pacific/Easter']

The reverse lookup is also possible thanks to the getCountryCode() method,which returns the code of the country where the given timezone ID belongs to:

  1. $countryCode = Timezones::getCountryCode('America/Vancouver')
  2. // => $countryCode = 'CA' (CA = Canada)

The UTC/GMT time offsets of all timezones are provided by getRawOffset()(which returns an integer representing the offset in seconds) andgetGmtOffset() (which returns a string representation of the offset todisplay it to users):

  1. $offset = Timezones::getRawOffset('Etc/UTC');              // $offset = 0
  2. $offset = Timezones::getRawOffset('America/Buenos_Aires'); // $offset = -10800
  3. $offset = Timezones::getRawOffset('Asia/Katmandu');        // $offset = 20700
  4.  
  5. $offset = Timezones::getGmtOffset('Etc/UTC');              // $offset = 'GMT+00:00'
  6. $offset = Timezones::getGmtOffset('America/Buenos_Aires'); // $offset = 'GMT-03:00'
  7. $offset = Timezones::getGmtOffset('Asia/Katmandu');        // $offset = 'GMT+05:45'

The timezone offset can vary in time because of the daylight saving time (DST)practice. By default these methods use the time() PHP function to get thecurrent timezone offset value, but you can pass a timestamp as their secondarguments to get the offset at any given point in time:

  1. // In 2019, the DST period in Madrid (Spain) went from March 31 to October 27
  2. $offset = Timezones::getRawOffset('Europe/Madrid', strtotime('March 31, 2019'));   // $offset = 3600
  3. $offset = Timezones::getRawOffset('Europe/Madrid', strtotime('April 1, 2019'));    // $offset = 7200
  4. $offset = Timezones::getGmtOffset('Europe/Madrid', strtotime('October 27, 2019')); // $offset = 'GMT+02:00'
  5. $offset = Timezones::getGmtOffset('Europe/Madrid', strtotime('October 28, 2019')); // $offset = 'GMT+01:00'

The string representation of the GMT offset can vary depending on the locale, soyou can pass the locale as the third optional argument:

  1. $offset = Timezones::getGmtOffset('Europe/Madrid', strtotime('October 28, 2019'), 'ar')); // $offset = 'غرينتش+01:00'
  2. $offset = Timezones::getGmtOffset('Europe/Madrid', strtotime('October 28, 2019'), 'dz')); // $offset = 'ཇི་ཨེམ་ཏི་+01:00'

If the given timezone ID doesn't exist, the methods trigger aMissingResourceException. In additionto catching the exception, you can also check if a given timezone ID is valid:

  1. $isValidTimezone = Timezones::exists($timezoneId);

New in version 4.3: The Timezones class was introduced in Symfony 4.3.

Learn more