Deprecate passing false as $label to ChoiceListFactoryInterface

vudaltsov · vudaltsov · commit fcda646a67f2 · 2019-08-09T12:13:56.000+03:00
diff --git a/UPGRADE-5.0.md b/UPGRADE-5.0.md
@@ -215,6 +215,7 @@ Form
 
  * The `regions` option was removed from the `TimezoneType`.
  * Added support for PHPUnit 8. A `void` return-type was added to the `FormIntegrationTestCase::setUp()`, `TypeTestCase::setUp()` and `TypeTestCase::tearDown()` methods.
+ * Passing `false` as `$label` to `ChoiceListFactoryInterface::createView` now throws a `TypeError`, pass a callable that returns false instead.
 
 FrameworkBundle
 ---------------
diff --git a/src/Symfony/Component/Form/CHANGELOG.md b/src/Symfony/Component/Form/CHANGELOG.md
@@ -10,6 +10,7 @@ CHANGELOG
  * deprecated using `int` or `float` as data for the `NumberType` when the `input` option is set to `string`
  * The type guesser guesses the HTML accept attribute when a mime type is configured in the File or Image constraint.
  * Overriding the methods `FormIntegrationTestCase::setUp()`, `TypeTestCase::setUp()` and `TypeTestCase::tearDown()` without the `void` return-type is deprecated.
+ * deprecated passing `false` as `$label` to `ChoiceListFactoryInterface::createView`, pass a callable that returns false instead
 
 4.3.0
 -----
diff --git a/src/Symfony/Component/Form/ChoiceList/Factory/CachingFactoryDecorator.php b/src/Symfony/Component/Form/ChoiceList/Factory/CachingFactoryDecorator.php
@@ -118,6 +118,12 @@ public function createListFromLoader(ChoiceLoaderInterface $loader, $value = nul
      */
     public function createView(ChoiceListInterface $list, $preferredChoices = null, $label = null, $index = null, $groupBy = null, $attr = null)
     {
+        if (false === $label) {
+            @trigger_error(sprintf('Passing false as $label to %s is deprecated in Symfony 4.4 and will trigger a TypeError in 5.0, pass a callable that returns false instead.', __METHOD__), E_USER_DEPRECATED);
+
+            $label = static function () { return false; };
+        }
+
         // The input is not validated on purpose. This way, the decorated
         // factory may decide which input to accept and which not.
         $hash = self::generateHash([$list, $preferredChoices, $label, $index, $groupBy, $attr]);
diff --git a/src/Symfony/Component/Form/ChoiceList/Factory/DefaultChoiceListFactory.php b/src/Symfony/Component/Form/ChoiceList/Factory/DefaultChoiceListFactory.php
@@ -47,6 +47,12 @@ public function createListFromLoader(ChoiceLoaderInterface $loader, $value = nul
      */
     public function createView(ChoiceListInterface $list, $preferredChoices = null, $label = null, $index = null, $groupBy = null, $attr = null)
     {
+        if (false === $label) {
+            @trigger_error(sprintf('Passing false as $label to %s is deprecated in Symfony 4.4 and will trigger a TypeError in 5.0, pass a callable that returns false instead.', __METHOD__), E_USER_DEPRECATED);
+
+            $label = static function () { return false; };
+        }
+
         $preferredViews = [];
         $preferredViewsOrder = [];
         $otherViews = [];
diff --git a/src/Symfony/Component/Form/ChoiceList/Factory/PropertyAccessDecorator.php b/src/Symfony/Component/Form/ChoiceList/Factory/PropertyAccessDecorator.php
@@ -130,6 +130,12 @@ public function createListFromLoader(ChoiceLoaderInterface $loader, $value = nul
      */
     public function createView(ChoiceListInterface $list, $preferredChoices = null, $label = null, $index = null, $groupBy = null, $attr = null)
     {
+        if (false === $label) {
+            @trigger_error(sprintf('Passing false as $label to %s is deprecated in Symfony 4.4 and will trigger a TypeError in 5.0, pass a callable that returns false instead.', __METHOD__), E_USER_DEPRECATED);
+
+            $label = static function () { return false; };
+        }
+
         $accessor = $this->propertyAccessor;
 
         if (\is_string($label)) {
diff --git a/src/Symfony/Component/Form/Extension/Core/Type/ChoiceType.php b/src/Symfony/Component/Form/Extension/Core/Type/ChoiceType.php
@@ -404,10 +404,14 @@ private function createChoiceList(array $options)
 
     private function createChoiceListView(ChoiceListInterface $choiceList, array $options)
     {
+        if (false === $label = $options['choice_label']) {
+            $label = static function () { return false; };
+        }
+
         return $this->choiceListFactory->createView(
             $choiceList,
             $options['preferred_choices'],
-            $options['choice_label'],
+            $label,
             $options['choice_name'],
             $options['group_by'],
             $options['choice_attr']
