date_widget¶

type: string default: choice

Defines the widget option for the date type

time_widget¶

type: string default: choice

Defines the widget option for the time 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 (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. See the date type’s format option for more details.

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.

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.

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.

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

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:

$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),
));

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.

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.

mapped¶

type: boolean

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

virtual¶

type: boolean default: false

This option determines if the form will be mapped with data. This can be useful if you need a form to structure the view. See How to use the Virtual Form Field Option.