CollectionType领域
编辑该页面CollectionType领域
这个字段类型用于呈现一个“集合”的一些字段或形式。在最简单的意义上,它可以是数组TextType
字段填充数组电子邮件
值。在更复杂的例子,你可以嵌入整个表单,它是有用的在创建形式公开一对多关系(例如,一个产品,你可以管理许多相关产品照片)。
呈现时,现有条目数组索引键的集合和集合类型字段数据传递。
呈现为 | 取决于entry_type选项 |
默认的无效信息 | 集合是无效的。 |
遗留无效的信息 | {{value}}的值是无效的。 |
父类型 | FormType |
类 | CollectionType |
提示
选项的完整列表和继承了这种类型定义在你的应用可以运行这个命令:
1 2
#替换“FooType”的表单类型的类名美元php bin /控制台调试:FooType形式
请注意
如果你正在与教义的实体的集合,特别注意allow_add,allow_delete和by_reference选项。你也可以看到一个完整的示例如何嵌入一组形式篇文章。
基本用法
当你想使用这个类型管理形式类似项目的集合。例如,假设您有一个电子邮件
字段对应于一个电子邮件地址数组。的形式,你想让每个电子邮件地址作为自己的输入文本框:
1 2 3 4 5 6 7 8 9 10 11 12
使用ob娱乐下载\组件\形式\扩展\核心\类型\CollectionType;使用ob娱乐下载\组件\形式\扩展\核心\类型\EmailType;/ /……美元构建器- >add (“电子邮件”,CollectionType::类,/ /数组中的每一项都将是一个“电子邮件”字段“entry_type”= > EmailType::类,/ /这些选项传递给每一个“电子邮件”类型“entry_options”= > [“attr”= > [“类”= >“邮箱”]]]);
最简单的方式来呈现这是:
1
{{form_row (form.emails)}}
一个更灵活的方法是这样的:
1 2 3 4 5 6 7 8 9 10 11
{{了form_label (form.emails)}}{{form_errors (form.emails)}}<ul>{%为emailField形式。电子邮件%}<李>{{form_errors (emailField)}}{{form_widget (emailField)}}< /李>{%endfor%}< /ul>
在这两种情况下,会呈现,除非你没有输入字段电子邮件
数据数组已经包含了一些电子邮件。
在这个简单的例子中,它仍然是无法添加新地址或删除现有的地址。添加新地址可以使用allow_add选项(和可选原型选项)(见下面的例子)。删除的邮件电子邮件
数组是可能的allow_delete选择。
场的选择
allow_add
类型:布尔
默认的:假
如果设置为真正的
,如果未识别的项目提交给集合,它们将被添加新项。结束数组将包含现有的项目以及新项目,在提交数据。详细信息,请参阅上面的例子。
的原型选项可以用来帮助呈现一个原型项目,可以使用——使用JavaScript动态地创建新表单项在客户端。有关更多信息,请参见上面的例子如何嵌入一组形式。
谨慎
如果你嵌入整个其他形式来反映一个一对多的关系数据库,您可能需要手动确保正确地设置这些新对象的外键。如果你使用原则,这不会自动发生。请点击上面的链接查看更多细节。
allow_delete
类型:布尔
默认的:假
如果设置为真正的
,那么如果一个现有的项目不包含在提交数据,它将正确地缺席最后一项的数组。这意味着您可以通过JavaScript实现一个“删除”按钮,删除表单元素的DOM。当用户提交表单时,其缺席提交的数据将意味着从最终数组中删除。
有关更多信息,请参见如何嵌入一组形式。
谨慎
使用此选项时要小心当你嵌入对象的集合。在这种情况下,如果任何嵌入形式被移除,他们将正确地失踪的最终数组对象。然而,根据您的应用程序逻辑,当一个对象被删除,您可能需要删除它或者至少删除外键引用的主要对象。这一切都是自动处理的。有关更多信息,请参见如何嵌入一组形式。
delete_empty
类型:布尔
或可调用的
默认的:假
如果你想显式地删除空从表单收集条目必须设置这个选项真正的
。然而,现有的收集条目只会被删除,如果你有allow_delete选择启用。否则,空值将保存。
谨慎
的delete_empty
归一化值时只选择删除项零
。如果嵌套entry_type是一种复合类型,您必须设置要求
选项假
或设置empty_data
选项零
。这两个选项可以设置里面entry_options。读到的表单的empty_data选项学习为什么这是必要的。
从集合中删除的值只有在规范化值零
。然而,你也可以选择值设置为一个可调用,将执行提交每个值的集合。如果可调用的返回真正的
从集合中移除的价值。例如:
1 2 3 4 5 6 7 8 9
使用ob娱乐下载\组件\形式\扩展\核心\类型\CollectionType;/ /……美元构建器- >add (“用户”,CollectionType::类,/ /……“delete_empty”= >函数(用户美元用户= null):bool{返回零= = =美元用户| |空(美元用户- >getFirstName ());}));
使用一个可调用的是特别有用的化合物形式类型,这可能定义复杂条件考虑他们是空的。
entry_options
类型:数组
默认的:[]
这个数组的形式传递给指定的类型entry_type选择。例如,如果您使用了ChoiceType作为你的entry_type选项(例如下拉菜单的集合),那么你需要至少通过选择
选择基本的类型:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
使用ob娱乐下载\组件\形式\扩展\核心\类型\ChoiceType;使用ob娱乐下载\组件\形式\扩展\核心\类型\CollectionType;/ /……美元构建器- >add (“favoriteCities”,CollectionType::类,“entry_type”= > ChoiceType::类,“entry_options”= > [“选择”= > [纳什维尔的= >纳什维尔的,“巴黎”= >“巴黎”,“柏林”= >“柏林”,“伦敦”= >“伦敦”,]]]);
prototype_options
类型:数组
默认的:[]
6.1
的prototype_options
选项是在Symfony 6.1中引入的。ob娱乐下载
这个数组的形式传递给指定的类型entry_type选择在创建它的原型。它允许有不同的选项取决于你添加一个新的条目或编辑现有条目:
1 2 3 4 5 6 7 8 9 10 11 12 13
使用ob娱乐下载\组件\形式\扩展\核心\类型\CollectionType;使用ob娱乐下载\组件\形式\扩展\核心\类型\TextType;/ /……美元构建器- >add (“名字”,CollectionType::类,“entry_type”= > TextType::类,“entry_options”= > [“帮助”= >“你可以在这里编辑这个名字。”),“prototype_options”= > [“帮助”= >你可以在这里输入一个新的名称。、]]);
entry_type
类型:字符串
默认的:ob娱乐下载
这是对每一项的字段类型集合(如。TextType
,ChoiceType
等等)。例如,如果你有一个电子邮件地址数组,可以使用的EmailType。如果你想嵌入其它形式的集合,通过表单类型类(如这个选项。MyFormType::类
)。
原型
类型:布尔
默认的:真正的
当使用这个选项是有用的allow_add选择。如果真正的
(如果allow_add也真正的
),一个特殊的“原型”属性将是可用的,这样您就可以呈现一个“模板”示例页面上的一个新元素应该是什么样子。的的名字
给这个元素属性__name__
。这允许您添加一个“添加另一个”按钮通过JavaScript读取原型,取代__name__
里面有一些独特的名称或编号和渲染表单。当提交,它将被添加到您的底层数组的allow_add选择。
原型可以通过呈现原型
集合中的变量:
1
{{form_row (form.emails.vars.prototype)}}
注意,你真正需要的是“部件”,但这取决于你呈现形式,在整个“行”可能更容易。
提示
如果你渲染整个收藏领域,然后原型形式行自动上可用data-prototype
(如属性的元素。div
或表
)围绕你的收藏。
如何真正使用这个选项的详细信息,见上面的例子一样如何嵌入一组形式。
prototype_data
类型:混合
默认的:零
允许您定义特定数据的原型。每个新行添加最初将包含这个选项的数据集。默认情况下,数据配置的所有条目entry_options选项将使用:
1 2 3 4 5 6 7 8 9 10
使用ob娱乐下载\组件\形式\扩展\核心\类型\CollectionType;使用ob娱乐下载\组件\形式\扩展\核心\类型\TextType;/ /……美元构建器- >add (“标签”,CollectionType::类,“entry_type”= > TextType::类,“allow_add”= >真正的,“原型”= >真正的,“prototype_data”= >“新标签占位符”]);
覆盖选项
invalid_message
类型:字符串
默认的:这个值是无效的
这是验证错误消息,如果数据使用进入这个领域没有意义(即未验证)。
这可能发生,例如,如果用户输入一个无意义的字符串TimeType字段不能被转换成实时或如果用户输入一个字符串(例如苹果
)进入很多领域。
正常(业务逻辑)验证(例如当设置一个最小长度字段)应设置使用验证消息的验证规则(参考)。
继承的选项
这些选项的继承FormType。并不是所有的选项都列在这里,只有最适用于这类:
attr
类型:数组
默认的:[]
如果你想添加额外的属性可以使用HTML字段表示attr
选择。这是一个与HTML属性关联数组的键。这可能是有用的,当你需要设置一个自定义类部件:
1 2 3
美元构建器- >add (“身体”,TextareaType::类,“attr”= > [“类”= >“tinymce”)));
另请参阅
使用row_attr
选择如果你想将这些属性添加到表单类型行元素。
by_reference
类型:布尔
默认的:真正的
在大多数情况下,如果你有一个作者
场,然后你期望setAuthor ()
被称为底层对象。然而,在某些情况下,setAuthor ()
可能不被称为。设置by_reference
来假
在所有情况下确保调用setter。
进一步解释这个,这里有一个简单的例子:
1 2 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领域潜在的收集数据是一个对象(如与学说ArrayCollection
),然后by_reference
必须设置为假
如果你需要加法器和剂(如。addAuthor ()
和removeAuthor ()
)被称为。
empty_data
类型:混合
默认值是[]
(空数组)。
这个选项决定了价值领域返回当提交的值为空(或失踪)。它没有设置一个初始值时如果没有提供一个视图的形式呈现。
这意味着它可以帮助您处理表单提交空白的领域。例如,如果你想要的的名字
字段被显式地设置John Doe
当选择没有价值,你可以这样做:
1 2 3 4
美元构建器- >add (“名字”,零,(“要求”= >假,“empty_data”= >“John Doe”]);
这仍将呈现一个空的文本框,但在提交John Doe
值将被设置。使用数据
或占位符
选项来显示这个初始值呈现形式。
如果一种复合,可以设置empty_data
作为数组、对象或关闭。看到如何配置空数据形式类文章关于这些选项的更多细节。
请注意
如果你想设置empty_data
选择整个表格类,看到如何配置空数据形式类篇文章。
谨慎
表单数据变形金刚仍将被应用到吗empty_data
价值。这意味着将把一个空的string零
。使用自定义数据变压器如果你明确想返回一个空字符串。
error_mapping
类型:数组
默认的:[]
这个选项允许您修改验证错误的目标。
想象你有一个自定义的命名方法matchingCityAndZipCode ()
验证城市和邮编是否匹配。不幸的是,没有matchingCityAndZipCode
在表单字段,所以Symfony所能做的一切是显示错误的形式。ob娱乐下载
自定义错误映射,你可以做得更好:误差映射到城市字段以便它上面显示:
1 2 3 4 5 6 7 8
公共函数configureOptions(OptionsResolver美元解析器){美元解析器- >setDefaults ([“error_mapping”= > [“matchingCityAndZipCode”= >“城市”、]]);}
这里的规则是左边和右边的映射:
- 左侧包含属性的路径;李><李>如果违反上生成一个类的属性或方法,它的路径
propertyName
;李><李>如果违反上生成一个条目的数组
或ArrayAccess
对象,属性路径(indexName)
;李><李>您可以构建嵌套属性路径通过连接,分离属性点。例如:地址[工作].matchingCityAndZipCode
;李><李>右侧包含表单中字段的名称。李>< /ul>默认情况下,没有任何属性映射错误将泡沫到父窗体。您可以使用点(
。
)左边错误的所有地图上未标明的属性映射到一个特定的领域。例如,所有这些错误的地图城市
字段中,使用:1 2 3 4 5
美元解析器- >setDefaults ([“error_mapping”= > [“。”= >“城市”、]]);
帮助
类型:字符串
或TranslatableInterface
默认的:零
允许您定义一个表单字段的帮助信息,默认情况下是呈现以下字段:
1 2 3 4 5 6 7 8 9 10 11 12 13
使用ob娱乐下载\组件\翻译\TranslatableMessage;美元构建器- >add (“zipCode”,零,(“帮助”= >你的信用卡的邮政编码\ ' s帐单地址。,)/ /……- >add (“状态”,零,(“帮助”= >新TranslatableMessage (“order.status”,(“% order_id %”= >美元订单- >getId ()),“存储”)));
6.2
支持TranslatableInterface
对象作为帮助内容是在Symfony 6.2中引入的。ob娱乐下载
help_attr
类型:数组
默认的:[]
设置元素的HTML属性用于显示帮助信息的表单字段。它的值是一个关联数组与HTML属性名称作为键。这些属性也可以在模板设置:
1 2 3
{{form_help (form.name,“你的名字”,{help_attr:{‘类’:‘CUSTOM_LABEL_CLASS}})}}
标签
类型:字符串
或TranslatableMessage
默认的:标签是“猜”字段名称
设置标签时,将使用渲染。设置为假
将抑制标签:
1 2 3 4 5 6 7 8
使用ob娱乐下载\组件\翻译\TranslatableMessage;美元构建器- >add (“zipCode”,零,(“标签”= >“邮政编码”,/ /可选地,您可以使用TranslatableMessage对象作为标签的内容“标签”= >新TranslatableMessage (“address.zipCode”,(%的国家%的= >美元国家),“地址”),)
标签也可以在模板设置:
1
{{了form_label (form.name '你的名字')}}
1 2 3 4
回声美元视图(“形式”]- >标签(美元形式(“名字”),“你的名字”);
label_attr
类型:数组
默认的:[]
集的HTML属性<标识>
元素,它将使用时呈现字段的标签。这是一个关联数组与HTML属性作为一个关键。这个属性也可以直接设置在模板:
1 2 3
{{了form_label (form.name,“你的名字”,{label_attr:{‘类’:‘CUSTOM_LABEL_CLASS}})}}
1 2 3 4 5
回声美元视图(“形式”]- >标签(美元形式(“名字”),“你的名字”,(“label_attr”= > [“类”= >“CUSTOM_LABEL_CLASS”]]);
label_format
类型:字符串
默认的:零
配置字段的字符串作为标签,以防标签
选择是没有设置,这是有用的在使用关键字翻译的消息。
如果你使用关键字翻译信息标签,你经常有多个关键字信息相同的标签(如。profile_address_street
,invoice_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
关键字信息。
两个变量标签格式是可用的:
-
% id %
-
字段的惟一标识符,包括完整的路径字段和字段名(如。
profile_address_street
); -
%的名字%
-
字段名(如。
街
)。
默认值(零
)的结果“人性化”版本的字段名。
请注意
的label_format
选择是评估形式的主题。如果你一定要更新您的模板定制的形式主题。
要求
类型:布尔
默认的:真正的
如果这是真的,一个HTML5必需属性将会呈现。相应的标签
还将呈现的要求
类。
这是肤浅的和独立的验证。在最好的情况下,如果你让Symfony猜ob娱乐下载你的字段类型,那么这个选项的值将从你的猜测验证信息。
请注意
所需的选择也会影响每个字段是空的数据如何处理。更多细节,请参阅empty_data选择。
场变量
变量 | 类型 | 使用 |
---|---|---|
allow_add | 布尔 |
的值allow_add选择。 |
allow_delete | 布尔 |
的值allow_delete选择。 |