ObjectDeclarations::getDeclaredProperties(): improve documentation

Add a note about constructor promoted properties being included in the return value.
PHPCSStandards · Dec 12, 2024 · 9c2ca35 · 9c2ca35
1 parent f836f00
commit 9c2ca35
Showing 1 changed file with 7 additions and 2 deletions.
diff --git a/PHPCSUtils/Utils/ObjectDeclarations.php b/PHPCSUtils/Utils/ObjectDeclarations.php
@@ -433,8 +433,13 @@ public static function getDeclaredEnumCases(File $phpcsFile, $stackPtr)
     /**
      * Retrieve all properties declared in an OO structure.
      *
-     * Note: interfaces and enums cannot contain properties. This method does not take this into
-     * account to allow sniffs to flag this kind of incorrect PHP code.
+     * Notes:
+     * - Properties declared via PHP 8.0+ contructor property promotion **will** be included
+     *   in the return value.
+     *   However, keep in mind that passing the stack pointer of such a property to the
+     *   {@see Variables::getMemberProperties()} method is not supported.
+     * - Interfaces and enums cannot contain properties. This method does not take this into
+     *   account to allow sniffs to flag this kind of incorrect PHP code.
      *
      * @since 1.1.0
      *