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

fabpot · fabpot · commit 80e5a7fbd80e · 2020-09-09T07:17:12.000+02:00
This PR was merged into the 5.2-dev branch. Discussion ---------- [PropertyInfo] fix array types with keys (array<string, string>) | 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?) Commits ------- 64f7bd7 [PropertyInfo] fix array types with keys (array<string, string>)
diff --git a/src/Symfony/Component/PropertyInfo/Tests/Extractor/PhpDocExtractorTest.php b/src/Symfony/Component/PropertyInfo/Tests/Extractor/PhpDocExtractorTest.php
@@ -150,6 +150,39 @@ public function provideCollectionTypes()
                 null,
                 null,
             ],
+            [
+                'arrayWithKeys',
+                [new Type(
+                    Type::BUILTIN_TYPE_ARRAY,
+                    false,
+                    null,
+                    true,
+                    new Type(Type::BUILTIN_TYPE_STRING),
+                    new Type(Type::BUILTIN_TYPE_STRING)
+                )],
+                null,
+                null,
+            ],
+            [
+                'arrayWithKeysAndComplexValue',
+                [new Type(
+                    Type::BUILTIN_TYPE_ARRAY,
+                    false,
+                    null,
+                    true,
+                    new Type(Type::BUILTIN_TYPE_STRING),
+                    new Type(
+                        Type::BUILTIN_TYPE_ARRAY,
+                        true,
+                        null,
+                        true,
+                        new Type(Type::BUILTIN_TYPE_INT),
+                        new Type(Type::BUILTIN_TYPE_STRING, true)
+                    )
+                )],
+                null,
+                null,
+            ],
         ];
     }
 
diff --git a/src/Symfony/Component/PropertyInfo/Tests/Extractor/ReflectionExtractorTest.php b/src/Symfony/Component/PropertyInfo/Tests/Extractor/ReflectionExtractorTest.php
@@ -63,6 +63,8 @@ public function testGetProperties()
                 'iteratorCollection',
                 'iteratorCollectionWithKey',
                 'nestedIterators',
+                'arrayWithKeys',
+                'arrayWithKeysAndComplexValue',
                 'foo',
                 'foo2',
                 'foo3',
@@ -111,6 +113,8 @@ public function testGetPropertiesWithCustomPrefixes()
                 'iteratorCollection',
                 'iteratorCollectionWithKey',
                 'nestedIterators',
+                'arrayWithKeys',
+                'arrayWithKeysAndComplexValue',
                 'foo',
                 'foo2',
                 'foo3',
@@ -149,6 +153,8 @@ public function testGetPropertiesWithNoPrefixes()
                 'iteratorCollection',
                 'iteratorCollectionWithKey',
                 'nestedIterators',
+                'arrayWithKeys',
+                'arrayWithKeysAndComplexValue',
                 'foo',
                 'foo2',
                 'foo3',
diff --git a/src/Symfony/Component/PropertyInfo/Tests/Fixtures/Dummy.php b/src/Symfony/Component/PropertyInfo/Tests/Fixtures/Dummy.php
@@ -130,6 +130,16 @@ class Dummy extends ParentDummy
      */
     public $nestedIterators;
 
+    /**
+     * @var array<string,string>
+     */
+    public $arrayWithKeys;
+
+    /**
+     * @var array<string,array<integer,null|string>|null>
+     */
+    public $arrayWithKeysAndComplexValue;
+
     public static function getStatic()
     {
     }
diff --git a/src/Symfony/Component/PropertyInfo/Util/PhpDocTypeHelper.php b/src/Symfony/Component/PropertyInfo/Util/PhpDocTypeHelper.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\PropertyInfo\Util;
 
 use phpDocumentor\Reflection\Type as DocType;
+use phpDocumentor\Reflection\Types\Array_;
 use phpDocumentor\Reflection\Types\Collection;
 use phpDocumentor\Reflection\Types\Compound;
 use phpDocumentor\Reflection\Types\Null_;
@@ -109,12 +110,23 @@ private function createType(DocType $type, bool $nullable, string $docType = nul
         }
 
         if ('[]' === substr($docType, -2)) {
-            if ('mixed[]' === $docType) {
-                $collectionKeyType = null;
+            $collectionKeyType = new Type(Type::BUILTIN_TYPE_INT);
+            $collectionValueType = $this->createType($type, false, substr($docType, 0, -2));
+
+            return new Type(Type::BUILTIN_TYPE_ARRAY, $nullable, null, true, $collectionKeyType, $collectionValueType);
+        }
+
+        if (0 === strpos($docType, 'array<') && $type instanceof Array_) {
+            // array<value> is converted to x[] which is handled above
+            // so it's only necessary to handle array<key, value> here
+            $collectionKeyType = $this->getTypes($type->getKeyType())[0];
+
+            $collectionValueTypes = $this->getTypes($type->getValueType());
+            if (\count($collectionValueTypes) > 1) {
+                // the Type class does not support union types yet, so assume that no type was defined
                 $collectionValueType = null;
             } else {
-                $collectionKeyType = new Type(Type::BUILTIN_TYPE_INT);
-                $collectionValueType = $this->createType($type, false, substr($docType, 0, -2));
+                $collectionValueType = $collectionValueTypes[0];
             }
 
             return new Type(Type::BUILTIN_TYPE_ARRAY, $nullable, null, true, $collectionKeyType, $collectionValueType);
@@ -160,6 +172,6 @@ private function getPhpTypeAndClass(string $docType): array
             return [$docType, null];
         }
 
-        return ['object', substr($docType, 1)];
+        return ['object', substr($docType, 1)]; // substr to strip the namespace's `\`-prefix
     }
 }
