SONARPHP-1562 Add basic support for PropertyHooks

php-frontend/src/main/java/org/sonar/php/parser/PHPGrammar.java

@@ -49,6 +49,8 @@
 import org.sonar.plugins.php.api.tree.declaration.NamespaceNameTree;
 import org.sonar.plugins.php.api.tree.declaration.ParameterListTree;
 import org.sonar.plugins.php.api.tree.declaration.ParameterTree;
+import org.sonar.plugins.php.api.tree.declaration.PropertyHookListTree;
+import org.sonar.plugins.php.api.tree.declaration.PropertyHookTree;
 import org.sonar.plugins.php.api.tree.declaration.ReturnTypeClauseTree;
 import org.sonar.plugins.php.api.tree.declaration.TypeNameTree;
 import org.sonar.plugins.php.api.tree.declaration.TypeTree;
@@ -342,7 +344,7 @@ public EnumDeclarationTree ENUM_DECLARATION() {
   }
 
   /**
-   *  In contrast to class declarations, enums cannot contain properties. They do allow enum cases as an addition.
+   * In contrast to class declarations, enums cannot contain properties. They do allow enum cases as an addition.
    */
   public ClassMemberTree ENUM_MEMBER() {
     return b.<ClassMemberTree>nonterminal(PHPLexicalGrammar.ENUM_MEMBER).is(
@@ -410,15 +412,24 @@ public ConstantDeclarationTree CONSTANT_DECLARATION() {
 
   public ClassPropertyDeclarationTree CLASS_VARIABLE_DECLARATION() {
     return b.<ClassPropertyDeclarationTree>nonterminal(PHPLexicalGrammar.CLASS_VARIABLE_DECLARATION).is(
-      f.classVariableDeclaration(
-        b.zeroOrMore(ATTRIBUTE_GROUP()),
-        b.firstOf(
-          f.singleToken(b.token(PHPKeyword.VAR)),
-          b.oneOrMore(MEMBER_MODIFIER())),
-        b.optional(DECLARED_TYPE()),
-        VARIABLE_DECLARATION(),
-        b.zeroOrMore(f.newTuple(b.token(COMMA), VARIABLE_DECLARATION())),
-        EOS()));
+      b.firstOf(
+        f.classVariableDeclaration(
+          b.zeroOrMore(ATTRIBUTE_GROUP()),
+          b.firstOf(
+            f.singleToken(b.token(PHPKeyword.VAR)),
+            b.oneOrMore(MEMBER_MODIFIER())),
+          b.optional(DECLARED_TYPE()),
+          VARIABLE_DECLARATION(),
+          PROPERTY_HOOK_LIST()),
+        f.classVariableDeclaration(
+          b.zeroOrMore(ATTRIBUTE_GROUP()),
+          b.firstOf(
+            f.singleToken(b.token(PHPKeyword.VAR)),
+            b.oneOrMore(MEMBER_MODIFIER())),
+          b.optional(DECLARED_TYPE()),
+          VARIABLE_DECLARATION(),
+          b.zeroOrMore(f.newTuple(b.token(COMMA), VARIABLE_DECLARATION())),
+          EOS())));
   }
 
   public SyntaxToken VISIBILITY_MODIFIER() {
@@ -636,6 +647,36 @@ public DeclaredTypeTree DECLARED_TYPE() {
       b.firstOf(DNF_TYPE(), UNION_TYPE(), INTERSECTION_TYPE(), TYPE()));
   }
 
+  public PropertyHookListTree PROPERTY_HOOK_LIST() {
+    return b.<PropertyHookListTree>nonterminal(PHPLexicalGrammar.PROPERTY_HOOK_LIST).is(
+      f.propertyHookList(
+        b.token(LCURLYBRACE),
+        b.oneOrMore(PROPERTY_HOOK()),
+        b.token(RCURLYBRACE)));
+  }
+
+  public PropertyHookTree PROPERTY_HOOK() {
+    return b.<PropertyHookTree>nonterminal(PHPLexicalGrammar.PROPERTY_HOOK).is(
+      f.propertyHook(
+        b.zeroOrMore(ATTRIBUTE_GROUP()),
+        b.optional(b.token(PHPKeyword.FINAL)),
+        b.optional(b.token(PHPPunctuator.AMPERSAND)),
+        PROPERTY_HOOK_FUNCTION_NAME(),
+        b.optional(PARAMETER_LIST()),
+        b.optional(b.token(DOUBLEARROW)),
+        b.firstOf(
+          EOS(),
+          BLOCK(),
+          EXPRESSION_STATEMENT())));
+  }
+
+  public InternalSyntaxToken PROPERTY_HOOK_FUNCTION_NAME() {
+    return b.<InternalSyntaxToken>nonterminal(PHPLexicalGrammar.PROPERTY_HOOK_FUNCTION_NAME).is(
+      b.firstOf(
+        b.token(PHPLexicalGrammar.GET),
+        b.token(PHPLexicalGrammar.SET)));
+  }
+
   /**
    * [ END ] Declaration
    */

php-frontend/src/main/java/org/sonar/php/parser/PHPLexicalGrammar.java

@@ -63,6 +63,10 @@ public enum PHPLexicalGrammar implements GrammarRuleKey {
   MEMBER_CONST_DECLARATION,
   FUNCTION_CALL_ARGUMENT,
 
+  PROPERTY_HOOK_LIST,
+  PROPERTY_HOOK,
+  PROPERTY_HOOK_FUNCTION_NAME,
+
   TRAIT_METHOD_REFERENCE_FULLY_QUALIFIED,
   TRAIT_METHOD_REFERENCE,
   TRAIT_ALIAS,
@@ -252,6 +256,9 @@ public enum PHPLexicalGrammar implements GrammarRuleKey {
   CLONE,
   PRINT,
 
+  GET,
+  SET,
+
   SELF,
   PARENT,
 
@@ -350,6 +357,9 @@ public static void lexical(LexerlessGrammarBuilder b) {
     b.rule(CLONE).is(word(b, "CLONE")).skip();
     b.rule(PRINT).is(word(b, "PRINT")).skip();
 
+    b.rule(GET).is(word(b, "GET")).skip();
+    b.rule(SET).is(word(b, "SET")).skip();
+
     b.rule(SELF).is(word(b, "SELF")).skip();
     b.rule(PARENT).is(word(b, "PARENT")).skip();
 

php-frontend/src/main/java/org/sonar/php/parser/TreeFactory.java

@@ -53,6 +53,8 @@
 import org.sonar.php.tree.impl.declaration.NamespaceNameTreeImpl;
 import org.sonar.php.tree.impl.declaration.ParameterListTreeImpl;
 import org.sonar.php.tree.impl.declaration.ParameterTreeImpl;
+import org.sonar.php.tree.impl.declaration.PropertyHookListTreeImpl;
+import org.sonar.php.tree.impl.declaration.PropertyHookTreeImpl;
 import org.sonar.php.tree.impl.declaration.ReturnTypeClauseTreeImpl;
 import org.sonar.php.tree.impl.declaration.TraitAliasTreeImpl;
 import org.sonar.php.tree.impl.declaration.TraitMethodReferenceTreeImpl;
@@ -162,6 +164,8 @@
 import org.sonar.plugins.php.api.tree.declaration.NamespaceNameTree;
 import org.sonar.plugins.php.api.tree.declaration.ParameterListTree;
 import org.sonar.plugins.php.api.tree.declaration.ParameterTree;
+import org.sonar.plugins.php.api.tree.declaration.PropertyHookListTree;
+import org.sonar.plugins.php.api.tree.declaration.PropertyHookTree;
 import org.sonar.plugins.php.api.tree.declaration.ReturnTypeClauseTree;
 import org.sonar.plugins.php.api.tree.declaration.TypeNameTree;
 import org.sonar.plugins.php.api.tree.declaration.TypeTree;
@@ -477,9 +481,24 @@ public ClassPropertyDeclarationTree classVariableDeclaration(
       modifierTokens,
       typeAnnotation.orNull(),
       separatedList(firstVariable, additionalVariables),
+      null,
       eosToken);
   }
 
+  public ClassPropertyDeclarationTree classVariableDeclaration(
+    Optional<List<AttributeGroupTree>> attributes,
+    List<SyntaxToken> modifierTokens,
+    Optional<DeclaredTypeTree> typeAnnotation,
+    VariableDeclarationTree variable,
+    PropertyHookListTree propertyHookListTree) {
+    return ClassPropertyDeclarationTreeImpl.variable(attributes.or(Collections.emptyList()),
+      modifierTokens,
+      typeAnnotation.orNull(),
+      separatedList(variable, Optional.absent()),
+      propertyHookListTree,
+      null);
+  }
+
   public MethodDeclarationTree methodDeclaration(
     Optional<List<AttributeGroupTree>> attributes,
     Optional<List<SyntaxToken>> modifiers,
@@ -681,6 +700,31 @@ public EnumCaseTree enumCase(Optional<List<AttributeGroupTree>> attributes, Synt
     return new EnumCaseTreeImpl(attributes.or(Collections.emptyList()), caseToken, name, equalToken, value, eosToken);
   }
 
+  public PropertyHookListTree propertyHookList(
+    InternalSyntaxToken openCurlyBrace,
+    List<PropertyHookTree> hooks,
+    InternalSyntaxToken closeCurlyBrace) {
+    return new PropertyHookListTreeImpl(openCurlyBrace, hooks, closeCurlyBrace);
+  }
+
+  public PropertyHookTree propertyHook(
+    Optional<List<AttributeGroupTree>> attributes,
+    Optional<SyntaxToken> modifier,
+    Optional<InternalSyntaxToken> referenceToken,
+    InternalSyntaxToken name,
+    Optional<ParameterListTree> parameters,
+    Optional<InternalSyntaxToken> doubleArrowToken,
+    Tree body) {
+    return new PropertyHookTreeImpl(
+      attributes.or(Collections.emptyList()),
+      modifier.orNull(),
+      referenceToken.orNull(),
+      new NameIdentifierTreeImpl(name),
+      parameters.orNull(),
+      doubleArrowToken.orNull(),
+      body);
+  }
+
   /**
    * [ END ] Declarations
    */

php-frontend/src/main/java/org/sonar/php/tree/impl/declaration/ClassPropertyDeclarationTreeImpl.java

@@ -32,6 +32,7 @@
 import org.sonar.plugins.php.api.tree.declaration.AttributeGroupTree;
 import org.sonar.plugins.php.api.tree.declaration.ClassPropertyDeclarationTree;
 import org.sonar.plugins.php.api.tree.declaration.DeclaredTypeTree;
+import org.sonar.plugins.php.api.tree.declaration.PropertyHookListTree;
 import org.sonar.plugins.php.api.tree.declaration.TypeTree;
 import org.sonar.plugins.php.api.tree.declaration.UnionTypeTree;
 import org.sonar.plugins.php.api.tree.declaration.VariableDeclarationTree;
@@ -44,6 +45,9 @@ public class ClassPropertyDeclarationTreeImpl extends PHPTree implements ClassPr
   private final List<AttributeGroupTree> attributeGroups;
   private final List<SyntaxToken> modifierTokens;
   private final SeparatedListImpl<VariableDeclarationTree> declarations;
+  @Nullable
+  private final PropertyHookListTree propertyHookList;
+  @Nullable
   private final InternalSyntaxToken eosToken;
   @Nullable
   private final DeclaredTypeTree typeAnnotation;
@@ -54,25 +58,29 @@ private ClassPropertyDeclarationTreeImpl(
     List<SyntaxToken> modifierTokens,
     @Nullable DeclaredTypeTree typeAnnotation,
     SeparatedListImpl<VariableDeclarationTree> declarations,
-    InternalSyntaxToken eosToken) {
+    @Nullable PropertyHookListTree propertyHookList,
+    @Nullable InternalSyntaxToken eosToken) {
     this.kind = kind;
     this.attributeGroups = attributeGroups;
     this.modifierTokens = modifierTokens;
     this.typeAnnotation = typeAnnotation;
     this.declarations = declarations;
+    this.propertyHookList = propertyHookList;
     this.eosToken = eosToken;
   }
 
   public static ClassPropertyDeclarationTree variable(List<AttributeGroupTree> attributes,
     List<SyntaxToken> modifierTokens,
     @Nullable DeclaredTypeTree typeAnnotation,
     SeparatedListImpl<VariableDeclarationTree> declarations,
-    InternalSyntaxToken eosToken) {
+    @Nullable PropertyHookListTree propertyHook,
+    @Nullable InternalSyntaxToken eosToken) {
     return new ClassPropertyDeclarationTreeImpl(Kind.CLASS_PROPERTY_DECLARATION,
       attributes,
       Collections.unmodifiableList(modifierTokens),
       typeAnnotation,
       declarations,
+      propertyHook,
       eosToken);
   }
 
@@ -90,6 +98,7 @@ public static ClassPropertyDeclarationTree constant(List<AttributeGroupTree> att
       Collections.unmodifiableList(modifierTokens),
       typeAnnotation,
       declarations,
+      null,
       eosToken);
   }
 
@@ -132,6 +141,13 @@ public SeparatedListImpl<VariableDeclarationTree> declarations() {
     return declarations;
   }
 
+  @Nullable
+  @Override
+  public PropertyHookListTree propertyHookList() {
+    return propertyHookList;
+  }
+
+  @Nullable
   @Override
   public SyntaxToken eosToken() {
     return eosToken;
@@ -167,13 +183,10 @@ public Iterator<Tree> childrenIterator() {
     return IteratorUtils.concat(
       attributeGroups.iterator(),
       modifierTokens.iterator(),
-      nullableIterator(typeAnnotation),
+      IteratorUtils.nullableIterator(typeAnnotation),
       declarations.elementsAndSeparators(),
-      IteratorUtils.iteratorOf(eosToken));
-  }
-
-  private static Iterator<? extends Tree> nullableIterator(@Nullable Tree tree) {
-    return tree == null ? Collections.emptyIterator() : IteratorUtils.iteratorOf(tree);
+      IteratorUtils.nullableIterator(propertyHookList),
+      IteratorUtils.nullableIterator(eosToken));
   }
 
   @Override

php-frontend/src/main/java/org/sonar/php/tree/impl/declaration/PropertyHookListTreeImpl.java

@@ -0,0 +1,79 @@
+/*
+ * SonarQube PHP Plugin
+ * Copyright (C) 2010-2024 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.php.tree.impl.declaration;
+
+import java.util.Iterator;
+import java.util.List;
+import org.sonar.php.tree.impl.PHPTree;
+import org.sonar.php.tree.impl.lexical.InternalSyntaxToken;
+import org.sonar.php.utils.collections.IteratorUtils;
+import org.sonar.plugins.php.api.tree.Tree;
+import org.sonar.plugins.php.api.tree.declaration.PropertyHookListTree;
+import org.sonar.plugins.php.api.tree.declaration.PropertyHookTree;
+import org.sonar.plugins.php.api.visitors.VisitorCheck;
+
+public class PropertyHookListTreeImpl extends PHPTree implements PropertyHookListTree {
+
+  private static final Kind KIND = Kind.PROPERTY_HOOK_LIST;
+
+  private final InternalSyntaxToken openCurlyBrace;
+  private final List<PropertyHookTree> hooks;
+  private final InternalSyntaxToken closeCurlyBrace;
+
+  public PropertyHookListTreeImpl(
+    InternalSyntaxToken openCurlyBrace, List<PropertyHookTree> hooks, InternalSyntaxToken closeCurlyBrace) {
+    this.openCurlyBrace = openCurlyBrace;
+    this.hooks = hooks;
+    this.closeCurlyBrace = closeCurlyBrace;
+  }
+
+  @Override
+  public List<PropertyHookTree> hooks() {
+    return hooks;
+  }
+
+  @Override
+  public Iterator<Tree> childrenIterator() {
+    return IteratorUtils.concat(
+      IteratorUtils.iteratorOf(openCurlyBrace),
+      hooks.iterator(),
+      IteratorUtils.iteratorOf(closeCurlyBrace));
+  }
+
+  @Override
+  public void accept(VisitorCheck visitor) {
+    visitor.visitPropertyHookList(this);
+  }
+
+  @Override
+  public Kind getKind() {
+    return KIND;
+  }
+
+  @Override
+  public InternalSyntaxToken openCurlyBrace() {
+    return openCurlyBrace;
+  }
+
+  @Override
+  public InternalSyntaxToken closeCurlyBrace() {
+    return closeCurlyBrace;
+  }
+}