bug #59681 [TypeInfo] Fix promoted property phpdoc reading (mtarld)

xabbuh · xabbuh · commit 20050496b30f · 2025-02-04T10:10:05.000+01:00
This PR was merged into the 7.2 branch. Discussion ---------- [TypeInfo] Fix promoted property phpdoc reading | Q | A | ------------- | --- | Branch? | 7.2 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | Fix #59650 | License | MIT The read of promoted property's PHPDoc was missing in `PhpDocAwareReflectionTypeResolver`. This PR adds it. Commits ------- 90dc4ee [TypeInfo] Fix promoted property phpdoc reading
diff --git a/src/Symfony/Component/TypeInfo/Tests/Fixtures/DummyWithPhpDoc.php b/src/Symfony/Component/TypeInfo/Tests/Fixtures/DummyWithPhpDoc.php
@@ -9,6 +9,14 @@ final class DummyWithPhpDoc
      */
     public mixed $arrayOfDummies = [];
 
+    /**
+     * @param bool $promoted
+     */
+    public function __construct(
+        public mixed $promoted,
+    ) {
+    }
+
     /**
      * @param Dummy $dummy
      *
diff --git a/src/Symfony/Component/TypeInfo/Tests/TypeResolver/PhpDocAwareReflectionTypeResolverTest.php b/src/Symfony/Component/TypeInfo/Tests/TypeResolver/PhpDocAwareReflectionTypeResolverTest.php
@@ -28,6 +28,7 @@ public function testReadPhpDoc()
         $reflection = new \ReflectionClass(DummyWithPhpDoc::class);
 
         $this->assertEquals(Type::array(Type::object(Dummy::class)), $resolver->resolve($reflection->getProperty('arrayOfDummies')));
+        $this->assertEquals(Type::bool(), $resolver->resolve($reflection->getProperty('promoted')));
         $this->assertEquals(Type::object(Dummy::class), $resolver->resolve($reflection->getMethod('getNextDummy')));
         $this->assertEquals(Type::object(Dummy::class), $resolver->resolve($reflection->getMethod('getNextDummy')->getParameters()[0]));
     }
diff --git a/src/Symfony/Component/TypeInfo/TypeResolver/PhpDocAwareReflectionTypeResolver.php b/src/Symfony/Component/TypeInfo/TypeResolver/PhpDocAwareReflectionTypeResolver.php
@@ -65,7 +65,7 @@ public function resolve(mixed $subject, ?TypeContext $typeContext = null): Type
         }
 
         $docComment = match (true) {
-            $subject instanceof \ReflectionProperty => $subject->getDocComment(),
+            $subject instanceof \ReflectionProperty => $subject->isPromoted() ? $subject->getDeclaringClass()?->getConstructor()?->getDocComment() : $subject->getDocComment(),
             $subject instanceof \ReflectionParameter => $subject->getDeclaringFunction()->getDocComment(),
             $subject instanceof \ReflectionFunctionAbstract => $subject->getDocComment(),
         };
@@ -77,7 +77,7 @@ public function resolve(mixed $subject, ?TypeContext $typeContext = null): Type
         $typeContext ??= $this->typeContextFactory->createFromReflection($subject);
 
         $tagName = match (true) {
-            $subject instanceof \ReflectionProperty => '@var',
+            $subject instanceof \ReflectionProperty => $subject->isPromoted() ? '@param' : '@var',
             $subject instanceof \ReflectionParameter => '@param',
             $subject instanceof \ReflectionFunctionAbstract => '@return',
         };

Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,7 @@ public function testReadPhpDoc()`
`28`	`28`	`$reflection = new \ReflectionClass(DummyWithPhpDoc::class);`
`29`	`29`
`30`	`30`	`$this->assertEquals(Type::array(Type::object(Dummy::class)), $resolver->resolve($reflection->getProperty('arrayOfDummies')));`
	`31`	`+ $this->assertEquals(Type::bool(), $resolver->resolve($reflection->getProperty('promoted')));`
`31`	`32`	`$this->assertEquals(Type::object(Dummy::class), $resolver->resolve($reflection->getMethod('getNextDummy')));`
`32`	`33`	`$this->assertEquals(Type::object(Dummy::class), $resolver->resolve($reflection->getMethod('getNextDummy')->getParameters()[0]));`
`33`	`34`	`}`