[Form] Add parameter type declarations #32237

vudaltsov · 2019-06-27T21:55:45Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#32179
License	MIT
Doc PR	n/a

Some hints added, will finish within 2 days.

src/Symfony/Bridge/Twig/Form/TwigRendererEngine.php

src/Symfony/Component/Form/ButtonBuilder.php

src/Symfony/Component/Form/ChoiceList/Factory/ChoiceListFactoryInterface.php

src/Symfony/Component/Form/ChoiceList/Loader/CallbackChoiceLoader.php

src/Symfony/Component/Form/ButtonBuilder.php

src/Symfony/Component/Form/Button.php

src/Symfony/Component/Form/ButtonBuilder.php

src/Symfony/Component/Form/Button.php

@nicolas-grekas

This PR was merged into the 3.4 branch. Discussion ---------- [Form] Name related PHPDoc fixes | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | relates to #32179 | License | MIT | Doc PR | n/a As I started working on #32179 in #32237, I noticed some PHPDoc inconsistencies around the form's name. I have researched the issue thoroughly and here's my proposal: 1. All "factory" methods (`FormFactory::create*`, `ResolvedFormType::createBuilder`, `FormBuilder::create|add`, `Form::add`) currently accept string and integer names. This should not be deprecated, because it's very convenient and natural to pass ints when adding children to types like `ChoiceType` or `CollectionType`. 1. None of the "factory" methods explicitly accepts `null` as a name, although passing `null` works the same as passing `''`. I consider passing `null` in this case to be ugly, so I corrected the builder's constructors mentioning `null` as a possible argument. One should pass an empty string `''` when creating such a form. We could also deprecate passing `null` in a PR targeting 4.4. 1. Currently the name becomes a string in the builder's (or config builder's) constructor. Which means that `FormConfigInterface::getName` always returns a string and thus the form's `$name` property is always a string. All related checks and PHPDocs should be corrected. 1. The "children accessors" (`Form::has|get|remove`, `FormBuilder::has|get|remove`) should accept both strings and ints because they are array-accessible by design (so it does not really matter, if the key is a string or an int). If it's valid to have `$collectionForm->add(1, ItemType::class)`, then it should be valid to do `$collectionForm->get(1)`. And it works in code, but is not mentioned in the PHPDoc. ping @nicolas-grekas , @xabbuh , @HeahDude Commits ------- eae95c4 PHPDoc fixes

kaznovac · 2019-07-15T11:24:10Z

should we typehint \Symfony\Component\Form\FormTypeGuesserInterface also?
(asking as i looked in typehinting doctrine bridge)

src/Symfony/Component/Form/FormBuilderInterface.php

vudaltsov · 2019-07-18T09:46:06Z

I will continue to work on the issue soon. Symfony\Component\Form\FormTypeGuesserInterface should be typehinted in this PR, I guess.

derrabus · 2019-07-18T09:59:27Z

I will continue to work on the issue soon. Symfony\Component\Form\FormTypeGuesserInterface should be typehinted in this PR, I guess.

Yes. If you also update the corresponding implementation in the doctrine bridge, remember to update the composer.json file of the bridge accordingly.

nicolas-grekas · 2019-07-31T15:25:06Z

Good for rebase.

src/Symfony/Component/Form/FormFactoryInterface.php

src/Symfony/Component/Form/FormBuilder.php

src/Symfony/Component/Form/Form.php

This PR was merged into the 4.4 branch. Discussion ---------- [Form] type cannot be a FormTypeInterface anymore | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | no  | BC breaks? | no  | Deprecations? | no  | Tests pass? | yes  | Fixed tickets | | License | MIT | Doc PR | Found in #32237. This style of adding FormTypes has been removed in sf 3. Could also be merged in 3.4 if preferred. But there was an outdated, broken test. So 4.4 seems enough as well. Commits ------- 6ee0d53 [Form] type cannot be a FormTypeInterface anymore

xabbuh · 2019-08-05T08:29:00Z

@vudaltsov Can you please rebase here? :)

src/Symfony/Component/Form/ChoiceList/Factory/CachingFactoryDecorator.php

Tobion · 2019-08-05T14:12:56Z

Tests are failing. The $label of createView can also be false, see \Symfony\Component\Form\ChoiceList\Factory\DefaultChoiceListFactory::addChoiceView

vudaltsov · 2019-08-05T14:17:17Z

@Tobion , I know that, that's exactly why I fixed it in #32935, see #32237 (comment). I propose waiting for the merge and then I will rebase and fix and squash everything, ok?

@xabbuh

This PR was squashed before being merged into the 3.4 branch (closes #32935). Discussion ---------- [Form] Fix inconsistencies | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | n/a - ~~Use `@inheritdoc` in `Button` and `ButtonBuilder` where the method does satisfy the contract.~~ - ~~Add `This method should not be invoked` in all unsupported methods in `Button` and `ButtonBuilder` for consistency.~~ - ~~Fix the misused `idempotent` term in implementations of the `getFormConfig` method. It is wrong in the sense that the method does not always return the same result. You can `setAttribute` for instance and `getFormConfig` will return a different config object.~~ - ~~Add `if ($this->locked)` checks in the supported mutators.~~ - ~~Fix the arguments contract in the `ChoiceListFactoryInterface` — now it supports `PropertyPathInterface` explicitly. The downside of it — breaking LSP in the `DefaultChoiceListFactory`.~~ - Fix the `$label` phpdoc of the `ChoiceView` (arised in #32237). - Use `PropertyPathInterface` instead of `PropertyPath` in `PropertyAccessDecorator` of the choice factory. - Fix `ArrayChoiceList::flatten` type hints. These changes are debatable, so feel free to correct me if I am wrong at some point. Ping @xabbuh , @HeahDude , @yceruto , @nicolas-grekas Commits ------- 360711c [Form] Fix inconsistencies

@xabbuh

This PR was squashed before being merged into the 3.4 branch (closes #32935). Discussion ---------- [Form] Fix inconsistencies | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | n/a - ~~Use `@inheritdoc` in `Button` and `ButtonBuilder` where the method does satisfy the contract.~~ - ~~Add `This method should not be invoked` in all unsupported methods in `Button` and `ButtonBuilder` for consistency.~~ - ~~Fix the misused `idempotent` term in implementations of the `getFormConfig` method. It is wrong in the sense that the method does not always return the same result. You can `setAttribute` for instance and `getFormConfig` will return a different config object.~~ - ~~Add `if ($this->locked)` checks in the supported mutators.~~ - ~~Fix the arguments contract in the `ChoiceListFactoryInterface` — now it supports `PropertyPathInterface` explicitly. The downside of it — breaking LSP in the `DefaultChoiceListFactory`.~~ - Fix the `$label` phpdoc of the `ChoiceView` (arised in symfony/symfony#32237). - Use `PropertyPathInterface` instead of `PropertyPath` in `PropertyAccessDecorator` of the choice factory. - Fix `ArrayChoiceList::flatten` type hints. These changes are debatable, so feel free to correct me if I am wrong at some point. Ping @xabbuh , @HeahDude , @yceruto , @nicolas-grekas Commits ------- 360711ce4e [Form] Fix inconsistencies

Tobion · 2019-08-05T14:28:24Z

Even if you know that, #32935 does not fix this completely. That is what I'm saying. https://github.com/vudaltsov/symfony/blob/360711ce4e3b83251e7fe9dac958dc4f4246c0b6/src/Symfony/Component/Form/ChoiceList/Factory/ChoiceListFactoryInterface.php#L81 can also be false. So the phpdocs are still wrong. Or you need to overwrite phpdocs of \Symfony\Component\Form\ChoiceList\Factory\DefaultChoiceListFactory::createView and all the other implementations which should also be done in lower branches.

nicolas-grekas · 2019-08-05T14:29:26Z

(merged up)

vudaltsov · 2019-08-05T14:35:39Z

@Tobion , got it, thank you!

I now need some time to distract from Forms before the final fight in this PR and relevant changes in other branches :)
I hope to finish tonight or tomorrow.

Tobion · 2019-08-05T15:17:07Z

#32955 should solve this problem.

nicolas-grekas · 2019-08-08T17:59:15Z

up for a rebase?

vudaltsov · 2019-08-08T18:03:53Z

@nicolas-grekas , sure, tonight I will take over #32955 and then we can safely add ?callable to $label. But I will rebase this branch today as well.

vudaltsov · 2019-08-09T03:11:17Z

@derrabus , should I revert changes to OptionsResolverWrapper extends OptionsResolver and ViolationPath implements PropertyPathInterface to avoid bumping up the versions of the required packages?

src/Symfony/Component/Form/ChoiceList/View/ChoiceGroupView.php

xabbuh · 2019-08-09T09:06:44Z

src/Symfony/Component/Form/FormRendererEngineInterface.php

@@ -128,7 +128,6 @@ public function getResourceHierarchyLevel(FormView $view, array $blockNameHierar
     *
     * @param FormView $view      The view to render
     * @param mixed    $resource  The renderer resource
-     * @param string   $blockName The name of the block to render


Why did you remove this one but not the others?

Think it happened when rebasing. I added string declaration myself and then someone added it too without removing the phpdoc, so only phpdoc removal left here.
Should I remove $view in another PR targeting 3.4? Or just revert my change in this class?

src/Symfony/Component/Form/ChoiceList/Factory/CachingFactoryDecorator.php

xabbuh · 2019-08-09T09:22:14Z

src/Symfony/Component/Form/DataMapperInterface.php

-     * @param mixed                        $viewData View data of the compound form being initialized
-     * @param FormInterface[]|\Traversable $forms    A list of {@link FormInterface} instances
+     * @param mixed                    $viewData View data of the compound form being initialized
+     * @param FormInterface[]|iterable $forms    A list of {@link FormInterface} instances


Would iterable<FormInterface> be a correct notation here?

it's a correct notation, but do we use it in Symfony?

xabbuh · 2019-08-09T09:22:20Z

src/Symfony/Component/Form/DataMapperInterface.php

-     * @param FormInterface[]|\Traversable $forms    A list of {@link FormInterface} instances
-     * @param mixed                        $viewData The compound form's view data that get mapped
-     *                                               its children model data
+     * @param FormInterface[]|iterable $forms    A list of {@link FormInterface} instances


Would iterable<FormInterface> be a correct notation here?

xabbuh · 2019-08-09T10:24:58Z

We need to update the minimum required version for the symfony/property-access package to 5.0.

vudaltsov · 2019-08-09T11:51:15Z

@xabbuh , for options-resolver as well, right? Since we have OptionsResolverWrapper. Done

src/Symfony/Component/Form/ChoiceList/Factory/DefaultChoiceListFactory.php

nicolas-grekas · 2019-08-13T07:01:58Z

Thank you @vudaltsov.

This PR was squashed before being merged into the 5.0-dev branch (closes #32237). Discussion ---------- [Form] Add parameter type declarations | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #32179 | License | MIT | Doc PR | n/a Some hints added, will finish within 2 days. Commits ------- 99a1d4c [Form] Add parameter type declarations

carsonbot added Status: Needs Review Form Feature labels Jun 27, 2019

derrabus mentioned this pull request Jun 27, 2019

[5.0] Add parameter type-hints #32179

Closed

57 tasks

derrabus requested changes Jun 27, 2019

View reviewed changes

src/Symfony/Bridge/Twig/Form/TwigRendererEngine.php Outdated Show resolved Hide resolved

carsonbot added Status: Needs Work and removed Status: Needs Review labels Jun 27, 2019

yceruto reviewed Jun 27, 2019

View reviewed changes

vudaltsov commented Jun 27, 2019

View reviewed changes

src/Symfony/Component/Form/ButtonBuilder.php Outdated Show resolved Hide resolved

nicolas-grekas reviewed Jun 28, 2019

View reviewed changes

src/Symfony/Component/Form/Button.php Outdated Show resolved Hide resolved

src/Symfony/Component/Form/ButtonBuilder.php Outdated Show resolved Hide resolved

src/Symfony/Component/Form/Button.php Outdated Show resolved Hide resolved

nicolas-grekas added this to the 5.0 milestone Jun 28, 2019

vudaltsov mentioned this pull request Jul 6, 2019

[Form] Name related PHPDoc fixes #32400

Merged

kaznovac reviewed Jul 18, 2019

View reviewed changes

src/Symfony/Component/Form/FormBuilderInterface.php Outdated Show resolved Hide resolved

vudaltsov mentioned this pull request Jul 30, 2019

[Form] Deprecate passing ints #32821

Closed

Tobion reviewed Aug 1, 2019

View reviewed changes

src/Symfony/Component/Form/FormFactoryInterface.php Outdated Show resolved Hide resolved

Tobion reviewed Aug 1, 2019

View reviewed changes

src/Symfony/Component/Form/FormBuilder.php Outdated Show resolved Hide resolved

Tobion reviewed Aug 1, 2019

View reviewed changes

src/Symfony/Component/Form/Form.php Show resolved Hide resolved

Tobion mentioned this pull request Aug 4, 2019

[Form] type cannot be a FormTypeInterface anymore #32934

Merged

vudaltsov force-pushed the 32179-form-type-hints branch from 5cbb4a6 to 9d4eb15 Compare August 4, 2019 20:12

vudaltsov marked this pull request as ready for review August 4, 2019 20:35

vudaltsov changed the title ~~[Form] Add parameter type-hints~~ [Form] Add parameter type declarations Aug 4, 2019

vudaltsov mentioned this pull request Aug 4, 2019

[Form] Fix inconsistencies #32935

Merged

vudaltsov force-pushed the 32179-form-type-hints branch from 16d3969 to 4ce52e4 Compare August 5, 2019 08:55

carsonbot added Status: Needs Work and removed Status: Reviewed labels Aug 5, 2019

Tobion reviewed Aug 5, 2019

View reviewed changes

src/Symfony/Component/Form/ChoiceList/Factory/CachingFactoryDecorator.php Outdated Show resolved Hide resolved

Tobion mentioned this pull request Aug 5, 2019

[Form] use a choice label normalizer instead of violating ChoiceListFactoryInterface::createView #32955

Closed

vudaltsov force-pushed the 32179-form-type-hints branch from c8716fe to e6f1868 Compare August 9, 2019 02:35

xabbuh reviewed Aug 9, 2019

View reviewed changes

nicolas-grekas reviewed Aug 11, 2019

View reviewed changes

src/Symfony/Component/Form/ChoiceList/Factory/DefaultChoiceListFactory.php Outdated Show resolved Hide resolved

vudaltsov mentioned this pull request Aug 12, 2019

[Form] Add bool type to ChoiceListFactoryInterface::createView $label argument #33131

Merged

[Form] Add parameter type declarations

99a1d4c

nicolas-grekas force-pushed the 32179-form-type-hints branch from 1fb8555 to 99a1d4c Compare August 13, 2019 07:01

nicolas-grekas approved these changes Aug 13, 2019

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Work labels Aug 13, 2019

nicolas-grekas merged commit 99a1d4c into symfony:master Aug 13, 2019

andrew-demb mentioned this pull request Dec 4, 2020

[Form] Argument $forms in DataMapperInterface methods should be \Traversable #39311

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Form] Add parameter type declarations #32237

[Form] Add parameter type declarations #32237

vudaltsov commented Jun 27, 2019

kaznovac commented Jul 15, 2019

vudaltsov commented Jul 18, 2019

derrabus commented Jul 18, 2019

nicolas-grekas commented Jul 31, 2019

xabbuh commented Aug 5, 2019

Tobion commented Aug 5, 2019

vudaltsov commented Aug 5, 2019 •

edited

Tobion commented Aug 5, 2019 •

edited

nicolas-grekas commented Aug 5, 2019

vudaltsov commented Aug 5, 2019

Tobion commented Aug 5, 2019

nicolas-grekas commented Aug 8, 2019

vudaltsov commented Aug 8, 2019

vudaltsov commented Aug 9, 2019

xabbuh Aug 9, 2019

vudaltsov Aug 9, 2019

xabbuh Aug 9, 2019

vudaltsov Aug 9, 2019

xabbuh Aug 9, 2019

xabbuh commented Aug 9, 2019

vudaltsov commented Aug 9, 2019

nicolas-grekas commented Aug 13, 2019

[Form] Add parameter type declarations #32237

[Form] Add parameter type declarations #32237

Conversation

vudaltsov commented Jun 27, 2019

kaznovac commented Jul 15, 2019

vudaltsov commented Jul 18, 2019

derrabus commented Jul 18, 2019

nicolas-grekas commented Jul 31, 2019

xabbuh commented Aug 5, 2019

Tobion commented Aug 5, 2019

vudaltsov commented Aug 5, 2019 • edited

Tobion commented Aug 5, 2019 • edited

nicolas-grekas commented Aug 5, 2019

vudaltsov commented Aug 5, 2019

Tobion commented Aug 5, 2019

nicolas-grekas commented Aug 8, 2019

vudaltsov commented Aug 8, 2019

vudaltsov commented Aug 9, 2019

xabbuh Aug 9, 2019

Choose a reason for hiding this comment

vudaltsov Aug 9, 2019

Choose a reason for hiding this comment

xabbuh Aug 9, 2019

Choose a reason for hiding this comment

vudaltsov Aug 9, 2019

Choose a reason for hiding this comment

xabbuh Aug 9, 2019

Choose a reason for hiding this comment

xabbuh commented Aug 9, 2019

vudaltsov commented Aug 9, 2019

nicolas-grekas commented Aug 13, 2019

vudaltsov commented Aug 5, 2019 •

edited

Tobion commented Aug 5, 2019 •

edited