datetime Field Type¶
This field type allows the user to modify data that represents a specific date and time (e.g. 1984-06-05 12:15:30).
Can be rendered as a text input or select tags. The underlying format of the data can be a DateTime object, a string, a timestamp or an array.
Underlying Data Type | can be DateTime, string, timestamp, or array (see the input option) |
Rendered as | single text box or three select fields |
Options | |
Parent type | form |
Class | Symfony\Component\Form\Extension\Core\Type\DateTimeType |
Field Options¶
input¶
type: string default: datetime
The format of the input data - i.e. the format that the date is stored on your underlying object. Valid values are:
- string (e.g. 2011-06-05 12:15:00)
- datetime (a DateTime object)
- array (e.g. array(2011, 06, 05, 12, 15, 0))
- timestamp (e.g. 1307276100)
The value that comes back from the form will also be normalized back into this format.
date_format¶
type: integer or string default: IntlDateFormatter::MEDIUM
Defines the format option that will be passed down to the date field.
hours¶
type: integer default: 1 to 23
List of hours available to the hours field type. This option is only relevant when the widget option is set to choice.
minutes¶
type: integer default: 1 to 59
List of minutes available to the minutes field type. This option is only relevant when the widget option is set to choice.
seconds¶
type: integer default: 1 to 59
List of seconds available to the seconds field type. This option is only relevant when the widget option is set to choice.
years¶
type: array default: five years before to five years after the current year
List of years available to the year field type. This option is only relevant when the widget option is set to choice.
months¶
type: array default: 1 to 12
List of months available to the month field type. This option is only relevant when the widget option is set to choice.
days¶
type: array default: 1 to 31
List of days available to the day field type. This option is only relevant when the widget option is set to choice:
'days' => range(1,31)
with_seconds¶
type: Boolean default: false
Whether or not to include seconds in the input. This will result in an additional input to capture seconds.
data_timezone¶
type: string default: system default timezone
Timezone that the input data is stored in. This must be one of the PHP supported timezones
user_timezone¶
type: string default: system default timezone
Timezone for how the data should be shown to the user (and therefore also the data that the user submits). This must be one of the PHP supported timezones