EntityType领域

编辑本页

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

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

EntityType领域

一个特殊的ChoiceType字段,用于从Doctrine实体加载选项。例如,如果你有一个类别实体,您可以使用此字段显示选择场的全部,或部分类别对象。

呈现为 可以是各种标签(看到了吗选择类型字段(选择下拉列表,单选按钮和复选框)
父类型 ChoiceType
EntityType

提示

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

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

基本用法

实体Type只有一个必选选项:实体应该在选择字段中列出:

12 3 4 5 6 7 8 9 10 11 12 13 14 15
使用应用程序实体用户使用ob娱乐下载学说形式类型EntityType/ /……构建器->add (“用户”, EntityType::类,//从这个实体中查找选项“类”= >用户::类,//使用User。使用rname property as the visible option string“choice_label”= >“用户名”//用于渲染选择框、复选框或单选// 'multiple' => true,// 'expanded' => true,]);

这将创建一个选择下拉菜单包含所有用户数据库中的对象。若要显示单选按钮或复选框,请更改多个而且扩大选项。

使用实体的自定义查询

如果你想创建一个自定义查询,以便在获取实体时使用(例如,你只想返回一些实体,或者需要对它们排序),请使用query_builder选择:

12 3 4 5 6 7 8 9 10 11 12 13
使用应用程序实体用户使用学说ORMEntityRepository使用ob娱乐下载学说形式类型EntityType/ /……构建器->add (“用户”, EntityType::类,“类”= >用户::类,“query_builder”= >函数(EntityRepository返回->createQueryBuilder (“u”->orderBy (“u.username”“ASC”);},“choice_label”= >“用户名”]);

请注意

使用表单集合可能会导致产生过多的数据库请求来获取相关的实体。这就是所谓的“N + 1查询问题”它可以通过加入相关记录当查询Doctrine关联时。

使用选择

如果您已经有了希望包含在choice元素中的实体的确切集合,只需将它们通过选择关键。

例如,如果你有一个美元集团变量(可能作为表单选项传递到表单中)和getuser ()的集合。用户实体,然后您可以提供选择选项直接:

1 2 3 4 5 6 7 8
使用应用程序实体用户使用ob娱乐下载学说形式类型EntityType/ /……构建器->add (“用户”, EntityType::类,“类”= >用户::类,“选择”= >集团->getuser ()));

选择标签、复选框或单选按钮

该字段可以呈现为多个HTML字段之一,具体取决于扩大而且多个选项:

元素类型 扩大 多个
选择标记
选择标签(使用多个属性) 真正的
单选按钮 真正的
复选框 真正的 真正的

场的选择

choice_label

类型字符串可调用的PropertyPath

这是用于在HTML元素中以文本形式显示实体的属性:

1 2 3 4 5 6 7 8
使用应用程序实体类别使用ob娱乐下载学说形式类型EntityType/ /……构建器->add (“类别”, EntityType::类,“类”= >类别::类,“choice_label”= >“displayName的”]);

如果为空,则实体对象将被转换为字符串,因此必须有__toString ()方法。你也可以通过一个回调函数来进行更多的控制:

1 2 3 4 5 6 7 8 9 10
使用应用程序实体类别使用ob娱乐下载学说形式类型EntityType/ /……构建器->add (“类别”, EntityType::类,“类”= >类别::类,“choice_label”= >函数类别返回类别->getDisplayName ();}));

针对列表中的每个实体调用该方法,并将其传递给函数。要了解更多细节,请参阅mainchoice_label欧宝官网下载app文档。

请注意

在传递字符串时,choice_labelOption是一个属性路径。因此,您可以使用PropertyAccess组件

例如,如果translations属性实际上是一个对象的关联数组,每个对象带有一个的名字属性,然后你可以这样做:

1 2 3 4 5 6 7 8
使用应用程序实体类型使用ob娱乐下载学说形式类型EntityType/ /……构建器->add (“类型”, EntityType::类,“类”= >类型::类,“choice_label”= >“翻译(en) . name”]);

类型字符串要求

你的实体的类(例如:应用:类别).这可以是一个完全限定的类名(例如。应用\ \实体类别)或短别名(如前所示)。

新兴市场

类型字符串|主义\ \ ObjectManager持久性默认的:默认的实体管理器

如果指定,则此实体管理器将用于加载选项,而不是默认的实体管理器。

query_builder

类型学说\ ORM \ QueryBuilder或者一个可调用的默认的

允许您为您的选择创建自定义查询。看到EntityType领域举个例子。

该选项的值可以是aQueryBuilder对象,一个可调用的或(这将加载所有实体)。在使用可调用对象时,将传递EntityRepository作为实体的唯一参数,并应返回QueryBuilder.返回将导致加载所有实体。

谨慎

类中使用的实体的条款query_builder选项将始终针对您在选择。如果您返回另一个实体,而不是在子句(例如,如果从连接的表中返回一个实体),则会破坏验证。

覆盖选项

choice_name

类型可调用的字符串PropertyPath默认的

控制选择的内部字段名。你通常不关心这个,但在一些高级情况下,你可能会关心。例如,这个“name”成为模板中选择视图的索引,并用作字段名称属性的一部分。

这可以是一个可调用路径或属性路径。看到choice_label类似用法。默认情况下,可以使用选择键或递增的整数(从0).

谨慎

配置的值必须是有效的表单名称。在使用可调用对象时,请确保只返回有效名称。有效的表单名称必须由字母、数字、下划线、破折号和冒号组成,并且不能以破折号或冒号开头。

EntityType,默认为id实体的,如果它可以读取。否则,它将退回到使用自动递增的整数。

choice_value

类型可调用的字符串PropertyPath默认的

为每个选项返回字符串“value”,在所有选项中必须是唯一的。这用于价值属性,并在POST/PUT请求中提交。您通常不需要担心这一点,但在处理API请求时可能很方便(因为您可以配置将在API请求中发送的值)。

这可以是一个可调用路径或属性路径。默认情况下,如果选项可以强制转换为字符串,则使用这些选项。否则使用递增的整数(从0).

如果传递一个可调用对象,它将接收一个参数:选择本身。当使用EntityType领域,参数将是每个选项或的实体对象在一个占位符被使用,你需要处理:

1 2 3
“choice_value”= >函数(?MyOptionEntity实体返回实体?实体->getId ():;},

EntityType时,此选项将被覆盖以使用id默认情况下。当id使用时,Doctrine仅查询实际提交的id的对象。

选择

类型数组|\可反驳的默认的

而不是允许而且query_builder选项来获取要包含的实体,您可以将选择直接选择。看到EntityType领域

data_class

类型字符串默认的

选项中不使用此选项选项,用于查询实体。

继承的选项

方法继承了这些选项ChoiceType

choice_attr

类型数组可调用的字符串PropertyPath默认的[]

使用它可以为每个选项添加额外的HTML属性。这可以是一个关联数组,其中键与选择键匹配,值是每个选项的属性,一个可调用的或一个属性路径(就像choice_label).

的键值选择Array必须用作键:

12 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
使用ob娱乐下载组件形式扩展核心类型ChoiceType/ /……构建器->add (“水果”, ChoiceType::类,“选择”= > [“苹果”= >1“香蕉”= >2“榴莲”= >3.),“choice_attr”= > [“苹果”= > [“data-color”= >“红色”),“香蕉”= > [“data-color”= >“黄色”),“榴莲”= > [“data-color”= >“绿色”],],]);//或使用可调用对象构建器->add (“参加”, ChoiceType::类,“选择”= > [“是的”= >真正的“不”= >“也许”= >),“choice_attr”= >函数选择关键价值//添加一个类,如attending_yes, attending_no等返回“类”= >“attending_”.strtolower (关键));}));

choice_translation_domain

类型字符串布尔默认的

此选项决定是否应该翻译所选值以及在哪个翻译域中翻译。

的值choice_translation_domain选项可以是真正的(重用当前翻译域),(禁用翻译),(使用父翻译域或默认域)或表示要使用的确切翻译域的字符串。

扩大

类型布尔默认的

如果设置为true,则将呈现单选按钮或复选框(取决于多个值)。如果为false,将呈现一个select元素。

group_by

类型字符串可调用的PropertyPath默认的

您可以将<选项>a的要素<选择>< optgroup >通过将多维数组传递给选择.看到分组选项部分。

group_byOption是分组选择的另一种方式,它给了你更多的灵活性。

举个例子:

12 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
使用ob娱乐下载组件形式扩展核心类型ChoiceType/ /……构建器->add (“publishAt”, ChoiceType::类,“选择”= > [“现在”= >\ DateTime (“现在”),“明天”= >\ DateTime (“+ 1天”),“1周”= >\ DateTime (“+ 1周”),“一个月”= >\ DateTime (“+ 1月”),),“group_by”= >函数选择关键价值如果选择< =\ DateTime (+ 3天的)) {返回“很快”;}返回“后来”;}));

它将3天以内的日期归类为“很快”其他的都归类为“稍后”< optgroup >

如果你回来,该选项将不会被分组。您还可以传递一个字符串“属性路径”,它将被调用来获取组。看到choice_label属性路径的详细信息。

多个

类型布尔默认的

如果真正的,用户将可以选择多个选项(而不是只选择一个选项)。的值扩大选项,这将呈现一个选择标记或复选框真正的和一个选择标签或单选按钮.返回值将是Doctrine的数组集合。

请注意

如果您正在使用Doctrine实体的集合,那么阅读文档将会很有帮助欧宝官网下载appCollectionType领域也此外,还有一个完整的例子如何嵌入一个集合的形式篇文章。

占位符

类型字符串布尔

这个选项决定了一个特殊的“空”选项(例如:“选择一个选项”)将出现在选择小部件的顶部。此选项仅适用于多个选项设置为false。

  • 添加一个空值,文本为“Choose an option”:

    1 2 3 4 5 6
    使用ob娱乐下载组件形式扩展核心类型ChoiceType/ /……构建器->add (“州”, ChoiceType::类,“占位符”= >“选择一个选项”]);
  • 确保没有“空”值选项显示:

    1 2 3 4 5 6
    使用ob娱乐下载组件形式扩展核心类型ChoiceType/ /……构建器->add (“州”, ChoiceType::类,“占位符”= >]);

如果你离开占位符选项未设置时,则当且仅当要求选项为false:

1 2 3 4 5 6 7
使用ob娱乐下载组件形式扩展核心类型ChoiceType/ /……//添加一个空白(无文本)选项构建器->add (“州”, ChoiceType::类,“要求”= >]);

preferred_choices

类型数组可调用的默认的[]

此选项允许您将某些选项移动到列表的顶部,并在它们与其他选项之间使用可视分隔符。该选项需要一个实体对象数组:

1 2 3 4 5 6 7 8 9
使用应用程序实体用户使用ob娱乐下载学说形式类型EntityType/ /……构建器->add (“用户”, EntityType::类,“类”= >用户::类,//该方法必须返回一个User实体数组“preferred_choices”= >集团->getPreferredUsers ()));

类时,首选选项才有意义选择元素(即。扩大假)。首选选项和普通选项在视觉上由一组虚线分隔开。-------------------).这可以在呈现字段时自定义:

1
{{form_widget(形式。publishAt, {'separator': '====='})}}

translation_domain

类型字符串默认的消息

以防choice_translation_domain设置为真正的,这将配置将用于此字段呈现的任何标签或选项的确切翻译域。

修剪

类型布尔默认的

默认情况下禁用微调,因为所选值必须与给定的选择值完全匹配(并且它们可以包含空白)。

方法继承了这些选项形式类型:

attr

类型数组默认的[]

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

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

另请参阅

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

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 ())被称为。

数据

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

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

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

谨慎

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

禁用

类型布尔默认的

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

empty_data

类型混合

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

  • 如果多个而且扩大,然后(空字符串);
  • 否则[](空数组)。

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

这意味着它可以帮助您处理带有空白字段的表单提交。例如,如果你想要的名字要显式设置为的字段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”= > [“。”= >“城市”,],]);

帮助

类型字符串默认的:零

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

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

help_attr

类型数组默认的[]

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

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

help_html

类型布尔默认的

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

标签

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

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

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

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选项在表单主题中求值。确保更新你的模板以防你定制表单主题

映射

类型布尔默认的真正的

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

要求

类型布尔默认的真正的

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

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

请注意

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

row_attr

类型数组默认的[]

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

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

另请参阅

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

4.3

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

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子字段的选项与父字段的相同选项合并,因此子字段可以重用和/或覆盖任何父字段占位符。

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子字段的选项与父字段的相同选项合并,因此子字段可以重用和/或覆盖任何父字段占位符。

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