Merge pull request #641 from PHPCSStandards/feature/minor-docs-tweaks

jrfnl · web-flow · commit 33dd7776e8a7 · 2024-12-12T08:44:32.000+01:00
ObjectDeclarations::getDeclaredProperties(): improve documentation
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
      *

Original file line number	Diff line number	Diff line change
`@@ -433,8 +433,13 @@ public static function getDeclaredEnumCases(File $phpcsFile, $stackPtr)`
`433`	`433`	`/**`
`434`	`434`	`* Retrieve all properties declared in an OO structure.`
`435`	`435`	`*`
`436`		`- * Note: interfaces and enums cannot contain properties. This method does not take this into`
`437`		`- * account to allow sniffs to flag this kind of incorrect PHP code.`
	`436`	`+ * Notes:`
	`437`	`+ * - Properties declared via PHP 8.0+ contructor property promotion will be included`
	`438`	`+ * in the return value.`
	`439`	`+ * However, keep in mind that passing the stack pointer of such a property to the`
	`440`	`+ * {@see Variables::getMemberProperties()} method is not supported.`
	`441`	`+ * - Interfaces and enums cannot contain properties. This method does not take this into`
	`442`	`+ * account to allow sniffs to flag this kind of incorrect PHP code.`
`438`	`443`	`*`
`439`	`444`	`* @since 1.1.0`
`440`	`445`	`*`