feature #38974 [Intl] deprecate polyfills in favor of symfony/polyfill-intl-icu (nicolas-grekas)

This PR was merged into the 5.x branch.

Discussion
----------

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

| Q             | A
| ------------- | ---
| Branch?       | 5.x
| Bug fix?      | no
| New feature?  | no
| Deprecations? | yes
| Tickets       | Fix #37758
| License       | MIT
| Doc PR        | -

Follows symfony/polyfill#310
/cc @stof

Commits
-------

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

Author: nicolas-grekas

src/Symfony/Component/Form/composer.json

@@ -22,6 +22,7 @@
         "symfony/intl": "^4.4|^5.0",
         "symfony/options-resolver": "^5.1",
         "symfony/polyfill-ctype": "~1.8",
+        "symfony/polyfill-intl-icu": "^1.21",
         "symfony/polyfill-mbstring": "~1.0",
         "symfony/polyfill-php80": "^1.15",
         "symfony/property-access": "^5.0.8",
@@ -48,7 +49,6 @@
         "symfony/error-handler": "<4.4.5",
         "symfony/framework-bundle": "<4.4",
         "symfony/http-kernel": "<4.4",
-        "symfony/intl": "<4.4",
         "symfony/translation": "<4.4",
         "symfony/translation-contracts": "<1.1.7",
         "symfony/twig-bridge": "<4.4"

src/Symfony/Component/Intl/Collator/Collator.php

@@ -32,6 +32,8 @@
  * @author Bernhard Schussek <[email protected]>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 abstract class Collator
 {

src/Symfony/Component/Intl/DateFormatter/DateFormat/AmPmTransformer.php

@@ -17,6 +17,8 @@
  * @author Igor Wiedler <[email protected]>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class AmPmTransformer extends Transformer
 {

src/Symfony/Component/Intl/DateFormatter/DateFormat/DayOfWeekTransformer.php

@@ -17,6 +17,8 @@
  * @author Igor Wiedler <[email protected]>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class DayOfWeekTransformer extends Transformer
 {

src/Symfony/Component/Intl/DateFormatter/DateFormat/DayOfYearTransformer.php

@@ -17,6 +17,8 @@
  * @author Igor Wiedler <[email protected]>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class DayOfYearTransformer extends Transformer
 {

src/Symfony/Component/Intl/DateFormatter/DateFormat/DayTransformer.php

@@ -17,6 +17,8 @@
  * @author Igor Wiedler <[email protected]>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class DayTransformer extends Transformer
 {

src/Symfony/Component/Intl/DateFormatter/DateFormat/FullTransformer.php

@@ -20,6 +20,8 @@
  * @author Igor Wiedler <[email protected]>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class FullTransformer
 {

src/Symfony/Component/Intl/DateFormatter/DateFormat/Hour1200Transformer.php

@@ -17,6 +17,8 @@
  * @author Igor Wiedler <[email protected]>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class Hour1200Transformer extends HourTransformer
 {

src/Symfony/Component/Intl/DateFormatter/DateFormat/Hour1201Transformer.php

@@ -17,6 +17,8 @@
  * @author Igor Wiedler <[email protected]>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class Hour1201Transformer extends HourTransformer
 {

src/Symfony/Component/Intl/DateFormatter/DateFormat/Hour2400Transformer.php

@@ -17,6 +17,8 @@
  * @author Igor Wiedler <[email protected]>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class Hour2400Transformer extends HourTransformer
 {

src/Symfony/Component/Intl/DateFormatter/DateFormat/Hour2401Transformer.php

@@ -17,6 +17,8 @@
  * @author Igor Wiedler <[email protected]>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class Hour2401Transformer extends HourTransformer
 {

src/Symfony/Component/Intl/DateFormatter/DateFormat/HourTransformer.php

@@ -17,6 +17,8 @@
  * @author Eriksen Costa <[email protected]>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 abstract class HourTransformer extends Transformer
 {

src/Symfony/Component/Intl/DateFormatter/DateFormat/MinuteTransformer.php

@@ -17,6 +17,8 @@
  * @author Igor Wiedler <[email protected]>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class MinuteTransformer extends Transformer
 {

src/Symfony/Component/Intl/DateFormatter/DateFormat/MonthTransformer.php

@@ -17,6 +17,8 @@
  * @author Igor Wiedler <[email protected]>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class MonthTransformer extends Transformer
 {

src/Symfony/Component/Intl/DateFormatter/DateFormat/QuarterTransformer.php

@@ -17,6 +17,8 @@
  * @author Igor Wiedler <[email protected]>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class QuarterTransformer extends Transformer
 {

src/Symfony/Component/Intl/DateFormatter/DateFormat/SecondTransformer.php

@@ -17,6 +17,8 @@
  * @author Igor Wiedler <[email protected]>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class SecondTransformer extends Transformer
 {

src/Symfony/Component/Intl/DateFormatter/DateFormat/TimezoneTransformer.php

@@ -19,6 +19,8 @@
  * @author Igor Wiedler <[email protected]>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class TimezoneTransformer extends Transformer
 {

src/Symfony/Component/Intl/DateFormatter/DateFormat/Transformer.php

@@ -17,6 +17,8 @@
  * @author Igor Wiedler <[email protected]>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 abstract class Transformer
 {

src/Symfony/Component/Intl/DateFormatter/DateFormat/YearTransformer.php

@@ -17,6 +17,8 @@
  * @author Igor Wiedler <[email protected]>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class YearTransformer extends Transformer
 {

src/Symfony/Component/Intl/DateFormatter/IntlDateFormatter.php

@@ -45,6 +45,8 @@
  * @author Bernhard Schussek <[email protected]>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 abstract class IntlDateFormatter
 {

src/Symfony/Component/Intl/Exception/MethodArgumentNotImplementedException.php

@@ -13,6 +13,8 @@
 
 /**
  * @author Eriksen Costa <[email protected]>
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class MethodArgumentNotImplementedException extends NotImplementedException
 {

src/Symfony/Component/Intl/Exception/MethodArgumentValueNotImplementedException.php

@@ -13,6 +13,8 @@
 
 /**
  * @author Eriksen Costa <[email protected]>
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class MethodArgumentValueNotImplementedException extends NotImplementedException
 {

src/Symfony/Component/Intl/Exception/MethodNotImplementedException.php

@@ -13,6 +13,8 @@
 
 /**
  * @author Eriksen Costa <[email protected]>
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class MethodNotImplementedException extends NotImplementedException
 {

src/Symfony/Component/Intl/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 <[email protected]>
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 class NotImplementedException extends RuntimeException
 {

src/Symfony/Component/Intl/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 <[email protected]>
  *
  * @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));
         }

src/Symfony/Component/Intl/Locale/Locale.php

@@ -23,6 +23,8 @@
  * @author Bernhard Schussek <[email protected]>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 abstract class Locale
 {

src/Symfony/Component/Intl/NumberFormatter/NumberFormatter.php

@@ -39,6 +39,8 @@
  * @author Bernhard Schussek <[email protected]>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use symfony/polyfill-intl-icu ^1.21 instead
  */
 abstract class NumberFormatter
 {

src/Symfony/Component/Intl/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

src/Symfony/Component/Intl/Resources/functions.php

@@ -0,0 +1,37 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * 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);
+    }
+}