如何嵌入一个集合的形式

编辑本页

警告:您正在浏览的文档欧宝体育电话欧宝娱乐app下载地址Symfony 4.2,现已不再维护。

本页的更新版本用于Sy欧宝娱乐app下载地址mfony 6.2(当前稳定版本)。

任务类,并且您想编辑/创建/删除许多标签与该任务相关的对象,就在同一个表单中。

请注意

在本文中,我们粗略地假设您使用Doctrine作为数据库存储。但如果你不使用Doctrine(例如,Propel或只是一个数据库连接),这是非常相似的。本教程中只有少数部分真正关心“持久性”。

如果你使用Doctrine时,您将需要添加Doctrine元数据,包括Task的关联映射定义标签财产。

首先,假设每个任务属于多个标签对象。首先创建一个简单的任务类:

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 29 30 31
/ / src /实体/ Task.php名称空间应用程序\实体使用学说\常见的\集合\ArrayCollection任务受保护的描述受保护的标签公共函数__construct()->标签=ArrayCollection ();}公共函数getDescription()返回->描述;}公共函数setDescription描述->描述=描述;}公共函数getTags()返回->标签;}}

请注意

ArrayCollection是教义所特有的,基本上与使用数组(但它必须是一个ArrayCollection如果你使用的是Doctrine)。

现在,创建一个标签类。正如你在上面看到的,a任务可以有很多标签对象:

12 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
/ / src /实体/ Tag.php名称空间应用程序\实体标签私人的名字公共函数getName()返回->名称;}公共函数setName的名字->name =的名字;}}

然后,创建一个表单类,以便a标签对象可以被用户修改:

12 3 4 5 6 7 8 9 10 11 12 13 14 16 17 18 19 20 21 22
/ / src /形式/ TagType.php名称空间应用程序\形式使用应用程序\实体\标签使用欧宝娱乐app下载地址\组件\形式\AbstractType使用欧宝娱乐app下载地址\组件\形式\FormBuilderInterface使用欧宝娱乐app下载地址\组件\OptionsResolver\OptionsResolverTagType扩展AbstractType公共函数buildForm(FormBuilderInterface构建器数组,选项构建器->add (“名字”);}公共函数configureOptions(OptionsResolver解析器解析器->setDefaults ([“data_class”= >标签::类,]);}}

有了这些,您就足够单独呈现一个标签表单了。但由于最终目标是允许a的标记任务控件的窗体中进行修改,请为任务类。

的集合TagType使用CollectionType字段:

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
/ / src /形式/ TaskType.php名称空间应用程序\形式使用应用程序\实体\任务使用欧宝娱乐app下载地址\组件\形式\AbstractType使用欧宝娱乐app下载地址\组件\形式\扩展\核心\类型\CollectionType使用欧宝娱乐app下载地址\组件\形式\FormBuilderInterface使用欧宝娱乐app下载地址\组件\OptionsResolver\OptionsResolverTaskType扩展AbstractType公共函数buildForm(FormBuilderInterface构建器数组,选项构建器->add (“描述”);构建器->add (“标签”, CollectionType::类,“entry_type”= > TagType::类,“entry_options”= > [“标签”= >)));}公共函数configureOptions(OptionsResolver解析器解析器->setDefaults ([“data_class”= >任务::类,]);}}

控件中创建一个新表单TaskType

12 34 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
/ / src /控制器/ TaskController.php名称空间应用程序\控制器使用应用程序\实体\标签使用应用程序\实体\任务使用应用程序\形式\TaskType使用欧宝娱乐app下载地址\\FrameworkBundle\控制器\AbstractController使用欧宝娱乐app下载地址\组件\HttpFoundation\请求TaskController扩展AbstractController公共函数(请求请求任务任务();//伪代码-这里只是为了任务有一些标签//否则,这不是一个有趣的例子标签1标签();标签1->setName (“标签1”);任务->getTags ()->add (标签1);标签2标签();标签2->setName (标签2的);任务->getTags ()->add (标签2);//结束虚拟代码形式->createForm (TaskType::类,任务);形式->handleRequest (请求);如果形式->isSubmitted () & &形式->isValid ()) {/ /……可能会做一些表单处理,比如保存Task和Tag对象返回->呈现(“任务/ new.html.twig”, (“形式”= >形式->createView ()));}}

对应的模板现在能够同时呈现描述字段的TagType已经与此相关的任何标记的表单任务.在上面的控制器中,我添加了一些虚拟代码,这样你就可以看到它的作用(因为a任务第一次创建时没有标记)。

12 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
{/任务/ new.html #模板。树枝#}{#……#}{{form_start(form)}}{#渲染任务的唯一字段:description #}{{form_row(form.description)}}<h3>标签h3><ul“标签”>{#遍历每个现有标签并呈现其唯一字段:name #}{%形式上的标签。标签%}<>{{form_row(tag.name)}}>{%endfor%}ul>{{form_end(form)}}{#……#}

当用户提交表单时,提交的数据为标签字段用于构造一个ArrayCollection标签对象,然后在标签字段任务实例。

标签收集自然是通过任务- > getTags ()并且可以持久化到数据库中,或者根据需要任意使用。

到目前为止,这工作得很好,但不允许动态添加新标记或删除现有标记。因此,虽然编辑现有的标签会工作得很好,但用户实际上还不能添加任何新标签。

谨慎

在本文中,您只嵌入了一个集合,但并不仅限于此。您还可以将嵌套集合嵌入到您喜欢的任意级别。但是,如果在开发设置中使用Xdebug,则可能会收到一个错误已达到'100'的最大函数嵌套级别,中止!错误。这是由于xdebug.max_nesting_levelPHP设置,默认为One hundred.

这个指令将递归限制在100个调用,如果你一次呈现整个表单,这可能还不够form_widget(形式)).要解决这个问题,你可以将这个指令设置为一个更高的值(通过aphp . ini档案或经由报错,例如在公共/ index . php)或手动渲染每个表单字段form_row ()

此表单不应包含额外字段.要使其更加灵活,可以添加allow_add选择您的收集字段:

12 3 4 5 6 7 8 9 10 11 12 13 14 15
/ / src /形式/ TaskType.php/ /……使用欧宝娱乐app下载地址\组件\形式\FormBuilderInterface公共函数buildForm(FormBuilderInterface构建器数组,选项构建器->add (“描述”);构建器->add (“标签”, CollectionType::类,“entry_type”= > TagType::类,“entry_options”= > [“标签”= >),“allow_add”= >真正的]);}

除了告诉字段接受任意数量的提交对象之外,allow_add也会产生“原型”变量可供您选择。这个“原型”是一个小的“模板”,它包含了能够呈现任何新“标签”表单的所有HTML。要渲染它,请对模板进行以下更改:

1 2 3
<ul“标签”data-prototype{{form_widget(form.tags.vars.prototype)|e('html_attr')}}>...ul>

请注意

如果你渲染你的整个“标签”子表单一次(例如。form_row (form.tags)),则原型自动可在外部使用div随着data-prototype属性,类似于上面所看到的。

提示

form.tags.vars.prototype表单元素看起来和感觉起来就像个体吗form_widget(标签)您的循环。这意味着你可以打电话form_widget ()form_row ()了form_label ()在上面。你甚至可以选择只呈现它的一个字段(例如的名字字段):

1
{{form_widget(form.tags.vars.prototype.name)|e}}

在渲染的页面上,结果看起来像这样:

1
<ul“标签”data-prototype& lt;div比;& lt;标签类=“;要求“;比;__name__& lt;/标签比;& lt;div id =“;task_tags___name__“;比;& lt;div比;& lt;标签=“;task_tags___name___name“;类=“;要求“;比;的名字& lt;/标签比;& lt;输入类型=“;文本“;id =“;task_tags___name___name“;name =“;任务[标记][__name__][名称]“;要求=“;要求“;最大长度=“;255“;/比;& lt;/ div比;& lt;/ div比;& lt;/ div比;>

本节的目标是使用JavaScript读取该属性,并在用户单击“添加标记”链接时动态添加新的标记表单。本示例使用jQuery,并假设您在页面的某个地方包含了jQuery。

添加一个脚本标签,这样您就可以开始编写JavaScript了。

首先,通过JavaScript将一个链接添加到“tags”列表的底部。其次,绑定到该链接的“click”事件,这样您就可以添加一个新的标记表单(addTagForm ()将在下一页显示):

12 3 4 5 6 7 8 9 10 11 12 13 14 16 17 18 19 20 21 22
varcollectionHolder美元;//设置一个“添加标签”链接var$addTagButton = $('');var$newLinkLi = $李李' < > < / > ') .append (addTagButton美元);jQuery (文档时(函数//获取包含标签集合的ul$collectionHolder = $(“ul.tags”);//添加“添加标签”锚和li到标签ul(collectionHolder.append美元newLinkLi);//计算当前的表单输入(例如2),使用它作为新的//当插入一个新项时(例如2)collectionHolder.data美元(“指数”collectionHolder.find美元(:输入) . length);addTagButton.on美元(“点击”函数e//添加一个新的标签表单(见下一个代码块)addTagForm (collectionHolder, newLinkLi美元);});});

addTagForm ()函数的工作是使用data-prototype属性在单击此链接时动态添加新表单。的data-prototypeHTML包含标签文本输入名称为的元素任务[标记][__name__][名称]的idtask_tags___name___name.的__name__是一个小的“占位符”,您将用一个唯一的递增数字(例如。任务[标记][3][名称]).

实现这一切所需的实际代码可能会有很大的不同,但这里有一个例子:

12 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
函数addTagFormcollectionHolder, newLinkLi美元//获取前面解释的数据原型var$collectionHolder.data(“原型”);//获取新的索引var$collectionHolder.data(“指数”);varnewForm =原型;//如果你没有在TaskType的tags字段中设置'label' => false,你就需要这个//替换原型HTML中的` __name__label__ `//而是一个基于我们有多少项的数字// newForm = newForm。替换(/ __name__label__ / g,指数);//将原型HTML中的__name__替换为//而是一个基于我们有多少项的数字newForm = newForm.replace(/ __name__ / g、指数);//为下一项增加索引collectionHolder.data美元(“指数”, index +1);//在“添加标签”链接之前,以一里的单位显示页面中的表单var$newFormLi = $(李李' < > < / > ') .append (newForm中将);(newLinkLi.before美元newFormLi);}

请注意

最好将JavaScript分离到真正的JavaScript文件中,而不是像这里这样在HTML中编写。

现在,每当用户单击添加标签链接,一个新的子表单将出现在页面上。当表单提交时,任何新的标签表单都将转换为新的标签对象,并添加到标签的属性任务对象。

另请参阅

如果您想自定义原型中的HTML代码,请阅读如何处理表单主题

控件中的标记添加一个“加法器”和一个“移除器”方法,使处理这些新标记更加容易任务类:

12 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
/ / src /实体/ Task.php名称空间应用程序\实体/ /……任务/ /……公共函数addTag(标签标签->标签->add (标签);}公共函数removeTag(标签标签/ /……}}

接下来,添加一个by_reference选项。标签字段并设置为

12 3 4 5 6 7 8 9 10 11 12
/ / src /形式/ TaskType.php/ /……公共函数buildForm(FormBuilderInterface构建器数组,选项/ /……构建器->add (“标签”, CollectionType::类,/ /……“by_reference”= >]);}

通过这两个更改,当表单提交时,每个更改都是新的标签对象添加到任务类,通过调用addTag ()方法。在此更改之前,它们是通过调用在表单内部添加的任务- > getTags() - >添加标签($).这很好,但是强制使用“加法器”方法使得处理这些问题变得很新鲜标签对象更容易(特别是如果你使用Doctrine,你将在接下来学习!)。

谨慎

你必须创造这两个addTag ()而且removeTag ()方法,否则表单仍将使用setTag ()即使by_reference.你会学到更多关于removeTag ()方法。

为了保存Doctrine的新标签,您需要考虑更多的事情。首先,除非遍历所有的new标签对象和调用entityManager - >保存(标签)在每一个,你会收到一个来自Doctrine的错误:

通过这种关系发现了一个新的实体应用实体\ \任务#标签没有配置为级联实体的持久化操作…

方法自动“级联”持久化操作任务对象到任何相关标记。要做到这一点,请添加级联选择您的元数据:

  • 注释
  • YAML
  • XML
1 2 3 4 5 6 7 8
/ / src /实体/ Task.php/ /……/ * * *@ORM\ManyToMany(targetEntity="App\Entity\Tag", cascade={"persist"}) */受保护的标签

第二个潜在的问题涉及拥有侧和反向侧教义关系。在这个例子中,如果关系的“拥有”方是“Task”,那么持久化将很好地工作,因为标记被正确地添加到Task中。但是,如果所属方在“Tag”上,那么您将需要做更多的工作,以确保修改关系的正确一方。

诀窍是确保每个“标签”上都设置了单个“任务”。做到这一点的一种方法是向addTag (),由表单类型since调用by_reference设置为

12 3 4 5 6 7 8 9 10 11 12 13
/ / src /实体/ Task.php/ /……公共函数addTag(标签标签//多对多关联:标签->addTask ();//多对一关联:标签->setTask ();->标签->add (标签);}

如果你想addTask (),确保你有一个合适的方法,看起来像这样:

1 2 3 4 5 6 7 8 9
/ / src /实体/ Tag.php/ /……公共函数addTask(任务任务如果(!->任务->包含(任务)) {->任务->add (任务);}}

allow_delete类型:

12 3 4 5 6 7 8 9 10 11 12
/ / src /形式/ TaskType.php/ /……公共函数buildForm(FormBuilderInterface构建器数组,选项/ /……构建器->add (“标签”, CollectionType::类,/ /……“allow_delete”= >真正的]);}

现在,需要将一些代码放入removeTag ()的方法任务

12 3 4 5 6 7 8 9 10 11 12
/ / src /实体/ Task.php/ /……任务/ /……公共函数removeTag(标签标签->标签->removeElement (标签);}}

allow_delete选项意味着如果集合的项在提交时没有发送,则相关数据将从服务器上的集合中删除。为了在HTML表单中工作,必须在提交表单之前删除要删除的集合项的DOM元素。

首先,在每个标签表单中添加一个“delete this tag”链接:

12 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
jQuery (文档时(函数//获取包含标签集合的ul$collectionHolder = $(“ul.tags”);//添加一个删除链接到所有现有的标签形式li元素collectionHolder.find美元(“李”) . each (函数{addTagFormDeleteLink ($ ());});/ /……从上面看剩下的街区});函数addTagForm/ /……//添加一个删除链接到新表单addTagFormDeleteLink ($ newFormLi);}

addTagFormDeleteLink ()函数看起来是这样的:

1 2 3 4 5 6 7 8 9
函数addTagFormDeleteLinktagFormLi美元var$removeFormButton = $('');(tagFormLi.append美元removeFormButton);removeFormButton.on美元(“点击”函数e//删除标签表单的li美元tagFormLi.remove ();});}

当一个标签表单从DOM中删除并提交时,被删除的标签对象将不包含在传递给的集合中setTags ().根据您的持久性层,这可能不足以实际删除被删除对象之间的关系标签而且任务对象。

当以这种方式删除对象时,您可能需要多做一点工作,以确保对象之间的关系任务被移除的标签被正确移除。

在《主义》中,你有关系的两个方面:拥有的一面和相反的一面。通常在这种情况下,您将有一个多对一的关系,删除的标记将消失并正确地保存(添加新标记也很容易)。

但是如果你有一对多的关系或者多对多的关系的mappedBy在Task实体上(意味着Task是“逆”面),您将需要做更多的工作来正确地保存已删除的标记。

在这种情况下,您可以修改控制器以删除已删除标记上的关系。假设你有一些编辑()正在处理任务的“更新”的动作:

12 34 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
/ / src /控制器/ TaskController.php使用应用程序\实体\任务使用学说\常见的\集合\ArrayCollection/ /……公共函数编辑id,请求请求, EntityManagerInterfaceentityManager如果= = =任务entityManager->getRepository(任务::类)->找到(id)) {->createNotFoundException (“未为id找到任务”id);}originalTagsArrayCollection ();//创建数据库中当前Tag对象的ArrayCollectionforeach任务->getTags ()作为标签) {originalTags->add (标签);}editForm->createForm (TaskType::类,任务);editForm->handleRequest (请求);如果editForm->isSubmitted () & &editForm->isValid ()) {//删除标签和任务之间的关系foreachoriginalTags作为标签) {如果= = =任务->getTags ()->包含(标签)) {//从标签中删除任务标签->getTasks ()->removeElement (任务);//如果它是一个多对一关系,像这样删除关系/ /标签- > setTask(空);entityManager->persist (标签);//如果你想完全删除标签,你也可以这样做/ / entityManager - >删除美元($标签);}}entityManager->persist (任务);entityManager->冲洗();//重定向到某个编辑页面返回->redirectToRoute (“task_edit”, (“id”= >id]);}//渲染一些表单模板

如您所见,正确地添加和删除元素可能很棘手。除非您有一个Task是“拥有”方的多对多关系,否则您将需要做额外的工作,以确保在每个Tag对象本身上正确地更新关系(无论是添加新标记还是删除现有标记)。

jQuery插件欧宝娱乐app下载地址symfony-collection有助于集合表单元素,通过提供添加、编辑和删除集合元素所需的JavaScript功能。更高级的功能,如移动或复制集合中的元素和自定义按钮也是可能的。

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