[PropertyInfo] Fixed promoted property type detection for PhpStanExtractor

LastDragon-ru · nicolas-grekas · commit 430ec797ee36 · 2023-11-24T12:57:32.000+01:00
diff --git a/src/Symfony/Component/PropertyInfo/Extractor/PhpStanExtractor.php b/src/Symfony/Component/PropertyInfo/Extractor/PhpStanExtractor.php
@@ -183,9 +183,7 @@ private function getDocBlockFromConstructor(string $class, string $property): ?P
             return null;
         }
 
-        $tokens = new TokenIterator($this->lexer->tokenize($rawDocNode));
-        $phpDocNode = $this->phpDocParser->parse($tokens);
-        $tokens->consumeTokenType(Lexer::TOKEN_END);
+        $phpDocNode = $this->getPhpDocNode($rawDocNode);
 
         return $this->filterDocBlockParams($phpDocNode, $property);
     }
@@ -239,24 +237,27 @@ private function getDocBlockFromProperty(string $class, string $property): ?arra
             return null;
         }
 
+        // Type can be inside property docblock as `@var`
+        $rawDocNode = $reflectionProperty->getDocComment();
+        $phpDocNode = $rawDocNode ? $this->getPhpDocNode($rawDocNode) : null;
         $source = self::PROPERTY;
 
-        if ($reflectionProperty->isPromoted()) {
+        if (!$phpDocNode?->getTagsByName('@var')) {
+            $phpDocNode = null;
+        }
+
+        // or in the constructor as `@param` for promoted properties
+        if (!$phpDocNode && $reflectionProperty->isPromoted()) {
             $constructor = new \ReflectionMethod($class, '__construct');
             $rawDocNode = $constructor->getDocComment();
+            $phpDocNode = $rawDocNode ? $this->getPhpDocNode($rawDocNode) : null;
             $source = self::MUTATOR;
-        } else {
-            $rawDocNode = $reflectionProperty->getDocComment();
         }
 
-        if (!$rawDocNode) {
+        if (!$phpDocNode) {
             return null;
         }
 
-        $tokens = new TokenIterator($this->lexer->tokenize($rawDocNode));
-        $phpDocNode = $this->phpDocParser->parse($tokens);
-        $tokens->consumeTokenType(Lexer::TOKEN_END);
-
         return [$phpDocNode, $source, $reflectionProperty->class];
     }
 
@@ -296,10 +297,17 @@ private function getDocBlockFromMethod(string $class, string $ucFirstProperty, i
             return null;
         }
 
+        $phpDocNode = $this->getPhpDocNode($rawDocNode);
+
+        return [$phpDocNode, $prefix, $reflectionMethod->class];
+    }
+
+    private function getPhpDocNode(string $rawDocNode): PhpDocNode
+    {
         $tokens = new TokenIterator($this->lexer->tokenize($rawDocNode));
         $phpDocNode = $this->phpDocParser->parse($tokens);
         $tokens->consumeTokenType(Lexer::TOKEN_END);
 
-        return [$phpDocNode, $prefix, $reflectionMethod->class];
+        return $phpDocNode;
     }
 }
diff --git a/src/Symfony/Component/PropertyInfo/Tests/Extractor/PhpStanExtractorTest.php b/src/Symfony/Component/PropertyInfo/Tests/Extractor/PhpStanExtractorTest.php
@@ -474,6 +474,8 @@ public function testExtractPhp80Type(string $class, $property, array $type = nul
     public static function php80TypesProvider()
     {
         return [
+            [Php80Dummy::class, 'promotedWithDocCommentAndType', [new Type(Type::BUILTIN_TYPE_INT)]],
+            [Php80Dummy::class, 'promotedWithDocComment', [new Type(Type::BUILTIN_TYPE_STRING)]],
             [Php80Dummy::class, 'promotedAndMutated', [new Type(Type::BUILTIN_TYPE_STRING)]],
             [Php80Dummy::class, 'promoted', null],
             [Php80Dummy::class, 'collection', [new Type(Type::BUILTIN_TYPE_ARRAY, collection: true, collectionValueType: new Type(Type::BUILTIN_TYPE_STRING))]],
diff --git a/src/Symfony/Component/PropertyInfo/Tests/Fixtures/Php80Dummy.php b/src/Symfony/Component/PropertyInfo/Tests/Fixtures/Php80Dummy.php
@@ -17,9 +17,23 @@ class Php80Dummy
 
     /**
      * @param string $promotedAndMutated
+     * @param string $promotedWithDocComment
+     * @param string $promotedWithDocCommentAndType
      * @param array<string> $collection
      */
-    public function __construct(private mixed $promoted, private mixed $promotedAndMutated, private array $collection)
+    public function __construct(
+        private mixed $promoted,
+        private mixed $promotedAndMutated,
+        /**
+         * Comment without @var.
+         */
+        private mixed $promotedWithDocComment,
+        /**
+         * @var int
+         */
+        private mixed $promotedWithDocCommentAndType,
+        private array $collection,
+    )
     {
     }
 

Original file line number	Diff line number	Diff line change
`@@ -474,6 +474,8 @@ public function testExtractPhp80Type(string $class, $property, array $type = nul`
`474`	`474`	`public static function php80TypesProvider()`
`475`	`475`	`{`
`476`	`476`	`return [`
	`477`	`+ [Php80Dummy::class, 'promotedWithDocCommentAndType', [new Type(Type::BUILTIN_TYPE_INT)]],`
	`478`	`+ [Php80Dummy::class, 'promotedWithDocComment', [new Type(Type::BUILTIN_TYPE_STRING)]],`
`477`	`479`	`[Php80Dummy::class, 'promotedAndMutated', [new Type(Type::BUILTIN_TYPE_STRING)]],`
`478`	`480`	`[Php80Dummy::class, 'promoted', null],`
`479`	`481`	`[Php80Dummy::class, 'collection', [new Type(Type::BUILTIN_TYPE_ARRAY, collection: true, collectionValueType: new Type(Type::BUILTIN_TYPE_STRING))]],`