array_rand() requires a non-empty-array as of PHP 8

Author: staabm

resources/functionMap_php80delta_bleedingEdge.php

@@ -2,7 +2,11 @@
 
 return [
 	'new' => [
+		'array_rand' => ['int|string|array<int,int>|array<int,string>', 'input'=>'non-empty-array', 'num_req'=>'positive-int'],
+		'array_rand\'1' => ['int|string', 'input'=>'non-empty-array'],
 	],
 	'old' => [
+		'array_rand' => ['int|string|array<int,int>|array<int,string>', 'input'=>'array', 'num_req'=>'int'],
+		'array_rand\'1' => ['int|string', 'input'=>'array'],
 	],
 ];

resources/functionMap_php82delta.php

@@ -24,6 +24,7 @@
 		'iterator_count' => ['0|positive-int', 'iterator'=>'iterable'],
 		'iterator_to_array' => ['array', 'iterator'=>'iterable', 'use_keys='=>'bool'],
 		'str_split' => ['list<string>', 'str'=>'string', 'split_length='=>'positive-int'],
+		'Random\Randomizer::pickArrayKeys' => ['non-empty-array<int|string>', 'array'=>'non-empty-array', 'num'=>'positive-int'],
 	],
 	'old' => [
 

tests/PHPStan/Rules/Functions/CallToFunctionParametersRuleTest.php

@@ -2368,4 +2368,39 @@ public function testBug13556(): void
 		$this->analyse([__DIR__ . '/data/bug-13556.php'], []);
 	}
 
+	#[RequiresPhp('>= 8.0')]
+	public function testArrayRand(): void
+	{
+		$this->analyse([__DIR__ . '/data/array_rand.php'], [
+			[
+				'Parameter #1 $input of function array_rand expects non-empty-array, array{} given.',
+				7,
+				'array{} is empty.',
+			],
+			[
+				'Parameter #1 $input of function array_rand expects non-empty-array, array{} given.',
+				8,
+				'array{} is empty.',
+			],
+			[
+				'Parameter #2 $num_req of function array_rand expects int<1, max>, int given.',
+				8,
+			],
+			[
+				'Parameter #2 $num_req of function array_rand expects int<1, max>, -5 given.',
+				13,
+			],
+			[
+				'Parameter #2 $num_req of function array_rand expects int<1, max>, 0 given.',
+				14,
+			],
+		]);
+	}
+
+	#[RequiresPhp('< 8.0')]
+	public function testArrayRandPhp7(): void
+	{
+		$this->analyse([__DIR__ . '/data/array_rand.php'], []);
+	}
+
 }

tests/PHPStan/Rules/Functions/data/array_rand.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace ArrayRand;
+
+function doFoo(int $i) {
+	$arr = [];
+	$x = array_rand($arr);
+	$y = array_rand($arr, $i);
+}
+
+/** @param non-empty-array $arr */
+function doBar(array $arr) {
+	$y = array_rand($arr, -5);
+	$y = array_rand($arr, 0);
+	$y = array_rand($arr, 1);
+	$y = array_rand($arr);
+}

tests/PHPStan/Rules/Methods/CallMethodsRuleTest.php

@@ -3675,4 +3675,25 @@ public function testBug13511(): void
 		$this->analyse([__DIR__ . '/data/bug-13511.php'], []);
 	}
 
+	#[RequiresPhp('>= 8.2')]
+	public function testRandomizer(): void
+	{
+		$this->checkThisOnly = false;
+		$this->checkNullables = true;
+		$this->checkUnionTypes = true;
+		$this->checkExplicitMixed = true;
+
+		$this->analyse([__DIR__ . '/data/randomizer.php'], [
+			[
+				'Parameter #2 $num of method Random\Randomizer::pickArrayKeys() expects int<1, max>, 0 given.',
+				7,
+			],
+			[
+				'Parameter #1 $array of method Random\Randomizer::pickArrayKeys() expects non-empty-array, array{} given.',
+				8,
+				'array{} is empty.',
+			],
+		]);
+	}
+
 }

tests/PHPStan/Rules/Methods/data/randomizer.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Randomizer;
+
+$r = new \Random\Randomizer();
+var_dump($r->pickArrayKeys(['a', 'b'], 10));
+var_dump($r->pickArrayKeys(['a'], 0));
+var_dump($r->pickArrayKeys([], 1));