FormType领域

编辑本页

警告:您正在浏览的文档欧宝官网下载appob娱乐下载Symfony 4.4,现已不再维护。

本页的更新版本用于Syob娱乐下载mfony 6.2(当前稳定版本)。

FormType领域

FormType预定义两个选项,然后在所有类型上可用FormType是父节点。

没有一个
FormType

提示

这个表单类型定义和继承的完整选项列表可以在你的应用程序中运行这个命令:

1 2
将'FooType'替换为你的表单类型的类名php bin/console debug:form FooType . php

场的选择

行动

类型字符串默认的:空字符串

此选项指定提交表单时将数据发送到哪里(通常是URI)。的值表示为行动属性。形式元素。空值被认为是同一个文档引用,即表单将被提交给呈现表单的同一个URI。

allow_extra_fields

类型布尔默认的

通常,如果您提交了表单中未配置的额外字段,则会得到“此表单不应包含额外字段”验证错误。

方法可以禁用此验证错误allow_extra_fields表单上的选项。

by_reference

类型布尔默认的真正的

在大多数情况下,如果你有作者场,然后你期望setAuthor ()在底层对象上调用。然而,在某些情况下,setAuthor ()五月被称为。设置by_reference确保在所有情况下都调用setter。

为了进一步解释这一点,这里有一个简单的例子:

12 3 4 5 6 7 8 9 10 11 12 13
使用ob娱乐下载组件形式扩展核心类型EmailType使用ob娱乐下载组件形式扩展核心类型FormType使用ob娱乐下载组件形式扩展核心类型TextType/ /……构建器->createFormBuilder (文章);构建器->add (“标题”, TextType::类)->add (构建器->创建(“作者”, FormType::类,“by_reference”= > ?)->add (“名字”, TextType::类)->add (“电子邮件”, EmailType::类))

如果by_reference是真的吗,下面的事情发生在你打电话时的幕后提交()(或handleRequest ())在表格上:

1 2 3
文章->setTitle ('...');文章->getAuthor ()->setName ('...');文章->getAuthor ()->setEmail ('...');

请注意,setAuthor ()没有调用。作者因引用而有所修改。

如果你设置by_reference对于false,提交看起来像这样:

1 2 3 4 5
文章->setTitle ('...');作者克隆文章->getAuthor ();作者->setName ('...');作者->setEmail ('...');文章->setAuthor (作者);

所有这些by_reference = false真正做的是它克隆对象,这强制框架在父对象上调用setter。

类似地,如果你使用CollectionType字段,其中您的底层收集数据是一个对象(就像Doctrine的ArrayCollection),然后by_reference必须设置为如果你需要加法器和移除器(例如。addAuthor ()而且removeAuthor ())被称为。

复合

类型布尔默认的真正的

复合形式可以是一个整体< >形式元素或一组表单字段(例如在< div >< tr >容器元素)。复合表单使用DataMapperInterface来初始化它们的子表单或回写它们提交的数据。

一个简单的(非复合)表单被呈现为以下HTML元素中的任何一个:<输入>TextType文件类型HiddenType),textarea > <TextareaType)或<选择>ChoiceType).

一些核心类型,如日期相关类型或ChoiceType简单还是复合取决于其他选项(例如扩大小部件).它们要么表现为一个简单的文本字段,要么表现为一组文本或选择字段。

约束

类型数组约束默认的

允许您将一个或多个验证约束附加到特定字段。有关更多信息,请参见添加验证.属性中添加此选项FormTypeValidatorExtension形式扩展。

数据

类型混合默认的:默认为底层结构的字段。

当你创建一个表单时,每个字段最初都会显示表单域数据的对应属性的值(例如,如果你将一个对象绑定到表单)。如果你想覆盖表单或单个字段的初始值,你可以在data选项中设置它:

1 2 3 4 5 6
使用ob娱乐下载组件形式扩展核心类型HiddenType/ /……构建器->add (“令牌”, HiddenType::类,“数据”= >“六边形abcdef”]);

谨慎

数据选项总是在呈现时覆盖从域数据(对象)获取的值。这意味着当表单编辑一个已经持久化的对象时,对象值也会被覆盖,从而导致在表单提交时失去它的持久化值。

data_class

类型字符串

此选项用于设置表单要使用的适当数据映射器,因此您可以将其用于任何需要对象的表单字段类型:

1 2 3 4 5 6 7
使用应用程序实体媒体使用应用程序形式MediaType/ /……构建器->add (“媒体”, MediaType::类,“data_class”= >媒体::类,]);

empty_data

类型混合

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

  • 如果data_class设置为要求真正的,然后新的data_class美元()
  • 如果data_class设置为要求,然后
  • 如果data_class并没有设置复合真正的,然后[](空数组);
  • 如果data_class并没有设置复合,然后(空字符串)。

这个选项决定字段的值返回当提交的值为空(或缺失)时。如果在视图中呈现表单时没有提供初始值,则不设置初始值。

这意味着它可以帮助您处理带有空白字段的表单提交。例如,如果你想要的名字要显式设置为的字段John Doe当没有选择值时,你可以这样做:

1 2 3 4
构建器->add (“名字”, [“要求”= >“empty_data”= >“John Doe”]);

这仍然会呈现一个空文本框,但在提交John Doe值将被设置。使用数据占位符选项,在呈现的表单中显示此初始值。

如果表单是复合的,则可以设置empty_data作为数组、对象或闭包。看到如何为窗体类配置空数据文章中有关于这些选项的详细信息。

请注意

如果你想设置empty_data整个表单类的选项,请参见如何为窗体类配置空数据篇文章。

谨慎

表格数据转换器还会适用于吗empty_data价值。这意味着将转换为空字符串.如果显式地希望返回空字符串,则使用自定义数据转换器。

error_bubbling

类型布尔默认的除非表格是复合

如果真正的,此字段的任何错误都将传递给父字段或表单。例如,如果设置为真正的对于普通字段,该字段的任何错误都将附加到主表单,而不是特定的字段。

error_mapping

类型数组默认的[]

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

假设您有一个名为matchingCityAndZipCode ()这将验证城市和邮政编码是否匹配。不幸的是,没有matchingCityAndZipCode字段,所以Symfony所能做的就是在表单的顶部显示错误。ob娱乐下载

使用自定义错误映射,你可以做得更好:将错误映射到城市字段,这样它就会显示在它上面:

1 2 3 4 5 6 7 8
公共函数configureOptions(OptionsResolver解析器解析器->setDefaults ([“error_mapping”= > [“matchingCityAndZipCode”= >“城市”,],]);}

下面是映射左侧和右侧的规则:

  • 左侧包含属性路径;
  • 如果在类的属性或方法上生成违规,则其路径为propertyName
  • 类的项上生成的违例数组ArrayAccess对象时,属性路径为(indexName)
  • 您可以通过连接它们来构造嵌套的属性路径,用圆点分隔属性。例如:地址[工作].matchingCityAndZipCode
  • 右侧包含表单中字段的名称。

默认情况下,任何未映射的属性的错误都会冒泡到父表单。你可以用点(),将所有未映射属性的错误映射到特定字段。例如,将所有这些错误映射到城市字段中,使用:

1 2 3 4 5
解析器->setDefaults ([“error_mapping”= > [“。”= >“城市”,],]);

extra_fields_message

类型字符串默认的此表单不应包含额外字段。

这是验证错误消息,如果提交的表单数据包含一个或多个不属于表单定义的字段,则使用该消息。占位符{{extra_fields}}可用于显示以逗号分隔的提交的额外字段名称列表。

帮助

类型字符串默认的:零

允许您为表单字段定义帮助消息,默认情况下呈现在字段下面:

1 2 3
构建器->add (“zipCode”, [“帮助”= >“您信用卡账单地址的邮政编码。”]);

help_attr

类型数组默认的[]

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

1 2 3
{{form_help (form.name,“你的名字”,{help_attr:{‘类’:‘CUSTOM_LABEL_CLASS}})}}

help_html

类型布尔默认的

的内容默认为帮助选项在模板中呈现之前进行转义。将此选项设置为真正的不转义它们,这在帮助包含HTML元素时很有用。

help_translation_parameters

类型数组默认的[]

4.3

help_translation_parameters选项是在Symfony 4.3中引入的。ob娱乐下载

的内容帮助选项在显示之前进行转换,因此它可以包含翻译占位符.此选项定义用于替换这些占位符的值。

考虑到以下翻译信息:

1 2
#翻译/ messages.en.yamlform.order.id.help:'这将是与%company%通信时的引用'

可以按照如下方式指定占位符值:

1 2 3 4 5 6
构建器->add (“id”, [“帮助”= >“form.order.id.help”“help_translation_parameters”= > [%公司%的= >“ACME公司”。,],]);

help_translation_parameters子字段的选项与父字段的相同选项合并,因此子字段可以重用和/或覆盖任何父字段占位符。

inherit_data

类型布尔默认的

此选项决定表单是否从其父表单继承数据。如果您有一组跨多个表单重复的字段,这可能很有用。看到如何使用"inherit_data"减少代码重复

谨慎

字段具有inherit_data选项集时,它按原样使用父表单的数据。这意味着数据变形金刚不会被应用到那个领域。

invalid_message

类型字符串默认的此值无效

这是验证错误消息,如果输入到该字段的数据没有意义(即验证失败),将使用该消息。

例如,如果用户将无意义的字符串输入到TimeType字段不能转换为实时的,或者如果用户输入字符串(例如。苹果)转换为数字字段。

正常(业务逻辑)验证(例如在设置字段的最小长度时)应该使用验证消息和验证规则(参考).

invalid_message_parameters

类型数组默认的[]

当设置invalid_message选项时,您可能需要在字符串中包含一些变量。这可以通过在该选项中添加占位符并包括该选项中的变量来实现:

1 2 3 4 5
构建器->add (“someField”, SomeFormType::类,/ /……“invalid_message”= >'您输入的值无效,它应该包含%num%字母'“invalid_message_parameters”= > [“% num %”= >6)));

label_attr

类型数组默认的[]

属性的HTML属性<标识>元素,它将在呈现字段的标签时使用。它是一个以HTML属性为键的关联数组。这些属性也可以直接在模板中设置:

  • 嫩枝
  • PHP
1 2 3
{{form_label(form.name, '您的名字',{' label_attr': {'class': 'CUSTOM_LABEL_CLASS'}})}}

label_format

类型字符串默认的

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

如果您使用关键字翻译消息作为标签,您通常会对同一个标签有多个关键字消息(例如。profile_address_streetinvoice_address_street).这是因为标签是为字段的每个“路径”构建的。为了避免重复的关键字消息,您可以将标签格式配置为静态值,例如:

1 2 3 4 5 6 7 8
/ /……profileFormBuilder->add (“地址”, AddressType::类,“label_format”= >“form.address. %名称%”]);invoiceFormBuilder->add (“发票”, AddressType::类,“label_format”= >“form.address. %名称%”]);

此选项由子类型继承。的标签字段都将使用form.address.street关键字信息。

label格式有两个变量:

% id %
字段的唯一标识符,由字段的完整路径和字段名组成。profile_address_street);
%的名字%
字段名(例如:).

默认值()的结果是“人性化”版本字段名的。

请注意

label_format选项在表单主题中求值。确保更新你的模板以防你定制表单主题

映射

类型布尔默认的真正的

如果希望在读取或写入对象时忽略该字段,则可以设置映射选项

方法

类型字符串默认的帖子

此选项指定用于提交表单数据的HTTP方法。的值表示为方法属性。形式元素中的表单提交,用于决定是否处理handleRequest ()提交后的方法。可能取值为:

  • 帖子
  • 得到
  • 删除
  • 补丁

请注意

当方法为PUT、PATCH或DELETE时,Symfony将自动呈现一个ob娱乐下载_method表单中的隐藏字段。这用于“伪造”这些HTTP方法,因为标准浏览器不支持这些方法。当通过HTTP方式匹配路由

请注意

PATCH方法允许提交部分数据。换句话说,如果提交的表单数据缺少某些字段,这些字段将被忽略,并使用默认值(如果有的话)。对于所有其他HTTP方法,如果提交的表单数据缺少某些字段,则将这些字段设置为

post_max_size_message

类型字符串默认的上传的文件过大。请尝试上传一个小一点的文件。

这是验证错误消息,如果提交的POST表单数据超过php . inipost_max_size指令。的{{Max}}占位符可以用来显示允许的大小。

请注意

验证post_max_size只发生在根形式。

property_path

类型PropertyPathInterface | |空字符串默认的

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

要求

类型布尔默认的真正的

如果为,则HTML5所需属性将被渲染。相应的标签还会渲染一个要求类。

这是肤浅的,与验证无关。如果您让Symfony猜测您的字段类型,ob娱乐下载那么这个选项的值将从您的验证信息中猜测出来。

请注意

必选选项还影响如何处理每个字段的空数据。有关详细信息,请参见empty_data选择。

修剪

类型布尔默认的真正的

如果为真,提交的字符串值的空白将通过修剪函数在绑定数据时调用。这可以保证,如果提交的值带有额外的空格,那么在将值合并回基础对象之前,该值将被删除。

validation_groups

类型数组字符串可调用的GroupSequence默认的

此选项仅在根表单上有效,用于指定验证器将使用哪些组。

验证器将只使用默认的组。

如果你将这些组指定为数组或字符串,它们将被验证器原样使用:

1 2 3 4 5 6
公共函数configureOptions(OptionsResolver解析器解析器->setDefaults ([“validation_groups”= >“注册”]);}

这相当于将group作为数组传递:

1
“validation_groups”= > [“注册”),

表单的数据将是针对所有给定组进行验证

如果验证组依赖于表单的数据,则可以将可调用对象传递给该选项。ob娱乐下载Symfony将在调用表单时传递表单:

12 3 4 5 6 7 8 9 10 11 12 13 14
使用ob娱乐下载组件形式FormInterface使用ob娱乐下载组件OptionsResolverOptionsResolver/ /……公共函数configureOptions(OptionsResolver解析器解析器->setDefaults ([“validation_groups”= >函数(FormInterface形式实体形式->getData ();返回实体->isUser () ?[“用户”]: [“公司”];}));}

另请参阅

你可以在如何根据提交的数据选择验证组

请注意

当您的表单包含多个提交按钮时,您可以根据使用哪个按钮提交表格。

如果您需要高级逻辑来确定验证组,请参阅如何动态配置表单验证组

在某些情况下,您希望逐步验证您的组。要做到这一点,你可以传递一个GroupSequence到这个选项。这使您能够针对多个组进行验证,就像在数组中传递多个组一样,但不同的是,只有在前一个组没有错误地传递时,才会验证一个组。这里有一个例子:

12 3 4 5 6 7 8 9 10 11 12 13 14
使用ob娱乐下载组件形式AbstractType使用ob娱乐下载组件验证器约束GroupSequence/ /……MyType扩展AbstractType/ /……公共函数configureOptions(OptionsResolver解析器解析器->setDefaults ([“validation_groups”= >GroupSequence ([“第一”“第二”))));}}

另请参阅

阅读文章如何按顺序应用验证组来了解更多。

继承的选项

属性中定义了以下选项基类型类。的基类型类的父类形式类型和ButtonType,但它不是表单类型树的一部分(即它不能单独用作表单类型)。

attr

类型数组默认的[]

属性,可以向HTML字段表示形式添加额外属性attr选择。它是一个以HTML属性为键的关联数组。当你需要为某个小部件设置自定义类时,这可能很有用:

1 2 3
构建器->add (“身体”, TextareaType::类,“attr”= > [“类”= >“tinymce”)));

另请参阅

使用row_attr属性中添加这些属性表单类型行元素。

auto_initialize

类型布尔默认的真正的

一个内部选项:设置表单是否应该自动初始化。对于所有字段,该选项应该仅为真正的对于根形式。您不需要更改这个选项,也不需要为此担心。

block_name

类型字符串默认的:表格名称(见知道要定制哪个块

允许您将自定义块名添加到默认情况下用于呈现表单类型的块名。例如,如果您有相同表单的多个实例,并且您需要分别个性化表单的呈现,则很有用。

如果您将此选项设置为my_custom_name字段是type文本, ob娱乐下载Symfony将使用以下名称(并按此顺序)来查找用于渲染字段的小部件的块:_my_custom_name_widgettext_widget而且form_widget

block_prefix

类型字符串默认的(见知道要定制哪个块

4.3

block_prefix选项是在Symfony 4.3中引入的。ob娱乐下载

允许您添加自定义块前缀并覆盖用于呈现表单类型的块名称。例如,如果您有相同表单的多个实例,并且您需要对所有实例进行个性化呈现,而不需要创建新的表单类型,则非常有用。

禁用

类型布尔默认的

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

标签

类型字符串默认的:从字段名“猜测”标签

设置呈现字段时将使用的标签。设置为false将屏蔽标签。标签也可以直接在模板内设置:

  • 嫩枝
  • PHP
1
{{form_label(form.name, '你的名字')}}

row_attr

类型数组默认的[]

元素中添加的HTML属性的关联数组,用于呈现表单类型行

1 2 3
构建器->add (“身体”, TextareaType::类,“row_attr”= > [“类”= >“文本编辑器”“id”= >'...')));

另请参阅

使用attr属性中添加这些属性表单类型小部件元素。

4.3

row_attr选项是在Symfony 4.3中引入的。ob娱乐下载

translation_domain

类型字符串默认的

这是翻译域,将用于为该字段呈现的任何标签或选项。使用要重用父表单的翻译域(或根表单的翻译器的默认域)。使用禁用翻译。

label_translation_parameters

类型数组默认的[]

4.3

label_translation_parameters选项是在Symfony 4.3中引入的。ob娱乐下载

的内容标签选项在显示之前进行转换,因此它可以包含翻译占位符.此选项定义用于替换这些占位符的值。

考虑到以下翻译信息:

1 2
#翻译/ messages.en.yamlform.order.id:%company%订单的标识符

可以按照如下方式指定占位符值:

1 2 3 4 5 6
构建器->add (“id”, [“标签”= >“form.order.id”“label_translation_parameters”= > [%公司%的= >“ACME公司”。,],]);

label_translation_parameters子字段的选项与父字段的相同选项合并,因此子字段可以重用和/或覆盖任何父字段占位符。

attr_translation_parameters

类型数组默认的[]

4.3

attr_translation_parameters选项是在Symfony 4.3中引入的。ob娱乐下载

的内容标题而且占位符定义在attr选项在显示之前进行转换,因此它可以包含翻译占位符.此选项定义用于替换这些占位符的值。

考虑到以下翻译信息:

1 2 3
#翻译/ messages.en.yamlform.order.id.placeholder:'输入订单的唯一标识符%company%'form.order.id.title:'这将是与%company%通信时的引用'

可以按照如下方式指定占位符值:

1 2 3 4 5 6 7 8 9
构建器->add (“id”, [“attr”= > [“占位符”= >“form.order.id.placeholder”“标题”= >“form.order.id.title”),“attr_translation_parameters”= > [%公司%的= >“ACME公司”。,],]);

attr_translation_parameters子字段的选项与父字段的相同选项合并,因此子字段可以重用和/或覆盖任何父字段占位符。

此工作,包括代码示例,是根据创作共用BY-SA 3.0许可证。