Merge pull request #2498 from zephir-lang/niden/stubs-typed-constants

Adding support for typed constants (stubs) for php 8.3+

Author: Jeckerson

src/Stubs/Generator.php

@@ -31,6 +31,7 @@
 use function is_dir;
 use function key;
 use function mkdir;
+use function preg_match;
 use function realpath;
 use function sprintf;
 use function str_ireplace;
@@ -40,6 +41,7 @@
 
 use const DIRECTORY_SEPARATOR;
 use const PHP_EOL;
+use const PHP_VERSION_ID;
 
 class Generator
 {
@@ -218,7 +220,8 @@ protected function buildClass(Definition $class, string $indent, string $banner)
 
     protected function buildConstant(Constant $constant, string $indent): string
     {
-        $source = 'const ' . $constant->getName();
+        $type   = PHP_VERSION_ID >= 80300 ? $this->extractVarTypeFromDocBlock($constant->getDocBlock()) : '';
+        $source = 'const ' . ($type !== '' ? $type . ' ' : '') . $constant->getName();
 
         $value = $this->wrapPHPValue([
             'default' => $constant->getValue(),
@@ -427,6 +430,19 @@ protected function wrapPHPValue(array $parameter): string
         return (string)$returnValue;
     }
 
+    private function extractVarTypeFromDocBlock(?string $docBlock): string
+    {
+        if ($docBlock === null) {
+            return '';
+        }
+
+        if (preg_match('/@var\s+([\w\\\\|]+)/', $docBlock, $matches)) {
+            return $matches[1];
+        }
+
+        return '';
+    }
+
     private function fetchDocBlock(?string $docBlock, string $indent): string
     {
         $docBlock = (new DocBlock($docBlock, $indent))->__toString();

tests/Zephir/Stubs/GeneratorTest.php

@@ -326,6 +326,63 @@ public function constantProvider(): array
         ];
     }
 
+    public function typedConstantProvider(): array
+    {
+        $typed   = PHP_VERSION_ID >= 80300;
+        $docPart = "/**\n * @var %s\n */\n";
+
+        return [
+            [
+                'int', 1, '@var int',
+                sprintf($docPart, 'int') . ($typed ? 'const int TEST = 1;' : 'const TEST = 1;'),
+            ],
+            [
+                'string', 'Foo', '@var string',
+                sprintf($docPart, 'string') . ($typed ? "const string TEST = 'Foo';" : "const TEST = 'Foo';"),
+            ],
+            [
+                'bool', 1, '@var bool',
+                sprintf($docPart, 'bool') . ($typed ? 'const bool TEST = 1;' : 'const TEST = 1;'),
+            ],
+            [
+                'string', 'bar', null, "const TEST = 'bar';",
+            ],
+        ];
+    }
+
+    /**
+     * @dataProvider typedConstantProvider
+     *
+     * @throws \ReflectionException
+     */
+    public function testShouldBuildTypedConstant(string $type, mixed $value, ?string $docBlock, string $expected): void
+    {
+        if (Os::isWindows()) {
+            $this->markTestSkipped('Warning: Strings contain different line endings!');
+        }
+
+        $buildClass = $this->getMethod('buildConstant');
+
+        $classConstant = new Constant(
+            'TEST',
+            [
+                'type'  => $type,
+                'value' => $value,
+            ],
+            $docBlock
+        );
+
+        $actual = $buildClass->invokeArgs(
+            $this->testClass,
+            [
+                $classConstant,
+                '',
+            ]
+        );
+
+        $this->assertSame($expected, $actual);
+    }
+
     /**
      * @dataProvider constantProvider
      *