Merge pull request #1361 from staabm/interfaces

Implement ReflectionClass->getInterfaceClassNames()
Roave · Aug 7, 2023 · 350fb40 · 350fb40
2 parents d96fe51 + dbbd52a
commit 350fb40
Show file tree

Hide file tree

Showing 4 changed files with 110 additions and 0 deletions.
diff --git a/src/Reflection/ReflectionClass.php b/src/Reflection/ReflectionClass.php
@@ -1448,6 +1448,12 @@ private function methodHash(string $className, string $methodName): string
         );
     }
 
+    /** @return list<class-string> */
+    public function getInterfaceClassNames(): array
+    {
+        return $this->implementsClassNames;
+    }
+
     /**
      * Gets the interfaces.
      *

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

diff --git a/test/unit/Fixture/ClassWithMissingInterface.php b/test/unit/Fixture/ClassWithMissingInterface.php
@@ -0,0 +1,8 @@
+<?php
+
+namespace Roave\BetterReflectionTest\Fixture;
+
+class ClassWithMissingInterface implements InterfaceThatDoesNotExist
+{
+
+}
diff --git a/test/unit/Reflection/ReflectionClassTest.php b/test/unit/Reflection/ReflectionClassTest.php
@@ -65,6 +65,7 @@
 use Roave\BetterReflectionTest\Fixture\ClassUsingTraitWithAbstractMethod;
 use Roave\BetterReflectionTest\Fixture\ClassWithAttributes;
 use Roave\BetterReflectionTest\Fixture\ClassWithCaseInsensitiveMethods;
+use Roave\BetterReflectionTest\Fixture\ClassWithMissingInterface;
 use Roave\BetterReflectionTest\Fixture\ClassWithMissingParent;
 use Roave\BetterReflectionTest\Fixture\ClassWithNonAbstractTraitMethodThatOverwritePreviousAbstractTraitMethod;
 use Roave\BetterReflectionTest\Fixture\DefaultProperties;
@@ -425,6 +426,93 @@ public function testGetParentClassWithMissingParent(): void
         $classInfo->getParentClass();
     }
 
+    public function testGetInterfaceNamesWithMissingInterfaceDefinitions(): void
+    {
+        $classInfo = (new DefaultReflector(new SingleFileSourceLocator(
+            __DIR__ . '/../Fixture/ClassWithMissingInterface.php',
+            $this->astLocator,
+        )))->reflectClass(ClassWithMissingInterface::class);
+
+        $this->expectException(IdentifierNotFound::class);
+
+        self::assertNotNull($classInfo->getInterfaceNames());
+    }
+
+    public function testGetInterfacesWithMissingInterfaceDefinitions(): void
+    {
+        $classInfo = (new DefaultReflector(new SingleFileSourceLocator(
+            __DIR__ . '/../Fixture/ClassWithMissingInterface.php',
+            $this->astLocator,
+        )))->reflectClass(ClassWithMissingInterface::class);
+
+        $this->expectException(IdentifierNotFound::class);
+
+        self::assertNotNull($classInfo->getInterfaces());
+    }
+
+    /** @param list<class-string> $expectedInterfaces */
+    #[DataProvider('getInterfaceClassNamesDataProvider')]
+    public function testGetInterfaceClassNames(string $sourcePath, string $className, array $expectedInterfaces): void
+    {
+        $classInfo = (new DefaultReflector(new SingleFileSourceLocator(
+            $sourcePath,
+            $this->astLocator,
+        )))->reflectClass($className);
+
+        self::assertSame(
+            $expectedInterfaces,
+            $classInfo->getInterfaceClassNames(),
+        );
+    }
+
+    /** @return list<array{string, class-string, list<class-string>}> */
+    public static function getInterfaceClassNamesDataProvider(): array
+    {
+        return [
+            [
+                __DIR__ . '/../Fixture/ClassWithMissingInterface.php',
+                ClassWithMissingInterface::class,
+                ['Roave\BetterReflectionTest\Fixture\InterfaceThatDoesNotExist'],
+            ],
+            [
+                __DIR__ . '/../Fixture/ClassWithInterfaces.php',
+                ClassWithInterfaces\ExampleClass::class,
+                [
+                    'Roave\BetterReflectionTest\ClassWithInterfaces\A',
+                    'Roave\BetterReflectionTest\ClassWithInterfacesOther\B',
+                    'Roave\BetterReflectionTest\ClassWithInterfaces\C',
+                    'Roave\BetterReflectionTest\ClassWithInterfacesOther\D',
+                    'E',
+                ],
+            ],
+            [
+                __DIR__ . '/../Fixture/ClassWithInterfaces.php',
+                ClassWithInterfaces\SubExampleClass::class,
+                [],
+            ],
+            [
+                __DIR__ . '/../Fixture/ClassWithInterfaces.php',
+                ClassWithInterfaces\ExampleImplementingCompositeInterface::class,
+                ['Roave\BetterReflectionTest\ClassWithInterfacesExtendingInterfaces\D'],
+            ],
+            [
+                __DIR__ . '/../Fixture/EmptyTrait.php',
+                Fixture\EmptyTrait::class,
+                [],
+            ],
+            [
+                __DIR__ . '/../Fixture/Enums.php',
+                IntEnum::class,
+                ['Roave\BetterReflectionTest\Fixture\InterfaceForEnum'],
+            ],
+            [
+                __DIR__ . '/../Fixture/Enums.php',
+                Fixture\IsDeprecated::class,
+                [],
+            ],
+        ];
+    }
+
     public function testGetMethodsOrder(): void
     {
         $classInfo = (new DefaultReflector(new SingleFileSourceLocator(