形式

编辑该页面

警告:你浏览的文档欧宝官网下载appob娱乐下载Symfony 3.3,不再维护。

这个页面的更新版本Symfob娱乐下载ony 6.2(当前的稳定版本)。

形式

处理HTML表单是最常见的一种为web开发人员和具有挑战性的任务。ob娱乐下载Symfony集成表单组件,简化处理形式。在这篇文章中,您将构建一个复杂的形式从地上起来,形成图书馆的学习最重要的特性。

请注意

Symfob娱乐下载ony的表单组件是一个独立的库,可以使用Symfony以外的项目。有关更多信息,请参见表单组件文档欧宝官网下载app在GitHub上。

创建一个简单的形式

假设你正在构建一个简单的todo列表应用程序,它将需要显示“任务”。因为你的用户将需要编辑和创建任务,你需要建立一个形式。但在你开始之前,首先关注通用任务类表示并存储数据为单个任务:

1 2 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 / AppBundle /实体/ Task.php名称空间AppBundle\实体;任务{受保护的美元任务;受保护的美元dueDate;公共函数getTask(){返回美元- >任务;}公共函数setTask(美元任务){美元- >任务=美元任务;}公共函数getDueDate(){返回美元- >dueDate;}公共函数setDueDate(\ DateTime美元dueDate= null){美元- >dueDate =美元dueDate;}}

这个类是一个“plain-old-PHP-object”,因为,到目前为止,它已经与Symfony或任何其他图书馆。ob娱乐下载很简单的一个正常的PHP对象里面直接解决问题你的应用程序(例如,需要在应用程序中代表一个任务)。当然,通过本文的结尾,您将能够提交数据任务实例(通过HTML表单),验证其数据并保存到数据库中。

建筑的形式

现在,您已经创建了一个任务类,下一步是创建和渲染实际的HTML表单。在Syob娱乐下载mfony中,这是通过构建一个form对象,然后呈现在一个模板。现在,从在一个控制器都可以做到这一点:

1 2 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
/ / src / AppBundle /控制器/ DefaultController.php名称空间AppBundle\控制器;使用AppBundle\实体\任务;使用ob娱乐下载\\FrameworkBundle\控制器\控制器;使用ob娱乐下载\组件\HttpFoundation\请求;使用ob娱乐下载\组件\形式\扩展\核心\类型\TextType;使用ob娱乐下载\组件\形式\扩展\核心\类型\DateType;使用ob娱乐下载\组件\形式\扩展\核心\类型\SubmitType;DefaultController扩展控制器{公共函数newAction(请求美元请求){/ /创建一个任务,给它一些虚拟的数据对于这个示例美元任务=任务();美元任务- >setTask (“写博客”);美元任务- >setDueDate (\ DateTime (“明天”));美元形式=美元- >createFormBuilder (美元任务)- >add (“任务”,TextType::类)- >add (“dueDate”,DateType::类)- >add (“保存”,SubmitType::类,数组(“标签”= >“创建任务”))- >getForm ();返回美元- >呈现(“违约/ new.html.twig”,数组(“形式”= >美元形式- >createView ()));}}

提示

这个例子展示了如何构建表单直接控制器。后,在“形式”部分中,您将学习如何构建表单在一个独立的类,这是推荐为表单变得可重用。

创建一个表单需要相对较少的代码,因为Symfony表单对象构建“形式构建器”。ob娱乐下载表单生成器的目的是允许您编写简单的形式“食谱”,实际上做的所有重型起重建筑形式。

在这个示例中,您已经添加了形式——两个字段任务dueDate- - - - - -对应任务dueDate的属性任务类。你也分配每一个“类型”(如。TextTypeDateType),由它的完全限定类名。除此之外,它决定哪些HTML表单标签(s)呈现。

最后,您添加了一个提交按钮和一个自定义标签向服务器提交表单。

ob娱乐下载Symfony提供了很多内建类型(见不久将讨论形式)。

呈现形式

既然已经创建了表单,下一步是呈现它。这样做是通过一种特殊的“视图”模板(注意对象$形式- > createView ()在上面的控制器),使用一组表单辅助函数:

  • 嫩枝
  • PHP
1 2 3 4
{# app /资源/视图/ / new.html违约。树枝#}{{form_start(形式)}}{{form_widget(形式)}}{{form_end(形式)}}

请注意

这个示例假设您提交表单的“后”请求和相同的URL,这是显示在。稍后您将了解如何更改请求方法和目标URL的形式。

就是这样!仅仅需要三行呈现完整的表单:

form_start(形式)
呈现表单的开始标记,包括当使用添加了正确的enctype属性文件上传。
form_widget(形式)
呈现的所有字段,包括字段元素本身,一个标签和任何验证错误消息的字段。
form_end(形式)
呈现表单的结束标记和尚未呈现的任何领域,以防你呈现的每个字段。这是用于呈现隐藏字段,利用自动CSRF保护

另请参阅

像这是那么容易,不是非常灵活的(还)。通常情况下,你要单独渲染每个表单字段,这样你就可以控制形式的样子。你将学习如何在“如何控制呈现的一种形式吗”一节。

在继续之前,请注意如何呈现任务输入字段的值任务财产的美元的任务对象(即。“写博客”)。这是第一份工作的一种形式:把数据从一个对象转换成适合的格式,会呈现在一个HTML表单。

提示

表单系统是足够聪明来访问受保护的价值任务属性通过getTask ()setTask ()方法任务类。除非一个属性是公共的,它必须有“getter”和“setter”方法,以便表单组件可以get和put数据到财产。对于一个布尔属性,您可以使用一个“伊塞”或“有”的方法(如。发表()hasReminder ())而不是一个getter(如。个短篇()getReminder ())。

处理表单提交

默认情况下,表单将提交一个POST请求回到相同的控制器,使它。

在这里,一种形式的第二份工作是将用户提交的数据对象的属性。为了实现这一点,用户提交的数据必须写入表单对象。添加以下功能控制器:

1 2 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 32 33 34
/ /……使用ob娱乐下载\组件\HttpFoundation\请求;公共函数newAction(请求美元请求){/ /设置一个新的美元任务对象(删除虚拟数据)美元任务=任务();美元形式=美元- >createFormBuilder (美元任务)- >add (“任务”,TextType::类)- >add (“dueDate”,DateType::类)- >add (“保存”,SubmitType::类,数组(“标签”= >“创建任务”))- >getForm ();美元形式- >handleRequest (美元请求);如果(美元形式- >isSubmitted () & &美元形式- >isValid ()) {/ / $形式- > getData()提交的值/ /但是,最初的“美元任务”变量也已更新美元任务=美元形式- >getData ();/ /……执行一些操作,比如拯救任务到数据库/ /例如,如果任务是一个学说的实体,保存它!/ / $ em = $ this - > getDoctrine () - > getManager ();/ / $ em - >保存($任务);/ / $ em - >冲洗();返回美元- >redirectToRoute (“task_success”);}返回美元- >呈现(“违约/ new.html.twig”,数组(“形式”= >美元形式- >createView ()));}

谨慎

请注意,createView ()方法应该被称为handleRequest ()被称为。否则,所做的更改* _SUBMIT事件不应用于视图(如验证错误)。

该控制器采用处理形式和一种常见模式有三个可能的路径:

  1. 最初在浏览器中加载页面时,表单创建和渲染。handleRequest ()认识到表单没有提交,什么也不做。isSubmitted ()返回如果表单没有提交。
  2. 当用户提交表单时,handleRequest ()承认这一点,立即回写提交的数据任务dueDate的属性美元的任务对象。然后这个对象验证。如果它是无效的(验证将在下一节中讨论),isValid ()返回再次和形式呈现,但现在验证错误;
  3. 有效数据的用户提交表单时,再次写入表单提交的数据,但这一次isValid ()返回真正的。现在你有机会使用执行一些操作美元的任务对象(例如持久化到数据库)之前将用户重定向到其他页面(例如,一个“谢谢”或“成功”页面)。

    请注意

    重定向用户表单提交成功后可以防止用户能够点击浏览器的“刷新”按钮并转发数据。

另请参阅

如果你需要更多的控制什么时候提交表单或数据传递给它,您可以使用提交()方法。阅读更多关于它如何使用submit()函数来处理表单提交

表单验证

在前面的部分中,您了解了如何有效或无效的表单可以提交数据。在Syob娱乐下载mfony中,验证应用于底层对象(例如任务)。换句话说,问题不是“形式”是否有效,但是否美元的任务对象是有效的表单之后应用提交的数据。调用$ - > isValid形式()是一个快捷方式,要求吗美元的任务对象是否有效的数据。

验证是通过添加一组规则一个类(称为约束)。看到这,以便添加验证约束任务字段不能为空,dueDate字段不能为空,必须有效的DateTime对象。

  • 注释
  • YAML
  • XML
  • PHP
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
/ / src / AppBundle /实体/ Task.php名称空间AppBundle\实体;使用ob娱乐下载\组件\验证器\约束作为断言;任务{/ * * *@Assert\ NotBlank () * /公共美元任务;/ * * *@Assert* \ NotBlank ()@Assert\类型(" \ DateTime ") * /受保护的美元dueDate;}

就是这样!如果你重新提交表单无效数据,您将看到相应的错误打印的形式。

Symfony的验证是一个非常强大的特性,都有它自己的ob娱乐下载专门的文章

由于HTML5,许多本地浏览器可以在客户端上执行特定的验证约束。最常见的验证激活呈现要求属性字段是必需的。对于支持HTML5的浏览器,这将导致原生浏览器消息显示,如果用户试图提交表单字段空白。

生成的形式充分利用这个新特性添加合理的HTML属性触发验证。然而,客户端验证可以通过添加禁用已经属性的形式标签或formnovalidate提交标记。这是特别有用,当你想测试您的服务器端验证约束,但被浏览器阻止了,例如,提交空白领域。

  • 嫩枝
  • PHP
1 2
{# app /资源/视图/ / new.html违约。树枝#}{{形式(形式,{attr”:{“已经”:“已经”}})}}

内置字段类型

ob娱乐下载Symfony是标准与一大群字段类型,覆盖所有常见的表单字段和数据类型你会遇到:

基础领域

您还可以创建自己的自定义字段类型。看到如何创建一个自定义表单字段类型的信息。

字段类型选项

每种字段类型有很多选项可用于配置它。例如,dueDate领域目前正呈现为3选择框。然而,DateType可以配置为显示为一个单一的文本框(用户输入的日期作为一个字符串在盒子里):

1
- >add (“dueDate”,DateType::类,数组(“部件”= >“single_text”))

每个字段类型都有许多不同的选项,可以传递给它。这些特定于字段类型和细节可以在每种类型的文档中找到。欧宝官网下载app

最常见的选项要求选项,它可以应用于任何领域。默认情况下,要求选项设置为真正的,这意味着准备好了支持html5技术的浏览器将客户端验证字段留空。如果你不希望这种行为禁用HTML5验证或设置要求选择在你的领域:

1 2 3 4
- >add (“dueDate”,DateType::类,数组(“部件”= >“single_text”,“要求”= >))

还要注意,设置要求选项真正的导致应用服务器端验证。换句话说,如果用户提交一个空白字段的值(用旧浏览器或web服务,例如),它会被接受作为一个有效的值,除非你使用Symfony的ob娱乐下载NotBlankNotNull验证约束。

换句话说,要求选择“好”,但真正的服务器端验证总是被使用。

表单字段的标签可以设置使用标签选项,它可以应用于任何领域:

1 2 3 4
- >add (“dueDate”,DateType::类,数组(“部件”= >“single_text”,“标签”= >“到期日”,))

字段的标签也可以在模板设置呈现形式,见下文。如果你不需要一个标签相关的输入,您可以禁用它通过设置它的值

字段类型猜测

现在您已经添加验证元数据任务类,Symfoob娱乐下载ny已经知道一点关于你的领域。如果你允许,Symfony会“猜”ob娱乐下载字段的类型和设置它。在这个例子中,Symfony的验证ob娱乐下载规则可以猜到了任务字段是一个正常的TextType场和dueDate字段是一个DateType字段:

1 2 3 4 5 6 7 8 9 10
公共函数newAction(){美元任务=任务();美元形式=美元- >createFormBuilder (美元任务)- >add (“任务”)- >add (“dueDate”,,数组(“部件”= >“single_text”))- >add (“保存”,SubmitType::类)- >getForm ();}

“猜测”被激活时省略第二个参数add ()方法(或者如果你通过它)。如果你通过选项数组作为第三个参数(完蛋了dueDate上图),这些选项应用到猜。

谨慎

如果你的表单使用一个特定的验证组,字段类型猜测者仍然会考虑所有验证约束当猜测你的字段类型(包括验证组的约束不属于被使用)。

字段类型选项猜

除了猜测的“类型”字段,Symfony也可以尝试猜测正确的值的字段选项。ob娱乐下载

提示

当设置这些选项时,该领域将呈现特殊的HTML属性为HTML5客户端验证。然而,它不产生相当于端约束(如。维护\长度)。虽然你需要手动添加服务器端验证,这些字段类型选项可以猜到的信息。

要求
要求选项可以猜测基于验证规则(即是NotBlankNotNull)或教义的元数据(即可以为空)。这是非常有用的,因为你的客户端验证将自动匹配您的验证规则。
最大长度
如果字段是某种形式的文本字段,然后最大长度选择属性验证约束(如果可以猜到了长度范围使用)或教义的元数据(通过字段的长度)。

谨慎

这些字段选项只有猜如果你使用Symfony猜字段类型(即省略或通ob娱乐下载过作为第二个参数add ())。

如果你想改变一个的猜测值,您可以重写它通过选项选项字段数组:

1
- >add (“任务”,,数组(“attr”= >数组(最大长度的= >4)))

创建表单类

如您所见,一个表单可以直接创建和使用一个控制器。然而,更好的做法是建立在一个单独的形式,独立的PHP类,它可以在您的应用程序中重用。创建一个新类,它将构建任务的逻辑形式:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
/ / src / AppBundle /形式/ TaskType.php名称空间AppBundle\形式;使用ob娱乐下载\组件\形式\AbstractType;使用ob娱乐下载\组件\形式\FormBuilderInterface;使用ob娱乐下载\组件\形式\扩展\核心\类型\SubmitType;TaskType扩展AbstractType{公共函数buildForm(FormBuilderInterface美元构建器数组,美元选项){美元构建器- >add (“任务”)- >add (“dueDate”,,数组(“部件”= >“single_text”))- >add (“保存”,SubmitType::类);}}

这个新类包含所需的所有方向创建任务表单。它可以用于快速构建一个表单对象的控制器:

1 2 3 4 5 6 7 8 9 10
/ / src / AppBundle /控制器/ DefaultController.php使用AppBundle\形式\TaskType;公共函数newAction(){美元任务=……;美元形式=美元- >createForm (TaskType::类,美元任务);/ /……}

把形式逻辑分类意味着形式可以很容易地在你的项目中重用。这是最好的方法来创建表单,但最终取决于你的选择。

每个表单需要知道类的名称,底层数据(例如实体AppBundle \ \任务)。通常情况下,这仅仅是猜测的基于对象传递给第二个参数createForm ()(即。美元的任务)。后来,当你开始嵌入形式,这将不再是足够的。所以,虽然并不总是必要的,通常是一个好主意来显式地指定data_class选择通过添加以下表单类型类:

1 2 3 4 5 6 7 8 9 10 11
/ / src / AppBundle /形式/ TaskType.php使用AppBundle\实体\任务;使用ob娱乐下载\组件\OptionsResolver\OptionsResolver;/ /……公共函数configureOptions(OptionsResolver美元解析器){美元解析器- >setDefaults (数组(“data_class”= >任务::类);}

提示

当映射对象的形式,所有字段映射。任何字段映射对象的形式,不存在会导致抛出一个异常。

在这种情况下,您需要额外的字段的形式(例如:“你同意这些条款”复选框),将不会被映射到底层对象,您需要设置映射选项:

1 2 3 4 5 6 7 8 9 10 11
使用ob娱乐下载\组件\形式\FormBuilderInterface;公共函数buildForm(FormBuilderInterface美元构建器数组,美元选项){美元构建器- >add (“任务”)- >add (“dueDate”)- >add (“agreeTerms”,CheckboxType::类,数组(“映射”= >))- >add (“保存”,SubmitType::类);}

另外,如果有任何字段的形式不包括在提交数据,将显式地设置这些字段

可以访问字段数据的控制器:

1
美元形式- >get (“agreeTerms”)- >getData ();

此外,一个未映射字段的数据也可以直接修改:

1
美元形式- >get (“agreeTerms”)- >setData (真正的);

最终的想法

在构建形式时,记住,一个表单的第一个目标是将数据从一个对象(任务)HTML表单,以便用户可以修改该数据。一种形式的第二个目标是把用户提交的数据并重新应用到对象。

有很多学习和很多更多强大的技巧的形式系统。

这项工作,包括代码示例,许可下Creative Commons冲锋队3.0许可证。