minor #8223 Documentation input+regions options in TimezoneType (ro0NL, javiereguiluz)

javiereguiluz · javiereguiluz · commit 63d3090558a3 · 2018-01-03T10:06:02.000+01:00
This PR was merged into the 3.4 branch. Discussion ---------- Documentation input+regions options in TimezoneType See symfony/symfony#23648 Commits ------- 99f5f3e Minor typo d6611eb Update timezone.rst de490ca Update timezone.rst
diff --git a/reference/forms/types/timezone.rst b/reference/forms/types/timezone.rst
@@ -17,6 +17,9 @@ manually, but then you should just use the ``ChoiceType`` directly.
 +-------------+------------------------------------------------------------------------+
 | Rendered as | can be various tags (see :ref:`forms-reference-choice-tags`)           |
 +-------------+------------------------------------------------------------------------+
+| Options     | - `input`_                                                             |
+|             | - `regions`_                                                           |
++-------------+------------------------------------------------------------------------+
 | Overridden  | - `choices`_                                                           |
 | options     |                                                                        |
 +-------------+------------------------------------------------------------------------+
@@ -45,6 +48,27 @@ manually, but then you should just use the ``ChoiceType`` directly.
 | Class       | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\TimezoneType` |
 +-------------+------------------------------------------------------------------------+
 
+Field Options
+-------------
+
+input
+~~~~~
+
+**type**: ``string`` **default**: ``string``
+
+The format of the *input* data - i.e. the format that the timezone is stored
+on your underlying object. Valid values are:
+
+* ``string`` (e.g. ``America/New_York``)
+* ``datetimezone`` (a ``DateTimeZone`` object)
+
+regions
+~~~~~~~
+
+**type**: ``int`` **default**: ``\DateTimeZone::ALL``
+
+The available regions in the timezone choice list. For example: ``DateTimeZone::AMERICA | DateTimeZone::EUROPE``
+
 Overridden Options
 ------------------
 
