[Form] Added option type checks in some FormTypes #12425

kix · 2014-11-06T18:08:35Z

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

Follow-up to #11696. Some of the built-in form types allowed passing invalid options, which lead to errors that were not so easy to understand. This PR adds needed checks where applicable.

Allowed types in TimeType's empty_value option were taken from the documentation.

stof · 2014-11-07T08:25:39Z

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

@@ -239,7 +239,9 @@ public function setDefaultOptions(OptionsResolverInterface $resolver)
        ));

        $resolver->setAllowedTypes(array(
+            'choices' => array('null', 'array'),


This is wrong. It also support Traversable

@stof, however, passing an ArrayObject which implements Traversable triggers an exception due to SimpleChoiceList::__construct $choices parameter type hint.
This is a test case that would fail against the current master branch:

namespace Symfony\Component\Form\Tests\Extension\Core\Type; use Symfony\Component\Form\Extension\Core\ChoiceList\ObjectChoiceList; use Symfony\Component\Form\Extension\Core\View\ChoiceView; class ChoiceTypeTest extends \Symfony\Component\Form\Test\TypeTestCase { private $choices = array( 'a' => 'Bernhard', 'b' => 'Fabien', 'c' => 'Kris', 'd' => 'Jon', 'e' => 'Roman', ); // ... public function testChoicesOptionSupportsTraversable() { $this->factory->create('choice', null, array( 'choices' => new \ArrayObject($this->choices), )); } }

And this is how it fails:

There was 1 error: 1) Symfony\Component\Form\Tests\Extension\Core\Type\ChoiceTypeTest::testChoicesOptionSupportsTraversable Argument 1 passed to Symfony\Component\Form\Extension\Core\ChoiceList\SimpleChoiceList::__construct() must be of the type array, object given, called in /Users/kix/Documents/Code/php/symfony/src/Symfony/Component/Form/Extension/Core/Type/ChoiceType.php on line 176 and defined /symfony/src/Symfony/Component/Form/Extension/Core/ChoiceList/SimpleChoiceList.php:45 /symfony/src/Symfony/Component/Form/Extension/Core/Type/ChoiceType.php:176 /symfony/src/Symfony/Component/OptionsResolver/OptionsResolver.php:836 /symfony/src/Symfony/Component/OptionsResolver/OptionsResolver.php:769 /symfony/src/Symfony/Component/Form/ResolvedFormType.php:109 /symfony/src/Symfony/Component/Form/FormFactory.php:87 /symfony/src/Symfony/Component/Form/FormFactory.php:67 /symfony/src/Symfony/Component/Form/FormFactory.php:39 /symfony/src/Symfony/Component/Form/Tests/Extension/Core/Type/ChoiceTypeTest.php:1302

Should this become a separate issue? The doc clearly states that the a valid 'choices' option has to be be an array.

hmm, the choice type itself indeed does not support iterators. but child types (for instance the EntityType) are supporting it, while your change prevents it

And the condition in

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

Line 44 in f1c34f9

if (!$options['choice_list'] && !is_array($options['choices']) && !$options['choices'] instanceof \Traversable) {

let me think that iterators were meant to be supported, and that this is a bug in the SimpleChoiceList conversion

Also, should this check be implemented in the ChoiceType at all? It looks like an OptionsResolver's responsibility to filter out invalid values.

The OptionsResolver cannot make an option required only when the other is not there.

kix · 2014-11-07T09:00:11Z

Also, looking at this line which @stof has linked to, I think that the exception message could be more clear. If I pass a non-\Traversable and non-array argument inside 'choices' option, I'd get an exception thrown that says I'm not passing anything, while I'm passing bad values.

kix · 2014-11-27T09:40:47Z

Seems like we should wait for #12148 here?

kix · 2014-12-12T09:30:28Z

Ping @stof @webmozart
This is referenced in symfony-docs#1226, that's 7th page of issues. Looks like a 500+100 :)

stof · 2015-01-04T13:42:08Z

Once the validation for the choices option of the ChoiceType is fixed to avoid breaking BC in child types, I think this should be merged (and it should go in older branches than master)

stof · 2015-01-18T12:41:13Z

@kix can you update the PR to fix the case of the ChoiceType ?

kix · 2015-01-18T12:42:25Z

@stof, yeah, sorry for the wait, been a bit too busy by the end of the year.

kix · 2015-01-19T10:43:55Z

I've had to remove type hints in some ChoiceList's for the test suite to pass. The check is implemented in ChoiceList::__construct() instead. Is this wrong?

stof · 2015-01-19T11:05:09Z

src/Symfony/Component/Form/Extension/Core/ChoiceList/ChoiceList.php

@@ -100,7 +108,7 @@ public function __construct($choices, array $labels, array $preferredChoices = a
     * @param array              $labels           The labels belonging to the choices.
     * @param array              $preferredChoices The choices to display with priority.
     */
-    protected function initialize($choices, array $labels, array $preferredChoices)
+    protected function initialize($choices, $labels, $preferredChoices)


changing this signature is a BC break

@stof is right. However, this class is not an API class, so technically this change is possible, as long as the change and the upgrade path is documented in the UPGRADE file (as per our BC policy). Can you add that information to the UPGRADE file please?

@webmozart, sure, will do.

Can you add a note in the UPGRADE file, it looks like this is the only remaining thing to do before merging.

@fabpot This file has been removed in 3.0.

This PR should be rebased before a new review IMHO.

A new PR on master is indeed needed.

OK, will try to fix it up.

webmozart · 2015-06-17T15:26:47Z

Looks good! Can you please rebase and document how to upgrade subclasses of ChoiceList in the UPGRADE file? After that, I'm 👍.

kix · 2015-06-17T19:05:42Z

@webmozart, does 7d623ab look good to you? Anything I should add or remove?
On build failure: investigating.

webmozart · 2015-06-18T13:31:32Z

UPGRADE-3.0.md

@@ -110,6 +110,9 @@ UPGRADE FROM 2.x to 3.0

 ### Form

+ * Type hints for `ChoiceList::initialize()` method's `$labels` and `$preferredChoices` 


"The array type hints..."

webmozart · 2015-06-18T13:33:04Z

Could you please rebase your PR onto 2.8? You need to open a new PR for the 2.8 branch as well.

kix · 2015-06-18T14:50:53Z

@webmozart, sorry, I must've rebased better. Will fix and write a comment once it looks good, OK?

fabpot · 2016-03-02T15:36:06Z

@kix This one looks easy to finish :)

kix · 2016-03-02T15:56:23Z

@fabpot, sure!
2 марта 2016 г. 8:36 PM пользователь "Fabien Potencier" <
[email protected]> написал:

@kix https://github.com/kix This ones looks easy to finish :)

—
Reply to this email directly or view it on GitHub
#12425 (comment).

xabbuh · 2016-03-29T13:17:45Z

@kix Any news here? :)

kix · 2016-03-29T13:26:06Z

@xabbuh, sorry for the wait, I'll try to finish this by the end of the week (hopefully, if nothing unusual comes up)

HeahDude · 2016-03-29T13:27:12Z

@xabbuh @kix This PR is deprecated by #14050, those changes are not needed anymore.

Excepted allow type array for entry_options which might be relevant today. Since it's normalized, it will actually make php crash on the call to $value['block_name'], but it's common sense IHMO that entry_options option in CollectionType is an array, that's probably why no one complained until now.

kix · 2016-03-29T13:30:21Z

@HeahDude, hmm, thanks, I'll take a look at $value['block_name'], I think. Is it OK to close this PR?

HeahDude · 2016-03-29T13:31:44Z

Yes :)

HeahDude · 2016-03-29T13:36:23Z

If you do you should do it on 2.8 I think. Throw the right exception should be a bug fix IMO.

kix · 2016-03-29T13:37:40Z

@HeahDude, agreed, thanks :)

kix changed the title ~~Form option type checks~~ [Form] Added option type checks in some FormTypes Nov 6, 2014

kix force-pushed the form_option_type_checks branch 2 times, most recently from 7136987 to eb7e9b4 Compare November 6, 2014 19:12

stof reviewed Nov 7, 2014
View reviewed changes

fabpot added the Form label Dec 7, 2014

stof reviewed Jan 19, 2015
View reviewed changes

kix force-pushed the form_option_type_checks branch from 10508cf to 753a08e Compare June 17, 2015 18:19

webmozart reviewed Jun 18, 2015
View reviewed changes

[Form] Added option type checks in some FormTypes

34e3a24

kix force-pushed the form_option_type_checks branch from 7d623ab to 34e3a24 Compare January 22, 2016 00:18

kix changed the title ~~[Form] Added option type checks in some FormTypes~~ [Form][3.0] Added option type checks in some FormTypes Jan 22, 2016

kix changed the title ~~[Form][3.0] Added option type checks in some FormTypes~~ [Form] Added option type checks in some FormTypes Jan 22, 2016

javiereguiluz added the Bug label Mar 3, 2016

kix closed this Mar 29, 2016

kix deleted the form_option_type_checks branch March 29, 2016 13:37

HeahDude mentioned this pull request Mar 30, 2016

added a maintenance document symfony/symfony-docs#6412

Merged

		@@ -110,6 +110,9 @@ UPGRADE FROM 2.x to 3.0

		### Form

		* Type hints for `ChoiceList::initialize()` method's `$labels` and `$preferredChoices`

Uh oh!

[Form] Added option type checks in some FormTypes #12425

[Form] Added option type checks in some FormTypes #12425

Uh oh!

Conversation

kix commented Nov 6, 2014

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kix commented Nov 7, 2014

Uh oh!

kix commented Nov 27, 2014

Uh oh!

kix commented Dec 12, 2014

Uh oh!

stof commented Jan 4, 2015

Uh oh!

stof commented Jan 18, 2015

Uh oh!

kix commented Jan 18, 2015

Uh oh!

kix commented Jan 19, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

webmozart commented Jun 17, 2015

Uh oh!

kix commented Jun 17, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

webmozart commented Jun 18, 2015

Uh oh!

kix commented Jun 18, 2015

Uh oh!

fabpot commented Mar 2, 2016

Uh oh!

kix commented Mar 2, 2016

Uh oh!

xabbuh commented Mar 29, 2016

Uh oh!

kix commented Mar 29, 2016

Uh oh!

HeahDude commented Mar 29, 2016

Uh oh!

kix commented Mar 29, 2016

Uh oh!

HeahDude commented Mar 29, 2016

Uh oh!

HeahDude commented Mar 29, 2016

Uh oh!

kix commented Mar 29, 2016

Uh oh!

Uh oh!