vendor/symfony/intl/Countries.php line 114

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Intl;
  14. use Symfony\Component\Intl\Exception\MissingResourceException;
  16. /**
  17.  * Gives access to region-related ICU data.
  18.  *
  19.  * @author Bernhard Schussek <bschussek@gmail.com>
  20.  * @author Roland Franssen <franssen.roland@gmail.com>
  21.  */
  22. final class Countries extends ResourceBundle
  23. {
  24.     /**
  25.      * Returns all available countries.
  26.      *
  27.      * Countries are returned as uppercase ISO 3166 two-letter country codes.
  28.      *
  29.      * A full table of ISO 3166 country codes can be found here:
  30.      * https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
  31.      *
  32.      * This list only contains "officially assigned ISO 3166-1 alpha-2" country codes.
  33.      *
  34.      * @return string[] an array of canonical ISO 3166 alpha-2 country codes
  35.      */
  36.     public static function getCountryCodes(): array
  37.     {
  38.         return self::readEntry(['Regions'], 'meta');
  39.     }
  41.     /**
  42.      * Returns all available countries (3 letters).
  43.      *
  44.      * Countries are returned as uppercase ISO 3166 three-letter country codes.
  45.      *
  46.      * This list only contains "officially assigned ISO 3166-1 alpha-3" country codes.
  47.      *
  48.      * @return string[] an array of canonical ISO 3166 alpha-3 country codes
  49.      */
  50.     public static function getAlpha3Codes(): array
  51.     {
  52.         return self::readEntry(['Alpha2ToAlpha3'], 'meta');
  53.     }
  55.     public static function getAlpha3Code(string $alpha2Code): string
  56.     {
  57.         return self::readEntry(['Alpha2ToAlpha3', $alpha2Code], 'meta');
  58.     }
  60.     public static function getAlpha2Code(string $alpha3Code): string
  61.     {
  62.         return self::readEntry(['Alpha3ToAlpha2', $alpha3Code], 'meta');
  63.     }
  65.     public static function exists(string $alpha2Code): bool
  66.     {
  67.         try {
  68.             self::readEntry(['Names', $alpha2Code]);
  70.             return true;
  71.         } catch (MissingResourceException $e) {
  72.             return false;
  73.         }
  74.     }
  76.     public static function alpha3CodeExists(string $alpha3Code): bool
  77.     {
  78.         try {
  79.             self::getAlpha2Code($alpha3Code);
  81.             return true;
  82.         } catch (MissingResourceException $e) {
  83.             return false;
  84.         }
  85.     }
  87.     /**
  88.      * Gets the country name from its alpha2 code.
  89.      *
  90.      * @throws MissingResourceException if the country code does not exist
  91.      */
  92.     public static function getName(string $country, string $displayLocale = null): string
  93.     {
  94.         return self::readEntry(['Names', $country], $displayLocale);
  95.     }
  97.     /**
  98.      * Gets the country name from its alpha3 code.
  99.      *
  100.      * @throws MissingResourceException if the country code does not exist
  101.      */
  102.     public static function getAlpha3Name(string $alpha3Code, string $displayLocale = null): string
  103.     {
  104.         return self::getName(self::getAlpha2Code($alpha3Code), $displayLocale);
  105.     }
  107.     /**
  108.      * Gets the list of country names indexed with alpha2 codes as keys.
  109.      *
  110.      * @return string[]
  111.      */
  112.     public static function getNames($displayLocale = null): array
  113.     {
  114.         return self::asort(self::readEntry(['Names'], $displayLocale), $displayLocale);
  115.     }
  117.     /**
  118.      * Gets the list of country names indexed with alpha3 codes as keys.
  119.      *
  120.      * Same as method getNames, but with alpha3 codes instead of alpha2 codes as keys.
  121.      *
  122.      * @return string[]
  123.      */
  124.     public static function getAlpha3Names($displayLocale = null): array
  125.     {
  126.         $alpha2Names = self::getNames($displayLocale);
  127.         $alpha3Names = [];
  128.         foreach ($alpha2Names as $alpha2Code => $name) {
  129.             $alpha3Names[self::getAlpha3Code($alpha2Code)] = $name;
  130.         }
  132.         return $alpha3Names;
  133.     }
  135.     protected static function getPath(): string
  136.     {
  137.         return Intl::getDataDirectory().'/'.Intl::REGION_DIR;
  138.     }
  139. }