CheckboxType 字段

false_values

类型: array 默认值: [null]

要解释为 false 的值数组。

value

类型: mixed 默认值: 1

实际用作复选框或单选按钮的值。这不会影响在您的对象上设置的值。

compound

类型: boolean 默认值: false

此选项指定表单是否为复合表单。由于复选框不是这种情况，默认情况下，该值将被 false 值覆盖。

empty_data

类型: string 默认值: mixed

此选项确定当选择 placeholder 选项时字段将返回的值。在复选框和单选类型中，empty_data 的值将被数据转换器返回的值覆盖（请参阅 如何使用数据转换器）。

invalid_message

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

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

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

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

attr

类型: array 默认值: []

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

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_bubbling

类型: boolean 默认值: false，除非表单是 compound

如果 true，则此字段的任何错误都将传递给父字段或表单。例如，如果在普通字段上设置为 true，则该字段的任何错误都将附加到主表单，而不是附加到特定字段。

error_mapping

类型: array 默认值: []

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

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

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

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

类型: 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 元素时很有用。

label

类型: string 或 TranslatableMessage 默认值: 标签从字段名称“猜测”而来

设置渲染字段时将使用的标签。设置为 false 将禁止显示标签

1
2
3
4
5
6
7
8

use Symfony\Component\Translation\TranslatableMessage;

$builder
    ->add('zipCode', null, [
        'label' => 'The ZIP/Postal code',
        // optionally, you can use TranslatableMessage objects as the label content
        'label' => new TranslatableMessage('address.zipCode', ['%country%' => $country], 'address'),
    ])

标签也可以在模板中设置

1

{{ form_label(form.name, 'Your name') }}

1
2
3
4

echo $view['form']->label(
    $form['name'],
    'Your name'
);

label_attr

类型: array 默认值: []

设置 <label> 元素的 HTML 属性，该元素将在渲染字段的标签时使用。它是一个关联数组，其中 HTML 属性作为键。这些属性也可以直接在模板内设置

1
2
3

{{ form_label(form.name, 'Your name', {
    'label_attr': {'class': 'CUSTOM_LABEL_CLASS'}
}) }}

1
2
3
4
5

echo $view['form']->label(
    $form['name'],
    'Your name',
    ['label_attr' => ['class' => 'CUSTOM_LABEL_CLASS']]
);

label_html

类型: boolean 默认值: false

默认情况下，在模板中呈现 label 选项的内容之前对其进行转义。将此选项设置为 true 以不转义它们，这在标签包含 HTML 元素时很有用。

label_format

类型: string 默认值: null

配置用作字段标签的字符串，以防未设置 label 选项。当使用 关键字翻译消息 时，这很有用。

如果您使用关键字翻译消息作为标签，您通常最终会为同一标签使用多个关键字消息（例如 profile_address_street，invoice_address_street）。这是因为标签是为字段的每个“路径”构建的。为了避免重复的关键字消息，您可以将标签格式配置为静态值，例如

1
2
3
4
5
6
7
8

// ...
$profileFormBuilder->add('address', AddressType::class, [
    'label_format' => 'form.address.%name%',
]);

$invoiceFormBuilder->add('invoice', AddressType::class, [
    'label_format' => 'form.address.%name%',
]);

此选项由子类型继承。使用上面的代码，两个表单的 street 字段的标签都将使用 form.address.street 关键字消息。

标签格式中有两个变量可用

%id%

字段的唯一标识符，由字段的完整路径和字段名称组成（例如 profile_address_street）；

%name%

字段名称（例如 street）。

默认值 (null) 会生成字段名称的 “人性化”版本。

mapped

类型: boolean 默认值: true

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

required

类型: boolean 默认值: true

如果为 true，将呈现 HTML5 required 属性。相应的 label 也将使用 required 类进行渲染。

这是表面的，并且独立于验证。在最好的情况下，如果您让 Symfony 猜测您的字段类型，那么此选项的值将从您的验证信息中猜测出来。

row_attr

类型: array 默认值: []

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

1
2
3

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