bug #40811 [PropertyInfo] Use the right context for methods defined in traits (colinodell)

nicolas-grekas · nicolas-grekas · commit 236e61b620a1 · 2021-04-14T19:13:01.000+02:00
This PR was merged into the 4.4 branch. Discussion ---------- [PropertyInfo] Use the right context for methods defined in traits | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | Fix #34191 | License | MIT | Doc PR | Pull request #40175 only partially fixed #34191 - it solved the problem for properties used in traits but it did not address the same issue with methods. I have therefore applied the same style of fix and confirmed it works properly with tests. Commits ------- c7e9493 [PropertyInfo] Use the right context for methods defined in traits
diff --git a/src/Symfony/Component/PropertyInfo/Extractor/PhpDocExtractor.php b/src/Symfony/Component/PropertyInfo/Extractor/PhpDocExtractor.php
@@ -269,7 +269,17 @@ private function getDocBlockFromMethod(string $class, string $ucFirstProperty, i
         }
 
         try {
-            return [$this->docBlockFactory->create($reflectionMethod, $this->createFromReflector($reflectionMethod->getDeclaringClass())), $prefix];
+            $reflector = $reflectionMethod->getDeclaringClass();
+
+            foreach ($reflector->getTraits() as $trait) {
+                if ($trait->hasMethod($methodName)) {
+                    $reflector = $trait;
+
+                    break;
+                }
+            }
+
+            return [$this->docBlockFactory->create($reflectionMethod, $this->createFromReflector($reflector)), $prefix];
         } catch (\InvalidArgumentException $e) {
             return null;
         } catch (\RuntimeException $e) {
diff --git a/src/Symfony/Component/PropertyInfo/Tests/Extractor/PhpDocExtractorTest.php b/src/Symfony/Component/PropertyInfo/Tests/Extractor/PhpDocExtractorTest.php
@@ -295,6 +295,23 @@ public function propertiesDefinedByTraitsProvider(): array
         ];
     }
 
+    /**
+     * @dataProvider methodsDefinedByTraitsProvider
+     */
+    public function testMethodsDefinedByTraits(string $property, Type $type)
+    {
+        $this->assertEquals([$type], $this->extractor->getTypes(DummyUsingTrait::class, $property));
+    }
+
+    public function methodsDefinedByTraitsProvider(): array
+    {
+        return [
+            ['methodInTraitPrimitiveType', new Type(Type::BUILTIN_TYPE_STRING)],
+            ['methodInTraitObjectSameNamespace', new Type(Type::BUILTIN_TYPE_OBJECT, false, DummyUsedInTrait::class)],
+            ['methodInTraitObjectDifferentNamespace', new Type(Type::BUILTIN_TYPE_OBJECT, false, Dummy::class)],
+        ];
+    }
+
     /**
      * @dataProvider propertiesStaticTypeProvider
      */
diff --git a/src/Symfony/Component/PropertyInfo/Tests/Fixtures/TraitUsage/DummyTrait.php b/src/Symfony/Component/PropertyInfo/Tests/Fixtures/TraitUsage/DummyTrait.php
@@ -29,4 +29,28 @@ trait DummyTrait
      * @var Dummy
      */
     private $propertyInTraitObjectDifferentNamespace;
+
+    /**
+     * @return string
+     */
+    public function getMethodInTraitPrimitiveType()
+    {
+        return 'value';
+    }
+
+    /**
+     * @return DummyUsedInTrait
+     */
+    public function getMethodInTraitObjectSameNamespace()
+    {
+        return new DummyUsedInTrait();
+    }
+
+    /**
+     * @return Dummy
+     */
+    public function getMethodInTraitObjectDifferentNamespace()
+    {
+        return new Dummy();
+    }
 }
