Skip to content

[Reference][Form Types] Add missing "format" option to "datetime" field #3466

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 2 commits into from
Feb 1, 2014
Merged

[Reference][Form Types] Add missing "format" option to "datetime" field #3466

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1d6df4
[Reference][Form Types] Add missing "format" option to "datetime" field
bicpi Jan 11, 2014
127b089
Be more specific for the rendered field type
bicpi Jan 23, 2014
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
14 changes: 14 additions & 0 deletions reference/forms/types/datetime.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ data can be a ``DateTime`` object, a string, a timestamp or an array.
| | - `widget`_ |
| | - `input`_ |
| | - `date_format`_ |
| | - `format`_ |
| | - `hours`_ |
| | - `minutes`_ |
| | - `seconds`_ |
Expand Down Expand Up @@ -98,6 +99,17 @@ Defines the ``format`` option that will be passed down to the date field.
See the :ref:`date type's format option <reference-forms-type-date-format>`
for more details.

format
~~~~~~

**type**: ``string`` **default**: ``Symfony\Component\Form\Extension\Core\Type\DateTimeType::HTML5_FORMAT``

If the ``widget`` option is set to ``single_text``, this option specifies the
the format of the input, i.e. how Symfony will interpret the given input
as a datetime string. It defaults to the `RFC 3339`_ format which is used
by the HTML5 ``datetime`` field. Keeping the default will render a field of
type ``datetime``.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is an important note, and I think we can be even more specific on what we mean:

Keeping the default value will cause the field to be rendered as an ``input`` field with ``type="datetime"``.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@weaverryan Adopted your proposal, sounds good, thanks. And it's really important to know when exactly you get thedatetime field type :-)


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

.. include:: /reference/forms/types/options/minutes.rst.inc
Expand Down Expand Up @@ -138,3 +150,5 @@ These options inherit from the :doc:`form </reference/forms/types/form>` type:
.. include:: /reference/forms/types/options/mapped.rst.inc

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

.. _`RFC 3339`: http://tools.ietf.org/html/rfc3339