feature #5428 Improved description of choice_list option (adamziel, javiereguiluz)

weaverryan · weaverryan · commit 68db46c5b9a9 · 2015-06-23T12:13:32.000-04:00
This PR was merged into the 2.3 branch. Discussion ---------- Improved description of choice_list option | Q | A | ------------- | --- | Doc fix? | yes | New docs? | no | Applies to | all | Fixed tickets | - Commits ------- 381720b Completed the explanation as suggested by Ryan 5bc5969 improved description of choice_list option of Choice form type
diff --git a/reference/forms/types/choice.rst b/reference/forms/types/choice.rst
@@ -109,17 +109,31 @@ The ``choice_list`` option must be an instance of the ``ChoiceListInterface``.
 For more advanced cases, a custom class that implements the interface
 can be created to supply the choices.
 
-With this option you can also allow float values to be selected as data.
+With this option you can also allow float values to be selected as data. For example:
 
 .. code-block:: php
 
     use Symfony\Component\Form\Extension\Core\ChoiceList\ChoiceList;
 
     // ...
     $builder->add('status', 'choice', array(
-      'choice_list' => new ChoiceList(array(1, 0.5), array('Full', 'Half'))
+      'choice_list' => new ChoiceList(array(1, 0.5, 0.1), array('Full', 'Half', 'Almost empty'))
     ));
 
+The ``status`` field created by the code above will be rendered as:
+
+.. code-block:: html
+
+    <select name="status">
+        <option value="0">Full</option>
+        <option value="1">Half</option>
+        <option value="2">Almost empty</option>
+    </select>
+
+But don't be confused! If ``Full`` is selected (value ``0`` in HTML), ``1`` will
+be returned in your form. If ``Almost empty`` is selected (value ``2`` in HTML),
+``0.1`` will be returned.
+
 .. include:: /reference/forms/types/options/empty_value.rst.inc
 
 .. include:: /reference/forms/types/options/expanded.rst.inc
