Merge pull request #1362 from staabm/traits

Implement `ReflectionClass#getTraitClassNames()`
Roave · Aug 7, 2023 · 77c68f6 · 77c68f6
2 parents 350fb40 + f89b16b
commit 77c68f6
Show file tree

Hide file tree

Showing 4 changed files with 101 additions and 0 deletions.
diff --git a/src/Reflection/ReflectionClass.php b/src/Reflection/ReflectionClass.php
@@ -1292,6 +1292,12 @@ private function addEnumInterfaces(array $interfaces): array
         return $interfaces;
     }
 
+    /** @return list<trait-string> */
+    public function getTraitClassNames(): array
+    {
+        return $this->traitClassNames;
+    }
+
     /**
      * Get the names of the traits used as an array of strings, if any are
      * defined. If this class does not have any defined traits, this will

diff --git a/src/Reflection/ReflectionObject.php b/src/Reflection/ReflectionObject.php
@@ -364,6 +364,14 @@ public function isInterface(): bool
         return $this->reflectionClass->isInterface();
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    public function getTraitClassNames(): array
+    {
+        return $this->reflectionClass->getTraitClassNames();
+    }
+
     /**
      * {@inheritDoc}
      */

diff --git a/test/unit/Fixture/ClassUsesUnknownTrait.php b/test/unit/Fixture/ClassUsesUnknownTrait.php
@@ -0,0 +1,8 @@
+<?php
+
+namespace Roave\BetterReflectionTest\Fixture;
+
+class ClassUsesUnknownTrait
+{
+    use UnknownTrait;
+}
diff --git a/test/unit/Reflection/ReflectionClassTest.php b/test/unit/Reflection/ReflectionClassTest.php
@@ -88,6 +88,8 @@
 use SplFileInfo;
 use stdClass;
 use Stringable;
+use TraitFixtureA;
+use TraitFixtureC;
 use TypeError;
 use UnitEnum;
 
@@ -1500,6 +1502,83 @@ public function testGetTraitAliases(): void
         ], $classInfo->getTraitAliases());
     }
 
+    public function testGetTraitNamesWithMissingTraitDefinitions(): void
+    {
+        $reflector = new DefaultReflector(new SingleFileSourceLocator(
+            __DIR__ . '/../Fixture/ClassUsesUnknownTrait.php',
+            $this->astLocator,
+        ));
+
+        $this->expectException(IdentifierNotFound::class);
+
+        $reflector->reflectClass(Fixture\ClassUsesUnknownTrait::class)->getTraitNames();
+    }
+
+    public function testGetTraitsWithMissingTraitDefinitions(): void
+    {
+        $reflector = new DefaultReflector(new SingleFileSourceLocator(
+            __DIR__ . '/../Fixture/ClassUsesUnknownTrait.php',
+            $this->astLocator,
+        ));
+
+        $this->expectException(IdentifierNotFound::class);
+
+        $reflector->reflectClass(Fixture\ClassUsesUnknownTrait::class)->getTraits();
+    }
+
+    public function testGetTraitAliasesWithMissingTraitDefinitions(): void
+    {
+        $reflector = new DefaultReflector(new SingleFileSourceLocator(
+            __DIR__ . '/../Fixture/ClassUsesUnknownTrait.php',
+            $this->astLocator,
+        ));
+
+        self::assertSame(
+            [],
+            $reflector->reflectClass(Fixture\ClassUsesUnknownTrait::class)->getTraitAliases(),
+        );
+    }
+
+    /** @param list<class-string> $expectedTraits */
+    #[DataProvider('getTraitClassNamesDataProvider')]
+    public function testGetTraitClassNames(string $sourcePath, string $className, array $expectedTraits): void
+    {
+        $reflector = new DefaultReflector(new SingleFileSourceLocator(
+            $sourcePath,
+            $this->astLocator,
+        ));
+
+        self::assertSame(
+            $expectedTraits,
+            $reflector->reflectClass($className)->getTraitClassNames(),
+        );
+    }
+
+    /** @return list<array{string, class-string, list<class-string>}> */
+    public static function getTraitClassNamesDataProvider(): array
+    {
+        return [
+            [
+                __DIR__ . '/../Fixture/ClassUsesUnknownTrait.php',
+                Fixture\ClassUsesUnknownTrait::class,
+                ['Roave\BetterReflectionTest\Fixture\UnknownTrait'],
+            ],
+            [
+                __DIR__ . '/../Fixture/TraitFixture.php',
+                TraitFixtureA::class,
+                ['TraitFixtureTraitA'],
+            ],
+            [
+                __DIR__ . '/../Fixture/TraitFixture.php',
+                TraitFixtureC::class,
+                [
+                    'TraitFixtureTraitC',
+                    'TraitFixtureTraitC3',
+                ],
+            ],
+        ];
+    }
+
     public function testMethodsFromTraits(): void
     {
         $reflector = new DefaultReflector(new SingleFileSourceLocator(