fix: Mark array_shift as having side effects

- fixes phpstan/phpstan#8084
ryium · Jan 8, 2023 · fbce69c · fbce69c
1 parent 1403c03
commit fbce69c
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 0 deletions.
diff --git a/bin/functionMetadata_original.php b/bin/functionMetadata_original.php
@@ -36,6 +36,7 @@
 	'array_replace' => ['hasSideEffects' => false],
 	'array_replace_recursive' => ['hasSideEffects' => false],
 	'array_reverse' => ['hasSideEffects' => false],
+	'array_shift' => ['hasSideEffects' => true],
 	'array_slice' => ['hasSideEffects' => false],
 	'array_sum' => ['hasSideEffects' => false],
 	'array_udiff' => ['hasSideEffects' => false],

diff --git a/resources/functionMetadata.php b/resources/functionMetadata.php
@@ -702,6 +702,7 @@
 	'array_replace_recursive' => ['hasSideEffects' => false],
 	'array_reverse' => ['hasSideEffects' => false],
 	'array_search' => ['hasSideEffects' => false],
+	'array_shift' => ['hasSideEffects' => true],
 	'array_slice' => ['hasSideEffects' => false],
 	'array_sum' => ['hasSideEffects' => false],
 	'array_udiff' => ['hasSideEffects' => false],

diff --git a/tests/PHPStan/Analyser/NodeScopeResolverTest.php b/tests/PHPStan/Analyser/NodeScopeResolverTest.php
@@ -1170,6 +1170,7 @@ public function dataFileAsserts(): iterable
 		yield from $this->gatherAssertTypes(__DIR__ . '/data/bug-8635.php');
 		yield from $this->gatherAssertTypes(__DIR__ . '/data/bug-8625.php');
 		yield from $this->gatherAssertTypes(__DIR__ . '/data/bug-8621.php');
+		yield from $this->gatherAssertTypes(__DIR__ . '/data/bug-8084.php');
 	}
 
 	/**

diff --git a/tests/PHPStan/Analyser/data/bug-8084.php b/tests/PHPStan/Analyser/data/bug-8084.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace Bug8084;
+
+use function array_shift;
+use function PHPStan\Testing\assertType;
+
+class Bug8084
+{
+	public function run(array $arr): void
+	{
+		/** @var array{a: 0, b?: 1} $arr */
+		assertType('0', array_shift($arr) ?? throw new \Exception());
+		assertType('1|null', array_shift($arr));
+	}
+}