HiddenType 字段

compound

类型: boolean 默认值: false

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

error_bubbling

默认值: true

将错误传递到根表单，否则它们将不可见。

invalid_message

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

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

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

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

required

默认值: false

隐藏字段不能有 required 属性。

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',
]);

empty_data

类型: mixed

默认值为 '' （空字符串）。

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

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

1
2
3
4

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

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

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；
• 右侧包含表单中字段的名称。

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

1
2
3
4
5

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

mapped

类型: boolean 默认值: true

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

property_path

类型: PropertyPathInterface|string|null 默认值: null

默认情况下（当此选项的值为 null 时），表单字段从表单域对象中具有相同名称的属性读取和写入。 property_path 选项允许您定义字段从中读取和写入的属性。此选项的值可以是任何有效的 PropertyAccess 语法。

row_attr

类型: array 默认值: []

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

1
2
3

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