Merge pull request #9434 from weirdan/array_pop-is-impure

weirdan · web-flow · commit 72e4e1dba7fa · 2023-02-28T18:55:20.000-04:00
`array_pop` is impure
diff --git a/src/Psalm/Internal/Codebase/Functions.php b/src/Psalm/Internal/Codebase/Functions.php
@@ -476,6 +476,7 @@ public function isCallMapFunctionPure(
             'date_default_timezone_set', 'assert_options', 'setlocale',
             'set_exception_handler', 'set_time_limit', 'putenv', 'spl_autoload_register',
             'spl_autoload_unregister', 'microtime', 'array_rand', 'set_include_path',
+            'array_pop',
 
             // logging
             'openlog', 'syslog', 'error_log', 'define_syslog_variables',
diff --git a/tests/PureAnnotationTest.php b/tests/PureAnnotationTest.php
@@ -902,6 +902,30 @@ function (): void {}
                     ',
                 'error_message' => 'ImpureFunctionCall',
             ],
+            'array_popIsNotMutationFree' => [
+                'code' => <<<'PHP'
+                    <?php
+                    class Stack
+                    {
+                        /** @var array<string> */
+                        private array $stack = [];
+
+                        public function push(string $item): void
+                        {
+                            $this->stack[] = $item;
+                        }
+
+                        /** @psalm-mutation-free */
+                        public function next(): string|null
+                        {
+                            return array_pop($this->stack);
+                        }
+                    }
+                    PHP,
+                'error_message' => 'ImpureFunctionCall',
+                'ignored_issues' => [],
+                'php_version' => '8.0',
+            ],
         ];
     }
 }
