Refactor pseudo-types

src/Types/ArrayKey.php → src/PseudoTypes/ArrayKey.php

@@ -11,15 +11,17 @@
  * @link      http://phpdoc.org
  */
 
-namespace phpDocumentor\Reflection\Types;
+namespace phpDocumentor\Reflection\PseudoTypes;
 
 use phpDocumentor\Reflection\PseudoType;
 use phpDocumentor\Reflection\Type;
+use phpDocumentor\Reflection\Types\AggregatedType;
+use phpDocumentor\Reflection\Types\Compound;
+use phpDocumentor\Reflection\Types\Integer;
+use phpDocumentor\Reflection\Types\String_;
 
 /**
- * Value Object representing a array-key Type.
- *
- * A array-key Type is the supertype (but not a union) of int and string.
+ * Value Object representing the type `array-key`.
  *
  * @psalm-immutable
  */

src/PseudoTypes/ArrayShape.php

@@ -16,7 +16,6 @@
 use phpDocumentor\Reflection\PseudoType;
 use phpDocumentor\Reflection\Type;
 use phpDocumentor\Reflection\Types\Array_;
-use phpDocumentor\Reflection\Types\ArrayKey;
 use phpDocumentor\Reflection\Types\Mixed_;
 
 use function implode;

src/PseudoTypes/CallableString.php

@@ -18,7 +18,7 @@
 use phpDocumentor\Reflection\Types\String_;
 
 /**
- * Value Object representing the type 'string'.
+ * Value Object representing the type 'callable-string'.
  *
  * @psalm-immutable
  */

src/Types/ClassString.php → src/PseudoTypes/ClassString.php

@@ -11,14 +11,15 @@
  * @link      http://phpdoc.org
  */
 
-namespace phpDocumentor\Reflection\Types;
+namespace phpDocumentor\Reflection\PseudoTypes;
 
 use phpDocumentor\Reflection\Fqsen;
 use phpDocumentor\Reflection\PseudoType;
 use phpDocumentor\Reflection\Type;
+use phpDocumentor\Reflection\Types\String_;
 
 /**
- * Value Object representing the type 'string'.
+ * Value Object representing the type 'class-string'.
  *
  * @psalm-immutable
  */

src/PseudoTypes/HtmlEscapedString.php

@@ -18,7 +18,7 @@
 use phpDocumentor\Reflection\Types\String_;
 
 /**
- * Value Object representing the type 'string'.
+ * Value Object representing the type 'html-escaped-string'.
  *
  * @psalm-immutable
  */

src/Types/InterfaceString.php → src/PseudoTypes/InterfaceString.php

@@ -11,17 +11,19 @@
  * @link      http://phpdoc.org
  */
 
-namespace phpDocumentor\Reflection\Types;
+namespace phpDocumentor\Reflection\PseudoTypes;
 
 use phpDocumentor\Reflection\Fqsen;
+use phpDocumentor\Reflection\PseudoType;
 use phpDocumentor\Reflection\Type;
+use phpDocumentor\Reflection\Types\String_;
 
 /**
- * Value Object representing the type 'string'.
+ * Value Object representing the type `interface-string`.
  *
  * @psalm-immutable
  */
-final class InterfaceString implements Type
+final class InterfaceString extends String_ implements PseudoType
 {
     /** @var Fqsen|null */
     private $fqsen;
@@ -34,6 +36,11 @@ public function __construct(?Fqsen $fqsen = null)
         $this->fqsen = $fqsen;
     }
 
+    public function underlyingType(): Type
+    {
+        return new String_();
+    }
+
     /**
      * Returns the FQSEN associated with this object.
      */

src/PseudoTypes/KeyOf.php

@@ -15,7 +15,6 @@
 
 use phpDocumentor\Reflection\PseudoType;
 use phpDocumentor\Reflection\Type;
-use phpDocumentor\Reflection\Types\ArrayKey;
 
 /**
  * Value Object representing the `key-of` type.

src/PseudoTypes/LiteralString.php

@@ -18,7 +18,7 @@
 use phpDocumentor\Reflection\Types\String_;
 
 /**
- * Value Object representing the type 'string'.
+ * Value Object representing the type 'literal-string'.
  *
  * @psalm-immutable
  */

src/PseudoTypes/LowercaseString.php

@@ -18,7 +18,7 @@
 use phpDocumentor\Reflection\Types\String_;
 
 /**
- * Value Object representing the type 'string'.
+ * Value Object representing the type 'lowercase-string'.
  *
  * @psalm-immutable
  */

src/PseudoTypes/NonEmptyLowercaseString.php

@@ -18,7 +18,7 @@
 use phpDocumentor\Reflection\Types\String_;
 
 /**
- * Value Object representing the type 'string'.
+ * Value Object representing the type 'non-empty-lowercase-string'.
  *
  * @psalm-immutable
  */

src/PseudoTypes/NonEmptyString.php

@@ -18,7 +18,7 @@
 use phpDocumentor\Reflection\Types\String_;
 
 /**
- * Value Object representing the type 'string'.
+ * Value Object representing the type 'non-empty-string'.
  *
  * @psalm-immutable
  */

src/PseudoTypes/NumericString.php

@@ -18,7 +18,7 @@
 use phpDocumentor\Reflection\Types\String_;
 
 /**
- * Value Object representing the type 'string'.
+ * Value Object representing the type 'numeric-string'.
  *
  * @psalm-immutable
  */

src/PseudoTypes/TraitString.php

@@ -18,7 +18,7 @@
 use phpDocumentor\Reflection\Types\String_;
 
 /**
- * Value Object representing the type 'string'.
+ * Value Object representing the type `trait-string`.
  *
  * @psalm-immutable
  */

src/TypeResolver.php

@@ -15,9 +15,11 @@
 
 use Doctrine\Deprecations\Deprecation;
 use InvalidArgumentException;
+use phpDocumentor\Reflection\PseudoTypes\ArrayKey;
 use phpDocumentor\Reflection\PseudoTypes\ArrayShape;
 use phpDocumentor\Reflection\PseudoTypes\ArrayShapeItem;
 use phpDocumentor\Reflection\PseudoTypes\CallableString;
+use phpDocumentor\Reflection\PseudoTypes\ClassString;
 use phpDocumentor\Reflection\PseudoTypes\Conditional;
 use phpDocumentor\Reflection\PseudoTypes\ConditionalForParameter;
 use phpDocumentor\Reflection\PseudoTypes\ConstExpression;
@@ -28,6 +30,7 @@
 use phpDocumentor\Reflection\PseudoTypes\HtmlEscapedString;
 use phpDocumentor\Reflection\PseudoTypes\IntegerRange;
 use phpDocumentor\Reflection\PseudoTypes\IntegerValue;
+use phpDocumentor\Reflection\PseudoTypes\InterfaceString;
 use phpDocumentor\Reflection\PseudoTypes\IntMask;
 use phpDocumentor\Reflection\PseudoTypes\IntMaskOf;
 use phpDocumentor\Reflection\PseudoTypes\KeyOf;
@@ -53,17 +56,14 @@
 use phpDocumentor\Reflection\PseudoTypes\ValueOf;
 use phpDocumentor\Reflection\Types\AggregatedType;
 use phpDocumentor\Reflection\Types\Array_;
-use phpDocumentor\Reflection\Types\ArrayKey;
 use phpDocumentor\Reflection\Types\Boolean;
 use phpDocumentor\Reflection\Types\Callable_;
 use phpDocumentor\Reflection\Types\CallableParameter;
-use phpDocumentor\Reflection\Types\ClassString;
 use phpDocumentor\Reflection\Types\Compound;
 use phpDocumentor\Reflection\Types\Context;
 use phpDocumentor\Reflection\Types\Expression;
 use phpDocumentor\Reflection\Types\Float_;
 use phpDocumentor\Reflection\Types\Integer;
-use phpDocumentor\Reflection\Types\InterfaceString;
 use phpDocumentor\Reflection\Types\Intersection;
 use phpDocumentor\Reflection\Types\Iterable_;
 use phpDocumentor\Reflection\Types\Mixed_;

tests/unit/Types/ArrayKeyTest.php → tests/unit/PseudoTypes/ArrayKeyTest.php

@@ -11,12 +11,14 @@
  * @link      http://phpdoc.org
  */
 
-namespace phpDocumentor\Reflection\Types;
+namespace phpDocumentor\Reflection\PseudoTypes;
 
+use phpDocumentor\Reflection\Types\Integer;
+use phpDocumentor\Reflection\Types\String_;
 use PHPUnit\Framework\TestCase;
 
 /**
- * @coversDefaultClass \phpDocumentor\Reflection\Types\ArrayKey
+ * @coversDefaultClass \phpDocumentor\Reflection\PseudoTypes\ArrayKey
  */
 final class ArrayKeyTest extends TestCase
 {
@@ -30,7 +32,7 @@ public function testArrayKeyCanBeConstructedAndStringifiedCorrectly(): void
     }
 
     /**
-     * @uses \phpDocumentor\Reflection\Types\ArrayKey::__construct
+     * @uses \phpDocumentor\Reflection\PseudoTypes\ArrayKey::__construct
      *
      * @covers ::getIterator
      */

tests/unit/Types/ClassStringTest.php → tests/unit/PseudoTypes/ClassStringTest.php

@@ -11,13 +11,13 @@
  * @link      http://phpdoc.org
  */
 
-namespace phpDocumentor\Reflection\Types;
+namespace phpDocumentor\Reflection\PseudoTypes;
 
 use phpDocumentor\Reflection\Fqsen;
 use PHPUnit\Framework\TestCase;
 
 /**
- * @coversDefaultClass \phpDocumentor\Reflection\Types\ClassString
+ * @coversDefaultClass \phpDocumentor\Reflection\PseudoTypes\ClassString
  */
 class ClassStringTest extends TestCase
 {

tests/unit/Types/InterfaceStringTest.php → tests/unit/PseudoTypes/InterfaceStringTest.php

@@ -11,13 +11,13 @@
  * @link      http://phpdoc.org
  */
 
-namespace phpDocumentor\Reflection\Types;
+namespace phpDocumentor\Reflection\PseudoTypes;
 
 use phpDocumentor\Reflection\Fqsen;
 use PHPUnit\Framework\TestCase;
 
 /**
- * @coversDefaultClass \phpDocumentor\Reflection\Types\InterfaceString
+ * @coversDefaultClass \phpDocumentor\Reflection\PseudoTypes\InterfaceString
  */
 class InterfaceStringTest extends TestCase
 {

tests/unit/TypeResolverTest.php

@@ -15,9 +15,11 @@
 
 use Doctrine\Deprecations\PHPUnit\VerifyDeprecations;
 use InvalidArgumentException;
+use phpDocumentor\Reflection\PseudoTypes\ArrayKey;
 use phpDocumentor\Reflection\PseudoTypes\ArrayShape;
 use phpDocumentor\Reflection\PseudoTypes\ArrayShapeItem;
 use phpDocumentor\Reflection\PseudoTypes\CallableString;
+use phpDocumentor\Reflection\PseudoTypes\ClassString;
 use phpDocumentor\Reflection\PseudoTypes\Conditional;
 use phpDocumentor\Reflection\PseudoTypes\ConditionalForParameter;
 use phpDocumentor\Reflection\PseudoTypes\ConstExpression;
@@ -27,6 +29,7 @@
 use phpDocumentor\Reflection\PseudoTypes\HtmlEscapedString;
 use phpDocumentor\Reflection\PseudoTypes\IntegerRange;
 use phpDocumentor\Reflection\PseudoTypes\IntegerValue;
+use phpDocumentor\Reflection\PseudoTypes\InterfaceString;
 use phpDocumentor\Reflection\PseudoTypes\IntMask;
 use phpDocumentor\Reflection\PseudoTypes\IntMaskOf;
 use phpDocumentor\Reflection\PseudoTypes\KeyOf;
@@ -51,17 +54,14 @@
 use phpDocumentor\Reflection\PseudoTypes\True_;
 use phpDocumentor\Reflection\PseudoTypes\ValueOf;
 use phpDocumentor\Reflection\Types\Array_;
-use phpDocumentor\Reflection\Types\ArrayKey;
 use phpDocumentor\Reflection\Types\Boolean;
 use phpDocumentor\Reflection\Types\Callable_;
 use phpDocumentor\Reflection\Types\CallableParameter;
-use phpDocumentor\Reflection\Types\ClassString;
 use phpDocumentor\Reflection\Types\Compound;
 use phpDocumentor\Reflection\Types\Context;
 use phpDocumentor\Reflection\Types\Expression;
 use phpDocumentor\Reflection\Types\Float_;
 use phpDocumentor\Reflection\Types\Integer;
-use phpDocumentor\Reflection\Types\InterfaceString;
 use phpDocumentor\Reflection\Types\Intersection;
 use phpDocumentor\Reflection\Types\Iterable_;
 use phpDocumentor\Reflection\Types\Mixed_;