DateIntervalType Field¶

This field allows the user to select an interval of time. For example, if you want to allow the user to choose how often they receive a status email, they could use this field to choose intervals like every “10 minutes” or “3 days”.

The field can be rendered in a variety of different ways (see widget) and can be configured to give you a DateInterval object, an ISO 8601 duration string (e.g. P1DT12H) or an array (see input).

Underlying Data Type	can be `DateInterval`, string or array (see the `input` option)
Rendered as	single text box, multiple text boxes or select fields - see the widget option
Options	days hours minutes months seconds weeks input labels placeholder widget with_days with_hours with_invert with_minutes with_months with_seconds with_weeks with_years years
Inherited options	attr data disabled help help_attr help_html inherit_data invalid_message invalid_message_parameters mapped row_attr
Parent type	FormType
Class	`DateIntervalType`

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

Basic Usage¶

This field type is highly configurable. The most important options are input and widget.

You can configure a lot of different options, including exactly which range options to show (e.g. don’t show “months”, but do show “days”):

$builder->add('remindEvery', DateIntervalType::class, [
    'widget'      => 'integer', // render a text field for each part
    // 'input'    => 'string',  // if you want the field to return a ISO 8601 string back to you

    // customize which text boxes are shown
    'with_years'  => false,
    'with_months' => false,
    'with_days'   => true,
    'with_hours'  => true,
]);

Field Options¶

`days`¶

type: array default: 0 to 31

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

// values displayed to users range from 0 to 30 (both inclusive)
'days' => range(1, 31),

// values displayed to users range from 1 to 31 (both inclusive)
'days' => array_combine(range(1, 31), range(1, 31)),

`placeholder`¶

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 placeholder option can be used to add a “blank” entry to the top of each select box:

$builder->add('remindEvery', DateIntervalType::class, [
    'placeholder' => '',
]);

Alternatively, you can specify a string to be displayed for the “blank” value:

$builder->add('remindEvery', DateIntervalType::class, [
    'placeholder' => ['years' => 'Years', 'months' => 'Months', 'days' => 'Days']
]);

`hours`¶

type: array default: 0 to 24

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

// values displayed to users range from 0 to 23 (both inclusive)
'hours' => range(1, 24),

// values displayed to users range from 1 to 24 (both inclusive)
'hours' => array_combine(range(1, 24), range(1, 24)),

`input`¶

type: string default: dateinterval

The format of the input data - i.e. the format that the interval is stored on your underlying object. Valid values are:

string (a string formatted with ISO 8601 standard, e.g. P7Y6M5DT12H15M30S)
dateinterval (a DateInterval object)
array (e.g. ['days' => '1', 'hours' => '12',])

The value that comes back from the form will also be normalized back into this format.

`labels`¶

type: array default: (see below)

The labels displayed for each of the elements of this type. The default values are null, so they display the “humanized version” of the child names (Invert, Years, etc.):

'labels' => [
    'invert' => null,
    'years' => null,
    'months' => null,
    'weeks' => null,
    'days' => null,
    'hours' => null,
    'minutes' => null,
    'seconds' => null,
]

`minutes`¶

type: array default: 0 to 60

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

// values displayed to users range from 0 to 59 (both inclusive)
'minutes' => range(1, 60),

// values displayed to users range from 1 to 60 (both inclusive)
'minutes' => array_combine(range(1, 60), range(1, 60)),

`months`¶

type: array default: 0 to 12

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

// values displayed to users range from 0 to 11 (both inclusive)
'months' => range(1, 12),

// values displayed to users range from 1 to 12 (both inclusive)
'months' => array_combine(range(1, 12), range(1, 12)),

`seconds`¶

type: array default: 0 to 60

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

// values displayed to users range from 0 to 59 (both inclusive)
'seconds' => range(1, 60),

// values displayed to users range from 1 to 60 (both inclusive)
'seconds' => array_combine(range(1, 60), range(1, 60)),

`weeks`¶

type: array default: 0 to 52

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

// values displayed to users range from 0 to 51 (both inclusive)
'weeks' => range(1, 52),

// values displayed to users range from 1 to 52 (both inclusive)
'weeks' => array_combine(range(1, 52), range(1, 52)),

`widget`¶

type: string default: choice

The basic way in which this field should be rendered. Can be one of the following:

choice: renders one to six select inputs for years, months, weeks, days, hours, minutes and/or seconds, depending on the with_years, with_months, with_weeks, with_days, with_hours, with_minutes and with_seconds options. Default: Three fields for years, months and days.
text: renders one to six text inputs for years, months, weeks, days, hours, minutes and/or seconds, depending on the with_years, with_months, with_weeks, with_days, with_hours, with_minutes and with_seconds options. Default: Three fields for years, months and days.
integer: renders one to six integer inputs for years, months, weeks, days, hours, minutes and/or seconds, depending on the with_years, with_months, with_weeks, with_days, with_hours, with_minutes and with_seconds options. Default: Three fields for years, months and days.
single_text: renders a single input of type text. User’s input will be validated against the form PnYnMnDTnHnMnS (or PnW if using only weeks).

`with_days`¶

type: Boolean default: true

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

Caution

This can not be used when with_weeks is enabled.