[Form] deprecated choice_attr as nested arrays mapped by indexes

symfony · HeahDude · Mar 25, 2016 · Sep 25, 2016 · Mar 25, 2016 · Mar 26, 2017
commit e5cc7cd12648e403c8a87bae3a0ba90a7ead4101
diff --git a/UPGRADE-3.3.md b/UPGRADE-3.3.md
@@ -127,6 +127,55 @@ Finder
 
  * The `ExceptionInterface` has been deprecated and will be removed in 4.0.
 
+Form
+----
+
+ * Using `choice_attr` option as an array of nested arrays has been deprecated
+   and indexes will be considered as attributes in 4.0. Use a unique array for
+   all choices or a `callable` instead.
+
+   Before:
+
+   ```php
+   // Single array for all choices using callable
+   'choice_attr' => function () {
+       return array('class' => 'choice-options');
+   },
+
+   // Different arrays per choices using array
+   'choices' => array(
+       'Yes' => true,
+       'No' => false,
+       'Maybe' => null,
+   'choice_attr' => array(
+       'Yes' => array('class' => 'option-green'),
+       'No' => array('class' => 'option-red'),
+   ),
+   ```
+
+   After:
+
+   ```php
+   // Single array for all choices using array
+   'choice_attr' => array('class' => 'choice-options'),
+
+   // Different arrays per choices using callable
+   'choices' => array(
+       'Yes' => true,
+       'No' => false,
+       'Maybe' => null,
+   'choice_attr' => function ($choice, $index, $value) {
+       if ('Yes' === $index) {
+           return array('class' => 'option-green');
+       }
+       if ('No' === $index) {
+           return array('class' => 'option-red');
+       }
+
+       return array();
+   },
+   ```
+
 FrameworkBundle
 ---------------
 

diff --git a/UPGRADE-4.0.md b/UPGRADE-4.0.md
@@ -187,6 +187,52 @@ Form
    }
    ```
 
+ * Usage of `choice_attr` option as an array of nested arrays has been removed
+   and indexes will be considered as attributes in 4.0. Use a unique array for
+   all choices or a `callable` instead.
+
+   Before:
+
+   ```php
+   // Single array for all choices using callable
+   'choice_attr' => function () {
+       return array('class' => 'choice-options');
+   },
+
+   // Different arrays per choices using array
+   'choices' => array(
+       'Yes' => true,
+       'No' => false,
+       'Maybe' => null,
+   'choice_attr' => array(
+       'Yes' => array('class' => 'option-green'),
+       'No' => array('class' => 'option-red'),
+   ),
+   ```
+
+   After:
+
+   ```php
+   // Single array for all choices using array
+   'choice_attr' => array('class' => 'choice-options'),
+
+   // Different arrays per choices using callable
+   'choices' => array(
+       'Yes' => true,
+       'No' => false,
+       'Maybe' => null,
+   'choice_attr' => function ($choice, $index, $value) {
+       if ('Yes' === $index) {
+           return array('class' => 'option-green');
+       }
+       if ('No' === $index) {
+           return array('class' => 'option-red');
+       }
+
+       return array();
+   },
+   ```
+
 FrameworkBundle
 ---------------
 

diff --git a/src/Symfony/Bridge/Twig/composer.json b/src/Symfony/Bridge/Twig/composer.json
@@ -22,7 +22,7 @@
     "require-dev": {
         "symfony/asset": "~2.8|~3.0",
         "symfony/finder": "~2.8|~3.0",
-        "symfony/form": "^3.2.5",
+        "symfony/form": "~3.3",
         "symfony/http-kernel": "~3.2",
         "symfony/polyfill-intl-icu": "~1.0",
         "symfony/routing": "~2.8|~3.0",

diff --git a/src/Symfony/Component/Form/CHANGELOG.md b/src/Symfony/Component/Form/CHANGELOG.md
@@ -7,6 +7,7 @@ CHANGELOG
  * added `Symfony\Component\Form\FormErrorIterator::findByCodes()`
  * added `getTypedExtensions`, `getTypes`, and `getTypeGuessers` to `Symfony\Component\Form\Test\FormIntegrationTestCase`
  * added `FormPass`
+ * deprecated `choice_attr` option as array of nested arrays mapped by indexes
 
 3.2.0
 -----

diff --git a/src/Symfony/Component/Form/ChoiceList/Factory/DefaultChoiceListFactory.php b/src/Symfony/Component/Form/ChoiceList/Factory/DefaultChoiceListFactory.php
@@ -131,13 +131,31 @@ private static function addChoiceView($choice, $value, $label, $keys, &$index, $
             $label = false === $dynamicLabel ? false : (string) $dynamicLabel;
         }
 
+        // BC
+        if (is_array($attr)) {
+            if (isset($attr[$key])) {
+                @trigger_error('Passing an array of arrays to the "choice_attr" option with choice keys as keys is deprecated since version 3.3 and will no longer be supported in 4.0. Use a "\Closure" instead.', E_USER_DEPRECATED);
+                $attr = $attr[$key];
+            } else {
+                foreach ($attr as $a) {
+                    if (is_array($a)) {
+                        // Using the deprecated way of choice keys as keys allows to not define all choices.
+                        // When $attr[$key] is not set for this one but is for another we need to
+                        // prevent using an array as HTML attribute
+                        $attr = array();
+
+                        break;
+                    }
+                }
+            }
+        }
+
         $view = new ChoiceView(
             $choice,
             $value,
             $label,
-            // The attributes may be a callable or a mapping from choice indices
-            // to nested arrays
-            is_callable($attr) ? call_user_func($attr, $choice, $key, $value) : (isset($attr[$key]) ? $attr[$key] : array())
+            // The attributes may be a callable or an array
+            is_callable($attr) ? call_user_func($attr, $choice, $key, $value) : (null !== $attr ? $attr : array())
         );
 
         // $isPreferred may be null if no choices are preferred

diff --git a/src/Symfony/Component/Form/Extension/Core/Type/ChoiceType.php b/src/Symfony/Component/Form/Extension/Core/Type/ChoiceType.php
@@ -329,7 +329,7 @@ public function configureOptions(OptionsResolver $resolver)
             'choice_label' => null,
             'choice_name' => null,
             'choice_value' => null,
-            'choice_attr' => null,
+            'choice_attr' => array(),
             'preferred_choices' => array(),
             'group_by' => null,
             'empty_data' => $emptyData,