Add support for typed constants

RFC: https://wiki.php.net/rfc/typed_class_constants

grammar/php.y

@@ -340,7 +340,10 @@ non_empty_class_const_list:
 ;
 
 class_const:
-    identifier_maybe_reserved '=' expr                      { $$ = Node\Const_[$1, $3]; }
+      T_STRING '=' expr
+          { $$ = Node\Const_[new Node\Identifier($1, stackAttributes(#1)), $3]; }
+    | semi_reserved '=' expr
+          { $$ = Node\Const_[new Node\Identifier($1, stackAttributes(#1)), $3]; }
 ;
 
 inner_statement_list_ex:
@@ -842,6 +845,9 @@ class_statement:
     | optional_attributes method_modifiers T_CONST class_const_list semi
           { $$ = new Stmt\ClassConst($4, $2, attributes(), $1);
             $this->checkClassConst($$, #2); }
+    | optional_attributes method_modifiers T_CONST type_expr class_const_list semi
+          { $$ = new Stmt\ClassConst($5, $2, attributes(), $1, $4);
+            $this->checkClassConst($$, #2); }
     | optional_attributes method_modifiers T_FUNCTION optional_ref identifier_maybe_reserved '(' parameter_list ')'
       optional_return_type method_body
           { $$ = Stmt\ClassMethod[$5, ['type' => $2, 'byRef' => $4, 'params' => $7, 'returnType' => $9, 'stmts' => $10, 'attrGroups' => $1]];

lib/PhpParser/Builder/ClassConst.php

@@ -22,6 +22,8 @@ class ClassConst implements PhpParser\Builder {
 
     /** @var list<Node\AttributeGroup> */
     protected $attributeGroups = [];
+    /** @var Identifier|Node\Name|Node\ComplexType */
+    protected $type;
 
     /**
      * Creates a class constant builder
@@ -119,6 +121,19 @@ class ClassConst implements PhpParser\Builder {
         return $this;
     }
 
+    /**
+     * Sets the constant type.
+     *
+     * @param string|Node\Name|Identifier|Node\ComplexType $type
+     *
+     * @return $this
+     */
+    public function setType($type) {
+        $this->type = BuilderHelpers::normalizeType($type);
+
+        return $this;
+    }
+
     /**
      * Returns the built class node.
      *
@@ -129,7 +144,8 @@ class ClassConst implements PhpParser\Builder {
             $this->constants,
             $this->flags,
             $this->attributes,
-            $this->attributeGroups
+            $this->attributeGroups,
+            $this->type
         );
     }
 }

lib/PhpParser/Node/Stmt/ClassConst.php

@@ -10,31 +10,36 @@ class ClassConst extends Node\Stmt {
     public $flags;
     /** @var Node\Const_[] Constant declarations */
     public $consts;
-    /** @var Node\AttributeGroup[] */
+    /** @var Node\AttributeGroup[] PHP attribute groups */
     public $attrGroups;
+    /** @var Node\Identifier|Node\Name|Node\ComplexType Type declaration */
+    public $type;
 
     /**
      * Constructs a class const list node.
      *
-     * @param Node\Const_[]         $consts     Constant declarations
+     * @param Node\Const_[] $consts Constant declarations
-     * @param int                   $flags      Modifiers
+     * @param int $flags Modifiers
      * @param array<string, mixed> $attributes Additional attributes
      * @param list<Node\AttributeGroup> $attrGroups PHP attribute groups
+     * @param null|string|Node\Identifier|Node\Name|Node\ComplexType $type Type declaration
      */
     public function __construct(
         array $consts,
         int $flags = 0,
         array $attributes = [],
-        array $attrGroups = []
+        array $attrGroups = [],
+        $type = null
     ) {
         $this->attributes = $attributes;
         $this->flags = $flags;
         $this->consts = $consts;
         $this->attrGroups = $attrGroups;
+        $this->type = $type;
     }
 
     public function getSubNodeNames(): array {
-        return ['attrGroups', 'flags', 'consts'];
+        return ['attrGroups', 'flags', 'type', 'consts'];
     }
 
     /**

lib/PhpParser/PrettyPrinter/Standard.php

@@ -842,7 +842,9 @@ class Standard extends PrettyPrinterAbstract {
     protected function pStmt_ClassConst(Stmt\ClassConst $node): string {
         return $this->pAttrGroups($node->attrGroups)
              . $this->pModifiers($node->flags)
-             . 'const ' . $this->pCommaSeparated($node->consts) . ';';
+             . 'const '
+             . (null !== $node->type ? $this->p($node->type) . ' ' : '')
+             . $this->pCommaSeparated($node->consts) . ';';
     }
 
     protected function pStmt_Function(Stmt\Function_ $node): string {

lib/PhpParser/PrettyPrinterAbstract.php

@@ -1391,6 +1391,7 @@ abstract class PrettyPrinterAbstract implements PrettyPrinter {
             'Param->default' => $stripEquals,
             'Stmt_Break->num' => $stripBoth,
             'Stmt_Catch->var' => $stripLeft,
+            'Stmt_ClassConst->type' => $stripRight,
             'Stmt_ClassMethod->returnType' => $stripColon,
             'Stmt_Class->extends' => ['left' => \T_EXTENDS],
             'Stmt_Enum->scalarType' => $stripColon,
@@ -1434,6 +1435,7 @@ abstract class PrettyPrinterAbstract implements PrettyPrinter {
             'Stmt_Break->num' => [\T_BREAK, false, ' ', null],
             'Stmt_Catch->var' => [null, false, ' ', null],
             'Stmt_ClassMethod->returnType' => [')', false, ': ', null],
+            'Stmt_ClassConst->type' => [\T_CONST, false, ' ', null],
             'Stmt_Class->extends' => [null, false, ' extends ', null],
             'Stmt_Enum->scalarType' => [null, false, ' : ', null],
             'Stmt_EnumCase->expr' => [null, false, ' = ', null],

test/PhpParser/Builder/ClassConstTest.php

@@ -142,6 +142,18 @@ class ClassConstTest extends \PHPUnit\Framework\TestCase {
         );
     }
 
+    public function testType() {
+        $node = $this->createClassConstBuilder('TYPE', 1)
+            ->setType('int')
+            ->getNode();
+        $this->assertEquals(
+            new Stmt\ClassConst(
+                [new Const_('TYPE', new Int_(1))],
+                0, [], [], new Identifier('int')),
+            $node
+        );
+    }
+
     /**
      * @dataProvider provideTestDefaultValues
      */

test/code/formatPreservation/insertionOfNullable.test

@@ -49,6 +49,10 @@ X
     private
         $x
     ;
+
+    const
+    X
+    = 1;
 }
 
 foreach (
@@ -86,6 +90,7 @@ $stmts[9]->expr = new Expr\Variable('x');
 $stmts[10]->extends = new Node\Name\FullyQualified('Bar');
 $stmts[10]->stmts[0]->returnType = new Node\Name('Y');
 $stmts[10]->stmts[1]->props[0]->default = new Scalar\DNumber(42.0);
+$stmts[10]->stmts[2]->type = new Node\Identifier('int');
 $stmts[11]->keyVar = new Expr\Variable('z');
 $stmts[12]->vars[0]->default = new Scalar\String_('abc');
 $stmts[13]->finally = new Stmt\Finally_([]);
@@ -140,6 +145,10 @@ X extends \Bar
     private
         $x = 42.0
     ;
+
+    const int
+    X
+    = 1;
 }
 
 foreach (

test/code/formatPreservation/removalViaNull.test

@@ -35,6 +35,11 @@ Bar
         y
         ;
     }
+
+    const
+    int
+    X
+    = 1;
 }
 
 $foo [ $bar ];
@@ -97,6 +102,7 @@ $stmts[2]->extends = null;
 $stmts[2]->stmts[0]->returnType = null;
 $stmts[2]->stmts[1]->props[0]->default = null;
 $stmts[2]->stmts[2]->adaptations[0]->newName = null;
+$stmts[2]->stmts[3]->type = null;
 $stmts[3]->expr->dim = null;
 $stmts[4]->expr->expr = null;
 $stmts[5]->expr->if = null;
@@ -141,6 +147,10 @@ Foo
         public
         ;
     }
+
+    const
+    X
+    = 1;
 }
 
 $foo [];

test/code/parser/errorHandling/recovery.test

@@ -739,6 +739,7 @@ array(
                 attrGroups: array(
                 )
                 flags: 0
+                type: null
                 consts: array(
                     0: Const(
                         name: Identifier(
@@ -1495,6 +1496,7 @@ array(
                 attrGroups: array(
                 )
                 flags: 0
+                type: null
                 consts: array(
                     0: Const(
                         name: Identifier(

test/code/parser/semiReserved.test

@@ -152,6 +152,7 @@ array(
                 attrGroups: array(
                 )
                 flags: 0
+                type: null
                 consts: array(
                     0: Const(
                         name: Identifier(
@@ -175,6 +176,7 @@ array(
                 attrGroups: array(
                 )
                 flags: 0
+                type: null
                 consts: array(
                     0: Const(
                         name: Identifier(

test/code/parser/stmt/class/anonymous.test

@@ -205,6 +205,7 @@ array(
                                         attrGroups: array(
                                         )
                                         flags: 0
+                                        type: null
                                         consts: array(
                                             0: Const(
                                                 name: Identifier(

test/code/parser/stmt/class/constModifierErrors.test

@@ -22,6 +22,7 @@ array(
                 attrGroups: array(
                 )
                 flags: STATIC (8)
+                type: null
                 consts: array(
                     0: Const(
                         name: Identifier(
@@ -59,6 +60,7 @@ array(
                 attrGroups: array(
                 )
                 flags: ABSTRACT (16)
+                type: null
                 consts: array(
                     0: Const(
                         name: Identifier(
@@ -96,6 +98,7 @@ array(
                 attrGroups: array(
                 )
                 flags: READONLY (64)
+                type: null
                 consts: array(
                     0: Const(
                         name: Identifier(
@@ -133,6 +136,7 @@ array(
                 attrGroups: array(
                 )
                 flags: PUBLIC (1)
+                type: null
                 consts: array(
                     0: Const(
                         name: Identifier(

test/code/parser/stmt/class/constModifiers.test

@@ -26,6 +26,7 @@ array(
                 attrGroups: array(
                 )
                 flags: 0
+                type: null
                 consts: array(
                     0: Const(
                         name: Identifier(
@@ -41,6 +42,7 @@ array(
                 attrGroups: array(
                 )
                 flags: PUBLIC (1)
+                type: null
                 consts: array(
                     0: Const(
                         name: Identifier(
@@ -56,6 +58,7 @@ array(
                 attrGroups: array(
                 )
                 flags: PROTECTED (2)
+                type: null
                 consts: array(
                     0: Const(
                         name: Identifier(
@@ -71,6 +74,7 @@ array(
                 attrGroups: array(
                 )
                 flags: PRIVATE (4)
+                type: null
                 consts: array(
                     0: Const(
                         name: Identifier(
@@ -86,6 +90,7 @@ array(
                 attrGroups: array(
                 )
                 flags: FINAL (32)
+                type: null
                 consts: array(
                     0: Const(
                         name: Identifier(

test/code/parser/stmt/class/simple.test

@@ -46,6 +46,7 @@ array(
                 attrGroups: array(
                 )
                 flags: 0
+                type: null
                 consts: array(
                     0: Const(
                         name: Identifier(

test/code/parser/stmt/class/typedConstants.test

@@ -0,0 +1,124 @@
+Typed constants
+-----
+<?php
+class Test {
+    const int X = 1;
+    private const string Y = "a", Z = "b";
+    const array ARRAY = [];
+    const Foo|Bar|null FOO = null;
+}
+-----
+array(
+    0: Stmt_Class(
+        attrGroups: array(
+        )
+        flags: 0
+        name: Identifier(
+            name: Test
+        )
+        extends: null
+        implements: array(
+        )
+        stmts: array(
+            0: Stmt_ClassConst(
+                attrGroups: array(
+                )
+                flags: 0
+                type: Identifier(
+                    name: int
+                )
+                consts: array(
+                    0: Const(
+                        name: Identifier(
+                            name: X
+                        )
+                        value: Scalar_Int(
+                            value: 1
+                        )
+                    )
+                )
+            )
+            1: Stmt_ClassConst(
+                attrGroups: array(
+                )
+                flags: PRIVATE (4)
+                type: Identifier(
+                    name: string
+                )
+                consts: array(
+                    0: Const(
+                        name: Identifier(
+                            name: Y
+                        )
+                        value: Scalar_String(
+                            value: a
+                        )
+                    )
+                    1: Const(
+                        name: Identifier(
+                            name: Z
+                        )
+                        value: Scalar_String(
+                            value: b
+                        )
+                    )
+                )
+            )
+            2: Stmt_ClassConst(
+                attrGroups: array(
+                )
+                flags: 0
+                type: Identifier(
+                    name: array
+                )
+                consts: array(
+                    0: Const(
+                        name: Identifier(
+                            name: ARRAY
+                        )
+                        value: Expr_Array(
+                            items: array(
+                            )
+                        )
+                    )
+                )
+            )
+            3: Stmt_ClassConst(
+                attrGroups: array(
+                )
+                flags: 0
+                type: UnionType(
+                    types: array(
+                        0: Name(
+                            parts: array(
+                                0: Foo
+                            )
+                        )
+                        1: Name(
+                            parts: array(
+                                0: Bar
+                            )
+                        )
+                        2: Identifier(
+                            name: null
+                        )
+                    )
+                )
+                consts: array(
+                    0: Const(
+                        name: Identifier(
+                            name: FOO
+                        )
+                        value: Expr_ConstFetch(
+                            name: Name(
+                                parts: array(
+                                    0: null
+                                )
+                            )
+                        )
+                    )
+                )
+            )
+        )
+    )
+)

test/code/parser/stmt/newInInitializer.test

@@ -126,6 +126,7 @@ array(
                 attrGroups: array(
                 )
                 flags: 0
+                type: null
                 consts: array(
                     0: Const(
                         name: Identifier(

test/code/prettyPrinter/stmt/class_const.test

@@ -7,7 +7,7 @@ class Foo
     const A = 1, B = 2;
     public const C = 3, D = 4;
     protected const E = 5, F = 6;
-    private const G = 7, H = 8;
+    private const int G = 7, H = 8;
 }
 -----
 class Foo
@@ -15,5 +15,5 @@ class Foo
     const A = 1, B = 2;
     public const C = 3, D = 4;
     protected const E = 5, F = 6;
-    private const G = 7, H = 8;
+    private const int G = 7, H = 8;
 }