如何创建自定义表单字段类型
编辑本页警告:您正在浏览的文档欧宝官网下载appob娱乐下载Symfony 4.1,现已不再维护。
读本页的更新版本用于Syob娱乐下载mfony 6.2(当前稳定版本)。
如何创建自定义表单字段类型
ob娱乐下载Symfony提供了一堆可用于构建表单的核心字段类型。但是,在某些情况下,您可能希望为特定目的创建自定义表单字段类型。本文假设您需要一个基于现有选项字段的包含送货选项的字段定义。本节解释如何定义字段以及如何自定义其布局。
定义字段类型
为了创建自定义字段类型,首先必须创建表示该字段的类。在这种情况下,持有字段类型的类将被调用ShippingType
该文件将存储在表单字段的默认位置,即应用\ \形式类型
.确保字段延伸AbstractType:
12 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
/ / src /形式/类型/ ShippingType.php名称空间应用程序\形式\类型;使用ob娱乐下载\组件\形式\AbstractType;使用ob娱乐下载\组件\OptionsResolver\OptionsResolver;使用ob娱乐下载\组件\形式\扩展\核心\类型\ChoiceType;类ShippingType扩展AbstractType{公共函数configureOptions(OptionsResolver$解析器){$解析器->setDefaults ([“选择”= > [“标准航运”= >“标准”,加快运输的= >“加速”,“优先航运”= >“优先”,],]);}公共函数getParent(){返回ChoiceType::类;}}
提示
该文件的位置并不重要形式\类型
目录只是一种惯例。
函数的返回值getParent ()
函数指示您正在扩展ChoiceType
字段。这意味着,在默认情况下,您将继承该字段类型的所有逻辑和呈现。要了解其中的一些逻辑,请查看ChoiceType类。有三种方法特别重要:
-
buildForm ()
-
每个字段类型都有一个
buildForm ()
方法,您可以在其中配置和构建任何字段。请注意,这与您用于设置的方法相同你的形式,这里也一样。 -
buildView ()
-
此方法用于设置在模板中呈现字段时需要的任何额外变量。例如,在ChoiceType,一个
多个
变量,并在模板中用于设置(或不设置)多个
属性上的选择
字段。看到为字段创建模板欲知详情。 -
configureOptions ()
-
这将定义可用于的表单类型的选项
buildForm ()
而且buildView ()
.所有领域都有许多共同的选项(参见FormType领域),但您可以在这里创建所需的任何其他内容。
提示
如果您正在创建一个包含许多字段的字段,那么请确保将您的“父”类型设置为形式
或者一些延伸的东西形式
.同样,如果您需要从父类型修改任何子类型的“视图”,请使用finishView ()
方法。
该字段的目标是扩展选择类型,以支持对运输类型的选择。这是通过固定选择
到可用的运输选项列表。
为字段创建模板
每个字段类型都由模板片段呈现,模板片段的名称部分由类型的类名决定。读了从片段命名更多细节的规则。
请注意
前缀的第一部分(例如。航运
)来自类名(ShippingType
->航运
).这可以通过重写来控制getBlockPrefix ()
在ShippingType
.
谨慎
当表单类的名称与任何内置字段类型匹配时,表单可能无法正确呈现。一个名为应用\ \ PasswordType形式
将有相同的块名内置PasswordType
并且不会被正确渲染。覆盖getBlockPrefix ()
方法返回唯一的块前缀(例如:app_password
)以避免碰撞。
在本例中,由于父字段为ChoiceType
,你不知道需要做任何工作,作为自定义字段类型将自动呈现像ChoiceType
.但是为了这个例子,假设当你的字段被“扩展”时(例如单选按钮或复选框,而不是选择字段),你想总是以ul
元素。在您的表单主题模板(参见上面的链接了解详细信息)中,创建一个shipping_widget
块来处理这个:
12 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
{/形式/ fields.html #模板。树枝#}{%块shipping_widget %}{%没有余地的%}{%如果扩大%}<ul{{块(“widget_container_attributes”)}}>{%为表单%}中的子元素<李>{{form_widget(child)}}{{form_label(child)}}李>{%endfor%}ul>{%其他的%}{#让选择小部件呈现选择标签#}{{块(“choice_widget”)}}{%endif%}{%endspaceless%}{%endblock%}
提示
您可以进一步定制用于呈现所选类型的每个子类型的模板。在这种情况下要覆盖的块被命名为“块名”+_entry
+ "元素名称" (标签
,错误
或小部件
)(例如,定制你需要定义的Shipping小部件的子部件的标签{% block shipping_entry_label %}…{% endblock %}
).
请注意
确保使用了正确的小部件前缀。在本例中,名称应该是shipping_widget
(见表单片段命名规则)。此外,主配置文件应该指向自定义表单模板,以便在呈现所有表单时使用它。
当使用Twig时,这是:
- YAML
- XML
- PHP
1 2 3 4
#配置/包/ twig.yaml枝:form_themes:-“形式/ fields.html.twig”
对于PHP模板引擎,你的配置应该是这样的:
- YAML
- XML
- PHP
1 2 3 4 5 6
#配置/包/ framework.yaml框架:模板:形式:资源:-”:形式:fields.html.php”
使用字段类型
您现在可以立即使用您的自定义字段类型,通过在您的表单之一中创建类型的新实例:
12 3 4 5 6 7 8 9 10 11 12 13 14 15 16
/ / src /形式/类型/ OrderType.php名称空间应用程序\形式\类型;使用ob娱乐下载\组件\形式\AbstractType;使用ob娱乐下载\组件\形式\FormBuilderInterface;使用应用程序\形式\类型\ShippingType;类订单类型扩展AbstractType{公共函数buildForm(FormBuilderInterface$构建器数组,$选项){$构建器->add (“shipping_code”, ShippingType::类,“占位符”= >“选择送货方式”]);}}
但这只是因为ShippingType ()
很简单。如果运输代码存储在配置中或数据库中呢?下一节将解释更复杂的字段类型如何解决此问题。
访问服务和配置
如果你需要访问服务从您的表单类中添加一个__construct ()
方法正常:
12 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
/ / src /形式/类型/ ShippingType.php名称空间应用程序\形式\类型;/ /……使用学说\ORM\EntityManagerInterface;类ShippingType扩展AbstractType{私人$entityManager;公共函数__construct(EntityManagerInterface$entityManager){$这->entityManager =$entityManager;}//使用$this->entityManager下任何你想要的地方…}
如果您使用默认设置services.yaml
配置(即来自形式/
加载和可以使用autoconfigure
启用),这将已经工作!看到服务容器欲知详情。
提示
如果你不吸毒的话可以使用autoconfigure,请务必标签你的服务form.type
.
玩得开心!