Skip to content

Commit 6c4dcf4

Browse files
committed
minor #13410 [Form] document the reference_date option (xabbuh)
This PR was merged into the 4.4 branch. Discussion ---------- [Form] document the reference_date option fixes #12032 Commits ------- f8c3968 document the reference_date option
2 parents 1003548 + f8c3968 commit 6c4dcf4

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

reference/forms/types/time.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ stored as a ``DateTime`` object, a string, a timestamp or an array.
2323
| | - `input_format`_ |
2424
| | - `minutes`_ |
2525
| | - `model_timezone`_ |
26+
| | - `reference_date`_ |
2627
| | - `seconds`_ |
2728
| | - `view_timezone`_ |
2829
| | - `widget`_ |
@@ -150,10 +151,29 @@ of the time. This must be a valid `PHP time format`_.
150151

151152
.. include:: /reference/forms/types/options/model_timezone.rst.inc
152153

154+
.. caution::
155+
156+
When using different values for ``model_timezone`` and `view_timezone`_,
157+
a `reference_date`_ must be configured.
158+
159+
reference_date
160+
~~~~~~~~~~~~~~
161+
162+
**type**: ``DateTimeInterface`` **default**: ``null``
163+
164+
Configuring a reference date is required when the `model_timezone`_ and
165+
`view_timezone`_ are different. Timezone conversions will be calculated
166+
based on this date.
167+
153168
.. include:: /reference/forms/types/options/seconds.rst.inc
154169

155170
.. include:: /reference/forms/types/options/view_timezone.rst.inc
156171

172+
.. caution::
173+
174+
When using different values for `model_timezone`_ and ``view_timezone``,
175+
a `reference_date`_ must be configured.
176+
157177
widget
158178
~~~~~~
159179

0 commit comments

Comments
 (0)