FormType领域
编辑该页面FormType领域
的FormType
预定义了一些选项,然后可以在所有类型的FormType
是父母。
默认的无效信息 | 这个值是无效的。 |
遗留无效的信息 | 这个值是无效的。 |
父 | 没有一个 |
类 | FormType |
提示
选项的完整列表和继承了这种类型定义在你的应用可以运行这个命令:
1 2
#替换“FooType”的表单类型的类名美元php bin /控制台调试:FooType形式
场的选择
allow_extra_fields
类型:布尔
默认的:假
通常,如果你提交额外的字段,没有在你的配置形式,你会得到一个“这种形式不应包含额外的字段。”验证错误。
你可以通过启用沉默这个验证错误allow_extra_fields
选择的形式。
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 ()
)被称为。
复合
类型:布尔
默认的:真正的
可以是一个完整的复合形式<形式>
元素或一群表单字段(例如呈现在一个< div >
或< tr >
容器元素)。复合形式使用DataMapperInterface初始化他们的孩子或回写提交数据。
一个简单的(非混合的)形式呈现这些HTML元素:<输入>
(TextType
,文件类型
,HiddenType
),textarea > <
(TextareaType
)或<选择>
(ChoiceType
)。
一些核心类型,如日期或相关类型ChoiceType
是简单或复合取决于其他选项(如扩大
或小部件
)。他们会像一个简单的文本字段或一组文本或选择字段。
数据
类型:混合
默认的:默认字段的底层结构。
当你创建一个表单,最初显示每个字段的值对应的表单的域数据的属性(例如,如果您将对象绑定到表单)。如果你想覆盖这个表单或单个字段的初始值,你可以设置它在数据选项:
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
价值。这意味着将把一个空的string零
。使用自定义数据变压器如果你明确想返回一个空字符串。
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
5.1
多元化支持是在Symfony 5.1中引入的。ob娱乐下载
类型:字符串
默认的:这种形式不应该包含额外的字段。
这是使用的验证错误消息如果提交的表单数据包含一个或多个字段不表单定义的一部分。占位符{{extra_fields}}
可以用来显示一个逗号分隔的列表提交额外的字段名称。
这个信息可以多元化,明白了格式化多元化的信息获取详细信息。
form_attr
类型:布尔
或字符串
默认的:假
当真正的
和使用的表单元素,它添加了一个“形式”属性它的HTML字段表示HTML表单的id。通过这样做,可以呈现在表单元素的HTML表单时仍按预期工作:
1 2 3
美元构建器- >add (“身体”,TextareaType::类,“form_attr”= >真正的]);
这可能是有用的,当你需要解决嵌套形式的问题。你也可以设置真正的
在根的形式自动设置“形式”属性在所有的孩子。
请注意
当根形成没有身份证,form_attr
需要一个字符串标识符作为ID。
getter
类型:可调用的
默认的:零
当提供,这将调用调用读取的值从底层对象将用于填充表单字段。
更多的细节部分是可用的何时以及如何使用数据映射器。
5.2
在Symfony 5.2加入了形式映射回调。ob娱乐下载
帮助
类型:字符串
或TranslatableMessage
默认的:零
允许您定义一个表单字段的帮助信息,默认情况下是呈现以下字段:
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 ()),“存储”)));
5.4
支持通过TranslatableMessage
对象是在Symfony 5.4中引入的。ob娱乐下载
help_attr
类型:数组
默认的:[]
设置元素的HTML属性用于显示帮助信息的表单字段。它的值是一个关联数组与HTML属性名称作为键。这些属性也可以在模板设置:
1 2 3
{{form_help (form.name,“你的名字”,{help_attr:{‘类’:‘CUSTOM_LABEL_CLASS}})}}
help_translation_parameters
类型:数组
默认的:[]
的内容帮助选择是在显示之前翻译,所以它可以包含翻译占位符。这个选项定义了用于替换这些占位符的值。
鉴于这种翻译的信息:
1 2
#翻译/ messages.en.yamlform.order.id.help:这将在通信参考%公司%的
您可以指定占位符的值如下:
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:{‘类’:‘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
选择是评估形式的主题。如果你一定要更新您的模板定制的形式主题。
方法
类型:字符串
默认的:帖子
这个选项指定HTTP方法用于提交表单的数据。其价值的呈现方法
的属性形式
元素,用于决定是否处理表单提交的handleRequest ()
方法后提交。可能的值是:
- 帖子
- 得到
- 把
- 删除
- 补丁
请注意
当该方法把、补丁或删除,Symfony会自动呈现ob娱乐下载_method
在表单隐藏字段。这是用来“假”这些HTTP方法,他们不支持标准的浏览器。这可能是有用的时候匹配路由HTTP方法。
请注意
补丁方法允许提交部分数据。换句话说,如果提交的表单数据丢失某些字段,这些将被忽略,将使用默认值(如果有的话)。与所有其他HTTP方法,如果提交的表单数据是缺少一些字段,这些字段设置零
。
post_max_size_message
类型:字符串
默认的:上传文件太大。请上传一个更小的文件。
这是验证错误消息,如果提交的表单数据后超过使用php . ini
的post_max_size
指令。的{{马克斯}}
占位符可以用来显示允许大小。
请注意
验证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”= >“注册”]);}
这相当于将组作为数组:
1
“validation_groups”= > [“注册”),
将表单的数据验证对所有群体。
如果验证组取决于表单的数据可以传递到调用选项。ob娱乐下载Symfony将通过表单时调用它:
1 2 3 4 5 6 7 8 9 10 11 12 13 14
使用ob娱乐下载\组件\形式\FormInterface;使用ob娱乐下载\组件\OptionsResolver\OptionsResolver;/ /……公共函数configureOptions(OptionsResolver美元解析器){美元解析器- >setDefaults ([“validation_groups”= >函数(FormInterface美元形式){美元实体=美元形式- >getData ();返回美元实体- >isUser () ?(“用户”]:[“公司”];}));}
另请参阅
你可以阅读更多关于这个如何选择基于验证组提交的数据。
在某些情况下,你想一步一步验证您的组织。要做到这一点,你可以通过GroupSequence这个选项。这使您能够验证多个组,就像当你通过数组中多个组,但与一群的区别只是验证如果前一组通过没有错误。这里有一个例子:
1 2 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
选择如果你想将这些属性添加到表单类型行元素。
block_name
类型:字符串
默认的(参见:表单的名称知道哪块定制)
允许您添加一个自定义块的名称使用默认情况下呈现形式类型。有用,例如,如果你有多个实例相同的形式,你需要单独呈现个性化的形式。
例如如果您设置这个选项my_custom_name
的字段类型文本
,Sob娱乐下载ymfony将使用以下名称(在这个顺序)找到块用于呈现小部件的字段:_my_custom_name_widget
,text_widget
和form_widget
。
block_prefix
类型:字符串
或零
默认的:零
(见知道哪块定制)
允许您添加一个自定义块前缀和覆盖块名称用于呈现表单类型。有用,例如,如果你有多个实例相同的形式和您需要个性化呈现它们,而不需要创建一个新的表单类型。
标签
类型:字符串
或TranslatableMessage
默认的:标签是“猜”字段名称
设置标签时,将使用渲染。设置为假
将抑制标签:
1 2 3 4 5 6 7 8
使用ob娱乐下载\组件\翻译\TranslatableMessage;美元构建器- >add (“zipCode”,零,(“标签”= >“邮政编码”,/ /可选地,您可以使用TranslatableMessage对象作为标签的内容“标签”= >新TranslatableMessage (“address.zipCode”,(%的国家%的= >美元国家),“地址”),)
5.2
支持TranslatableMessage
对象标签
是在Symfony 5.2中引入的。ob娱乐下载
标签也可以在模板设置:
- 嫩枝
- PHP
1
{{了form_label (form.name '你的名字')}}
1 2 3 4
回声美元视图(“形式”]- >标签(美元形式(“名字”),“你的名字”);
label_html
类型:布尔
默认的:假
5.1
的label_html
选项是在Symfony 5.1中引入的。ob娱乐下载
默认情况下,的内容标签
选择逃渲染他们之前的模板。设置这个选项真正的
时不逃避它们,这是有用的标签包含HTML元素。
row_attr
类型:数组
默认的:[]
一个关联数组的HTML属性添加到元素用于呈现表单类型行:
1 2 3
美元构建器- >add (“身体”,TextareaType::类,“row_attr”= > [“类”= >“文本编辑器”,“id”= >“……”)));
另请参阅
使用attr
选择如果你想将这些属性添加到表单类型小部件元素。
label_translation_parameters
类型:数组
默认的:[]
的内容标签选择是在显示之前翻译,所以它可以包含翻译占位符。这个选项定义了用于替换这些占位符的值。
鉴于这种翻译的信息:
1 2
#翻译/ messages.en.yamlform.order.id:的标识符以%公司%的
您可以指定占位符的值如下:
1 2 3 4 5 6
美元构建器- >add (“id”,零,(“标签”= >“form.order.id”,“label_translation_parameters”= > [%公司%的= >“ACME公司”。、]]);
的label_translation_parameters
选择儿童字段合并相同的选择他们的父母,这样孩子们就可以重用和/或覆盖的任何父占位符。
attr_translation_parameters
类型:数组
默认的:[]
的内容标题
和占位符
中定义的值attr选择是在显示之前翻译,所以它可以包含翻译占位符。这个选项定义了用于替换这些占位符的值。
鉴于这种翻译的信息:
1 2 3
#翻译/ messages.en.yamlform.order.id.placeholder:“输入惟一标识符以%公司%的form.order.id.title:这将在通信参考%公司%的
您可以指定占位符的值如下:
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
选择儿童字段合并相同的选择他们的父母,这样孩子们就可以重用和/或覆盖的任何父占位符。
优先级
类型:整数
默认的:0
5.3
的优先级
选项是在Symfony 5.3中引入的。ob娱乐下载
字段显示在相同的顺序包含在表单。这个选项改变渲染优先领域,允许您显示领域早或晚于原来的秩序。
这个选项会影响视图顺序。这个优先级越高,越早该领域将呈现。优先级具有相同优先级的也可以是负面的和字段将保持原来的订单。