Skip to content

[Form] document the reference_date option #13410

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 24, 2020
Merged

[Form] document the reference_date option #13410

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions reference/forms/types/time.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ stored as a ``DateTime`` object, a string, a timestamp or an array.
| | - `input_format`_ |
| | - `minutes`_ |
| | - `model_timezone`_ |
| | - `reference_date`_ |
| | - `seconds`_ |
| | - `view_timezone`_ |
| | - `widget`_ |
Expand Down Expand Up @@ -150,10 +151,29 @@ of the time. This must be a valid `PHP time format`_.

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

.. caution::

When using different values for ``model_timezone`` and `view_timezone`_,
a `reference_date`_ must be configured.

reference_date
~~~~~~~~~~~~~~

**type**: ``DateTimeInterface`` **default**: ``null``

Configuring a reference date is required when the `model_timezone`_ and
`view_timezone`_ are different. Timezone conversions will be calculated
based on this date.

.. include:: /reference/forms/types/options/seconds.rst.inc

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

.. caution::

When using different values for `model_timezone`_ and ``view_timezone``,
a `reference_date`_ must be configured.

widget
~~~~~~

Expand Down