[Form] Add option widget to ChoiceType #17646

bamarni · 2016-02-01T23:11:10Z

Q	A
Bug fix?	[no]
New feature?	[yes]
BC breaks?	[no]
Deprecations?	[yes]
Tests pass?	[yes]
Fixed tickets	#6602
License	MIT

Some tests are failing after rebase from 2.x to 3.x branch.

fix tests failures because of deprecations
fix tests in doctrine bridge
some tests are failing in appveyor but seems unrelated

HeahDude · 2016-02-02T04:31:06Z

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

@@ -60,7 +61,7 @@ public function buildForm(FormBuilderInterface $builder, array $options)
        $choiceList = $this->createChoiceList($options);
        $builder->setAttribute('choice_list', $choiceList);

-        if ($options['expanded']) {
+        if ($options['expanded'] && !in_array($options['widget'], array('text', 'hidden'))) {
            $builder->setDataMapper($options['multiple']


Could be if ('expanded' === $options['widget'])

What is the point of having checkbox and radio value for widget option if you still have to deal with multiple option ?

widget might have few options like text, hidden, select and expanded

For checkbox and radio, multiple option is ignored, I had made the same suggestion (see linked PR description) and @webmozart preferred to have more explicit names.

HeahDude · 2016-02-02T17:16:57Z

Tests are actually failing and html output should be tested as well IMO.
Status: Needs Work

bamarni · 2016-02-03T07:57:04Z

@HeahDude : Thanks for reviewing and testing the feature in this PR. Please also refer to the original discussions in #6602 for more information about what the widget option is about.

There are still some tests failing because of deprecation notices, I'll try to fix them soon.

HeahDude · 2016-02-03T12:35:48Z

What happens when text choice is edited is the form ?

It looks like choice_value and choice_attr are not working well with this widget option.
Especially when using translation, validation is failing.

HeahDude · 2016-02-03T14:30:59Z

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

+            if (null !== $expanded) {
+                @trigger_error('The "expanded" option is deprecated since version 3.1 and will be removed in 4.0. You should use "widget" instead.', E_USER_DEPRECATED);
+            } else {
+                $expanded = false;


This line is not need if you cast return to bool :

return (bool) (in_array($options['widget'], array('radio', 'checkbox'), true) ?: $expanded);

anyway the cast would be done anywhere in this class as it's only a test variable. Then it has to remain internal and not to be removed in 4.0 with the actual implementation IMO.

What is so wrong about this normalizer for you to comment on it since days? :D
Handling everything in one line makes it less readable imo.

bamarni · 2016-02-04T18:38:20Z

It looks like choice_value and choice_attr are not working well with this widget option.
Especially when using translation, validation is failing.

There might be some options not meaningful if the widget is text, in that case for example attr could be used instead of choice_attr. About translation issues, do you have an example?

HeahDude · 2016-02-04T19:13:47Z

@bamarni I've tried to make a recap on all the past PR you've made because I actually missed some discussions in there ;) I will soon post it on the main issue (will keep you tagged) to stop over commenting this thread because I really think that the actual implementation of text widget is wrong.

You've done a great job so far. It seems that while testing this feature I encountered a bug from 2.7 due to #14050 with entity type, PR is coming :)

HeahDude · 2016-02-05T08:54:03Z

src/Symfony/Component/Form/Tests/AbstractBootstrap3LayoutTest.php

@@ -214,7 +214,7 @@ public function testSingleChoice()
        $form = $this->factory->createNamed('name', 'Symfony\Component\Form\Extension\Core\Type\ChoiceType', '&a', array(
            'choices' => array('Choice&A' => '&a', 'Choice&B' => '&b'),
            'multiple' => false,


if widget is explicitly set as select, multiple can be omitted too IMO to ease reading.
You should maybe add a test without widget to see it falls back on select.

HeahDude · 2016-02-05T09:03:15Z

src/Symfony/Component/Form/Tests/AbstractBootstrap3LayoutTest.php

@@ -841,8 +836,7 @@ public function testSingleChoiceExpandedWithBooleanValue()
    {
        $form = $this->factory->createNamed('name', 'Symfony\Component\Form\Extension\Core\Type\ChoiceType', true, array(
            'choices' => array('Choice&A' => '1', 'Choice&B' => '0'),
-            'multiple' => false,
-            'expanded' => true,
+            'widget' => 'radio',


Missing a legacy test for singleChoiceExpanded without widget option and expanded as true.

HeahDude · 2016-02-05T09:48:18Z

Well sorry for that new wave of comments, but this is quite a big and important refactoring here :)

Tell me if you need some help with the tests !

HeahDude · 2016-02-05T10:43:31Z

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

+        if (in_array($options['widget'], array('text', 'hidden'), true)) {
+            return;
+        }
+
        if ($options['expanded']) {


One last comment "for the road" if I may :

You did the change in https://github.com/bamarni/symfony/blob/9ba6a34f64fc063b3bfc8874d6f9300ba8f4c0be/src/Symfony/Component/Form/Extension/Core/Type/ChoiceType.php#L145

Why not this PR ?

Handling this everywhere in the class (except for choice view vars) is how you can make $options['expanded'] deprecated otherwise it has to be marked internal.

fabpot · 2016-07-01T05:49:19Z

@bamarni What's the status of this PR? How can we move forward. I can see that @HeahDude made a lof of comments, can you review them?

bamarni · 2016-07-01T08:53:49Z

@fabpot : As I was working on this I noticed the choice type is not the best fit for this feature. @HeahDude also agrees, cf last messages on the original issue.

IMO : While the original design for this feature looks fine in theory, it comes with quite some inconsistencies, special cases to handle, plus the BC break about the basic usage which would affect all users. Here we basically just need a data transformer on top of existing form types (text, hidden).

fabpot · 2016-07-01T08:57:44Z

ok, so let's close this one then, right?

HeahDude · 2016-07-01T09:16:40Z

Agreed! Let's keep the original issue open to discuss a better way to get this moving forward.

bamarni · 2016-07-01T09:17:38Z

Yep 👍

carsonbot added the Status: Needs Review label Feb 1, 2016

bamarni mentioned this pull request Feb 1, 2016

[Form] Add option widget to ChoiceType #15053

Closed

HeahDude reviewed Feb 2, 2016
View reviewed changes

carsonbot added Status: Needs Work and removed Status: Needs Review labels Feb 2, 2016

bamarni force-pushed the form-choice-widget branch from 3f6ca42 to 7504dde Compare February 2, 2016 17:58

HeahDude reviewed Feb 3, 2016
View reviewed changes

bamarni force-pushed the form-choice-widget branch from af698a0 to 5eac83c Compare February 3, 2016 22:45

bamarni added 3 commits February 4, 2016 18:42

[Form] Add option widget to ChoiceType

3d61584

fix twig bridge tests - use strict comparison

ced878a

add legacy tag to EntityTypeTest - edit upgrade/changelog

1491bb7

bamarni force-pushed the form-choice-widget branch from 5eac83c to 4361034 Compare February 4, 2016 17:58

update tests

2a972f3

bamarni force-pushed the form-choice-widget branch from 4361034 to 2a972f3 Compare February 4, 2016 18:07

HeahDude mentioned this pull request Feb 4, 2016

[Form] Add option "widget" to ChoiceType #6602

Closed

HeahDude reviewed Feb 5, 2016
View reviewed changes

javiereguiluz added Form Feature labels Mar 3, 2016

bamarni closed this Jul 1, 2016

Uh oh!

[Form] Add option widget to ChoiceType #17646

[Form] Add option widget to ChoiceType #17646

Uh oh!

Conversation

bamarni commented Feb 1, 2016

Uh oh!

HeahDude Feb 2, 2016

Choose a reason for hiding this comment

Uh oh!

bamarni Feb 2, 2016

Choose a reason for hiding this comment

Uh oh!

HeahDude commented Feb 2, 2016

Uh oh!

bamarni commented Feb 3, 2016

Uh oh!

HeahDude commented Feb 3, 2016

Uh oh!

HeahDude Feb 3, 2016

Choose a reason for hiding this comment

Uh oh!

bamarni Feb 4, 2016

Choose a reason for hiding this comment

Uh oh!

bamarni commented Feb 4, 2016

Uh oh!

HeahDude commented Feb 4, 2016

Uh oh!

HeahDude Feb 5, 2016

Choose a reason for hiding this comment

Uh oh!

HeahDude Feb 5, 2016

Choose a reason for hiding this comment

Uh oh!

HeahDude commented Feb 5, 2016

Uh oh!

HeahDude Feb 5, 2016

Choose a reason for hiding this comment

Uh oh!

fabpot commented Jul 1, 2016

Uh oh!

bamarni commented Jul 1, 2016

Uh oh!

fabpot commented Jul 1, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

HeahDude commented Jul 1, 2016

Uh oh!

bamarni commented Jul 1, 2016

Uh oh!

Uh oh!

fabpot commented Jul 1, 2016 •

edited

Loading