TimeType Field ¶

choice_translation_domain ¶

type: string, boolean or null default: false

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.

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:

1
2
3

$builder->add('startTime', 'time', [
    'placeholder' => 'Select a value',
]);

Alternatively, you can use an array that configures different placeholder values for the hour, minute and second fields:

1
2
3
4
5

$builder->add('startTime', 'time', [
    'placeholder' => [
        'hour' => 'Hour', 'minute' => 'Minute', 'second' => 'Second',
    ],
]);

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.

html5 ¶

type: boolean default: true

If this is set to true (the default), it'll use the HTML5 type (date, time or datetime-local) to render the field. When set to false, it'll use the text type.

This is useful when you want to use a custom JavaScript datepicker, which often requires a text type instead of an HTML5 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. 12:17:26)
  文字列 (例: 12:17:26)
• datetime (a DateTime object)
  datetime (DateTime オブジェクト)
• datetime_immutable (a DateTimeImmutable object)
  datetime_immutable (DateTimeImmutable オブジェクト)
• array (e.g. ['hour' => 12, 'minute' => 17, 'second' => 26])
  配列 (例: ['hour' => 12, 'minute' => 17, 'second' => 26])
• timestamp (e.g. 1307232000)
  タイムスタンプ (例: 1307232000)

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

input_format ¶

type: string default: H:i:s

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

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.

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.

reference_date ¶

type: DateTimeInterface default: null

Configuring a reference date is required when the model_timezone and view_timezone are different. Timezone conversions will be calculated based on this date.

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.

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.

When no reference_date is set the view_timezone defaults to the configured model_timezone.

widget ¶

type: string default: choice

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

• choice: renders one, two (default) or three select inputs (hour, minute, second), depending on the with_minutes and with_seconds options.
  choice: with_minutes および with_seconds オプションに応じて、1 つ、2 つ (デフォルト)、または 3 つの選択入力 (時間、分、秒) をレンダリングします。
• text: renders one, two (default) or three text inputs (hour, minute, second), depending on the with_minutes and with_seconds options.
  text: with_minutes および with_seconds オプションに応じて、1 つ、2 つ (デフォルト)、または 3 つのテキスト入力 (時、分、秒) をレンダリングします。
• single_text: renders a single input of type time. User's input will be validated against the form hh:mm (or hh:mm:ss if using seconds).
  single_text: タイプ time の単一の入力をレンダリングします。ユーザーの入力は、hh:mm (秒を使用する場合は hh:mm:ss) の形式に対して検証されます。

with_minutes ¶

type: boolean default: true

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

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.

by_reference ¶

default: false

The DateTime classes are treated as immutable objects.

compound ¶

type: boolean default: false

This option specifies whether the type contains child types or not. This option is managed internally for built-in types, so there is no need to configure it explicitly.

data_class ¶

type: string default: null

The internal normalized representation of this type is an array, not a \DateTime object. Therefore, the data_class option is initialized to null to avoid the FormType object from initializing it to \DateTime.

error_bubbling ¶

default: false

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

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:

1
2
3

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

1
2
3
4
5
6

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

$builder->add('token', HiddenType::class, [
    'data' => 'abcdef',
]);

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.

error_mapping ¶

type: array default: []

This option allows you to modify the target of a validation error.

Imagine you have a custom method named matchingCityAndZipCode() that validates whether the city and zip code match. Unfortunately, there is no matchingCityAndZipCode field in your form, so all that Symfony can do is display the error on top of the form.

With customized error mapping, you can do better: map the error to the city field so that it displays above it:

1
2
3
4
5
6
7
8

public function configureOptions(OptionsResolver $resolver)
{
    $resolver->setDefaults([
        'error_mapping' => [
            'matchingCityAndZipCode' => 'city',
        ],
    ]);
}

Here are the rules for the left and the right side of the mapping:

• The left side contains property paths;
  左側にはプロパティ パスが含まれています。
• If the violation is generated on a property or method of a class, its path is the propertyName;
  違反がクラスのプロパティまたはメソッドで生成された場合、そのパスは propertyName です。
• If the violation is generated on an entry of an array or ArrayAccess object, the property path is [indexName];
  違反が配列または ArrayAccess オブジェクトのエントリで生成された場合、プロパティ パスは [indexName] です。
• You can construct nested property paths by concatenating them, separating properties by dots. For example: addresses[work].matchingCityAndZipCode;
  プロパティをドットで区切って連結することにより、ネストされたプロパティ パスを作成できます。例: address[work].matchingCityAndZipCode;
• The right side contains the names of fields in the form.
  右側には、フォーム内のフィールドの名前が含まれています。

By default, errors for any property that is not mapped will bubble up to the parent form. You can use the dot (.) on the left side to map errors of all unmapped properties to a particular field. For instance, to map all these errors to the city field, use:

1
2
3
4
5

$resolver->setDefaults([
    'error_mapping' => [
        '.' => 'city',
    ],
]);

help ¶

type: string or TranslatableInterface default: null

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

1
2
3
4
5
6
7
8
9
10
11
12
13

use Symfony\Component\Translation\TranslatableMessage;

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

    // ...

    ->add('status', null, [
        'help' => new TranslatableMessage('order.status', ['%order_id%' => $order->getId()], 'store'),
    ])
;

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:

1
2
3

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

help_html ¶

type: boolean 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".

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:

1
2
3
4
5

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

1
2
3

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