TextType 字段

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

empty_data

类型: mixed

从 HTTP 的角度来看，提交的数据始终是字符串或字符串数组。 因此，默认情况下，表单会将任何空字符串视为空值。 如果你希望获取一个空字符串，请显式地将 empty_data 选项设置为空字符串。

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

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

1
2
3
4

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

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

error_bubbling

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

如果为 true，则此字段的任何错误都将传递给父字段或表单。 例如，如果在普通字段上设置为 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

类型: 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' => '...'],
]);

sanitize_html

类型: boolean 默认值: false

当为 true 时，在提交表单后，文本输入将使用 Symfony HTML Sanitizer 组件进行清理。 这可以保护表单输入免受 XSS、点击劫持和 CSS 注入的攻击。

sanitizer

类型: string 默认值: "default"

启用 sanitize_html 后，你可以使用此选项指定自定义 sanitizer 的名称。

trim

类型: boolean 默认值: true

如果为 true，则在绑定数据时，提交的字符串值的空格将通过 trim 函数去除。 这保证了如果提交的值带有额外的空格，它将在值合并回底层对象之前被删除。

compound

类型: boolean 默认值: false

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