time Field Type¶

A field to capture time input.

This can be rendered as a text field, a series of text fields (e.g. hour, minute, second) or a series of select fields. The underlying data can be stored as 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	can be various tags (see below)
Options	widget input with_seconds hours minutes seconds data_timezone user_timezone
Parent type	form
Class	`Symfony\Component\Form\Extension\Core\Type\TimeType`

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 startTime field whose underlying time data is a DateTime object. The following configures the time type for that field as three different choice fields:

$builder->add('startTime', 'time', array(
    'input'  => 'datetime',
    'widget' => 'choice',
));

The input option must be changed to match the type of the underlying date data. For example, if the startTime field’s data were a unix timestamp, you’d need to set input to timestamp:

$builder->add('startTime', 'time', array(
    'input'  => 'timestamp',
    'widget' => 'choice',
));

The field also supports an array and string as valid input option values.

Field Options¶

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. 12:17:26)
datetime (a DateTime object)
array (e.g. array('hour' => 12, 'minute' => 17, 'second' => 26))
timestamp (e.g. 1307232000)

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

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.

hours¶

type: integer default: 1 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: integer default: 1 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: integer default: 1 to 59

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

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¶