bug #46576 Fix choice filter error when loading mix of grouped and non-grouped choices (BreyndotEchse)

fabpot · fabpot · commit 5346467de48a · 2022-06-09T08:21:33.000+02:00
This PR was merged into the 5.4 branch. Discussion ---------- Fix choice filter error when loading mix of grouped and non-grouped choices | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | License | MIT **How to reproduce this bug:** ```php $choiceType = $builder->create('test', ChoiceType::class, [ 'choice_loader' => new CallbackChoiceLoader(fn() => [ 'Foo', 'Optgroup' => [ 'Bar', 'Baz', ], ]), 'choice_filter' => fn() => true, ]); $choiceType->getForm()->createView(); ``` **TypeError:** ``` Argument 1 passed to Symfony\Component\Form\ChoiceList\ArrayChoiceList::getChoicesForValues() must be of the type array, string given, called in ~/symfony/form/ChoiceList/Loader/FilterChoiceLoaderDecorator.php on line 39 ``` Commits ------- 24c65bf Fix choice filter error when loading mix of grouped and non-grouped choices
diff --git a/src/Symfony/Component/Form/ChoiceList/Loader/FilterChoiceLoaderDecorator.php b/src/Symfony/Component/Form/ChoiceList/Loader/FilterChoiceLoaderDecorator.php
@@ -36,10 +36,17 @@ protected function loadChoices(): iterable
         }
 
         foreach ($structuredValues as $group => $values) {
-            if ($values && $filtered = array_filter($list->getChoicesForValues($values), $this->filter)) {
-                $choices[$group] = $filtered;
+            if (is_array($values)) {
+                if ($values && $filtered = array_filter($list->getChoicesForValues($values), $this->filter)) {
+                    $choices[$group] = $filtered;
+                }
+                continue;
+                // filter empty groups
+            }
+
+            if ($filtered = array_filter($list->getChoicesForValues([$values]), $this->filter)) {
+                $choices[$group] = $filtered[0];
             }
-            // filter empty groups
         }
 
         return $choices ?? [];
diff --git a/src/Symfony/Component/Form/Tests/ChoiceList/Loader/FilterChoiceLoaderDecoratorTest.php b/src/Symfony/Component/Form/Tests/ChoiceList/Loader/FilterChoiceLoaderDecoratorTest.php
@@ -47,6 +47,29 @@ public function testLoadChoiceListWithGroupedChoices()
         ]), $loader->loadChoiceList());
     }
 
+    public function testLoadChoiceListMixedWithGroupedAndNonGroupedChoices()
+    {
+        $filter = function ($choice) {
+            return 0 === $choice % 2;
+        };
+
+        $choices = array_merge(range(1, 9), ['grouped' => range(10, 40, 5)]);
+        $loader = new FilterChoiceLoaderDecorator(new ArrayChoiceLoader($choices), $filter);
+
+        $this->assertEquals(new ArrayChoiceList([
+            1 => 2,
+            3 => 4,
+            5 => 6,
+            7 => 8,
+            'grouped' => [
+                0 => 10,
+                2 => 20,
+                4 => 30,
+                6 => 40,
+            ],
+        ]), $loader->loadChoiceList());
+    }
+
     public function testLoadValuesForChoices()
     {
         $evenValues = [1 => '2', 3 => '4'];

Original file line number	Diff line number	Diff line change
`@@ -36,10 +36,17 @@ protected function loadChoices(): iterable`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`foreach ($structuredValues as $group => $values) {`
`39`		`- if ($values && $filtered = array_filter($list->getChoicesForValues($values), $this->filter)) {`
`40`		`- $choices[$group] = $filtered;`
	`39`	`+ if (is_array($values)) {`
	`40`	`+ if ($values && $filtered = array_filter($list->getChoicesForValues($values), $this->filter)) {`
	`41`	`+ $choices[$group] = $filtered;`
	`42`	`+ }`
	`43`	`+ continue;`
	`44`	`+ // filter empty groups`
	`45`	`+ }`
	`46`	`+`
	`47`	`+ if ($filtered = array_filter($list->getChoicesForValues([$values]), $this->filter)) {`
	`48`	`+ $choices[$group] = $filtered[0];`
`41`	`49`	`}`
`42`		`- // filter empty groups`
`43`	`50`	`}`
`44`	`51`
`45`	`52`	`return $choices ?? [];`