[PropertyInfo] fix array types with keys (array<string, string>) #37559

digilist · 2020-07-11T14:14:28Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
Deprecations?	no
Tickets	n/a
License	MIT
Doc PR	n/a

Array types with keys are currently not detected correctly from the PropertyInfo component:

@var array<string, string>
@var array<string, array<integer, string>>

Those are currently identified as object with class rray<string, string>.

This PR tries to fix it.

What I noticed while fixing this, is that union types in arrays are not supported in general at the moment, because the Type class supports only one collectionValueType and I do not see how to pass a Union Type there. But I guess that's a different issue and for those types I decided to return null as collection value type for now. (Or better throw on exception?)

digilist · 2020-07-11T14:16:54Z

src/Symfony/Component/PropertyInfo/Util/PhpDocTypeHelper.php

@@ -109,19 +111,30 @@ private function createType(DocType $type, bool $nullable, string $docType = nul
        }

        if ('[]' === substr($docType, -2)) {
-            if ('mixed[]' === $docType) {
-                $collectionKeyType = null;


this code was never executed. in case of a mixed[] type on the variable, $docType was array, so I removed this code.

src/Symfony/Component/PropertyInfo/Util/PhpDocTypeHelper.php

digilist · 2020-07-11T14:40:13Z

I just noticed that the build is failing for older PHP versions, please let me check first.

Update: Fixed it. It was because older versions of the phpdocumenter reflection package did not allow/parse spaces in array<string, string> The appveyor and travis builds are still red, but those builds are failing because of unrelated tests.

src/Symfony/Component/PropertyInfo/Util/PhpDocTypeHelper.php

nicolas-grekas · 2020-07-12T09:36:39Z

We would consider this as a new feature indeed. Can you rebase and target master please?

MaSpeng · 2020-08-20T16:12:53Z

How is the status of this merge request, I stumbled over this issue by myself right now?

src/Symfony/Component/PropertyInfo/Util/PhpDocTypeHelper.php

nicolas-grekas · 2020-09-07T14:20:31Z

/cc @dunglas could you maybe have a look?

fabpot · 2020-09-09T05:17:18Z

Thank you @digilist.

ghost · 2020-09-16T07:05:44Z

Hello, is there a known workaround to wait to next property-info patch release?

pl-github · 2020-09-22T11:20:15Z

Hello, is there a known workaround to wait to next property-info patch release?

We used object<string, MyOwnClass> instead of array<string, MyOwnClass> in our ApiPlatform project as a workaround. I know it is very crappy and phpstan does not like it either, but it is the easiest way to bridge the time until the next minor release.

Marmelatze · 2020-09-22T11:27:20Z

You can use something like this:

@var MyOwnClass[]
@phpstan-var array<string, MyOwnClass>

That should satisfy phpstan and the serializer.

pl-github · 2020-09-22T13:01:04Z

@Marmelatze Thank you for your suggestion.

The phpstan annotation works, but the normal @var annotation does not work, because the unfixed PropertyInfo version enforces arrays with a numeric index and the ArrayDenormalizer fails.

aso824 · 2020-09-26T22:18:51Z

You could use @var aarray<string, MyOwnClass> which is also ugly hack but works with ArrayDenormalizer.

mdeboer · 2020-10-06T11:21:13Z

You could use @var aarray<string, MyOwnClass> which is also ugly hack but works with ArrayDenormalizer.

Thank you, this worked perfectly! Looking forward to the 5.2 release though!

digilist requested a review from dunglas as a code owner July 11, 2020 14:14

carsonbot added Status: Needs Review PropertyInfo labels Jul 11, 2020

digilist changed the base branch from master to 4.4 July 11, 2020 14:14

digilist commented Jul 11, 2020

View reviewed changes

digilist force-pushed the property_info_array_keys branch from 131f362 to ab80d9e Compare July 11, 2020 14:17

digilist commented Jul 11, 2020

View reviewed changes

src/Symfony/Component/PropertyInfo/Util/PhpDocTypeHelper.php Outdated Show resolved Hide resolved

digilist force-pushed the property_info_array_keys branch from ab80d9e to f7f49c9 Compare July 11, 2020 15:19

stloyd suggested changes Jul 11, 2020

View reviewed changes

src/Symfony/Component/PropertyInfo/Util/PhpDocTypeHelper.php Outdated Show resolved Hide resolved

carsonbot added Status: Needs Work and removed Status: Needs Review labels Jul 11, 2020

digilist force-pushed the property_info_array_keys branch 2 times, most recently from 77974e2 to 93882ea Compare July 11, 2020 17:39

nicolas-grekas added this to the next milestone Jul 12, 2020

digilist force-pushed the property_info_array_keys branch from 93882ea to d118c6e Compare July 12, 2020 20:35

digilist requested review from jderusse, lyrixx, sroze and xabbuh as code owners July 12, 2020 20:35

carsonbot added Status: Needs Review and removed Status: Needs Work labels Jul 12, 2020

digilist changed the base branch from 4.4 to master July 12, 2020 20:36

digilist force-pushed the property_info_array_keys branch from d118c6e to 34a1c69 Compare July 12, 2020 20:38

nicolas-grekas reviewed Sep 3, 2020

View reviewed changes

[PropertyInfo] fix array types with keys (array<string, string>)

64f7bd7

digilist force-pushed the property_info_array_keys branch from 34a1c69 to 64f7bd7 Compare September 7, 2020 12:54

nicolas-grekas approved these changes Sep 7, 2020

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Sep 7, 2020

digilist mentioned this pull request Sep 7, 2020

[PropertyInfo] Support multiple types (union types) for collection values #38093

Closed

dunglas approved these changes Sep 8, 2020

View reviewed changes

fabpot mentioned this pull request Sep 9, 2020

[PropertyInfo] fix array types with keys (array<string, string>) symfony/symfony-docs#14205

Closed

fabpot merged commit 80e5a7f into symfony:master Sep 9, 2020

nicolas-grekas modified the milestones: next, 5.2 Oct 5, 2020

fabpot mentioned this pull request Oct 5, 2020

Release v5.2.0-BETA1 #38417

Merged

Korbeil mentioned this pull request Nov 3, 2020

[AutoMapper] Handle dictionary with ArrayTransformer janephp/janephp#433

Merged

guilliamxavier mentioned this pull request Nov 4, 2020

SchemaFactory fail for type @var array<string, string> api-platform/api-platform#1439

Open

guilliamxavier mentioned this pull request Apr 7, 2021

Doc: PHPDoc return tag array type parse error api-platform/core#4190

Closed

MatTheCat mentioned this pull request Aug 19, 2022

[Serializer][PropertyInfo] PHPDocExtractor is failing with array<string, mixed> #47224

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[PropertyInfo] fix array types with keys (array<string, string>) #37559

[PropertyInfo] fix array types with keys (array<string, string>) #37559

digilist commented Jul 11, 2020 •

edited by nicolas-grekas

Loading

digilist Jul 11, 2020

digilist commented Jul 11, 2020 •

edited

Loading

nicolas-grekas commented Jul 12, 2020

MaSpeng commented Aug 20, 2020

nicolas-grekas commented Sep 7, 2020

fabpot commented Sep 9, 2020

ghost commented Sep 16, 2020 •

edited by ghost

Loading

pl-github commented Sep 22, 2020

Marmelatze commented Sep 22, 2020

pl-github commented Sep 22, 2020 •

edited

Loading

aso824 commented Sep 26, 2020 •

edited

Loading

mdeboer commented Oct 6, 2020

[PropertyInfo] fix array types with keys (array<string, string>) #37559

[PropertyInfo] fix array types with keys (array<string, string>) #37559

Conversation

digilist commented Jul 11, 2020 • edited by nicolas-grekas Loading

digilist Jul 11, 2020

Choose a reason for hiding this comment

digilist commented Jul 11, 2020 • edited Loading

nicolas-grekas commented Jul 12, 2020

MaSpeng commented Aug 20, 2020

nicolas-grekas commented Sep 7, 2020

fabpot commented Sep 9, 2020

ghost commented Sep 16, 2020 • edited by ghost Loading

pl-github commented Sep 22, 2020

Marmelatze commented Sep 22, 2020

pl-github commented Sep 22, 2020 • edited Loading

aso824 commented Sep 26, 2020 • edited Loading

mdeboer commented Oct 6, 2020

digilist commented Jul 11, 2020 •

edited by nicolas-grekas

Loading

digilist commented Jul 11, 2020 •

edited

Loading

ghost commented Sep 16, 2020 •

edited by ghost

Loading

pl-github commented Sep 22, 2020 •

edited

Loading

aso824 commented Sep 26, 2020 •

edited

Loading