From 6440a374ee532cb1dce5dd2074a054bc1555da10 Mon Sep 17 00:00:00 2001
From: Javier Eguiluz <javier.eguiluz@gmail.com>
Date: Mon, 29 Jul 2019 17:44:11 +0200
Subject: [PATCH] [Validation] Documented the intlCompatible option in Timezone
 constraint

---
 components/intl.rst                |  2 ++
 reference/constraints/Timezone.rst | 46 ++++++++++++++++++++----------
 2 files changed, 33 insertions(+), 15 deletions(-)

diff --git a/components/intl.rst b/components/intl.rst
index 4255de60a7f..12656bcad69 100644
--- a/components/intl.rst
+++ b/components/intl.rst
@@ -254,6 +254,8 @@ to catching the exception, you can also check if a given currency code is valid:
 
     The ``Currencies`` class was introduced in Symfony 4.3.
 
+.. _component-intl-timezones:
+
 Timezones
 ~~~~~~~~~
 
diff --git a/reference/constraints/Timezone.rst b/reference/constraints/Timezone.rst
index c195a5d46f6..7eed2624ef6 100644
--- a/reference/constraints/Timezone.rst
+++ b/reference/constraints/Timezone.rst
@@ -9,11 +9,12 @@ Validates that a value is a valid timezone identifier (e.g. ``Europe/Paris``).
 
 ==========  ======================================================================
 Applies to  :ref:`property or method <validation-property-target>`
-Options     - `groups`_
+Options     - `countryCode`_
+            - `groups`_
+            - `intlCompatible`_
             - `message`_
             - `payload`_
             - `zone`_
-            - `countryCode`_
 Class       :class:`Symfony\\Component\\Validator\\Constraints\\Timezone`
 Validator   :class:`Symfony\\Component\\Validator\\Constraints\\TimezoneValidator`
 ==========  ======================================================================
@@ -22,7 +23,7 @@ Basic Usage
 -----------
 
 Suppose you have a ``UserSettings`` class, with a ``timezone`` field that is a
-string meant to contain a timezone identifier (e.g. ``America/New_York``):
+string which contains any of the `PHP timezone identifiers`_ (e.g. ``America/New_York``):
 
 .. configuration-block::
 
@@ -85,8 +86,34 @@ string meant to contain a timezone identifier (e.g. ``America/New_York``):
 Options
 -------
 
+countryCode
+~~~~~~~~~~~
+
+**type**: ``string`` **default**: ``null``
+
+If the ``zone`` option is set to ``\DateTimeZone::PER_COUNTRY``, this option
+restricts the valid timezone identifiers to the ones that belong to the given
+country.
+
+The value of this option must be a valid `ISO 3166-1 alpha-2`_ country code
+(e.g. ``CN`` for China).
+
 .. include:: /reference/constraints/_groups-option.rst.inc
 
+intlCompatible
+~~~~~~~~~~~~~~
+
+**type**: ``boolean`` **default**: ``false``
+
+This constraint considers valid both the `PHP timezone identifiers`_ and the
+:ref:`ICU timezones <component-intl-timezones>` provided by Symfony's
+:doc:`Intl component </components/intl>`
+
+However, the timezones provided by the Intl component can be different from the
+timezones provided by PHP's Intl extension (because they use different ICU
+versions). If this option is set to ``true``, this constraint only considers
+valid the values created with the PHP ``\IntlTimeZone::createTimeZone()`` method.
+
 message
 ~~~~~~~
 
@@ -131,17 +158,6 @@ In addition, there are some special zone values:
 * ``\DateTimeZone::PER_COUNTRY`` restricts the valid timezones to a certain
   country (which is defined using the ``countryCode`` option).
 
-countryCode
-~~~~~~~~~~~
-
-**type**: ``string`` **default**: ``null``
-
-If the ``zone`` option is set to ``\DateTimeZone::PER_COUNTRY``, this option
-restricts the valid timezone identifiers to the ones that belong to the given
-country.
-
-The value of this option must be a valid `ISO 3166-1 alpha-2`_ country code
-(e.g. ``CN`` for China).
-
+.. _`PHP timezone identifiers`: https://www.php.net/manual/en/timezones.php
 .. _`DateTimeZone`: https://www.php.net/datetimezone
 .. _`ISO 3166-1 alpha-2`: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2