date Field Type
Edit this pageWarning: You are browsing the documentation for Symfony 2.4, which is no longer maintained.
Read the updated version of this page for Symfony 6.3 (the current stable version).
date Field Type
A field that allows the user to modify date information via a variety of different HTML elements.
The underlying data used for this field type can be a DateTime
object,
a string, a timestamp or an array. As long as the input option is set
correctly, the field will take care of all of the details.
The field can be rendered as a single text box, three text boxes (month, day, and year) or three select boxes (see the widget option).
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 | form |
Class | DateType |
Basic Usage
This field type is highly configurable, but easy to use. The most important
options are input
and widget
.
Suppose that you have a publishedAt
field whose underlying date is a
DateTime
object. The following configures the date
type for that
field as three different choice fields:
1 2 3 4
$builder->add('publishedAt', 'date', array(
'input' => 'datetime',
'widget' => 'choice',
));
The input
option must be changed to match the type of the underlying
date data. For example, if the publishedAt
field's data were a unix timestamp,
you'd need to set input
to timestamp
:
1 2 3 4
$builder->add('publishedAt', 'date', array(
'input' => 'timestamp',
'widget' => 'choice',
));
The field also supports an array
and string
as valid input
option
values.
Field Options
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
type: string
or array
If your widget option is set to choice
, then this field will be represented
as a series of select
boxes. The empty_value
option can be used to
add a "blank" entry to the top of each select box:
1 2 3
$builder->add('dueDate', 'date', array(
'empty_value' => '',
));
Alternatively, you can specify a string to be displayed for the "blank" value:
1 2 3
$builder->add('dueDate', 'date', array(
'empty_value' => array('year' => 'Year', 'month' => 'Month', 'day' => 'Day')
));
format
type: integer
or string
default: IntlDateFormatter::MEDIUM (or yyyy-MM-dd
if widget is single_text
)
Option passed to the IntlDateFormatter
class, used to transform user input
into the proper format. This is critical when the widget option is
set to single_text
, and will define how the user will input the data.
By default, the format is determined based on the current user locale: meaning
that the expected format will be different for different users. You
can override it by passing the format as a string.
For more information on valid formats, see Date/Time Format Syntax:
1 2 3 4 5
$builder->add('date_created', 'date', array(
'widget' => 'single_text',
// this is actually the default format for single_text
'format' => 'yyyy-MM-dd',
));
Note
If you want your field to be rendered as an HTML5 "date" field, you have to
use a single_text
widget with the yyyy-MM-dd
format (the RFC 3339
format) which is the default value if you use the single_text
widget.
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
)datetime
(aDateTime
object)array
(e.g.array('year' => 2011, 'month' => 06, 'day' => 05)
)timestamp
(e.g.1307232000
)
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.
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
.
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: choice
The basic way in which this field should be rendered. Can be one of the following:
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
error_bubbling
default: false
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.
error_mapping
type: array
default: empty
This option allows you to modify the target of a validation error.
Imagine you have a custom method named matchingCityAndZipCode
that validates
whether the city and zip code match. Unfortunately, there is no "matchingCityAndZipCode"
field in your form, so all that Symfony can do is display the error on top
of the form.
With customized error mapping, you can do better: map the error to the city field so that it displays above it:
1 2 3 4 5 6 7 8
public function setDefaultOptions(OptionsResolverInterface $resolver)
{
$resolver->setDefaults(array(
'error_mapping' => array(
'matchingCityAndZipCode' => 'city',
),
));
}
Here are the rules for the left and the right side of the mapping:
- The left side contains property paths;
- If the violation is generated on a property or method of a class, its path
is simply
propertyName
; - If the violation is generated on an entry of an
array
orArrayAccess
object, the property path is[indexName]
; - You can construct nested property paths by concatenating them, separating
properties by dots. For example:
addresses[work].matchingCityAndZipCode
; - The left side of the error mapping also accepts a dot
.
, which refers to the field itself. That means that any error added to the field is added to the given nested field instead; - The right side contains simply the names of fields in the form.
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".
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 ). |
date_pattern | string |
A string with the date format to use. |