[Intl] Implemented Locale::exists()

symfony · webmozart · Oct 2, 2013 · Oct 2, 2013 · Oct 2, 2013 · Oct 2, 2013
commit a7e8e683759ef5cdba2a72d3563dcfc84b589864
diff --git a/src/Symfony/Component/Intl/Currency.php b/src/Symfony/Component/Intl/Currency.php
@@ -75,7 +75,7 @@ public static function getSymbol($currency, $displayLocale = null)
            throw new InvalidArgumentException('The currency "' . $currency . '" does not exist.');
        }

-        if (null !== $displayLocale && !in_array($displayLocale, Locale::getLocales(), true)) {
+        if (null !== $displayLocale && !Locale::exists($displayLocale)) {
            throw new InvalidArgumentException('The locale "' . $displayLocale . '" does not exist.');
        }

@@ -111,7 +111,7 @@ public static function getName($currency, $displayLocale = null)
            throw new InvalidArgumentException('The currency "' . $currency . '" does not exist.');
        }

-        if (null !== $displayLocale && !in_array($displayLocale, Locale::getLocales(), true)) {
+        if (null !== $displayLocale && !Locale::exists($displayLocale)) {
            throw new InvalidArgumentException('The locale "' . $displayLocale . '" does not exist.');
        }

@@ -141,7 +141,7 @@ public static function getName($currency, $displayLocale = null)
     */
    public static function getNames($displayLocale = null)
    {
-        if (null !== $displayLocale && !in_array($displayLocale, Locale::getLocales(), true)) {
+        if (null !== $displayLocale && !Locale::exists($displayLocale)) {
            throw new InvalidArgumentException('The locale "' . $displayLocale . '" does not exist.');
        }


diff --git a/src/Symfony/Component/Intl/Language.php b/src/Symfony/Component/Intl/Language.php
@@ -80,7 +80,7 @@ public static function getLanguages()
     * provided where an equivalent ISO 639-1 two-letter code exists.
     *
     * If you want to support the above cases, you should manually canonicalize
-     * the language code in prior to calling this method.
+     * the language code prior to calling this method.
     *
     * @param string $language A canonicalized ISO 639 language code (e.g. "en")
     *
@@ -184,7 +184,7 @@ public static function getName($language, $displayLocale = null)
            throw new InvalidArgumentException('The language "' . $language . '" does not exist.');
        }

-        if (null !== $displayLocale && !in_array($displayLocale, Locale::getLocales(), true)) {
+        if (null !== $displayLocale && !Locale::exists($displayLocale)) {
            throw new InvalidArgumentException('The locale "' . $displayLocale . '" does not exist.');
        }

@@ -215,7 +215,7 @@ public static function getName($language, $displayLocale = null)
     */
    public static function getNames($displayLocale = null)
    {
-        if (null !== $displayLocale && !in_array($displayLocale, Locale::getLocales(), true)) {
+        if (null !== $displayLocale && !Locale::exists($displayLocale)) {
            throw new InvalidArgumentException('The locale "' . $displayLocale . '" does not exist.');
        }


diff --git a/src/Symfony/Component/Intl/Locale.php b/src/Symfony/Component/Intl/Locale.php
@@ -34,6 +34,11 @@ class Locale extends \Locale
     */
    private static $locales;

+    /**
+     * @var integer[]|null
+     */
+    private static $lookupTable;
+
    /**
     * Returns all available locales.
     *
@@ -50,6 +55,35 @@ public static function getLocales()
        return self::$locales;
    }

+    /**
+     * Returns whether the given ICU locale exists.
+     *
+     * This method does not canonicalize the given locale. Specifically, it will
+     * return false if the locale is not correctly cased or uses hyphens ("-")
+     * as separators between the subtags instead of underscores ("_"). For
+     * example, this method returns false for "en-Latn-GB", but true for
+     * "en_Latn_GB".
+     *
+     * If you want to support the above cases, you should manually canonicalize
+     * the locale prior to calling this method.
+     *
+     * @param string $locale A canonicalized ICU locale (e.g. "en_Latn_GB")
+     *
+     * @return Boolean Whether the locale exists
+     *
+     * @see canonicalize
+     *
+     * @api
+     */
+    public static function exists($locale)
+    {
+        if (null === self::$lookupTable) {
+            self::$lookupTable = array_flip(static::getLocales());
+        }
+
+        return isset(self::$lookupTable[$locale]);
+    }
+
    /**
     * Returns the name of a locale in the given display locale.
     *
@@ -74,7 +108,7 @@ public static function getLocales()
     */
    public static function getName($locale, $displayLocale = null)
    {
-        if (!in_array($locale, self::getLocales(), true)) {
+        if (!static::exists($locale)) {
            throw new InvalidArgumentException('The locale "' . $locale . '" does not exist.');
        }

@@ -108,7 +142,7 @@ public static function getName($locale, $displayLocale = null)
     */
    public static function getNames($displayLocale = null)
    {
-        if (null !== $displayLocale && !in_array($displayLocale, Locale::getLocales(), true)) {
+        if (null !== $displayLocale && !Locale::exists($displayLocale)) {
            throw new InvalidArgumentException('The locale "' . $displayLocale . '" does not exist.');
        }


diff --git a/src/Symfony/Component/Intl/Tests/LanguageTest.php b/src/Symfony/Component/Intl/Tests/LanguageTest.php
@@ -12,12 +12,18 @@
 namespace Symfony\Component\Intl\Tests;

 use Symfony\Component\Intl\Language;
+use Symfony\Component\Intl\Locale;

 /**
 * @author Bernhard Schussek <bschussek@gmail.com>
 */
 class LanguageTest extends \PHPUnit_Framework_TestCase
 {
+    protected function setUp()
+    {
+        Locale::setDefault('en');
+    }
+
    public function existsProvider()
    {
        return array(

diff --git a/src/Symfony/Component/Intl/Tests/LocaleTest.php b/src/Symfony/Component/Intl/Tests/LocaleTest.php
@@ -23,6 +23,37 @@ protected function setUp()
        Locale::setDefault('en');
    }

+    public function existsProvider()
+    {
+        return array(
+            array(true, 'de'),
+            array(true, 'de_AT'),
+            // scripts are supported in some cases
+            array(true, 'zh_Hant_TW'),
+            // but not in others
+            array(false, 'de_Latn_AT'),
+            // different casing is not supported
+            array(false, 'De_AT'),
+            // hyphens are not supported
+            array(false, 'de-AT'),
+            // aliases with individual translations are supported
+            array(true, 'mo'),
+            // ISO 936-2 is not supported if an equivalent exists in ISO 936-1
+            array(false, 'deu'),
+            array(false, 'deu_AT'),
+            // country aliases are not supported
+            array(false, 'de_AUT'),
+        );
+    }
+
+    /**
+     * @dataProvider existsProvider
+     */
+    public function testExists($exists, $language)
+    {
+        $this->assertSame($exists, Locale::exists($language));
+    }
+
    public function testGetName()
    {
        $this->assertSame('English', Locale::getName('en', 'en'));