[Intl] deprecate polyfills in favor of symfony/polyfill-intl-icu

nicolas-grekas · nicolas-grekas · commit 7119bf4607d8 · 2020-11-04T16:35:46.000+01:00
diff --git a/Collator/Collator.php b/Collator/Collator.php
@@ -32,6 +32,8 @@
  * @author Bernhard Schussek <bschussek@gmail.com>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 abstract class Collator
 {
diff --git a/DateFormatter/DateFormat/AmPmTransformer.php b/DateFormatter/DateFormat/AmPmTransformer.php
@@ -17,6 +17,8 @@
  * @author Igor Wiedler <igor@wiedler.ch>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class AmPmTransformer extends Transformer
 {
diff --git a/DateFormatter/DateFormat/DayOfWeekTransformer.php b/DateFormatter/DateFormat/DayOfWeekTransformer.php
@@ -17,6 +17,8 @@
  * @author Igor Wiedler <igor@wiedler.ch>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class DayOfWeekTransformer extends Transformer
 {
diff --git a/DateFormatter/DateFormat/DayOfYearTransformer.php b/DateFormatter/DateFormat/DayOfYearTransformer.php
@@ -17,6 +17,8 @@
  * @author Igor Wiedler <igor@wiedler.ch>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class DayOfYearTransformer extends Transformer
 {
diff --git a/DateFormatter/DateFormat/DayTransformer.php b/DateFormatter/DateFormat/DayTransformer.php
@@ -17,6 +17,8 @@
  * @author Igor Wiedler <igor@wiedler.ch>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class DayTransformer extends Transformer
 {
diff --git a/DateFormatter/DateFormat/FullTransformer.php b/DateFormatter/DateFormat/FullTransformer.php
@@ -20,6 +20,8 @@
  * @author Igor Wiedler <igor@wiedler.ch>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class FullTransformer
 {
diff --git a/DateFormatter/DateFormat/Hour1200Transformer.php b/DateFormatter/DateFormat/Hour1200Transformer.php
@@ -17,6 +17,8 @@
  * @author Igor Wiedler <igor@wiedler.ch>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class Hour1200Transformer extends HourTransformer
 {
diff --git a/DateFormatter/DateFormat/Hour1201Transformer.php b/DateFormatter/DateFormat/Hour1201Transformer.php
@@ -17,6 +17,8 @@
  * @author Igor Wiedler <igor@wiedler.ch>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class Hour1201Transformer extends HourTransformer
 {
diff --git a/DateFormatter/DateFormat/Hour2400Transformer.php b/DateFormatter/DateFormat/Hour2400Transformer.php
@@ -17,6 +17,8 @@
  * @author Igor Wiedler <igor@wiedler.ch>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class Hour2400Transformer extends HourTransformer
 {
diff --git a/DateFormatter/DateFormat/Hour2401Transformer.php b/DateFormatter/DateFormat/Hour2401Transformer.php
@@ -17,6 +17,8 @@
  * @author Igor Wiedler <igor@wiedler.ch>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class Hour2401Transformer extends HourTransformer
 {
diff --git a/DateFormatter/DateFormat/HourTransformer.php b/DateFormatter/DateFormat/HourTransformer.php
@@ -17,6 +17,8 @@
  * @author Eriksen Costa <eriksen.costa@infranology.com.br>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 abstract class HourTransformer extends Transformer
 {
diff --git a/DateFormatter/DateFormat/MinuteTransformer.php b/DateFormatter/DateFormat/MinuteTransformer.php
@@ -17,6 +17,8 @@
  * @author Igor Wiedler <igor@wiedler.ch>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class MinuteTransformer extends Transformer
 {
diff --git a/DateFormatter/DateFormat/MonthTransformer.php b/DateFormatter/DateFormat/MonthTransformer.php
@@ -17,6 +17,8 @@
  * @author Igor Wiedler <igor@wiedler.ch>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class MonthTransformer extends Transformer
 {
diff --git a/DateFormatter/DateFormat/QuarterTransformer.php b/DateFormatter/DateFormat/QuarterTransformer.php
@@ -17,6 +17,8 @@
  * @author Igor Wiedler <igor@wiedler.ch>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class QuarterTransformer extends Transformer
 {
diff --git a/DateFormatter/DateFormat/SecondTransformer.php b/DateFormatter/DateFormat/SecondTransformer.php
@@ -17,6 +17,8 @@
  * @author Igor Wiedler <igor@wiedler.ch>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class SecondTransformer extends Transformer
 {
diff --git a/DateFormatter/DateFormat/TimezoneTransformer.php b/DateFormatter/DateFormat/TimezoneTransformer.php
@@ -19,6 +19,8 @@
  * @author Igor Wiedler <igor@wiedler.ch>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class TimezoneTransformer extends Transformer
 {
diff --git a/DateFormatter/DateFormat/Transformer.php b/DateFormatter/DateFormat/Transformer.php
@@ -17,6 +17,8 @@
  * @author Igor Wiedler <igor@wiedler.ch>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 abstract class Transformer
 {
diff --git a/DateFormatter/DateFormat/YearTransformer.php b/DateFormatter/DateFormat/YearTransformer.php
@@ -17,6 +17,8 @@
  * @author Igor Wiedler <igor@wiedler.ch>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class YearTransformer extends Transformer
 {
diff --git a/DateFormatter/IntlDateFormatter.php b/DateFormatter/IntlDateFormatter.php
@@ -45,6 +45,8 @@
  * @author Bernhard Schussek <bschussek@gmail.com>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 abstract class IntlDateFormatter
 {
diff --git a/Exception/MethodArgumentNotImplementedException.php b/Exception/MethodArgumentNotImplementedException.php
@@ -13,6 +13,8 @@
 
 /**
  * @author Eriksen Costa <eriksen.costa@infranology.com.br>
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class MethodArgumentNotImplementedException extends NotImplementedException
 {
diff --git a/Exception/MethodArgumentValueNotImplementedException.php b/Exception/MethodArgumentValueNotImplementedException.php
@@ -13,6 +13,8 @@
 
 /**
  * @author Eriksen Costa <eriksen.costa@infranology.com.br>
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class MethodArgumentValueNotImplementedException extends NotImplementedException
 {
diff --git a/Exception/MethodNotImplementedException.php b/Exception/MethodNotImplementedException.php
@@ -13,6 +13,8 @@
 
 /**
  * @author Eriksen Costa <eriksen.costa@infranology.com.br>
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class MethodNotImplementedException extends NotImplementedException
 {
diff --git a/Exception/NotImplementedException.php b/Exception/NotImplementedException.php
@@ -15,6 +15,8 @@
  * Base exception class for not implemented behaviors of the intl extension in the Locale component.
  *
  * @author Eriksen Costa <eriksen.costa@infranology.com.br>
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class NotImplementedException extends RuntimeException
 {
diff --git a/Globals/IntlGlobals.php b/Globals/IntlGlobals.php
@@ -11,12 +11,16 @@
 
 namespace Symfony\Component\Intl\Globals;
 
+use Symfony\Polyfill\Intl\Icu\Icu;
+
 /**
  * Provides fake static versions of the global functions in the intl extension.
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 abstract class IntlGlobals
 {
@@ -61,6 +65,12 @@ abstract class IntlGlobals
      */
     public static function isFailure(int $errorCode): bool
     {
+        if (class_exists(Icu::class)) {
+            return Icu::isFailure($errorCode);
+        }
+
+        trigger_deprecation('symfony/intl', '5.3', 'Polyfills are deprecated, try running "composer require symfony/polyfill-intl-icu ^1.21" instead.');
+
         return isset(self::$errorCodes[$errorCode])
             && $errorCode > self::U_ZERO_ERROR;
     }
@@ -74,6 +84,12 @@ public static function isFailure(int $errorCode): bool
      */
     public static function getErrorCode()
     {
+        if (class_exists(Icu::class)) {
+            return Icu::getErrorCode();
+        }
+
+        trigger_deprecation('symfony/intl', '5.3', 'Polyfills are deprecated, try running "composer require symfony/polyfill-intl-icu ^1.21" instead.');
+
         return self::$errorCode;
     }
 
@@ -84,6 +100,12 @@ public static function getErrorCode()
      */
     public static function getErrorMessage(): string
     {
+        if (class_exists(Icu::class)) {
+            return Icu::getErrorMessage();
+        }
+
+        trigger_deprecation('symfony/intl', '5.3', 'Polyfills are deprecated, try running "composer require symfony/polyfill-intl-icu ^1.21" instead.');
+
         return self::$errorMessage;
     }
 
@@ -94,6 +116,12 @@ public static function getErrorMessage(): string
      */
     public static function getErrorName(int $code): string
     {
+        if (class_exists(Icu::class)) {
+            return Icu::getErrorName($code);
+        }
+
+        trigger_deprecation('symfony/intl', '5.3', 'Polyfills are deprecated, try running "composer require symfony/polyfill-intl-icu ^1.21" instead.');
+
         return self::$errorCodes[$code] ?? '[BOGUS UErrorCode]';
     }
 
@@ -107,6 +135,10 @@ public static function getErrorName(int $code): string
      */
     public static function setError(int $code, string $message = '')
     {
+        if (class_exists(Icu::class)) {
+            return Icu::setError($code, $message);
+        }
+
         if (!isset(self::$errorCodes[$code])) {
             throw new \InvalidArgumentException(sprintf('No such error code: "%s".', $code));
         }
diff --git a/Locale/Locale.php b/Locale/Locale.php
@@ -23,6 +23,8 @@
  * @author Bernhard Schussek <bschussek@gmail.com>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 abstract class Locale
 {
diff --git a/NumberFormatter/NumberFormatter.php b/NumberFormatter/NumberFormatter.php
@@ -39,6 +39,8 @@
  * @author Bernhard Schussek <bschussek@gmail.com>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 abstract class NumberFormatter
 {
diff --git a/README.md b/README.md
@@ -1,11 +1,7 @@
 Intl Component
 =============
 
-A PHP replacement layer for the C intl extension that also provides access to
-the localization data of the ICU library.
-
-The replacement layer is limited to the locale "en". If you want to use other
-locales, you should [install the intl PHP extension][0] instead.
+This package provides access to the CLDR localization data of the ICU library.
 
 Resources
 ---------
@@ -17,5 +13,3 @@ Resources
     in the [main Symfony repository](https://github.com/symfony/symfony)
   * [Docker images with intl support](https://hub.docker.com/r/jakzal/php-intl)
     (for the Intl component development)
-
-[0]: https://php.net/intl.setup
diff --git a/Resources/functions.php b/Resources/functions.php
@@ -0,0 +1,37 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Symfony\Component\Intl\Globals\IntlGlobals;
+
+if (!function_exists('intl_is_failure')) {
+    function intl_is_failure($error_code)
+    {
+        return IntlGlobals::isFailure($error_code);
+    }
+}
+if (!function_exists('intl_get_error_code')) {
+    function intl_get_error_code()
+    {
+        return IntlGlobals::getErrorCode();
+    }
+}
+if (!function_exists('intl_get_error_message')) {
+    function intl_get_error_message()
+    {
+        return IntlGlobals::getErrorMessage();
+    }
+}
+if (!function_exists('intl_error_name')) {
+    function intl_error_name($error_code)
+    {
+        return IntlGlobals::getErrorName($error_code);
+    }
+}
diff --git a/Resources/stubs/Collator.php b/Resources/stubs/Collator.php
@@ -10,12 +10,26 @@
  */
 
 use Symfony\Component\Intl\Collator\Collator as IntlCollator;
+use Symfony\Polyfill\Intl\Icu\Collator as CollatorPolyfill;
 
-/**
- * Stub implementation for the Collator class of the intl extension.
- *
- * @author Bernhard Schussek <bschussek@gmail.com>
- */
-class Collator extends IntlCollator
-{
+if (!class_exists(CollatorPolyfill::class)) {
+    trigger_deprecation('symfony/intl', '5.3', 'Polyfills are deprecated, try running "composer require symfony/polyfill-intl-icu ^1.21" instead.');
+
+    /**
+     * Stub implementation for the Collator class of the intl extension.
+     *
+     * @author Bernhard Schussek <bschussek@gmail.com>
+     */
+    class Collator extends IntlCollator
+    {
+    }
+} else {
+    /**
+     * Stub implementation for the Collator class of the intl extension.
+     *
+     * @author Bernhard Schussek <bschussek@gmail.com>
+     */
+    class Collator extends CollatorPolyfill
+    {
+    }
 }
diff --git a/Resources/stubs/IntlDateFormatter.php b/Resources/stubs/IntlDateFormatter.php
diff --git a/Resources/stubs/Locale.php b/Resources/stubs/Locale.php
diff --git a/Resources/stubs/NumberFormatter.php b/Resources/stubs/NumberFormatter.php
diff --git a/Tests/Collator/CollatorTest.php b/Tests/Collator/CollatorTest.php
diff --git a/Tests/DateFormatter/AbstractIntlDateFormatterTest.php b/Tests/DateFormatter/AbstractIntlDateFormatterTest.php
diff --git a/Tests/DateFormatter/IntlDateFormatterTest.php b/Tests/DateFormatter/IntlDateFormatterTest.php
diff --git a/Tests/Globals/AbstractIntlGlobalsTest.php b/Tests/Globals/AbstractIntlGlobalsTest.php
diff --git a/Tests/Globals/IntlGlobalsTest.php b/Tests/Globals/IntlGlobalsTest.php
diff --git a/Tests/Globals/Verification/IntlGlobalsTest.php b/Tests/Globals/Verification/IntlGlobalsTest.php
diff --git a/Tests/NumberFormatter/AbstractNumberFormatterTest.php b/Tests/NumberFormatter/AbstractNumberFormatterTest.php
diff --git a/Tests/NumberFormatter/NumberFormatterTest.php b/Tests/NumberFormatter/NumberFormatterTest.php
diff --git a/composer.json b/composer.json

Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,8 @@`
`32`	`32`	`* @author Bernhard Schussek <[email protected]>`
`33`	`33`	`*`
`34`	`34`	`* @internal`
	`35`	`+ *`
	`36`	`+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead`
`35`	`37`	`*/`
`36`	`38`	`abstract class Collator`
`37`	`39`	`{`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,8 @@`
`17`	`17`	`* @author Igor Wiedler <[email protected]>`
`18`	`18`	`*`
`19`	`19`	`* @internal`
	`20`	`+ *`
	`21`	`+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead`
`20`	`22`	`*/`
`21`	`23`	`class AmPmTransformer extends Transformer`
`22`	`24`	`{`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,8 @@`
`20`	`20`	`* @author Igor Wiedler <[email protected]>`
`21`	`21`	`*`
`22`	`22`	`* @internal`
	`23`	`+ *`
	`24`	`+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead`
`23`	`25`	`*/`
`24`	`26`	`class FullTransformer`
`25`	`27`	`{`