BirthdayType Field¶

A DateType field that specializes in handling birth date data.

Can be rendered as a single text box, three text boxes (month, day and year), or three select boxes.

This type is essentially the same as the DateType type, but with a more appropriate default for the years option. The years option defaults to 120 years ago to the current year.

Underlying Data Type	can be `DateTime`, `string`, `timestamp`, or `array` (see the input option)
Rendered as	can be three select boxes or 1 or 3 text boxes, based on the widget option
Overridden options	years
Inherited options	from the DateType: choice_translation_domain days placeholder format input input_format model_timezone months view_timezone widget from the FormType: attr data disabled help help_attr help_html inherit_data invalid_message invalid_message_parameters mapped row_attr
Parent type	DateType
Class	`BirthdayType`

Tip

The full list of options defined and inherited by this form type is available running this command in your app:

# replace 'FooType' by the class name of your form type
$ php bin/console debug:form FooType

Overridden Options¶

`years`¶

type: array default: 120 years ago to 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 DateType:

`choice_translation_domain`¶

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.

`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)

`placeholder`¶

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:

$builder->add('birthdate', BirthdayType::class, [
    'placeholder' => 'Select a value',
]);

Alternatively, you can use an array that configures different placeholder values for the year, month and day fields:

$builder->add('birthdate', BirthdayType::class, [
    'placeholder' => [
        '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:

use Symfony\Component\Form\Extension\Core\Type\DateType;
// ...

$builder->add('dateCreated', DateType::class, [
    '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 (a DateTime object)
datetime_immutable (a DateTimeImmutable object)
array (e.g. ['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.

input_format¶

type: string default: Y-m-d

If the input option is set to string, this option specifies the format of the date. This must be a valid PHP date format.

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

`attr`¶

type: array default: []

If you want to add extra attributes to an HTML field representation you can use the attr option. It’s an associative array with HTML attributes as keys. This can be useful when you need to set a custom class for some widget:

$builder->add('body', TextareaType::class, [
    'attr' => ['class' => 'tinymce'],
]);

`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:

use Symfony\Component\Form\Extension\Core\Type\HiddenType;
// ...

$builder->add('token', HiddenType::class, [
    '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 overridden 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.

help¶

type: string default: null

Allows you to define a help message for the form field, which by default is rendered below the field:

$builder->add('zipCode', null, [
    'help' => 'The ZIP/Postal code for your credit card\'s billing address.',
]);

help_attr¶

type: array default: []

Sets the HTML attributes for the element used to display the help message of the form field. Its value is an associative array with HTML attribute names as keys. These attributes can also be set in the template:

{{ form_help(form.name, 'Your name', {
    'help_attr': {'class': 'CUSTOM_LABEL_CLASS'}
}) }}

help_html¶

type: bool default: false

By default, the contents of the help option are escaped before rendering them in the template. Set this option to true to not escape them, which is useful when the help contains HTML elements.

`inherit_data`¶

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: []

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:

$builder->add('someField', SomeFormType::class, [
    // ...
    'invalid_message' => 'You entered an invalid value, it should include %num% letters',
    'invalid_message_parameters' => ['%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.

row_attr¶

type: array default: []

An associative array of the HTML attributes added to the element which is used to render the form type row:

$builder->add('body', TextareaType::class, [
    'row_attr' => ['class' => 'text-editor', 'id' => '...'],
]);

BirthdayType Field¶

Overridden Options¶

years¶

Inherited Options¶

choice_translation_domain¶

days¶

placeholder¶

format¶

input¶

input_format¶

model_timezone¶

months¶

view_timezone¶

widget¶

attr¶

data¶

disabled¶

help¶

help_attr¶

help_html¶

inherit_data¶

invalid_message¶

invalid_message_parameters¶

mapped¶

row_attr¶

`years`¶

`choice_translation_domain`¶

`days`¶

`placeholder`¶

`format`¶

`input`¶

`model_timezone`¶

`months`¶

`view_timezone`¶

`widget`¶

`attr`¶

`data`¶

`disabled`¶

`inherit_data`¶

`invalid_message`¶

`invalid_message_parameters`¶

`mapped`¶