feature symfony#4241 [Form] Added information about float choice lists (peterrehm)

weaverryan · weaverryan · commit c2342a72d0bc · 2014-10-02T08:30:12.000-04:00
This PR was submitted for the 2.5 branch but it was merged into the 2.3 branch instead (closes symfony#4241). Discussion ---------- [Form] Added information about float choice lists | Q | A | ------------- | --- | Doc fix? | no | New docs? | no | Applies to | all | Fixed tickets | - Added an information about the possibility to have a choice list with float values. Relates to symfony/symfony#11849 Commits ------- 81e3728 Added information about float choice lists
diff --git a/reference/forms/types/choice.rst b/reference/forms/types/choice.rst
@@ -93,6 +93,14 @@ is the item value and the array value is the item's label::
         'choices' => array('m' => 'Male', 'f' => 'Female')
     ));
 
+.. tip::
+
+    When the values to choose from are not integers or strings (but e.g. floats
+    or booleans), you should use the `choice_list`_ option instead. With this
+    option you are able to keep the original data format which is important
+    to ensure that the user input is validated properly and useless database
+    updates caused by a data type mismatch are avoided.
+
 choice_list
 ~~~~~~~~~~~
 
@@ -103,6 +111,17 @@ 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.
+
+.. 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')
+    ));
+
 .. include:: /reference/forms/types/options/empty_value.rst.inc
 
 .. include:: /reference/forms/types/options/expanded.rst.inc
