Merge pull request #252 from mspirkov/add-enum-string

Add support for `enum-string`

Author: jaapio

src/PseudoTypes/EnumString.php

@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of phpDocumentor.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @link      http://phpdoc.org
+ */
+
+namespace phpDocumentor\Reflection\PseudoTypes;
+
+use phpDocumentor\Reflection\PseudoType;
+use phpDocumentor\Reflection\Type;
+use phpDocumentor\Reflection\Types\String_;
+
+/**
+ * Value Object representing the type 'enum-string'.
+ *
+ * @psalm-immutable
+ */
+final class EnumString extends String_ implements PseudoType
+{
+    /** @var Type|null */
+    private $genericType;
+
+    public function __construct(?Type $genericType = null)
+    {
+        $this->genericType = $genericType;
+    }
+
+    public function underlyingType(): Type
+    {
+        return new String_();
+    }
+
+    public function getGenericType(): ?Type
+    {
+        return $this->genericType;
+    }
+
+    /**
+     * Returns a rendered output of the Type as it would be used in a DocBlock.
+     */
+    public function __toString(): string
+    {
+        if ($this->genericType === null) {
+            return 'enum-string';
+        }
+
+        return 'enum-string<' . (string) $this->genericType . '>';
+    }
+}

src/TypeResolver.php

@@ -23,6 +23,7 @@
 use phpDocumentor\Reflection\PseudoTypes\Conditional;
 use phpDocumentor\Reflection\PseudoTypes\ConditionalForParameter;
 use phpDocumentor\Reflection\PseudoTypes\ConstExpression;
+use phpDocumentor\Reflection\PseudoTypes\EnumString;
 use phpDocumentor\Reflection\PseudoTypes\False_;
 use phpDocumentor\Reflection\PseudoTypes\FloatValue;
 use phpDocumentor\Reflection\PseudoTypes\Generic;
@@ -141,6 +142,7 @@ final class TypeResolver
         'numeric-string' => NumericString::class,
         'numeric' => Numeric_::class,
         'trait-string' => TraitString::class,
+        'enum-string' => EnumString::class,
         'int' => Integer::class,
         'integer' => Integer::class,
         'positive-int' => PositiveInteger::class,
@@ -409,6 +411,9 @@ private function createFromGeneric(GenericTypeNode $type, Context $context): Typ
             case 'trait-string':
                 return new TraitString($this->createType($type->genericTypes[0], $context));
 
+            case 'enum-string':
+                return new EnumString($this->createType($type->genericTypes[0], $context));
+
             case 'list':
                 return new List_(
                     $this->createType($type->genericTypes[0], $context)

tests/unit/TypeResolverTest.php

@@ -23,6 +23,7 @@
 use phpDocumentor\Reflection\PseudoTypes\Conditional;
 use phpDocumentor\Reflection\PseudoTypes\ConditionalForParameter;
 use phpDocumentor\Reflection\PseudoTypes\ConstExpression;
+use phpDocumentor\Reflection\PseudoTypes\EnumString;
 use phpDocumentor\Reflection\PseudoTypes\False_;
 use phpDocumentor\Reflection\PseudoTypes\FloatValue;
 use phpDocumentor\Reflection\PseudoTypes\Generic;
@@ -1132,6 +1133,23 @@ public function genericsProvider(): array
                     ])
                 ),
             ],
+            [
+                'enum-string',
+                new EnumString(),
+            ],
+            [
+                'enum-string<MyEnum>',
+                new EnumString(new Object_(new Fqsen('\\phpDocumentor\\MyEnum'))),
+            ],
+            [
+                'enum-string<MyEnumFirst|MyEnumSecond>',
+                new EnumString(
+                    new Compound([
+                        new Object_(new Fqsen('\\phpDocumentor\\MyEnumFirst')),
+                        new Object_(new Fqsen('\\phpDocumentor\\MyEnumSecond')),
+                    ])
+                ),
+            ],
             [
                 'List<Foo>',
                 new List_(new Object_(new Fqsen('\\phpDocumentor\\Foo'))),