Merge pull request #9312 from weirdan/deprecate-functionlikestorage-unused_docblock_params

weirdan · web-flow · commit 33f18e8d2dec · 2023-02-15T21:46:39.000-04:00
diff --git a/src/Psalm/Internal/Analyzer/FunctionLikeAnalyzer.php b/src/Psalm/Internal/Analyzer/FunctionLikeAnalyzer.php
@@ -361,8 +361,8 @@ public function analyze(
             $context->external_mutation_free = true;
         }
 
-        if ($storage->unused_docblock_params) {
-            foreach ($storage->unused_docblock_params as $param_name => $param_location) {
+        if ($storage->has_undertyped_native_parameters) {
+            foreach ($storage->unused_docblock_parameters as $param_name => $param_location) {
                 IssueBuffer::maybeAdd(
                     new InvalidDocblockParamName(
                         'Incorrect param name $' . $param_name . ' in docblock for ' . $cased_method_id,
diff --git a/src/Psalm/Internal/PhpVisitor/Reflector/FunctionLikeDocblockScanner.php b/src/Psalm/Internal/PhpVisitor/Reflector/FunctionLikeDocblockScanner.php
@@ -908,8 +908,12 @@ private static function improveParamsFromDocblock(
         );
 
         if ($params_without_docblock_type) {
+            /** @psalm-suppress DeprecatedProperty remove in Psalm 6 */
             $storage->unused_docblock_params = $unused_docblock_params;
         }
+
+        $storage->has_undertyped_native_parameters = $params_without_docblock_type !== [];
+        $storage->unused_docblock_parameters = $unused_docblock_params;
     }
 
     /**
diff --git a/src/Psalm/Storage/FunctionLikeStorage.php b/src/Psalm/Storage/FunctionLikeStorage.php
@@ -172,10 +172,19 @@ abstract class FunctionLikeStorage implements HasAttributesInterface
     public $return_type_description;
 
     /**
+     * @psalm-suppress PossiblyUnusedProperty
      * @var array<string, CodeLocation>|null
+     * @deprecated will be removed in Psalm 6. use {@see FunctionLikeStorage::$unused_docblock_parameters} instead
      */
     public $unused_docblock_params;
 
+    /**
+     * @var array<string, CodeLocation>
+     */
+    public array $unused_docblock_parameters = [];
+
+    public bool $has_undertyped_native_parameters = false;
+
     /**
      * @var bool
      */

Original file line number	Diff line number	Diff line change
`@@ -908,8 +908,12 @@ private static function improveParamsFromDocblock(`
`908`	`908`	`);`
`909`	`909`
`910`	`910`	`if ($params_without_docblock_type) {`
	`911`	`+ /** @psalm-suppress DeprecatedProperty remove in Psalm 6 */`
`911`	`912`	`$storage->unused_docblock_params = $unused_docblock_params;`
`912`	`913`	`}`
	`914`	`+`
	`915`	`+ $storage->has_undertyped_native_parameters = $params_without_docblock_type !== [];`
	`916`	`+ $storage->unused_docblock_parameters = $unused_docblock_params;`
`913`	`917`	`}`
`914`	`918`
`915`	`919`	`/**`