Allow ARRAY_FILTER_USE_VALUE as the mode of array_filter() and narrow its result

Closes phpstan/phpstan#15372

Author: Amoifr

resources/constantToFunctionParameterMap.php

@@ -305,6 +305,7 @@
 			'constants' => [
 				'ARRAY_FILTER_USE_KEY',
 				'ARRAY_FILTER_USE_BOTH',
+				'ARRAY_FILTER_USE_VALUE',
 			],
 		],
 	],

src/Type/Php/ArrayFilterFunctionReturnTypeHelper.php

@@ -323,7 +323,10 @@ private function determineMode(?Expr $flagArg, Scope $scope): ?int
 			return null;
 		}
 
-		if ($flagValues[0] === $this->getConstant('ARRAY_FILTER_USE_KEY')) {
+		// ARRAY_FILTER_USE_VALUE (PHP 8.6+) is 0, the default mode
+		if ($flagValues[0] === 0) {
+			return self::USE_ITEM;
+		} elseif ($flagValues[0] === $this->getConstant('ARRAY_FILTER_USE_KEY')) {
 			return self::USE_KEY;
 		} elseif ($flagValues[0] === $this->getConstant('ARRAY_FILTER_USE_BOTH')) {
 			return self::USE_BOTH;

tests/PHPStan/Analyser/nsrt/bug-15372.php

@@ -0,0 +1,17 @@
+<?php // lint >= 8.6
+
+declare(strict_types = 1);
+
+namespace Bug15372;
+
+use function PHPStan\Testing\assertType;
+
+/**
+ * @param list<int|null> $list
+ */
+function doFoo(array $list): void
+{
+	assertType('array<int<0, max>, int>', array_filter($list, static fn ($item): bool => $item !== null, ARRAY_FILTER_USE_VALUE));
+	assertType('array<int<0, max>, int>', array_filter($list, static fn ($item): bool => $item !== null, mode: ARRAY_FILTER_USE_VALUE));
+	assertType('array<int<0, max>, int>', array_filter($list, static fn ($item): bool => $item !== null, 0));
+}

tests/PHPStan/Rules/Functions/CallToFunctionParametersRulePhp86Test.php

@@ -0,0 +1,64 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Functions;
+
+use PHPStan\Rules\FunctionCallParametersCheck;
+use PHPStan\Rules\NullsafeCheck;
+use PHPStan\Rules\PhpDoc\UnresolvableTypeHelper;
+use PHPStan\Rules\Properties\PropertyReflectionFinder;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleLevelHelper;
+use PHPStan\Testing\RuleTestCase;
+
+/**
+ * @extends RuleTestCase<CallToFunctionParametersRule>
+ */
+class CallToFunctionParametersRulePhp86Test extends RuleTestCase
+{
+
+	protected function getRule(): Rule
+	{
+		$broker = self::createReflectionProvider();
+		return new CallToFunctionParametersRule(
+			$broker,
+			new FunctionCallParametersCheck(
+				new RuleLevelHelper(
+					$broker,
+					checkNullables: true,
+					checkThisOnly: false,
+					checkUnionTypes: true,
+					checkExplicitMixed: true,
+					checkImplicitMixed: true,
+					checkBenevolentUnionTypes: false,
+					discoveringSymbolsTip: true,
+				),
+				new NullsafeCheck(),
+				new UnresolvableTypeHelper(),
+				new PropertyReflectionFinder(),
+				$broker,
+				checkArgumentTypes: true,
+				checkArgumentsPassedByReference: true,
+				checkExtraArguments: true,
+				checkMissingTypehints: true,
+			),
+		);
+	}
+
+	public function testBug15372(): void
+	{
+		$this->analyse([__DIR__ . '/data/bug-15372.php'], [
+			[
+				'Constant SORT_REGULAR is not allowed for parameter #3 $mode of function array_filter.',
+				10,
+			],
+		]);
+	}
+
+	public static function getAdditionalConfigFiles(): array
+	{
+		return [
+			__DIR__ . '/data/call-to-function-php86.neon',
+		];
+	}
+
+}

tests/PHPStan/Rules/Functions/data/bug-15372.php

@@ -0,0 +1,11 @@
+<?php declare(strict_types = 1);
+
+namespace Bug15372;
+
+function (array $a): void {
+	array_filter($a, fn ($v) => $v > 1, ARRAY_FILTER_USE_VALUE);
+	array_filter($a, fn ($v) => $v > 1, mode: ARRAY_FILTER_USE_VALUE);
+	array_filter($a, fn ($k) => $k > 1, ARRAY_FILTER_USE_KEY);
+	array_filter($a, fn ($v, $k) => $v > $k, ARRAY_FILTER_USE_BOTH);
+	array_filter($a, fn ($v) => $v > 1, SORT_REGULAR);
+};

tests/PHPStan/Rules/Functions/data/call-to-function-php86.neon

@@ -0,0 +1,2 @@
+parameters:
+    phpVersion: 80600