ClassReflection - getBackedEnumType() method

phpstan · Jan 15, 2022 · a0ed2d3 · a0ed2d3
1 parent 0eb9a63
commit a0ed2d3
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 0 deletions.
diff --git a/src/Reflection/ClassReflection.php b/src/Reflection/ClassReflection.php
@@ -29,6 +29,7 @@
 use PHPStan\Type\Generic\TemplateTypeScope;
 use PHPStan\Type\Type;
 use PHPStan\Type\TypeAlias;
+use PHPStan\Type\TypehintHelper;
 use PHPStan\Type\VerbosityLevel;
 use ReflectionClass;
 use ReflectionEnum;
@@ -512,6 +513,24 @@ public function isBackedEnum(): bool
 		return $this->reflection->isBacked();
 	}
 
+	public function getBackedEnumType(): ?Type
+	{
+		if (!$this->reflection instanceof ReflectionEnum) {
+			return null;
+		}
+
+		if (!$this->reflection->isBacked()) {
+			return null;
+		}
+
+		$reflectionType = $this->reflection->getBackingType();
+		if ($reflectionType === null) {
+			return null;
+		}
+
+		return TypehintHelper::decideTypeFromReflection($reflectionType);
+	}
+
 	public function hasEnumCase(string $name): bool
 	{
 		if (!$this->isEnum()) {

diff --git a/tests/PHPStan/Reflection/ClassReflectionTest.php b/tests/PHPStan/Reflection/ClassReflectionTest.php
@@ -33,6 +33,7 @@
 use PHPStan\PhpDoc\StubPhpDocProvider;
 use PHPStan\Testing\PHPStanTestCase;
 use PHPStan\Type\FileTypeMapper;
+use PHPStan\Type\IntegerType;
 use ReflectionClass;
 use ReflectionEnum;
 use WrongClassConstantFile\SecuredRouter;
@@ -339,4 +340,15 @@ public function testEnumIsFinal(): void
 		$this->assertTrue($enum->isFinalByKeyword());
 	}
 
+	public function testBackedEnumType(): void
+	{
+		if (PHP_VERSION_ID < 80100) {
+			$this->markTestSkipped('Test requires PHP 8.1.');
+		}
+
+		$reflectionProvider = $this->createReflectionProvider();
+		$enum = $reflectionProvider->getClass('PHPStan\Fixture\TestEnum');
+		$this->assertInstanceOf(IntegerType::class, $enum->getBackedEnumType());
+	}
+
 }