time Field Type

CAUTION: You are browsing the documentation for Symfony 2.0 which is not maintained anymore. Consider upgrading your projects to Symfony 3.2.

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
Overridden Options
Inherited options
Parent type form
Class 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:

1
2
3
4
$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:

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

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

Field Options

widget

type: string default: choice

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

  • choice: renders two (or three if with_seconds is true) select inputs.
  • text: renders a two or three text inputs (hour, minute, second).
  • single_text: renders a single input of type text. User's input will be validated against the form hh:mm (or hh:mm:ss if using seconds).

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. This may not work as expected in Symfony 2.0 due to a known bug.

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.

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

Overridden Options

by_reference

default: false

The DateTime classes are treated as immutable objects.

error_bubbling

default: false

Inherited options

These options inherit from the field type:

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

These options inherit from the date type:

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.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.