Merge pull request #1380 from forrest79/unable-to-get-enum-value

Better exception message for when default value is an enum
Roave · Dec 7, 2023 · 92e9cbd · 92e9cbd
2 parents 7a7c9c3 + 2ae41b8
commit 92e9cbd
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 0 deletions.
diff --git a/src/NodeCompiler/CompileNodeToValue.php b/src/NodeCompiler/CompileNodeToValue.php
@@ -244,6 +244,10 @@ private function getClassConstantValue(Node\Expr\ClassConstFetch $node, string|n
         $classContext    = $context->getClass();
         $classReflection = $classContext !== null && $classContext->getName() === $className ? $classContext : $context->getReflector()->reflectClass($className);
 
+        if ($classReflection instanceof ReflectionEnum) {
+            throw Exception\UnableToCompileNode::becauseOfValueIsEnum($context, $classReflection, $node);
+        }
+
         $reflectionConstant = $classReflection->getConstant($constantName);
 
         if (! $reflectionConstant instanceof ReflectionClassConstant) {

diff --git a/src/NodeCompiler/Exception/UnableToCompileNode.php b/src/NodeCompiler/Exception/UnableToCompileNode.php
@@ -112,6 +112,23 @@ public static function becauseOfInitializer(
         ));
     }
 
+    public static function becauseOfValueIsEnum(
+        CompilerContext $fetchContext,
+        ReflectionClass $targetClass,
+        Node\Expr\ClassConstFetch $constantFetch,
+    ): self {
+        assert($constantFetch->name instanceof Node\Identifier);
+
+        return new self(sprintf(
+            'An enum expression %s::%s is not supported in %s in file %s (line %d)',
+            $targetClass->getName(),
+            $constantFetch->name->name,
+            self::compilerContextToContextDescription($fetchContext),
+            self::getFileName($fetchContext),
+            $constantFetch->getLine(),
+        ));
+    }
+
     private static function getFileName(CompilerContext $fetchContext): string
     {
         $fileName = $fetchContext->getFileName();

diff --git a/test/unit/NodeCompiler/CompileNodeToValueTest.php b/test/unit/NodeCompiler/CompileNodeToValueTest.php
@@ -741,6 +741,29 @@ class Bat {
         $classInfo->getConstant('ONE_VALUE')->getValue();
     }
 
+    public function testEnumValueThrowsException(): void
+    {
+        $phpCode = <<<'PHP'
+        <?php
+
+        enum Foo: int {
+            case ONE = 1;
+        }
+        class Bat {
+            const ONE_VALUE = Foo::ONE;
+        }
+        PHP;
+
+        $reflector = new DefaultReflector(new AggregateSourceLocator([
+            new StringSourceLocator($phpCode, $this->astLocator),
+            new PhpInternalSourceLocator($this->astLocator, $this->sourceStubber),
+        ]));
+        $classInfo = $reflector->reflectClass('Bat');
+
+        $this->expectExceptionMessage('An enum expression Foo::ONE is not supported in class Bat in file ');
+        $classInfo->getConstant('ONE_VALUE')->getValue();
+    }
+
     /** @return list<array{0: string, 1: mixed}> */
     public static function magicConstantsWithoutNamespaceProvider(): array
     {