Add support for compound FQSEN to class-string and interface-string (#249)

mspirkov · web-flow · commit e2de53af74e2 · 2025-11-30T20:54:40.000+01:00
* Add support for compound FQSEN to `class-string` and `interface-string`

* Add tests

* Fix CS

* Add support for any generics to `class-string` and `interface-string`

* Fix CS
diff --git a/src/PseudoTypes/ClassString.php b/src/PseudoTypes/ClassString.php
@@ -13,7 +13,6 @@
 
 namespace phpDocumentor\Reflection\PseudoTypes;
 
-use phpDocumentor\Reflection\Fqsen;
 use phpDocumentor\Reflection\PseudoType;
 use phpDocumentor\Reflection\Type;
 use phpDocumentor\Reflection\Types\String_;
@@ -25,39 +24,33 @@
  */
 final class ClassString extends String_ implements PseudoType
 {
-    /** @var Fqsen|null */
-    private $fqsen;
+    /** @var Type|null */
+    private $genericType;
 
-    /**
-     * Initializes this representation of a class string with the given Fqsen.
-     */
-    public function __construct(?Fqsen $fqsen = null)
+    public function __construct(?Type $genericType = null)
     {
-        $this->fqsen = $fqsen;
+        $this->genericType = $genericType;
     }
 
     public function underlyingType(): Type
     {
         return new String_();
     }
 
-    /**
-     * Returns the FQSEN associated with this object.
-     */
-    public function getFqsen(): ?Fqsen
+    public function getGenericType(): ?Type
     {
-        return $this->fqsen;
+        return $this->genericType;
     }
 
     /**
      * Returns a rendered output of the Type as it would be used in a DocBlock.
      */
     public function __toString(): string
     {
-        if ($this->fqsen === null) {
+        if ($this->genericType === null) {
             return 'class-string';
         }
 
-        return 'class-string<' . (string) $this->fqsen . '>';
+        return 'class-string<' . (string) $this->genericType . '>';
     }
 }
diff --git a/src/PseudoTypes/InterfaceString.php b/src/PseudoTypes/InterfaceString.php
@@ -13,7 +13,6 @@
 
 namespace phpDocumentor\Reflection\PseudoTypes;
 
-use phpDocumentor\Reflection\Fqsen;
 use phpDocumentor\Reflection\PseudoType;
 use phpDocumentor\Reflection\Type;
 use phpDocumentor\Reflection\Types\String_;
@@ -25,39 +24,33 @@
  */
 final class InterfaceString extends String_ implements PseudoType
 {
-    /** @var Fqsen|null */
-    private $fqsen;
+    /** @var Type|null */
+    private $genericType;
 
-    /**
-     * Initializes this representation of a class string with the given Fqsen.
-     */
-    public function __construct(?Fqsen $fqsen = null)
+    public function __construct(?Type $genericType = null)
     {
-        $this->fqsen = $fqsen;
+        $this->genericType = $genericType;
     }
 
     public function underlyingType(): Type
     {
         return new String_();
     }
 
-    /**
-     * Returns the FQSEN associated with this object.
-     */
-    public function getFqsen(): ?Fqsen
+    public function getGenericType(): ?Type
     {
-        return $this->fqsen;
+        return $this->genericType;
     }
 
     /**
      * Returns a rendered output of the Type as it would be used in a DocBlock.
      */
     public function __toString(): string
     {
-        if ($this->fqsen === null) {
+        if ($this->genericType === null) {
             return 'interface-string';
         }
 
-        return 'interface-string<' . (string) $this->fqsen . '>';
+        return 'interface-string<' . (string) $this->genericType . '>';
     }
 }
diff --git a/src/TypeResolver.php b/src/TypeResolver.php
@@ -399,28 +399,10 @@ private function createFromGeneric(GenericTypeNode $type, Context $context): Typ
                 return new NonEmptyArray(...$genericTypes);
 
             case 'class-string':
-                $subType = $this->createType($type->genericTypes[0], $context);
-                if (!$subType instanceof Object_ || $subType->getFqsen() === null) {
-                    throw new RuntimeException(
-                        $subType . ' is not a class string'
-                    );
-                }
-
-                return new ClassString(
-                    $subType->getFqsen()
-                );
+                return new ClassString($this->createType($type->genericTypes[0], $context));
 
             case 'interface-string':
-                $subType = $this->createType($type->genericTypes[0], $context);
-                if (!$subType instanceof Object_ || $subType->getFqsen() === null) {
-                    throw new RuntimeException(
-                        $subType . ' is not a class string'
-                    );
-                }
-
-                return new InterfaceString(
-                    $subType->getFqsen()
-                );
+                return new InterfaceString($this->createType($type->genericTypes[0], $context));
 
             case 'list':
                 return new List_(
diff --git a/tests/unit/PseudoTypes/ClassStringTest.php b/tests/unit/PseudoTypes/ClassStringTest.php
@@ -14,6 +14,8 @@
 namespace phpDocumentor\Reflection\PseudoTypes;
 
 use phpDocumentor\Reflection\Fqsen;
+use phpDocumentor\Reflection\Types\Compound;
+use phpDocumentor\Reflection\Types\Object_;
 use PHPUnit\Framework\TestCase;
 
 /**
@@ -25,19 +27,31 @@ class ClassStringTest extends TestCase
      * @dataProvider provideClassStrings
      * @covers ::__toString
      */
-    public function testClassStringStringifyCorrectly(ClassString $array, string $expectedString): void
+    public function testClassStringStringifyCorrectly(ClassString $type, string $expectedString): void
     {
-        $this->assertSame($expectedString, (string) $array);
+        $this->assertSame($expectedString, (string) $type);
     }
 
     /**
-     * @return mixed[]
+     * @return array<string, array{ClassString, string}>
      */
     public function provideClassStrings(): array
     {
         return [
             'generic class string' => [new ClassString(), 'class-string'],
-            'typed class string' => [new ClassString(new Fqsen('\Foo\Bar')), 'class-string<\Foo\Bar>'],
+            'typed class string' => [
+                new ClassString(new Object_(new Fqsen('\Foo\Bar'))),
+                'class-string<\Foo\Bar>',
+            ],
+            'more than one class' => [
+                new ClassString(
+                    new Compound([
+                        new Object_(new Fqsen('\Foo\Bar')),
+                        new Object_(new Fqsen('\Foo\Barrr')),
+                    ])
+                ),
+                'class-string<\Foo\Bar|\Foo\Barrr>',
+            ],
         ];
     }
 }
diff --git a/tests/unit/PseudoTypes/InterfaceStringTest.php b/tests/unit/PseudoTypes/InterfaceStringTest.php
@@ -14,6 +14,8 @@
 namespace phpDocumentor\Reflection\PseudoTypes;
 
 use phpDocumentor\Reflection\Fqsen;
+use phpDocumentor\Reflection\Types\Compound;
+use phpDocumentor\Reflection\Types\Object_;
 use PHPUnit\Framework\TestCase;
 
 /**
@@ -25,19 +27,31 @@ class InterfaceStringTest extends TestCase
      * @dataProvider provideInterfaceStrings
      * @covers ::__toString
      */
-    public function testInterfaceStringStringifyCorrectly(InterfaceString $array, string $expectedString): void
+    public function testInterfaceStringStringifyCorrectly(InterfaceString $type, string $expectedString): void
     {
-        $this->assertSame($expectedString, (string) $array);
+        $this->assertSame($expectedString, (string) $type);
     }
 
     /**
-     * @return mixed[]
+     * @return array<string, array{InterfaceString, string}>
      */
     public function provideInterfaceStrings(): array
     {
         return [
             'generic interface string' => [new InterfaceString(), 'interface-string'],
-            'typed interface string' => [new InterfaceString(new Fqsen('\Foo\Bar')), 'interface-string<\Foo\Bar>'],
+            'typed interface string' => [
+                new InterfaceString(new Object_(new Fqsen('\Foo\Bar'))),
+                'interface-string<\Foo\Bar>',
+            ],
+            'more than one class' => [
+                new InterfaceString(
+                    new Compound([
+                        new Object_(new Fqsen('\Foo\Bar')),
+                        new Object_(new Fqsen('\Foo\Barrr')),
+                    ])
+                ),
+                'interface-string<\Foo\Bar|\Foo\Barrr>',
+            ],
         ];
     }
 }
diff --git a/tests/unit/TypeResolverTest.php b/tests/unit/TypeResolverTest.php
@@ -112,54 +112,6 @@ public function testResolvingKeywords(string $keyword, string $expectedClass): v
         $this->assertInstanceOf($expectedClass, $resolvedType);
     }
 
-    /**
-     * @uses         \phpDocumentor\Reflection\Types\Context
-     * @uses         \phpDocumentor\Reflection\Types\Object_
-     * @uses         \phpDocumentor\Reflection\Types\String_
-     *
-     * @covers ::__construct
-     * @covers ::resolve
-     * @covers ::createType
-     *
-     * @dataProvider provideClassStrings
-     */
-    public function testResolvingClassStrings(string $classString, bool $throwsException): void
-    {
-        $fixture = new TypeResolver();
-
-        if ($throwsException) {
-            $this->expectException(RuntimeException::class);
-        }
-
-        $resolvedType = $fixture->resolve($classString, new Context(''));
-
-        $this->assertInstanceOf(ClassString::class, $resolvedType);
-    }
-
-    /**
-     * @uses         \phpDocumentor\Reflection\Types\Context
-     * @uses         \phpDocumentor\Reflection\Types\Object_
-     * @uses         \phpDocumentor\Reflection\Types\String_
-     *
-     * @covers ::__construct
-     * @covers ::resolve
-     * @covers ::createType
-     *
-     * @dataProvider provideInterfaceStrings
-     */
-    public function testResolvingInterfaceStrings(string $interfaceString, bool $throwsException): void
-    {
-        $fixture = new TypeResolver();
-
-        if ($throwsException) {
-            $this->expectException(RuntimeException::class);
-        }
-
-        $resolvedType = $fixture->resolve($interfaceString, new Context(''));
-
-        $this->assertInstanceOf(InterfaceString::class, $resolvedType);
-    }
-
     /**
      * @uses         \phpDocumentor\Reflection\Types\Context
      * @uses         \phpDocumentor\Reflection\Types\Object_
@@ -811,34 +763,6 @@ public function provideKeywords(): array
         ];
     }
 
-    /**
-     * Returns a list of class string types and whether they throw an exception.
-     *
-     * @return (string|bool)[][]
-     */
-    public function provideClassStrings(): array
-    {
-        return [
-            ['class-string<\phpDocumentor\Reflection>', false],
-            ['class-string<\phpDocumentor\Reflection\DocBlock>', false],
-            ['class-string<string>', true],
-        ];
-    }
-
-    /**
-     * Returns a list of interface string types and whether they throw an exception.
-     *
-     * @return (string|bool)[][]
-     */
-    public function provideInterfaceStrings(): array
-    {
-        return [
-            ['interface-string<\phpDocumentor\Reflection>', false],
-            ['interface-string<\phpDocumentor\Reflection\DocBlock>', false],
-            ['interface-string<string>', true],
-        ];
-    }
-
     /**
      * Provides a list of FQSENs to test the resolution patterns with.
      *
@@ -1122,15 +1046,37 @@ public function genericsProvider(): array
             ],
             [
                 'class-string',
-                new ClassString(null),
+                new ClassString(),
             ],
             [
                 'class-string<Foo>',
-                new ClassString(new Fqsen('\\phpDocumentor\\Foo')),
+                new ClassString(new Object_(new Fqsen('\\phpDocumentor\\Foo'))),
+            ],
+            [
+                'class-string<Foo|Bar>',
+                new ClassString(
+                    new Compound([
+                        new Object_(new Fqsen('\\phpDocumentor\\Foo')),
+                        new Object_(new Fqsen('\\phpDocumentor\\Bar')),
+                    ])
+                ),
+            ],
+            [
+                'interface-string',
+                new InterfaceString(),
             ],
             [
                 'interface-string<Foo>',
-                new InterfaceString(new Fqsen('\\phpDocumentor\\Foo')),
+                new InterfaceString(new Object_(new Fqsen('\\phpDocumentor\\Foo'))),
+            ],
+            [
+                'interface-string<Foo|Bar>',
+                new InterfaceString(
+                    new Compound([
+                        new Object_(new Fqsen('\\phpDocumentor\\Foo')),
+                        new Object_(new Fqsen('\\phpDocumentor\\Bar')),
+                    ])
+                ),
             ],
             [
                 'List<Foo>',

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,6 @@`
`13`	`13`
`14`	`14`	`namespace phpDocumentor\Reflection\PseudoTypes;`
`15`	`15`
`16`		`-use phpDocumentor\Reflection\Fqsen;`
`17`	`16`	`use phpDocumentor\Reflection\PseudoType;`
`18`	`17`	`use phpDocumentor\Reflection\Type;`
`19`	`18`	`use phpDocumentor\Reflection\Types\String_;`
`@@ -25,39 +24,33 @@`
`25`	`24`	`*/`
`26`	`25`	`final class ClassString extends String_ implements PseudoType`
`27`	`26`	`{`
`28`		`- /** @var Fqsen\|null */`
`29`		`- private $fqsen;`
	`27`	`+ /** @var Type\|null */`
	`28`	`+ private $genericType;`
`30`	`29`
`31`		`- /**`
`32`		`- * Initializes this representation of a class string with the given Fqsen.`
`33`		`- */`
`34`		`- public function __construct(?Fqsen $fqsen = null)`
	`30`	`+ public function __construct(?Type $genericType = null)`
`35`	`31`	`{`
`36`		`- $this->fqsen = $fqsen;`
	`32`	`+ $this->genericType = $genericType;`
`37`	`33`	`}`
`38`	`34`
`39`	`35`	`public function underlyingType(): Type`
`40`	`36`	`{`
`41`	`37`	`return new String_();`
`42`	`38`	`}`
`43`	`39`
`44`		`- /**`
`45`		`- * Returns the FQSEN associated with this object.`
`46`		`- */`
`47`		`- public function getFqsen(): ?Fqsen`
	`40`	`+ public function getGenericType(): ?Type`
`48`	`41`	`{`
`49`		`- return $this->fqsen;`
	`42`	`+ return $this->genericType;`
`50`	`43`	`}`
`51`	`44`
`52`	`45`	`/**`
`53`	`46`	`* Returns a rendered output of the Type as it would be used in a DocBlock.`
`54`	`47`	`*/`
`55`	`48`	`public function __toString(): string`
`56`	`49`	`{`
`57`		`- if ($this->fqsen === null) {`
	`50`	`+ if ($this->genericType === null) {`
`58`	`51`	`return 'class-string';`
`59`	`52`	`}`
`60`	`53`
`61`		`- return 'class-string<' . (string) $this->fqsen . '>';`
	`54`	`+ return 'class-string<' . (string) $this->genericType . '>';`
`62`	`55`	`}`
`63`	`56`	`}`