WeekType 字段

placeholder

类型: string | array

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

1
2
3
4
5

use Symfony\Component\Form\Extension\Core\Type\WeekType;

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

或者，您可以使用数组为年份和周字段配置不同的 placeholder 值

1
2
3
4
5
6
7
8

use Symfony\Component\Form\Extension\Core\Type\WeekType;

$builder->add('startDateTime', WeekType::class, [
    'placeholder' => [
        'year' => 'Year',
        'week' => 'Week',
    ],
]);

html5

类型: boolean 默认值: true

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

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

input

类型: string 默认值: array

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

• string (例如 "2011-W17")
• array (例如 [2011, 17])

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

widget

类型: string 默认值: choice

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

• choice：呈现两个选择输入框；
• text：呈现类型为 text 的双字段输入框（年份和周）；
• single_text：呈现类型为 week 的单个输入框。

years

类型: array 默认值: 当前年份前十年到后十年

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

weeks

类型: array 默认值: 1 到 53

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

compound

类型: boolean 默认值: false

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

empty_data

类型: mixed

此选项的实际默认值取决于其他字段选项

• 如果 widget 是 single_text，则为 '' (空字符串)；
• 否则为 [] (空数组)。

此选项决定当提交的值为空（或缺失）时字段将返回什么值。如果视图中呈现表单时未提供初始值，则它不会设置初始值。

这意味着它可以帮助您处理带有空白字段的表单提交。例如，如果您希望在未选择任何值时将 name 字段显式设置为 John Doe，您可以这样做

1
2
3
4

$builder->add('name', null, [
    'required'   => false,
    'empty_data' => 'John Doe',
]);

这仍然会呈现一个空文本框，但在提交后，将设置 John Doe 值。使用 data 或 placeholder 选项在呈现的表单中显示此初始值。

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。任何提交的值都将被忽略。

help

类型: string 或 TranslatableInterface 默认值: 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' => '...'],
]);