TimeType 字段

choice_translation_domain

类型: string, boolean 或 null 默认值: false

此选项确定是否应翻译选择值以及在哪个翻译域中翻译。

choice_translation_domain 选项的值可以是 true（重用当前翻译域）、false（禁用翻译）、null（使用父翻译域或默认域）或表示要使用的确切翻译域的字符串。

placeholder

类型: string | array

如果您的 widget 选项设置为 choice，则此字段将表示为一系列 select 框。当 placeholder 值为字符串时，它将用作所有选择框的**空白值**

1
2
3

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

或者，您可以使用一个数组，为小时、分钟和秒字段配置不同的 placeholder 值

1
2
3
4
5

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

hours

类型: array 默认值: 0 到 23

小时字段类型可用的小时列表。此选项仅在 widget 选项设置为 choice 时相关。

html5

类型: boolean 默认值: true

如果设置为 true（默认值），它将使用 HTML5 类型（date、time 或 datetime-local）来渲染字段。当设置为 false 时，它将使用文本类型。

当您想使用自定义 JavaScript 日期选择器时，这非常有用，自定义 JavaScript 日期选择器通常需要文本类型而不是 HTML5 类型。

input

类型: string 默认值: datetime

*input* 数据的格式 - 即日期存储在您的底层对象上的格式。有效值包括

• string (例如. 12:17:26)
• datetime (a DateTime 对象)
• datetime_immutable (a DateTimeImmutable 对象)
• array (例如. ['hour' => 12, 'minute' => 17, 'second' => 26])
• timestamp (例如. 1307232000)

从表单返回的值也将被规范化回这种格式。

input_format

类型: string 默认值: H:i:s

如果 input 选项设置为 string，则此选项指定时间的格式。这必须是有效的 PHP 时间格式。

minutes

类型: array 默认值: 0 到 59

分钟字段类型可用的分钟列表。此选项仅在 widget 选项设置为 choice 时相关。

model_timezone

类型: string 默认值: 系统默认时区

输入数据存储在的时区。这必须是 PHP 支持的时区之一。

reference_date

类型: DateTimeInterface 默认值: null

当 model_timezone 和 view_timezone 不同时，需要配置参考日期。时区转换将基于此日期计算。

seconds

类型: array 默认值: 0 到 59

秒字段类型可用的秒列表。此选项仅在 widget 选项设置为 choice 时相关。

view_timezone

类型: string 默认值: 系统默认时区

数据应如何向用户显示的时区（因此也是用户提交的数据的时区）。这必须是 PHP 支持的时区之一。

当未设置 reference_date 时，view_timezone 默认为配置的 model_timezone。

widget

类型: string 默认值: choice

此字段应渲染的基本方式。可以是以下之一

• choice: 渲染一个、两个（默认）或三个选择输入（小时、分钟、秒），具体取决于 with_minutes 和 with_seconds 选项。
• text: 渲染一个、两个（默认）或三个文本输入（小时、分钟、秒），具体取决于 with_minutes 和 with_seconds 选项。
• single_text: 渲染一个类型为 time 的输入。用户的输入将根据 hh:mm 表单（或 hh:mm:ss 如果使用秒）进行验证。

with_minutes

类型: boolean 默认值: true

是否在输入中包含分钟。这将导致一个额外的输入来捕获分钟。

with_seconds

类型: boolean 默认值: false

是否在输入中包含秒。这将导致一个额外的输入来捕获秒。

by_reference

默认值: false

DateTime 类被视为不可变对象。

compound

类型: boolean 默认值: false

此选项指定该类型是否包含子类型。此选项在内部为内置类型管理，因此无需显式配置。

data_class

类型: string 默认值: null

此类型的内部规范化表示形式是一个数组，而不是 \DateTime 对象。因此，data_class 选项初始化为 null，以避免 FormType 对象将其初始化为 \DateTime。

error_bubbling

默认值: false

invalid_message

类型: string 默认值: This value is not valid

如果输入到此字段的数据没有意义（即，验证失败），则使用此验证错误消息。

例如，如果用户在 TimeType 字段中输入无法转换为实际时间的无意义字符串，或者如果用户在数字字段中输入字符串（例如 apple），则可能会发生这种情况。

正常的（业务逻辑）验证（例如，当为字段设置最小长度时）应使用带有验证规则的验证消息设置（参考）。

attr

类型: array 默认值: []

如果要在 HTML 字段表示形式中添加额外的属性，可以使用 attr 选项。它是一个关联数组，其中 HTML 属性作为键。当您需要为某些 widget 设置自定义类时，这非常有用

1
2
3

$builder->add('body', TextareaType::class, [
    'attr' => ['class' => 'tinymce'],
]);

data

类型: mixed 默认值: 默认为底层结构的字段。

当您创建一个表单时，每个字段最初显示表单域数据的相应属性的值（例如，如果您将对象绑定到表单）。如果您想覆盖表单或单个字段的此初始值，可以在 data 选项中设置它

1
2
3
4
5
6

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

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

disabled

类型: boolean 默认值: false

如果您不希望用户修改字段的值，可以将 disabled 选项设置为 true。任何提交的值都将被忽略。

error_mapping

类型: array 默认值: []

此选项允许您修改验证错误的目标。

假设您有一个名为 matchingCityAndZipCode() 的自定义方法，用于验证城市和邮政编码是否匹配。不幸的是，您的表单中没有 matchingCityAndZipCode 字段，因此 Symfony 所能做的就是在表单顶部显示错误。

通过自定义错误映射，您可以做得更好：将错误映射到 city 字段，使其显示在其上方

1
2
3
4
5
6
7
8

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

以下是映射左侧和右侧的规则

• 左侧包含属性路径；
• 如果违规是在类的属性或方法上生成的，则其路径为 propertyName；
• 如果违规是在 array 或 ArrayAccess 对象的条目上生成的，则属性路径为 [indexName]；
• 您可以通过连接它们来构造嵌套属性路径，用点分隔属性。例如：addresses[work].matchingCityAndZipCode；
• 右侧包含表单中字段的名称。

默认情况下，任何未映射属性的错误都将冒泡到父表单。您可以使用左侧的点 (.) 将所有未映射属性的错误映射到特定字段。例如，要将所有这些错误映射到 city 字段，请使用

1
2
3
4
5

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

help

type: string 或 TranslatableInterface default: null

允许你为表单字段定义帮助消息，默认情况下，它会渲染在字段下方

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

类型: array 默认值: []

设置用于显示表单字段帮助消息的元素的 HTML 属性。它的值是一个关联数组，键为 HTML 属性名称。这些属性也可以在模板中设置

1
2
3

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

help_html

类型: boolean 默认值: false

默认情况下，help 选项的内容在模板中渲染之前会被转义。将此选项设置为 true 可不转义它们，当帮助信息包含 HTML 元素时，这非常有用。

inherit_data

类型: boolean 默认值: false

此选项确定表单是否将从其父表单继承数据。如果您有一组跨多个表单重复的字段，这将非常有用。请参阅 如何使用 "inherit_data" 减少代码重复。

invalid_message_parameters

类型: array 默认值: []

当设置 invalid_message 选项时，您可能需要在字符串中包含一些变量。这可以通过向该选项添加占位符并将变量包含在此选项中来完成

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

类型: boolean 默认值: true

如果您希望在读取或写入对象时忽略该字段，您可以将 mapped 选项设置为 false。

row_attr

类型: array 默认值: []

添加到用于渲染 表单类型行 的元素的 HTML 属性的关联数组

1
2
3

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