[PropertyInfo] Handle collection in PhpStan same as PhpDoc

mtarld · mtarld · commit f098683ce61f · 2024-07-05T09:59:29.000+02:00
diff --git a/src/Symfony/Component/PropertyInfo/Tests/Extractor/PhpDocExtractorTest.php b/src/Symfony/Component/PropertyInfo/Tests/Extractor/PhpDocExtractorTest.php
@@ -17,6 +17,7 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\PropertyInfo\Extractor\PhpDocExtractor;
 use Symfony\Component\PropertyInfo\Tests\Fixtures\Dummy;
+use Symfony\Component\PropertyInfo\Tests\Fixtures\DummyCollection;
 use Symfony\Component\PropertyInfo\Tests\Fixtures\ParentDummy;
 use Symfony\Component\PropertyInfo\Tests\Fixtures\PseudoTypeDummy;
 use Symfony\Component\PropertyInfo\Tests\Fixtures\TraitUsage\DummyUsedInTrait;
@@ -160,6 +161,7 @@ public static function typesProvider()
                 null,
             ],
             ['self', [new Type(Type::BUILTIN_TYPE_OBJECT, false, Dummy::class)], null, null],
+            ['collectionAsObject', [new Type(Type::BUILTIN_TYPE_OBJECT, false, DummyCollection::class, true, [new Type(Type::BUILTIN_TYPE_INT)], [new Type(Type::BUILTIN_TYPE_STRING)])], null, null],
         ];
     }
 
diff --git a/src/Symfony/Component/PropertyInfo/Tests/Extractor/PhpStanExtractorTest.php b/src/Symfony/Component/PropertyInfo/Tests/Extractor/PhpStanExtractorTest.php
@@ -17,6 +17,7 @@
 use Symfony\Component\PropertyInfo\Tests\Fixtures\ConstructorDummyWithoutDocBlock;
 use Symfony\Component\PropertyInfo\Tests\Fixtures\DefaultValue;
 use Symfony\Component\PropertyInfo\Tests\Fixtures\Dummy;
+use Symfony\Component\PropertyInfo\Tests\Fixtures\DummyCollection;
 use Symfony\Component\PropertyInfo\Tests\Fixtures\ParentDummy;
 use Symfony\Component\PropertyInfo\Tests\Fixtures\RootDummy\RootDummyItem;
 use Symfony\Component\PropertyInfo\Tests\Fixtures\TraitUsage\AnotherNamespace\DummyInAnotherNamespace;
@@ -130,6 +131,7 @@ public static function typesProvider()
             ['self', [new Type(Type::BUILTIN_TYPE_OBJECT, false, Dummy::class)]],
             ['rootDummyItems', [new Type(Type::BUILTIN_TYPE_ARRAY, false, null, true, new Type(Type::BUILTIN_TYPE_INT), new Type(Type::BUILTIN_TYPE_OBJECT, false, RootDummyItem::class))]],
             ['rootDummyItem', [new Type(Type::BUILTIN_TYPE_OBJECT, false, RootDummyItem::class)]],
+            ['collectionAsObject', [new Type(Type::BUILTIN_TYPE_OBJECT, false, DummyCollection::class, true, [new Type(Type::BUILTIN_TYPE_INT)], [new Type(Type::BUILTIN_TYPE_STRING)])]],
         ];
     }
 
diff --git a/src/Symfony/Component/PropertyInfo/Tests/Extractor/ReflectionExtractorTest.php b/src/Symfony/Component/PropertyInfo/Tests/Extractor/ReflectionExtractorTest.php
@@ -53,6 +53,7 @@ public function testGetProperties()
                 'bal',
                 'parent',
                 'collection',
+                'collectionAsObject',
                 'nestedCollection',
                 'mixedCollection',
                 'B',
@@ -118,6 +119,7 @@ public function testGetPropertiesWithCustomPrefixes()
                 'bal',
                 'parent',
                 'collection',
+                'collectionAsObject',
                 'nestedCollection',
                 'mixedCollection',
                 'B',
@@ -172,6 +174,7 @@ public function testGetPropertiesWithNoPrefixes()
                 'bal',
                 'parent',
                 'collection',
+                'collectionAsObject',
                 'nestedCollection',
                 'mixedCollection',
                 'B',
diff --git a/src/Symfony/Component/PropertyInfo/Tests/Fixtures/Dummy.php b/src/Symfony/Component/PropertyInfo/Tests/Fixtures/Dummy.php
@@ -46,6 +46,11 @@ class Dummy extends ParentDummy
      */
     public $collection;
 
+    /**
+     * @var DummyCollection<int, string>
+     */
+    public $collectionAsObject;
+
     /**
      * @var string[][]
      */
diff --git a/src/Symfony/Component/PropertyInfo/Tests/Fixtures/DummyCollection.php b/src/Symfony/Component/PropertyInfo/Tests/Fixtures/DummyCollection.php
@@ -0,0 +1,20 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\PropertyInfo\Tests\Fixtures;
+
+final class DummyCollection implements \IteratorAggregate
+{
+    public function getIterator(): \Traversable
+    {
+        return [];
+    }
+}
diff --git a/src/Symfony/Component/PropertyInfo/Util/PhpStanTypeHelper.php b/src/Symfony/Component/PropertyInfo/Util/PhpStanTypeHelper.php
@@ -121,7 +121,7 @@ private function extractTypes(TypeNode $node, NameScope $nameScope): array
                 return [$mainType];
             }
 
-            $collection = $mainType->isCollection() || \in_array($mainType->getClassName(), [\Traversable::class, \Iterator::class, \IteratorAggregate::class, \ArrayAccess::class, \Generator::class], true);
+            $collection = $mainType->isCollection() || \is_a($mainType->getClassName(), \Traversable::class, true) || \is_a($mainType->getClassName(), \ArrayAccess::class, true);
 
             // it's safer to fall back to other extractors if the generic type is too abstract
             if (!$collection && !class_exists($mainType->getClassName())) {

Original file line number	Diff line number	Diff line change
`@@ -121,7 +121,7 @@ private function extractTypes(TypeNode $node, NameScope $nameScope): array`
`121`	`121`	`return [$mainType];`
`122`	`122`	`}`
`123`	`123`
`124`		`- $collection = $mainType->isCollection() \|\| \in_array($mainType->getClassName(), [\Traversable::class, \Iterator::class, \IteratorAggregate::class, \ArrayAccess::class, \Generator::class], true);`
	`124`	`+ $collection = $mainType->isCollection() \|\| \is_a($mainType->getClassName(), \Traversable::class, true) \|\| \is_a($mainType->getClassName(), \ArrayAccess::class, true);`
`125`	`125`
`126`	`126`	`// it's safer to fall back to other extractors if the generic type is too abstract`
`127`	`127`	`if (!$collection && !class_exists($mainType->getClassName())) {`