[Form] Fixed: Duplicate choice labels are remembered when using "choices_as_values" = false #16685

webmozart · 2015-11-26T14:27:35Z

Q	A
Bug fix?	yes
New feature?	no
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#15606
License	MIT
Doc PR	-

Tobion · 2015-11-26T14:58:41Z

src/Symfony/Component/Form/Extension/Core/Type/ChoiceType.php

+            $nextKey = 0;
+        }
+
+


one empty line too much

ewgRa · 2015-11-26T15:03:12Z

Seems it is cover my case, but not cover all cases. For example this one: https://gist.githubusercontent.com/ewgRa/2a71d44329be2be6446e/raw/733b5baf2b18e42149a670e92e0a27b87ff27567/gistfile1.txt

Tobion · 2015-11-26T15:10:27Z

src/Symfony/Component/Form/Extension/Core/Type/ChoiceType.php

+            $options->offsetGet('choices');
+
+            // Pick labels from $choiceLabels if available
+            if (count($choiceLabels) > 0) {


if ($choiceLabels) is enough. We do not actually need to count them.

$choiceLabels is an array, so I think counting is more explicit and easier to understand.

in fact, there is a major performance issue in using count: $choiceLabels being a reference here, count is going to clone the array...

nicolas-grekas · 2015-11-26T15:24:15Z

src/Symfony/Component/Form/Extension/Core/Type/ChoiceType.php

+        };
+
+        // BC closure, to be removed in 3.0
+        $choiceLabel = function (Options $options) use (&$choiceLabels) {


I think you should remove the &, it creates an unnecessary ref mismatch
or is it really required?

ok, the answer is yes, there is a reason to keep the &, which means the count below has to be removed to prevent a useless memory duplication

I know, this is not really beautiful. But the closures need to access the same variable to be able to properly exchange information.

webmozart · 2015-11-26T15:24:47Z

@ewgRa The keys you pass in the choices array need to be unique. You can map those keys to labels by using a closure in the choice_label option though. The closure accepts the current $choice, $key and $value. Use $key (i.e. the key in the choices array) to access the corresponding label and return it from the closure.

stof · 2015-11-26T15:28:25Z

src/Symfony/Component/Form/Extension/Core/Type/ChoiceType.php

+
+            // Pick labels from $choiceLabels if available
+            if (count($choiceLabels) > 0) {
+                return function ($choice, $key) use ($choiceLabels) {


this may create a copy too (assuming we avoid the copy just above)

adding an & may be necessary I agree

This is without a & by intention. The outer $choiceLabels lives in the type's scope, i.e. every field uses the same variable to transfer information from choices to choice_label during its construction. The inner closure, however, lives in the scope of the field and is used to generate ChoiceView instances during view construction. If we'd use the global variable instead, all choice fields in a form would have the labels of the last one, which is not what we want.

ewgRa · 2015-11-26T16:07:17Z

@webmozart at least my case this PR solve.

Maybe good idea to document it, or add checks in cases like I show at gist.

webmozart · 2015-11-26T16:58:41Z

See symfony/symfony-docs#5905 for documentation.

nicolas-grekas · 2015-11-27T12:16:23Z

src/Symfony/Component/Form/Extension/Core/Type/ChoiceType.php

+     */
+    private static function normalizeLegacyChoices(array &$choices, array &$choiceLabels, &$nextKey = null)
+    {
+        if (null === $nextKey) {


$nextKey should defaut to 0 instead of this if

nicolas-grekas · 2015-11-27T12:18:19Z

👍 (with one comment)

…ces_as_values" = false

webmozart · 2015-11-27T14:26:04Z

Updated

nicolas-grekas · 2015-11-27T22:38:23Z

Thank you @webmozart.

…using "choices_as_values" = false (webmozart) This PR was merged into the 2.7 branch. Discussion ---------- [Form] Fixed: Duplicate choice labels are remembered when using "choices_as_values" = false | Q | A | ------------- | --- | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #15606 | License | MIT | Doc PR | - Commits ------- 1179f07 [Form] Fixed: Duplicate choice labels are remembered when using "choices_as_values" = false

stof · 2015-11-28T15:13:50Z

src/Symfony/Component/Form/Extension/Core/Type/ChoiceType.php

+                // copy here so that every form has an own version of that
+                // variable (contrary to the global reference shared by all
+                // forms)
+                return function ($choice, $key) use ($choiceLabels) {


shouldn't this use a reference too, to avoid copying the array ?

ghost · 2016-01-05T14:44:30Z

I did not follow the full thread, but this last update seems to have changed what is returned by $config->getOption('choices'). I'm not sure if this is intentional or not, but it is a breaking change and should not have been added to a minor release.
It can be fixed in my case by setting 'choices_as_values'=>true in all form types (and switch all values...).
I have already fought previously with the choice type and the big implementation changes and the general feeling is that it has been very unstable and a real headache through the 2.7 release.

peter17 · 2016-01-11T16:24:21Z

This change breaks compatibility with Symfony-2.7.7.
When updating to 2.7.8, I get this error:

Catchable Fatal Error: Argument 1 passed to Symfony\Component\Form\Extension\Core\Type\ChoiceType::normalizeLegacyChoices() must be of the type array, null given, called in myapp/vendor/symfony/symfony/src/Symfony/Component/Form/Extension/Core/Type/ChoiceType.php on line 266 and defined

The form contains a choice list to Propel1 models. Setting 'choices_as_values' => true solves the problem.

xabbuh · 2016-01-11T22:30:27Z

see #17163 which will be included in the next patch releases

webmozart added Form Bug labels Nov 26, 2015

webmozart mentioned this pull request Nov 26, 2015

[Form][2.7] Allow choices with duplicated content #16582

Closed

Tobion reviewed Nov 26, 2015
View reviewed changes

src/Symfony/Component/Form/Extension/Core/Type/ChoiceType.php

$nextKey = 0;

}

Copy link

Contributor

Tobion Nov 26, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one empty line too much

Tobion reviewed Nov 26, 2015
View reviewed changes

webmozart force-pushed the issue15606 branch from 94cd484 to 3aeb60b Compare November 26, 2015 15:20

nicolas-grekas reviewed Nov 26, 2015
View reviewed changes

stof reviewed Nov 26, 2015
View reviewed changes

webmozart force-pushed the issue15606 branch from 3aeb60b to 4b745b9 Compare November 26, 2015 16:45

nicolas-grekas reviewed Nov 27, 2015
View reviewed changes

[Form] Fixed: Duplicate choice labels are remembered when using "choi…

1179f07

…ces_as_values" = false

webmozart force-pushed the issue15606 branch from 4b745b9 to 1179f07 Compare November 27, 2015 14:25

nicolas-grekas merged commit 1179f07 into symfony:2.7 Nov 27, 2015

stof reviewed Nov 28, 2015
View reviewed changes

This was referenced Nov 30, 2015

Release v2.8.0 #16763

Merged

Release v3.0.0 #16766

Merged

fabpot mentioned this pull request Dec 26, 2015

Release v2.7.8 #17142

Merged

Gladhon mentioned this pull request Dec 29, 2015

[Form] fix Catchable Fatal Error if choices is not an array #17163

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Form] Fixed: Duplicate choice labels are remembered when using "choices_as_values" = false #16685

[Form] Fixed: Duplicate choice labels are remembered when using "choices_as_values" = false #16685

webmozart commented Nov 26, 2015

Tobion Nov 26, 2015

ewgRa commented Nov 26, 2015

Tobion Nov 26, 2015

webmozart Nov 26, 2015

nicolas-grekas Nov 26, 2015

nicolas-grekas Nov 26, 2015

nicolas-grekas Nov 26, 2015

webmozart Nov 26, 2015

webmozart commented Nov 26, 2015

stof Nov 26, 2015

nicolas-grekas Nov 26, 2015

webmozart Nov 26, 2015

ewgRa commented Nov 26, 2015

webmozart commented Nov 26, 2015

nicolas-grekas Nov 27, 2015

nicolas-grekas commented Nov 27, 2015

webmozart commented Nov 27, 2015

nicolas-grekas commented Nov 27, 2015

stof Nov 28, 2015

ghost commented Jan 5, 2016

peter17 commented Jan 11, 2016

xabbuh commented Jan 11, 2016

[Form] Fixed: Duplicate choice labels are remembered when using "choices_as_values" = false #16685

[Form] Fixed: Duplicate choice labels are remembered when using "choices_as_values" = false #16685

Conversation

webmozart commented Nov 26, 2015

Choose a reason for hiding this comment

ewgRa commented Nov 26, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

webmozart commented Nov 26, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ewgRa commented Nov 26, 2015

webmozart commented Nov 26, 2015

Choose a reason for hiding this comment

nicolas-grekas commented Nov 27, 2015

webmozart commented Nov 27, 2015

nicolas-grekas commented Nov 27, 2015

Choose a reason for hiding this comment

ghost commented Jan 5, 2016

peter17 commented Jan 11, 2016

xabbuh commented Jan 11, 2016