[Form] deprecated "choice_attr" option as PropertyPath

symfony · HeahDude · Mar 25, 2016 · Sep 25, 2016 · Mar 25, 2016 · Mar 26, 2017
commit eb658f971ad7b9d2047530b896166d1f522ecf53
diff --git a/UPGRADE-3.3.md b/UPGRADE-3.3.md
@@ -176,6 +176,22 @@ Form
    },
    ```
 
+ * Using `choice_attr` option as a string or a `ProprertyPath` instance has been
+   deprecated and will throw an exception in 4.0. Use a `callable` instead.
+
+   Before:
+
+   ```php
+   'choice_attr' => 'htmlAttributes',
+   ```
+
+   After:
+
+   ```php
+   'choice_attr' => function ($choice, $value, $index) {
+       return $choice->getHtmlAttributes();
+   ```
+
 FrameworkBundle
 ---------------
 

diff --git a/UPGRADE-4.0.md b/UPGRADE-4.0.md
@@ -233,6 +233,23 @@ Form
    },
    ```
 
+ * Using `choice_attr` option as a string or a `ProprertyPath` instance will
+   throw an exception. Use a `callable` instead.
+
+   Before:
+
+   ```php
+   'choice_attr' => 'htmlAttributes',
+   ```
+
+   After:
+
+   ```php
+   'choice_attr' => function ($choice, $value, $index) {
+       return $choice->getHtmlAttributes();
+   },
+   ```
+
 FrameworkBundle
 ---------------
 

diff --git a/src/Symfony/Component/Form/CHANGELOG.md b/src/Symfony/Component/Form/CHANGELOG.md
@@ -8,6 +8,7 @@ CHANGELOG
  * 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
+ * deprecated `choice_attr` option as string or `PropertyPath` instance
 
 3.2.0
 -----

diff --git a/src/Symfony/Component/Form/ChoiceList/Factory/PropertyAccessDecorator.php b/src/Symfony/Component/Form/ChoiceList/Factory/PropertyAccessDecorator.php
@@ -218,6 +218,7 @@ public function createView(ChoiceListInterface $list, $preferredChoices = null,
             @trigger_error('Passing callable strings is deprecated since version 3.1 and PropertyAccessDecorator will treat them as property paths in 4.0. You should use a "\Closure" instead.', E_USER_DEPRECATED);
         }
 
+        // Deprecated since 3.3 and to be removed in 4.0 with the condition above
         if ($attr instanceof PropertyPath) {
             $attr = function ($choice) use ($accessor, $attr) {
                 return $accessor->getValue($choice, $attr);

diff --git a/src/Symfony/Component/Form/Extension/Core/Type/ChoiceType.php b/src/Symfony/Component/Form/Extension/Core/Type/ChoiceType.php
@@ -34,6 +34,7 @@
 use Symfony\Component\Form\Util\FormUtil;
 use Symfony\Component\OptionsResolver\Options;
 use Symfony\Component\OptionsResolver\OptionsResolver;
+use Symfony\Component\PropertyAccess\PropertyPath;
 
 class ChoiceType extends AbstractType
 {
@@ -320,6 +321,14 @@ public function configureOptions(OptionsResolver $resolver)
             return $choiceTranslationDomain;
         };
 
+        $choiceAttrNormalizer = function (Options $options, $choiceAttr) {
+            if (is_string($choiceAttr) || $choiceAttr instanceof PropertyPath) {
+                @trigger_error(sprintf('Using "choice_attr" option as a string property path or a "%s" instance is deprecated since version 3.3 and will throw an exception in 4.0. Use a callable instead.', PropertyPath::class), E_USER_DEPRECATED);
+            }
+
+            return $choiceAttr;
+        };
+
         $resolver->setDefaults(array(
             'multiple' => false,
             'expanded' => false,
@@ -346,6 +355,7 @@ public function configureOptions(OptionsResolver $resolver)
         $resolver->setNormalizer('placeholder', $placeholderNormalizer);
         $resolver->setNormalizer('choice_translation_domain', $choiceTranslationDomainNormalizer);
         $resolver->setNormalizer('choices_as_values', $choicesAsValuesNormalizer);
+        $resolver->setNormalizer('choice_attr', $choiceAttrNormalizer);
 
         $resolver->setAllowedTypes('choices', array('null', 'array', '\Traversable'));
         $resolver->setAllowedTypes('choice_translation_domain', array('null', 'bool', 'string'));

diff --git a/src/Symfony/Component/Form/Tests/ChoiceList/Factory/PropertyAccessDecoratorTest.php b/src/Symfony/Component/Form/Tests/ChoiceList/Factory/PropertyAccessDecoratorTest.php
@@ -417,6 +417,9 @@ public function testCreateViewAssumeNullIfGroupsPropertyPathUnreadable()
         ));
     }
 
+    /**
+     * @group legacy
+     */
     public function testCreateViewAttrAsPropertyPath()
     {
         $list = $this->getMockBuilder('Symfony\Component\Form\ChoiceList\ChoiceListInterface')->getMock();
@@ -460,6 +463,9 @@ public function testCreateViewAttrAsPropertyPathWithCallableString()
         ));
     }
 
+    /**
+     * @group legacy
+     */
     public function testCreateViewAttrAsPropertyPathInstance()
     {
         $list = $this->getMockBuilder('Symfony\Component\Form\ChoiceList\ChoiceListInterface')->getMock();