Symfony2學習筆記之表單

時間  2019-11-24
標籤 symfony2 symfony 學習 筆記 表單 欄目 HTML 简体版
原文   原文鏈接


　　對於一個Web開發者來講，處理HTML表單是一個最爲普通又具挑戰的任務。Symfony2集成了一個Form組件，讓處理表單變的容易起來。在這一節裏，咱們將
從基礎開始建立一個複雜的表單，學習表單類庫中最重要的內容。php

　　Symfony2 的Form組件是一個獨立的類庫，你能夠在Symfony2項目以外使用它。html

建立一個簡單的表單：
　　假設你要建立一個應用程序的todo列表，須要顯示一些任務。由於你的用戶須要編輯和建立任務，因此你須要建立一個表單。在你開始以前，首先來看通用的Task類，用來表示和存儲一個單一任務的數據：數據庫

複製代碼 
// src/Acme/TaskBundle/Entity/Task.php
namespace Acme\TaskBundle\Entity;

class Task
{
    protected $task;

    protected $dueDate;

    public function getTask()
    {
        return $this->task;
    }
    public function setTask($task)
    {
        $this->task = $task;
    }

    public function getDueDate()
    {
        return $this->dueDate;
    }
    public function setDueDate(\DateTime $dueDate = null)
    {
        $this->dueDate = $dueDate;
    }
}
複製代碼

　　若是你是按照咱們提供的示例編碼，那麼你須要先建立一個AcmeTaskBundle：數組

$ php app/console generate:bundle --namespace=Acme/TaskBundle

　　該類是一個普通的PHP對象類，由於他們沒有任何Symfony或者其它類庫引用。很是簡單的一個PHP對象類，它直接解決的是你程序中表現 task的數據。固然，在本節的最後，你將可以經過HTML表單提交一個Task實例數據，校驗它的數值，並把它持久化到數據庫。瀏覽器

建立一個Form
　　如今已經建立了一個Task類，下一步就是建立和渲染一個真正的HTML表單了。在symfony2中，它是經過建立一個表單對象並渲染到模板的。如今，能夠從controller內部處理form。安全

複製代碼 
//src/Acme/TaskBundle/Controller/DefaultController.php

namespace Acme\TaskBundle\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\Request;
use Acme\TaskBundle\Entity\Task;

class DefaultController extends Controller
{
       //建立一個任務並給它一些假數據做爲示例
       $task = new Task();
       $task->setTask('Write a blog post');
       $task->setDueDate(new \DateTime('tomorrow'));

       $form = $this->createFormBuilder($task)
             ->add('task','text')
             ->add('dueDate','date')
             ->getForm();

        return $this->render('AcmeTaskBundle:Default:new.html.twig',array(
               'form' =>$form->createView(),
        ));
}
複製代碼

　　上面的示例顯示瞭如何直接在Controller中建立一個表單，爲了可讓表單重用你徹底能夠在一個單獨的類文件中建立表單。app

　　由於Symfony2經過一個表單生成器「form builder"來建立表單對象，因此你可使用不多的代碼就能完成建立表單任務。表單生成器的目的是讓你能編寫簡單的表單建立方法，讓它來負責繁重的建立任務。框架

　　在這個示例中，你已經添加了兩個字段到你的表單，一個是task一個是dueDate。它們關聯到Task類的task和dueDate屬性。你已經爲它們分別指定了類型（好比，text，date等），由這些類型來決定爲這些字段生成什麼樣的HTML表單標籤。less

　　Symfony2 擁有許多內建的類型，接下來咱們將簡單的介紹。函數


渲染一個表單
　　表單建立之後，下一步就是渲染它。這是經過傳遞一個特定的表單」view"對象（就是上例中的 $form->createView()返回的view對象）到你的模板並經過一些列的表單幫助函數來實現的。
Twig格式：

{# src/Acme/TaskBundle/Resources/views/Default/new.html.twig #}
<form action="{{ path('task_new') }}" method ="post" {{ form_enctype(form) }}>
    {{ form_widget(form) }}

     <input type="submit" />
</form>

PHP代碼格式：

複製代碼 
<!-- src/Acme/TaskBundle/Resources/views/Default/new.html.php -->
<form action="<?php echo $view['router']->generate('task_new') ?>" method="post" <?php echo $view['form']->enctype($form) ?> >
     <?php echo $view['form']->widget($form) ?>

     <input type="submit" />
</form>
複製代碼

　　在這裏假設你已經建立了一個名叫task_new的路由指向AcmeTaskBundle:Default:new Controller。

　　就是這些了，經過打印form_widget(form),表單中的每一個字段都會被渲染出來。同時還有一個文本標籤和錯誤信息。是否是很簡單， 不過如今它還不夠靈活。一般狀況下，咱們渴望單獨渲染表單中的每個字段，這樣咱們能夠更好的控制表單的樣式。咱們會在在模板中渲染表單一節介紹。

　　在繼續下去以前，咱們注意到，爲何咱們渲染出來的task輸入框中有一個來自$task對象的屬性值「Write a blog post"。這是表單的第一個工做：從一個對象中獲取數據並把它轉換爲合適的格式渲染到一個HTML表單中。
　 　注意，表單系統已經足夠聰明，它們可以經過像getTask()和setTask()方法來訪問Task類中受保護的屬性task。除非一個是公共屬 性，不然必須有一個getter和setter方法被定義來用於表單組件從這些屬性中獲取和保持數據。對於布爾型的屬性，你可使用一個」isser"方 法（好比 isPublished())替代getter方法(getPublished())。

 

處理表單提交
　　表單系統的第二個任務就是傳遞用戶提交的數據回到一個對象的屬性中。要作到這一點，用戶提交的數據必須綁定到表單才行。添加以下代碼到你的Controller類：

複製代碼 
//...

public function newAction(Request $request)
{
         //只是建立一個新的$task對象（不須要假數據）
        $task = new Task();

        $form= $this->createFormBuilder($task)
              ->add('task','text')
              ->add('dueDate','date')
              ->getForm();

        if($request->getMethod() == "POST"){
              $form->bindRequest($request);

              if($form->isValid()){
                     //執行一些行爲，好比保持task到數據庫
                     return $this->redirect($this->generateUrl('task_success'));
              }
        }

       //...
}
複製代碼

　　如今，當表單被提交時，Controller能夠綁定被提交的數據到表單，表單會把數據傳回$task對象的task和dueDate屬性。這 些都在bindRequest()方法中完成。只要bindRequest()方法被調用，提交的數據就會馬上被傳輸到底層對象。無論數據是否被真正的校 驗經過。

　　controller通常會遵循一個通用的模式來處理表單，它有三個可能的途徑：
　　　　1.當在瀏覽器初始加載一個頁面時，請求方法是GET，表單處理僅僅是建立和渲染。
　　　　2.當用戶提交帶有不合法數據的表單（方法爲POST)時，表單會並綁定而後渲染，這時候顯示全部校驗錯誤。
　　　　3.當用戶提交的表單帶有的數據均合法時，表單綁定而且在頁面跳轉以前你有機會去使用數據去執行一些業務邏輯活動，好比持久化它到數據庫）。

 

表單校驗
　　在前面咱們提到了，如何提交一個帶有合法數據和非法數據的表單。在Symfony2中，校 驗是在底層對象上進行的。換句話說，form表單合法與否不重要，主要看在表單提交數據之後，底層對象好比$task對象是否合法。調 用$form->isvalid() 是一個詢問底層對象是否得到合法數據的快捷方式。

　　校驗是經過添加一些列規則（約束）到一個類來完成的。咱們給Task類添加規則和約束，使它的task屬性不能爲空，duDate字段不能空而且是一個合法的DateTime對象。
YAML格式：

複製代碼 
# Acme/TaskBundle/Resources/config/validation.yml
Acme\TaskBundle\Entity\Task:
    properties:
        task:
            - NotBlank: ~
        dueDate:
            - NotBlank: ~
            - Type: \DateTime
複製代碼

在Task類中聲明格式：

複製代碼 
// Acme/TaskBundle/Entity/Task.php
use Symfony\Component\Validator\Constraints as Assert;

class Task
{
    /**
     * @Assert\NotBlank()
     */
    public $task;

    /**
     * @Assert\NotBlank()
     * @Assert\Type("\DateTime")
     */
    protected $dueDate;
}
複製代碼

XML格式：

複製代碼 
<!-- Acme/TaskBundle/Resources/config/validation.xml -->
<class name="Acme\TaskBundle\Entity\Task">
    <property name="task">
        <constraint name="NotBlank" />
    </property>
    <property name="dueDate">
        <constraint name="NotBlank" />
        <constraint name="Type">
            <value>\DateTime</value>
        </constraint>
    </property>
</class>
複製代碼

PHP代碼格式：

複製代碼 
// Acme/TaskBundle/Entity/Task.php
use Symfony\Component\Validator\Mapping\ClassMetadata;
use Symfony\Component\Validator\Constraints\NotBlank;
use Symfony\Component\Validator\Constraints\Type;

class Task
{
    // ...

    public static function loadValidatorMetadata(ClassMetadata $metadata)
    {
        $metadata->addPropertyConstraint('task', new NotBlank());

        $metadata->addPropertyConstraint('dueDate', new NotBlank());
        $metadata->addPropertyConstraint('dueDate', new Type('\DateTime'));
    }
}
複製代碼

　　就是這樣了，若是你如今再提交包含非法數據的表單，你將會看到相應的錯誤被打印在表單上。

 

HTML5 校驗
　　做爲HTML5，許多瀏覽器都增強了客戶端某些校驗約束。最經常使用的校驗活動是在一 個必須的字段上渲染一個required屬性。對於支持HTML5的瀏覽器來講，若是用戶此時提交一個空字段到表單時，瀏覽器會顯示提示信息。生成的表單 普遍吸取了這些新內容的優勢，經過添加一些HTML屬性來監控校驗。客戶端校驗能夠經過添加novalidate屬性到form標籤或者 formnovalidate 到提交標籤而關閉。這對你想檢查服務端校驗規則時很是有用。

 


校驗分組
　　若是你的對象想從校驗組中受益，你須要指定你的表單使用哪一個校驗組。

$form = $this->createFormBuilder($users, array(
    'validation_groups' => array('registration'),
))->add(...)
;

若是你建立表單類，你須要添加羨慕的getDefaultOptions()方法：

public function getDefaultOptions(array $options)
{
    return array(
        'validation_groups' => array('registration')
    );
}

在這兩種狀況下，只有registration 校驗組將被用於校驗底層對象。


內建字段類型
　　Symfony標準版含有大量的字段類型，它們幾乎涵蓋了全部通用表單的字段和數據類型。

文本字段：

text
textarea
email
integer
money
number
password
percent
search
url

選擇字段：

choice
entity
country
language
locale
timezone

日期和時間字段：
date
datetime
time
birthday


其它字段：
checkbox
file
radio


字段組：
collection
repeated

隱藏字段：
      hidden
      csrf

基礎字段：
       field
       form

固然，你也能夠定義本身的字段類型。


字段類型選項
　　每個字段類型都有必定數量的選項用於配置。好比，dueDate字段當前被渲染成3個選擇框。而日期字段能夠被配置渲染成一個單一的文本框，用戶能夠輸入字符串做爲日期。

->add('dueData','data', array('widget' = 'single_text'))

required選項:

　　最經常使用到的選項是required選項，它能夠應用於任何字段。默認狀況下它被設置爲true。這就意味着支持HTML5的瀏覽器會使用客戶端 校驗來判斷字段是否爲空。若是你不想讓它發生，或者把在你的字段上把required選項設置爲false，或者關閉HTML5校驗。設置 required爲true並不意味着服務端校驗被應用。換句話說，若是用戶提交一個空數值到該字段，它將接受這個控制除非你使用Symfony的 NotBlank或者NotNull校驗約束。也就是說，required選項是很好，可是服務端校驗仍是要繼續用。


label選項：
　　表單字段可使用label選項設置顯示字符標籤，能夠應用於任何字段：

->add('dueDate', 'date',array(
   'widget' =>'single_text',
   'label' => 'Due Date',
))

字段類型猜想：

　　如今你已經添加了校驗元數據到Task類，Symfony早已經瞭解一點關於你的字段了。若是你容許，Symfony能夠猜到你的字段數據類型 併爲你設置它。在下面的例子中，Symfony能夠根據校驗規則猜想到task字段是一個標準的text字段，dueDate是date字段。

複製代碼 
public function newAction()
{
    $task = new Task();

    $form = $this->createFormBuilder($task)
        ->add('task')
        ->add('dueDate', null, array('widget' => 'single_text'))
        ->getForm();
}
複製代碼

　　當你省略了add方法的第二個參數（或者你輸入null)時，Symfony的猜想能力就起做用了。若是你輸入一個選項數組做爲第三個參數（比 如上面的dueDate),那麼這些選項會成爲Symfony猜想的依據。若是你的表單使用了指定的校驗數組，字段類型猜想器將仍是要考慮全部的校驗規則 來綜合猜想你的字段類型。


字段類型可選項猜想
　　除了猜想字段類型，Symfony還能是這猜想一些可選項字段值。當這些可選項被設置時，字段將會被渲染到特定HTML屬性中，讓HTML5客戶端來提供校驗。
然而，它們不會在服務端生成相應的校驗規則。儘管你須要手動的在服務端添加這些規則，可是這些字段類型選項仍是能根據這些信息猜想到。

     required： required規則能夠在校驗規則或者Doctrine元數據的基礎上猜想到。這當你的客戶端校驗將自動匹配你的校驗規則時頗有用。
     max_length: 若是字段是一些列文本字段，那麼max_length選項能夠從校驗規則或者Doctrine元數據中猜到。

     若是你喜歡改變一個猜到的數值，你能夠經過在可選項數組中傳遞該選項來重寫它。

->add('task',null, array('max_length'=>4))

 

在模板中渲染表單
　　到目前爲止，咱們已經看了一個完整的表單是如何經過一行代碼被渲染的。固然，你一般須要更加靈活的渲染方式：
Twig格式：

複製代碼 
{# src/Acme/TaskBundle/Resources/views/Default/new.html.twig #}

<form action="{{ path('task_new') }}" method="post" {{ form_enctype(form) }}>
    {{ form_errors(form) }}

    {{ form_row(form.task) }}
    {{ form_row(form.dueDate) }}

    {{ form_rest(form) }}

    <input type="submit" />
</form>
複製代碼

PHP代碼格式：

複製代碼 
<!-- // src/Acme/TaskBundle/Resources/views/Default/newAction.html.php -->

<form action="<?php echo $view['router']->generate('task_new') ?>" method="post" <?php echo $view['form']->enctype($form) ?>>
    <?php echo $view['form']->errors($form) ?>

    <?php echo $view['form']->row($form['task']) ?>
    <?php echo $view['form']->row($form['dueDate']) ?>

    <?php echo $view['form']->rest($form) ?>

    <input type="submit" />
</form>
複製代碼

讓咱們看看這組代碼的詳細：

　　form_enctype(form) 只要有一個字段是文件上傳，那麼它就會義務的設置爲 enctype="multipart/form-data";
　　form_errors(form) 渲染任何整個form的任何錯誤信息(特定字段的錯誤，會顯示在每一個字段的下面一行）。
　　form_row(form.dueDate) 默認狀況下，爲給定的字段在一個div中渲染一個文本標籤，任何錯誤，和HTML表單部件。
　　form_rest(form) 渲染沒有指出的其他任何字段，一般在表單的末尾調用它防止遺忘或者渲染一些你不肯意手動設置的隱藏字段。它同時還能爲咱們提供CSRF保護。

　　大部分工做是由form_row幫助方法類完成的，它默認在一個div中爲每一個字段渲染顯示標籤，錯誤信息和HTML表單部件。
　　注意，你能夠經過form.vars.value 來訪問你當前是表當數據：
Twig格式：

{{ form.vars.value.task }}

PHP代碼格式：

<?php echo $view['form']->get('value')->getTask() ?>

 

 

手工渲染每個表單字段
　　form_row幫助器能讓你很快的渲染你表單中的每個字段，而且每一行能夠被自定義化。可是生活不老是那麼簡單的，你也可能要手動的渲染每個字段。
Twig格式：

複製代碼 
{{ form_errors(form) }}

<div>
    {{ form_label(form.task) }}
    {{ form_errors(form.task) }}
    {{ form_widget(form.task) }}
</div>

<div>
    {{ form_label(form.dueDate) }}
    {{ form_errors(form.dueDate) }}
    {{ form_widget(form.dueDate) }}
</div>

{{ form_rest(form) }}
複製代碼

PHP代碼格式:

複製代碼 
<?php echo $view['form']->errors($form) ?>

<div>
    <?php echo $view['form']->label($form['task']) ?>
    <?php echo $view['form']->errors($form['task']) ?>
    <?php echo $view['form']->widget($form['task']) ?>
</div>

<div>
    <?php echo $view['form']->label($form['dueDate']) ?>
    <?php echo $view['form']->errors($form['dueDate']) ?>
    <?php echo $view['form']->widget($form['dueDate']) ?>
</div>

<?php echo $view['form']->rest($form) ?>
複製代碼

若是自動生成顯示標籤不許確，那麼你能夠顯式的指定它：

Twig格式：

{{ form_label(form.task, 'Task Description') }}

PHP代碼格式：

<?php echo $view['form']->label($form['task'], 'Task Description') ?>

　　一些字段類型有一些額外的渲染選項能夠傳入widget，一個經常使用的選項爲attr，它容許你修改表單元素的屬性。下面的示例將添加task_field class到渲染的文本輸入字段：
Twig格式：

{{ form_widget(form.task, {'attr': {'class':'task_field'} }) }}

PHP代碼格式：

<?php echo $view['form']->widget($form['task'], array(
'attr' => array('class' => 'task_field'),
)) ?>

　　若是你想手工渲染表單字段，你能夠單獨訪問每一個字段的值，好比id,name和label，這裏咱們獲取id

Twig格式：

{{ form.task.vars.id }}

PHP代碼格式：

<?php echo $form['task']->get('id') ?>

須要獲取表單字段名稱屬性你須要使用full_name值：
Twig格式：

{{ form.task.vars.full_name }}

PHP代碼格式：

<?php echo $form['task']->get('full_name') ?>

 

 

建立表單類
　　正如你看到的，一個表單能夠直接在controller類中被建立和使用。然而，一個更好的作法是在一個單獨的PHP類中建立表單。它能夠被重用到你應用程序的任何地方。建立一個新類來保存生成task表單的邏輯：

複製代碼 
// src/Acme/TaskBundle/Form/Type/TaskType.php

namespace Acme\TaskBundle\Form\Type;

use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\FormBuilder;

class TaskType extends AbstractType
{
    public function buildForm(FormBuilder $builder, array $options)
    {
        $builder->add('task');
        $builder->add('dueDate', null, array('widget' => 'single_text'));
    }

    public function getName()
    {
        return 'task';
    }
}
複製代碼

這個新類包含了全部建立一個task表單所須要的內容，注意getName()方法將返回一個該表單類型的惟一標識，用於快速建立該表單。

複製代碼 
// src/Acme/TaskBundle/Controller/DefaultController.php

// 在類上添加這個新的引用語句
use Acme\TaskBundle\Form\Type\TaskType;

public function newAction()
{
       $task = // ...
       $form = $this->createForm(new TaskType(), $task);

       // ...
}
複製代碼

 

設置data_class
　　每一個表單都須要知道它底層保存數據的類名稱，（好比 Acme\TaskBundle\Entity\Task)。一般狀況下，是根據createForm方法的第二個參數來猜想的。之後，當你開始嵌入表單 時，這個可能就不怎麼充分了，因此，一般一個好的方法是經過添加下面代碼到你的表單類型類來顯式的指定data_class 選項。

public function getDefaultOptions(array $options)
{
      return array(
               'data_class' => 'Acme\TaskBundle\Entity\Task',
      );
}

固然，這種作法也不老是必須的。


　　當你映射表單到一個對象是，全部的字段都被映射。 表單的任何字段若是在映射的對象上不存在那麼就會形成拋出異常。在這種狀況下，你須要在表單中獲取字段（好比，一個「你贊成這些說法嗎？」複選框）將不能 映射到底層對象，那麼你須要設置property_path爲false以免拋出異常。

public function buildForm(FormBuilder $builder, array $options)
{
          $builder->add('task');
          $builder->add('dueDate', null, array('property_path' => false));
}

另外，若是有任何的表單字段沒有被包含着提交的數據中，那麼這些字段須要顯式的設置爲null。


在controller類中咱們能夠訪問字段數據：

$form->get('dueDate')->getData();

 

 

Forms和Doctrine
　　表單的目的是把數據從一個底層對象傳遞給一個HTML表單而後把用戶 提交的數據傳回到原先的底層對象。所以，底層對象把數據持久化到數據庫就跟表單沒有任何的關係了。可是，若是你已經配置了底層類是經過Doctrine來 持久化，（你已經定義了映射元數據在底層類），接下來當表單提交數據後，當表單合法後就能夠持久化它了。

複製代碼 
if ($form->isValid()) {
    $em = $this->getDoctrine()->getEntityManager();
    $em->persist($task);
    $em->flush();

    return $this->redirect($this->generateUrl('task_success'));
}
複製代碼

若是處於某種緣由，你不想訪問原有的$task對象，你能夠從表單中直接獲取數據：

$task = $form->getData();

　　在這裏，關鍵要理解當表單跟底層對象綁定後，用戶提交的數據會馬上傳遞給底層對象。若是你想持久化這些數據，你只須要持久化對象自己便可。

 

嵌入式表單：（Embedded Forms)
　　一般，你可能想生成一個表單，它包含來自不一樣對象的 字段。好比，一個註冊表單可能包含屬於User對象和Address對象的字段。幸運的是，這些對於form組件來講都是很容易很天然的事。嵌入一個單獨 對象：假設每一個Task屬於一個Category對象，首先建立這個Category對象：

複製代碼 
// src/Acme/TaskBundle/Entity/Category.php
namespace Acme\TaskBundle\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Category
{
    /**
     * @Assert\NotBlank()
     */
    public $name;
}
複製代碼

接下來，添加一個新的category屬性到Task類：

複製代碼 
// ...

class Task
{
    // ...

    /**
     * @Assert\Type(type="Acme\TaskBundle\Entity\Category")
     */
    protected $category;

    // ...

    public function getCategory()
    {
        return $this->category;
    }

    public function setCategory(Category $category = null)
    {
        $this->category = $category;
    }
}
複製代碼

　　如今咱們來相應咱們應用程序的一個新需求，須要建立一個 表單可讓用戶修改Category對象。

複製代碼 
// src/Acme/TaskBundle/Form/Type/CategoryType.php
namespace Acme\TaskBundle\Form\Type;

use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\FormBuilder;

class CategoryType extends AbstractType
{
    public function buildForm(FormBuilder $builder, array $options)
    {
        $builder->add('name');
    }

    public function getDefaultOptions(array $options)
    {
        return array(
            'data_class' => 'Acme\TaskBundle\Entity\Category',
        );
    }

    public function getName()
    {
        return 'category';
    }
}
複製代碼

　　咱們的最終目的是可以讓用戶在Task表單中修改Category對象，因此，咱們須要添加一個類型爲CategoryType表單類的category字段到TaskType 表單類。

public function buildForm(FormBuilder $builder, array $options)
{
    // ...

    $builder->add('category', new CategoryType());
}

　　這時咱們能夠在TaskType類字段渲染的旁邊渲染CategoryType類的字段了：

Twig格式:

複製代碼 
{# ... #}

<h3>Category</h3>
<div class="category">
    {{ form_row(form.category.name) }}
</div>

{{ form_rest(form) }}
{# ... #}
複製代碼

PHP代碼格式：

複製代碼 
<!-- ... -->

<h3>Category</h3>
<div class="category">
    <?php echo $view['form']->row($form['category']['name']) ?>
</div>

<?php echo $view['form']->rest($form) ?>
<!-- ... -->
複製代碼

　　當用戶提交表單時，提交的Category字段數據被用於建立一個Category實例，而後被設置到Task實例的category字段。該Category實例能夠經過Task實例來訪問,同時也能被持久化到數據或者用做它用。

$task->getCategory()

 

 

嵌入一個表單集合
　　你也能夠將一個表單集合嵌入到一個表單（想象一個Category 表單和許多Product子表單）。它是經過一個字段類型集合類實現的。

 

表單主題化
　　表單的每一部分渲染都是能夠被自定義個性化的。你能夠自由的改變每個表單行的渲染，改變渲染錯誤的標誌，更或者是textarea標籤應該怎樣顯示等。沒有任何限制，不一樣的個性化設置能用到不一樣的區域。

　　Symfony使用模板渲染每個或者部分表單，好比label標籤，input標籤，錯誤信息以及任何其它內容。在Twig中，每一個表單片斷 會被一個Twig block來渲染。要個性化渲染表單，你只須要重寫相應的block便可。在PHP模板中，它是經過單獨的模板文件來渲染表單片斷的，因此你須要經過編寫 新的模板來替代舊的模板便可。在理解了它們是怎麼工做的以後，讓咱們來個性化form_row片斷並添加一個class屬性到包裹每一表單行的div元 素。首先建立一個新模板文件用於存放新的標誌：

Twig格式：

複製代碼 
{# src/Acme/TaskBundle/Resources/views/Form/fields.html.twig #}

{% block field_row %}
{% spaceless %}
    <div class="form_row">
        {{ form_label(form) }}
        {{ form_errors(form) }}
        {{ form_widget(form) }}
    </div>
{% endspaceless %}
{% endblock field_row %}
複製代碼

PHP代碼格式：

複製代碼 
<!-- src/Acme/TaskBundle/Resources/views/Form/field_row.html.php -->

<div class="form_row">
    <?php echo $view['form']->label($form, $label) ?>
    <?php echo $view['form']->errors($form) ?>
    <?php echo $view['form']->widget($form, $parameters) ?>
</div>
複製代碼

　　field_row表單片斷會在經過form_row函數渲染大部分的表單字段時使用。 要告訴你的表單組件使用你的新的field_row片斷，須要添加下面的內容到你渲染該表單的模板頂部：
Twig格式：

複製代碼 
{# src/Acme/TaskBundle/Resources/views/Default/new.html.twig #}

{% form_theme form 'AcmeTaskBundle:Form:fields.html.twig' %}

{% form_theme form 'AcmeTaskBundle:Form:fields.html.twig' 'AcmeTaskBundle:Form:fields2.html.twig' %}

<form ...>
複製代碼

PHP代碼格式：

複製代碼 
<!-- src/Acme/TaskBundle/Resources/views/Default/new.html.php -->

<?php $view['form']->setTheme($form, array('AcmeTaskBundle:Form')) ?>

<?php $view['form']->setTheme($form, array('AcmeTaskBundle:Form', 'AcmeTaskBundle:Form')) ?>

<form ...>
複製代碼

　　其中的form_theme 標籤導入前面定義的片斷。換句話說，當form_row函數在模板中被調用後，它將從你的自定義主題中使用field_row 塊（替代Symfony已有的field_row block）。你的個性化主題沒必要重寫全部的塊。當渲染一個你沒有重寫過的塊時，主題引發會找全局的主題（定義在bundle級的主題）使用。

　　在擁有多個個性化主題的狀況下，它會在使用全局主題以前查找定製列表。要個性化你表單的任何部分，你只須要重寫相關的片斷便可。

 

表單片斷命名
　　在symfony中，表單的每一部分都會被渲染，HTML表單元素，錯誤消息，顯示標籤等這些都是被定義在基礎主題裏的。它組成了一個Twig的塊集合和一個PHP模板集合。

　　在Twig中，每一個須要的塊都被定義到一個單獨的模板文件中（form_dive_layout.html.twig),它們被保存在Twig Bridge裏。在這個文件中，你能夠看到渲染一個表單多須要的每個block和默認的字段類型。

　　在PHP模板中，片斷是單獨的模板文件。 默認狀況下它們位於框架bundle的Resources/views/Form 目錄下。每一個偏度名稱都遵循相同的基本模式，用一個下劃線（_）分爲兩部分，好比：

　　field_row 用於form_row渲染大部分的字段
　　textarea_widget 用於form_widget渲染一個textarea字段類型
　　field_errors 用於form_errors渲染一個字段的錯誤信息

　　每一個片斷都命名都遵循:type_part 模式。type部分對應被渲染的字段類型（好比textarea,checkbox,date等），而part部分對應着是什麼被渲染（好比label，widget，errors等）
　　默認狀況下，有4種可能的表單part被用來渲染：
　　　　label 渲染字段的標籤 如field_label
　　　　widget 渲染字段的HTML表示 如field_widget
　　　　errors 渲染字段的錯誤信息 如field_errors
　　　　row 渲染字段的整個行（包括label，widget和errors） 如 filed_row

　　還有其它3個part類型，分別是rows，rest和enctype,不過這三個通常不會用到。

　　經過知道字段類型(好比：textarea)和你想渲染那一部分（好比：widget)，你能夠建立一個你須要重寫的片斷名稱(好比：textarea_widget).


模板片斷繼承
　　在某些狀況下，你個性化的片斷可能會丟失。好比，在Symfony提供的默認主題中沒有提供textarea_errors片斷。那麼如何來渲染一個textarea字段的錯誤信息呢？

　　答案是經過field_errors片斷。當Symfony渲染一個textarea類型的錯誤時，它首先查找一個textarea_errors片斷，若是沒有找到則會回到field_errors片斷。
每一個field類型有一個parenttype（textarea的父類型爲field),Symfony若是沒有發現自己的片斷，就會轉而使用父類片斷。

　　因此，要重寫textarea字段的errors，拷貝field_errors片斷，重命名爲textarea_errors並個性化它們。爲全部字段重寫默認的error渲染，則須要直接拷貝和個性化field_errors片斷。

 

全局表單主題
　　在上面的示例中，咱們使用了form_theme helper來導入自定義個的表單片斷到表單。你也能夠告訴Symfony在全項目中導入自定義的form。

Twig

爲了從全部以前建立的fileds.html.twig模板中自動包含個性化的block，修改你的應用程序配置文件：

YAML格式：

複製代碼 
# app/config/config.yml

twig:
    form:
        resources:
            - 'AcmeTaskBundle:Form:fields.html.twig'
    # ...
複製代碼

XML格式：

複製代碼 
<!-- app/config/config.xml -->

<twig:config ...>
        <twig:form>
            <resource>AcmeTaskBundle:Form:fields.html.twig</resource>
        </twig:form>
        <!-- ... -->
</twig:config>
複製代碼

 

PHP代碼格式：

複製代碼 
// app/config/config.php

$container->loadFromExtension('twig', array(
    'form' => array('resources' => array(
        'AcmeTaskBundle:Form:fields.html.twig',
     ))
    // ...
));
複製代碼

　　如今在fields.html.twig模板中的任何塊均可以被普遍的使用來定義表單輸出了。

 

自定義表單輸出到一個單一的Twig文件中
　　在Twig中，你也能夠個性化一個表單塊在模板中

複製代碼 
{% extends '::base.html.twig'%}
{# 導入"_self" 做爲一個表單主題 #}
{% form_theme form _self %}
{# 個性化表單片斷 #}
{% block field_row %}
        {# 自定義字段行輸出 #}
{% endblock field_row %}

{% block content %}
        {# ... #}

        {{ form_row(form.task) }}
{% endblock %}
複製代碼

　　這裏{% form_theme form _self %}標籤容許表單塊在使用那些自動化內容的模板中被直接自定義化。使用這個方法來快速的生成個性化輸出。

　　注意，{% form_theme form _self %}的功能只有在繼承自其它模板時才能起做用，若是不是繼承自其它模板，則須要指出form_theme 到單獨模板中。


PHP
從之前在全部模板中建立的Acme/TaskBundle/Resources/views/Form 目錄自動導入個性化模板。修改你的配置文件：
YAML格式：

複製代碼 
# app/config/config.yml

framework:
    templating:
        form:
            resources:
                - 'AcmeTaskBundle:Form'
# ...
複製代碼

XML格式：

複製代碼 
<!-- app/config/config.xml -->

<framework:config ...>
    <framework:templating>
        <framework:form>
            <resource>AcmeTaskBundle:Form</resource>
        </framework:form>
    </framework:templating>
    <!-- ... -->
</framework:config>
複製代碼

PHP代碼格式：

複製代碼 
// app/config/config.php

$container->loadFromExtension('framework', array(
    'templating' => array('form' =>
        array('resources' => array(
            'AcmeTaskBundle:Form',
     )))
    // ...
));
複製代碼

　　此時在Acme/TaskBundle/Resources/views/Form目錄中的任何片斷均可以全局範圍內定義表單輸出了。

 

CSRF 保護
　　CSRF--Cross-site request forgery，跨站僞造請求 是惡意攻擊者試圖讓你的合法用戶在不知不覺中提交他們本不想提交的數據的一種方法。
幸運的是，CSRF攻擊能夠經過在你的表單中使用CSRF 記號來阻止。

　　默認狀況下，Symfony自動爲你嵌入一個合法的CSRF令牌。這就意味着你不須要作任何事情就能夠獲得CSRF保護。CSRF保護是經過在 你的表單中添加一個隱藏字段，默認的名叫_token。它包含一個值，這個值只有你和你的用戶知道。這確保了是用戶而不是其它實體在提交數據。 Symfony自動校驗該token是否存在以及其準確性。

　　_token 字段是一個隱藏字段而且會自動的渲染，只要你在你的模板中包含了form_rest()函數。它確保了沒有被渲染過的字段所有渲染出來。CSRF令牌能夠按照表單來個性化，好比：

複製代碼 
class TaskType extends AbstractType
{
      // ...

      public function getDefaultOptions(array $options)
      {
           return array(
                   'data_class' => 'Acme\TaskBundle\Entity\Task',
                   'csrf_protection' => true,
                   'csrf_field_name' => '_token',
                   // 一個惟一的鍵值來保證生成令牌
                   'intention' => 'task_item',
           );
      }

      // ...
}
複製代碼

　　要關閉CSRF保護，設置csrf_protection 選項爲false。intentsion選項是可選的，但爲不一樣的表單生成不一樣的令牌極大的增強了安全性。


使用一個無底層類表單
　　大多數狀況下，一個表單要綁定一個對象的，而且表單中全部的字段獲取或者保存它們的數據到該對象屬性。但有時候，你可能只想使用一個沒有類的表單，返回一個提交數據的數組，這個很是容易實現：

複製代碼 
// 確認你在類上方導入了Request對象
use Symfony\Component\HttpFoundation\Request
// ...

public function contactAction(Request $request)
{
        $defaultData = array('message' => 'Type your message here');
        $form = $this->createFormBuilder($defaultData)
              ->add('name', 'text')
              ->add('email', 'email')
              ->add('message', 'textarea')
              ->getForm();

         if ($request->getMethod() == 'POST') {
                $form->bindRequest($request);

                // 數據是一個數組幷包含 "name", "email", 和"message" 鍵
               $data = $form->getData();
         }

        // ... 渲染表單
}
複製代碼

　　默認狀況下，一個表單真的假設你想要一個數據數組而不是數據對象。

　　這裏有兩種方式你能夠改變它的行爲並綁定一個對象;
　　　　1.當建立表單時傳入一個對象（做爲createFormBuilder的第一個參數或者createForm的第二個參數）。
　　　　2.在你的表單中聲明data_class 選項

　　若是以上兩種方式都沒有，那麼表單會返回一個數組數據。在這個示例中由於$defaultData不是一個對象，又沒有設置data_class選項，則$form->getData()最終返回一個數組。


　　你也能夠經過Request對象直接訪問POST的值，

$this->get('request')->request->get('name');

　　注意,大多數的狀況下咱們使用getData()方法是更好一點的選擇。由於它返回的是通過表單框架轉換過的數據。


添加校驗規則
　　惟一遺漏的地方就是校驗規則了，一般當你調用$form->isvalid()時，對象會調用你在類東提供的校驗規則進行校驗。但若是沒有類，你怎麼來添加對你表單數據的約束規則呢？答案是本身建立約束，而後傳入到表單。

複製代碼 
// 在controller類前導入命名空間
use Symfony\Component\Validator\Constraints\Email;
use Symfony\Component\Validator\Constraints\MinLength;
use Symfony\Component\Validator\Constraints\Collection;

$collectionConstraint = new Collection(array(
           'name' => new MinLength(5),
           'email' => new Email(array('message' => 'Invalid email address')),
));

// 建立一個表單沒有默認值，傳入約束選項。
$form = $this->createFormBuilder(null, array(
                     'validation_constraint' => $collectionConstraint,
       ))->add('email', 'email')
// ...
;
複製代碼

　　如今，當你調用$form->bindRequest($request)時，約束就會被建立並做用於你的表單數據。若是你使用表單類，重寫getDefaultOptions 方法來指定可選項：

複製代碼 
namespace Acme\TaskBundle\Form\Type;

use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\FormBuilder;
use Symfony\Component\Validator\Constraints\Email;
use Symfony\Component\Validator\Constraints\MinLength;
use Symfony\Component\Validator\Constraints\Collection;

class ContactType extends AbstractType
{
    // ...

    public function getDefaultOptions(array $options)
    {
        $collectionConstraint = new Collection(array(
            'name' => new MinLength(5),
            'email' => new Email(array('message' => 'Invalid email address')),
        ));

        return array('validation_constraint' => $collectionConstraint);
    }
}
複製代碼

　　這樣你有了足夠的靈活性來建立表單類和約束了，它返回一個數據數組而不是一個對象。大多數狀況下，這個是不錯的，而綁定一個表單到一個對象，從某種程度上說更加健壯。對於簡單表單來講是個不錯的選擇。


總結思考
　　你如今已經瞭解了全部建造複雜功能性的表單所須要的全部建造塊。當生成表單時，記住一個表單的首要目標是從一個對象把數據傳遞給一個HTML表單以方便用戶修改它們。第二個目標就是把用戶提交的數據重寫提交回對象。

 

參考URL：http://symfony.com/doc/current/book/forms.html

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程