DateTimeType Field
Warning: You are browsing the documentation for Symfony 2.x, which is no longer maintained.
Read the updated version of this page for Symfony 7.1 (the current stable version).
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 | |
Overridden options | |
Inherited options |
|
Parent type | FormType |
Class | DateTimeType |
Field Options
choice_translation_domain
2.8
The choice_translation_domain
option was introduced in Symfony 2.8.
type: string
, boolean
or null
This option determines if the choice values should be translated and in which translation domain.
The values of the choice_translation_domain
option can be true
(reuse the current
translation domain), false
(disable translation), null
(uses the parent translation
domain or the default domain) or a string which represents the exact translation
domain to use.
date_format
type: integer
or string
default: IntlDateFormatter::MEDIUM
Defines the format
option that will be passed down to the date field.
See the DateType's format option
for more details.
date_widget
type: string
default: choice
The basic way in which this field should be rendered. Can be one of the following:
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)
placeholder
2.6
The placeholder
option was introduced in Symfony 2.6 and replaces
empty_value
, which is available prior to 2.6.
type: string
| array
If your widget option is set to choice
, then this field will be represented
as a series of select
boxes. When the placeholder value is a string,
it will be used as the blank value of all select boxes:
1 2 3 4 5
use Symfony\Component\Form\Extension\Core\Type\DateTimeType;
$builder->add('startDateTime', DateTimeType::class, array(
'placeholder' => 'Select a value',
));
Alternatively, you can use an array that configures different placeholder values for the year, month, day, hour, minute and second fields:
1 2 3 4 5 6 7 8
use Symfony\Component\Form\Extension\Core\Type\DateTimeType;
$builder->add('startDateTime', DateTimeType::class, array(
'placeholder' => array(
'year' => 'Year', 'month' => 'Month', 'day' => 'Day',
'hour' => 'Hour', 'minute' => 'Minute', 'second' => 'Second',
)
));
format
type: string
default: Symfony
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 datetime local format which is
used by the HTML5 datetime-local
field. Keeping the default value will
cause the field to be rendered as an input
field with type="datetime-local"
.
For more information on valid formats, see Date/Time Format Syntax.
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
.
html5
type: boolean
default: true
If this is set to true
(the default), it'll use the HTML5 type (date, time
or datetime) to render the field. When set to false
, it'll use the text type.
This is useful when you want to use a custom JavaScript datepicker, which often requires a text type instead of an HTML5 type.
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
(aDateTime
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
.
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 DateType
and TimeType. This can be overridden
with the date_widget and time_widget options.
with_minutes
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
.
Overridden Options
compound
type: boolean
default: false
This option specifies whether the type contains child types or not. This option is managed internally for built-in types, so there is no need to configure it explicitly.
data_class
type: string
default: null
The internal normalized representation of this type is an array, not a \DateTime
object. Therefore, the data_class
option is initialized to null
to avoid
the FormType
object from initializing it to \DateTime
.
error_bubbling
default: false
Inherited Options
These options inherit from the FormType:
data
type: mixed
default: Defaults to field of the underlying structure.
When you create a form, each field initially displays the value of the corresponding property of the form's domain data (e.g. if you bind an object to the form). If you want to override this initial value for the form or an individual field, you can set it in the data option:
1 2 3 4 5 6
use Symfony\Component\Form\Extension\Core\Type\HiddenType;
// ...
$builder->add('token', HiddenType::class, array(
'data' => 'abcdef',
));
Caution
The data
option always overrides the value taken from the domain data
(object) when rendering. This means the object value is also overriden when
the form edits an already persisted object, causing it to lose its
persisted value when the form is submitted.
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
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".
Caution
When a field has the inherit_data
option set, it uses the data of
the parent form as is. This means that
Data Transformers won't be
applied to that field.
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 TimeType 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', SomeFormType::class, 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
Caution
The read_only
option has been deprecated and will be removed in 3.0.
Instead, use the attr
option by setting it to an array with a readonly
key.
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 ). |