Fix #5517 - don’t let a variable’s by-refness be overwritten by a @var …

…docblock
vimeo · Apr 25, 2021 · 67c5dc3 · 67c5dc3
1 parent 7b7354e
commit 67c5dc3
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/src/Psalm/Internal/Analyzer/Statements/Expression/AssignmentAnalyzer.php b/src/Psalm/Internal/Analyzer/Statements/Expression/AssignmentAnalyzer.php
@@ -158,6 +158,10 @@ public static function analyze(
                     $comment_type_location,
                     $not_ignored_docblock_var_ids
                 );
+
+                if ($var_id === $var_comment->var_id && $assign_value_type && $comment_type) {
+                    $comment_type->by_ref = $assign_value_type->by_ref;
+                }
             }
         }
 

diff --git a/tests/UnusedVariableTest.php b/tests/UnusedVariableTest.php
@@ -2377,6 +2377,16 @@ function foo(object $a, string $k) : string {
                         return $sortA;
                     }'
             ],
+            'varDocblockVariableIsUsedByRef' => [
+                '<?php
+                    function foo(array $arr) : string {
+                        /** @var string $val */
+                        foreach ($arr as &$val) {
+                            $val = urlencode($val);
+                        }
+                        return implode("/", $arr);
+                    }'
+            ],
         ];
     }