8.4 - Property hooks

src/ast.js

@@ -106,6 +106,7 @@ const Position = require("./ast/position");
  *       - [Namespace](#namespace)
  *     - [PropertyStatement](#propertystatement)
  *     - [Property](#property)
+ *       - [PropertyHook](#propertyhook)
  *     - [Declaration](#declaration)
  *       - [Class](#class)
  *       - [Interface](#interface)
@@ -552,6 +553,7 @@ AST.prototype.checkNodes = function () {
   require("./ast/print"),
   require("./ast/program"),
   require("./ast/property"),
+  require("./ast/propertyhook"),
   require("./ast/propertylookup"),
   require("./ast/propertystatement"),
   require("./ast/reference"),

src/ast/property.js

@@ -18,6 +18,7 @@ const KIND = "property";
  * @property {boolean} readonly
  * @property {boolean} nullable
  * @property {Identifier|Array<Identifier>|null} type
+ * @propert {PropertyHook[]} hooks
  * @property {AttrGroup[]} attrGroups
  */
 module.exports = Statement.extends(
@@ -28,6 +29,7 @@ module.exports = Statement.extends(
     readonly,
     nullable,
     type,
+    hooks,
     attrGroups,
     docs,
     location,
@@ -38,6 +40,7 @@ module.exports = Statement.extends(
     this.readonly = readonly;
     this.nullable = nullable;
     this.type = type;
+    this.hooks = hooks;
     this.attrGroups = attrGroups;
   },
 );

src/ast/propertyhook.js

@@ -0,0 +1,33 @@
+/**
+ * Copyright (C) 2024 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+
+const Node = require("./node");
+const KIND = "propertyhook";
+
+/**
+ * Defines a class property hook getter & setter
+ *
+ * @constructor PropertyHook
+ * @memberOf module:php-parser
+ * @extends {Node}
+ * @property {string} name
+ * @property {Boolean} isFinal
+ * @property {Boolean} byref
+ * @property {Parameter|null} parameter
+ * @property {Block|Statement} body
+ */
+module.exports = Node.extends(
+  KIND,
+  function PropertyHook(name, isFinal, byref, parameter, body, docs, location) {
+    Node.apply(this, [KIND, docs, location]);
+    this.name = name;
+    this.byref = byref;
+    this.parameter = parameter;
+    this.body = body;
+    this.isFinal = isFinal;
+  },
+);

src/ast/propertystatement.js

@@ -52,6 +52,8 @@ PropertyStatement.prototype.parseFlags = function (flags) {
   }
 
   this.isStatic = flags[1] === 1;
+  this.isAbstract = flags[2] === 1;
+  this.isFinal = flags[2] === 2;
 };
 
 module.exports = PropertyStatement;

src/parser/class.js

@@ -152,8 +152,6 @@ module.exports = {
         // reads a variable
         const variables = this.read_variable_list(flags, attrs);
         attrs = [];
-        this.expect(";");
-        this.next();
         result = result.concat(variables);
       } else {
         // raise an error
@@ -178,7 +176,7 @@ module.exports = {
    * ```
    */
   read_variable_list: function (flags, attrs) {
-    const result = this.node("propertystatement");
+    let property_statement = this.node("propertystatement");
 
     const properties = this.read_list(
       /*
@@ -201,28 +199,119 @@ module.exports = {
         const name = this.text().substring(1); // ignore $
         this.next();
         propName = propName(name);
-        if (this.token === ";" || this.token === ",") {
-          return result(propName, null, readonly, nullable, type, attrs || []);
-        } else if (this.token === "=") {
+
+        let value = null;
+        let property_hooks = [];
+
+        this.expect([",", ";", "=", "{"]);
+
+        // Property has a value
+        if (this.token === "=") {
           // https://github.com/php/php-src/blob/master/Zend/zend_language_parser.y#L815
-          return result(
-            propName,
-            this.next().read_expr(),
-            readonly,
-            nullable,
-            type,
-            attrs || [],
-          );
+          value = this.next().read_expr();
+        }
+
+        // Property is using a hook to define getter/setters
+        if (this.token === "{") {
+          property_hooks = this.read_property_hooks();
         } else {
-          this.expect([",", ";", "="]);
-          return result(propName, null, nullable, type, attrs || []);
+          this.expect([";", ","]);
         }
+
+        return result(
+          propName,
+          value,
+          readonly,
+          nullable,
+          type,
+          property_hooks,
+          attrs || [],
+        );
       },
       ",",
     );
 
-    return result(null, properties, flags);
+    property_statement = property_statement(null, properties, flags);
+
+    // semicolons are found only for regular properties definitions.
+    // Property hooks are terminated by a closing curly brace, }.
+    // property_statement is instanciated before this check to avoid including the semicolon in the AST end location of the property.
+    if (this.token === ";") {
+      this.next();
+    }
+    return property_statement;
   },
+
+  /**
+   * Reads property hooks
+   *
+   * @returns {PropertyHook[]}
+   */
+  read_property_hooks: function () {
+    if (this.version < 804) {
+      this.raiseError("Parse Error: Typed Class Constants requires PHP 8.4+");
+    }
+    this.expect("{");
+    this.next();
+
+    const hooks = [];
+
+    while (this.token !== "}") {
+      hooks.push(this.read_property_hook());
+    }
+
+    if (this.token === "}") {
+      this.next();
+      return hooks;
+    }
+    return [];
+  },
+
+  read_property_hook: function () {
+    const property_hooks = this.node("propertyhook");
+
+    const is_final = this.token === this.tok.T_FINAL;
+    if (is_final) this.next();
+
+    const is_reference = this.token === "&";
+    if (is_reference) this.next();
+
+    const method_name = this.text();
+
+    if (method_name !== "get" && method_name !== "set") {
+      this.raiseError(
+        "Parse Error: Property hooks must be either 'get' or 'set'",
+      );
+    }
+    this.next();
+
+    let parameter = null;
+    let body = null;
+    this.expect([this.tok.T_DOUBLE_ARROW, "{", "(", ";"]);
+
+    // interface or abstract definition
+    if (this.token === ";") {
+      this.next();
+    }
+
+    if (this.token === "(") {
+      this.next();
+      parameter = this.read_parameter(false);
+      this.expect(")");
+      this.next();
+    }
+
+    if (this.token === this.tok.T_DOUBLE_ARROW) {
+      this.next();
+      body = this.read_expr();
+      this.next();
+    } else if (this.token === "{") {
+      body = this.read_code_block();
+    }
+
+    return property_hooks(method_name, is_final, is_reference, parameter, body);
+  },
+
   /*
    * Reads constant list
    * ```ebnf
@@ -460,9 +549,11 @@ module.exports = {
           this.next();
         }
         attrs = [];
+      } else if (this.token === this.tok.T_STRING) {
+        result.push(this.read_variable_list(flags, attrs));
       } else {
         // raise an error
-        this.error([this.tok.T_CONST, this.tok.T_FUNCTION]);
+        this.error([this.tok.T_CONST, this.tok.T_FUNCTION, this.tok.T_STRING]);
         this.next();
       }
     }

test/snapshot/__snapshots__/acid.test.js.snap

@@ -831,6 +831,8 @@ Program {
               "visibility": "",
             },
             PropertyStatement {
+              "isAbstract": false,
+              "isFinal": false,
               "isStatic": false,
               "kind": "propertystatement",
               "loc": Location {
@@ -852,6 +854,7 @@ Program {
               "properties": [
                 Property {
                   "attrGroups": [],
+                  "hooks": [],
                   "kind": "property",
                   "loc": Location {
                     "end": Position {

test/snapshot/__snapshots__/attributes.test.js.snap

@@ -365,6 +365,8 @@ Program {
       "attrGroups": [],
       "body": [
         PropertyStatement {
+          "isAbstract": false,
+          "isFinal": false,
           "isStatic": false,
           "kind": "propertystatement",
           "properties": [
@@ -381,6 +383,7 @@ Program {
                   "kind": "attrgroup",
                 },
               ],
+              "hooks": [],
               "kind": "property",
               "name": Identifier {
                 "kind": "identifier",
@@ -399,6 +402,8 @@ Program {
           "visibility": "public",
         },
         PropertyStatement {
+          "isAbstract": false,
+          "isFinal": false,
           "isStatic": false,
           "kind": "propertystatement",
           "properties": [
@@ -415,6 +420,7 @@ Program {
                   "kind": "attrgroup",
                 },
               ],
+              "hooks": [],
               "kind": "property",
               "name": Identifier {
                 "kind": "identifier",
@@ -433,6 +439,8 @@ Program {
           "visibility": "private",
         },
         PropertyStatement {
+          "isAbstract": false,
+          "isFinal": false,
           "isStatic": false,
           "kind": "propertystatement",
           "properties": [
@@ -449,6 +457,7 @@ Program {
                   "kind": "attrgroup",
                 },
               ],
+              "hooks": [],
               "kind": "property",
               "name": Identifier {
                 "kind": "identifier",
@@ -2566,6 +2575,8 @@ Program {
       "attrGroups": [],
       "body": [
         PropertyStatement {
+          "isAbstract": false,
+          "isFinal": false,
           "isStatic": false,
           "kind": "propertystatement",
           "properties": [
@@ -2652,6 +2663,7 @@ Program {
                   "kind": "attrgroup",
                 },
               ],
+              "hooks": [],
               "kind": "property",
               "name": Identifier {
                 "kind": "identifier",