datetime Field Type

WARNING: You are browsing the documentation for Symfony 2.4 which is not maintained anymore. Consider upgrading your projects to Symfony 3.3.

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
Inherited options
Parent type form
Class DateTimeType

Field Options

date_format

type: integer or string default: IntlDateFormatter::MEDIUM

Defines the format option that will be passed down to the date field. See the date type's format option for more details.

date_widget

type: string default: choice

Defines the widget option for the date type

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:

1
'days' => range(1,31)

empty_value

New in version 2.3: Since Symfony 2.3, empty values are also supported if the expanded option is set to true.

type: string or Boolean

This option determines whether or not a special "empty" option (e.g. "Choose an option") will appear at the top of a select widget. This option only applies if the multiple option is set to false.

  • Add an empty value with "Choose an option" as the text:

    1
    2
    3
    $builder->add('states', 'choice', array(
        'empty_value' => 'Choose an option',
    ));
    
  • Guarantee that no "empty" value option is displayed:

    1
    2
    3
    $builder->add('states', 'choice', array(
        'empty_value' => false,
    ));
    

If you leave the empty_value option unset, then a blank (with no text) option will automatically be added if and only if the required option is false:

1
2
3
4
// a blank (with no text) option will be added
$builder->add('states', 'choice', array(
    'required' => false,
));

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 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 value will cause the field to be rendered as an input field with type="datetime".

hours

type: array default: 0 to 23

List of hours available to the hours field type. This option is only relevant when the widget option is set to choice.

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.

Caution

If timestamp is used, DateType is limited to dates between Fri, 13 Dec 1901 20:45:54 GMT and Tue, 19 Jan 2038 03:14:07 GMT on 32bit systems. This is due to a limitation in PHP itself.

minutes

type: array default: 0 to 59

List of minutes available to the minutes field type. This option is only relevant when the widget option is set to choice.

model_timezone

type: string default: system default timezone

Timezone that the input data is stored in. This must be one of the PHP supported timezones.

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.

seconds

type: array default: 0 to 59

List of seconds available to the seconds field type. This option is only relevant when the widget option is set to choice.

time_widget

type: string default: choice

Defines the widget option for the time type

view_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.

widget

type: string default: null

Defines the widget option for both the date type and time type. This can be overridden with the date_widget and time_widget options.

with_minutes

New in version 2.2: The with_minutes option was introduced in Symfony 2.2.

type: Boolean default: true

Whether or not to include minutes in the input. This will result in an additional input to capture minutes.

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.

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.

Inherited Options

These options inherit from the form type:

data

type: mixed default: Defaults to field of the underlying object (if there is one)

When you create a form, each field initially displays the value of the corresponding property of the form's domain object (if an object is bound to the form). If you want to override the initial value for the form or just an individual field, you can set it in the data option:

1
2
3
$builder->add('token', 'hidden', array(
    'data' => 'abcdef',
));

Note

The default values for form fields are taken directly from the underlying data structure (e.g. an entity or an array). The data option overrides this default value.

disabled

type: boolean default: false

If you don't want a user to modify the value of a field, you can set the disabled option to true. Any submitted value will be ignored.

inherit_data

New in version 2.3: The inherit_data option was introduced in Symfony 2.3. Before, it was known as virtual.

type: boolean default: false

This option determines if the form will inherit data from its parent form. This can be useful if you have a set of fields that are duplicated across multiple forms. See How to Reduce Code Duplication with "inherit_data".

invalid_message

type: string default: This value is not valid

This is the validation error message that's used if the data entered into this field doesn't make sense (i.e. fails validation).

This might happen, for example, if the user enters a nonsense string into a time field that cannot be converted into a real time or if the user enters a string (e.g. apple) into a number field.

Normal (business logic) validation (such as when setting a minimum length for a field) should be set using validation messages with your validation rules (reference).

invalid_message_parameters

type: array default: array()

When setting the invalid_message option, you may need to include some variables in the string. This can be done by adding placeholders to that option and including the variables in this option:

1
2
3
4
5
$builder->add('some_field', 'some_type', array(
    // ...
    'invalid_message'            => 'You entered an invalid value - it should include %num% letters',
    'invalid_message_parameters' => array('%num%' => 6),
));

mapped

type: boolean default: true

If you wish the field to be ignored when reading or writing to the object, you can set the mapped option to false.

read_only

type: Boolean default: false

If this option is true, the field will be rendered with the readonly attribute so that the field is not editable.

Field Variables

Variable Type Usage
widget mixed The value of the widget option.
type string Only present when widget is single_text and HTML5 is activated, contains the input type to use (datetime, date or time).

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.