Improve support of FILTER_REQUIRE_ARRAY

VincentLanglet · web-flow · commit 782382d8efe3 · 2025-10-06T10:55:59.000+02:00
diff --git a/src/Type/Php/FilterFunctionReturnTypeHelper.php b/src/Type/Php/FilterFunctionReturnTypeHelper.php
@@ -139,10 +139,11 @@ public function getType(Type $inputType, ?Type $filterType, ?Type $flagsType): T
 		}
 
 		if ($inputType->isScalar()->no() && $inputType->isNull()->no()) {
-			return $defaultType;
+			$exactType = $defaultType;
+		} else {
+			$exactType = $this->determineExactType($inputType, $filterValue, $defaultType, $flagsType);
 		}
 
-		$exactType = $this->determineExactType($inputType, $filterValue, $defaultType, $flagsType);
 		$type = $exactType ?? $this->getFilterTypeMap()[$filterValue] ?? $mixedType;
 		$type = $this->applyRangeOptions($type, $options, $defaultType);
 
@@ -156,16 +157,19 @@ public function getType(Type $inputType, ?Type $filterType, ?Type $flagsType): T
 			$type = TypeCombinator::intersect($type, $accessory);
 		}
 
-		if ($hasRequireArrayFlag) {
-			$type = new ArrayType($inputArrayKeyType ?? $mixedType, $type);
-		}
-
 		if ($exactType === null || $hasOptions->maybe() || (!$inputType->equals($type) && $inputType->isSuperTypeOf($type)->yes())) {
 			if ($defaultType->isSuperTypeOf($type)->no()) {
 				$type = TypeCombinator::union($type, $defaultType);
 			}
 		}
 
+		if ($hasRequireArrayFlag) {
+			$type = new ArrayType($inputArrayKeyType ?? $mixedType, $type);
+			if (!$inputIsArray->yes()) {
+				$type = TypeCombinator::union($type, $defaultType);
+			}
+		}
+
 		if (!$hasRequireArrayFlag && $hasForceArrayFlag) {
 			return new ArrayType($inputArrayKeyType ?? $mixedType, $type);
 		}
diff --git a/tests/PHPStan/Analyser/nsrt/discussion-9134.php b/tests/PHPStan/Analyser/nsrt/discussion-9134.php
@@ -6,7 +6,7 @@
 
 $var = $_GET["data"];
 $res = filter_var($var, FILTER_VALIDATE_INT, FILTER_REQUIRE_ARRAY);
-assertType('array<int>|false', $res);
+assertType('array<int|false>|false', $res);
 if (is_array($res) === false) {
 	throw new \RuntimeException();
 }
diff --git a/tests/PHPStan/Analyser/nsrt/filter-var.php b/tests/PHPStan/Analyser/nsrt/filter-var.php
@@ -23,10 +23,10 @@ public function doFoo($mixed, array $stringMixedMap): void
 		assertType('null', filter_var(17, FILTER_VALIDATE_INT, ['flags' => FILTER_REQUIRE_ARRAY|FILTER_NULL_ON_FAILURE]));
 		assertType('false', filter_var('foo', FILTER_VALIDATE_INT, ['flags' => FILTER_REQUIRE_ARRAY]));
 		assertType('null', filter_var('foo', FILTER_VALIDATE_INT, ['flags' => FILTER_REQUIRE_ARRAY|FILTER_NULL_ON_FAILURE]));
-		assertType('array<int>|false', filter_var($mixed, FILTER_VALIDATE_INT, ['flags' => FILTER_REQUIRE_ARRAY]));
-		assertType('array<int>|null', filter_var($mixed, FILTER_VALIDATE_INT, ['flags' => FILTER_REQUIRE_ARRAY|FILTER_NULL_ON_FAILURE]));
-		assertType('array<string, int>|false', filter_var($stringMixedMap, FILTER_VALIDATE_INT, ['flags' => FILTER_REQUIRE_ARRAY]));
-		assertType('array<string, int>|null', filter_var($stringMixedMap, FILTER_VALIDATE_INT, ['flags' => FILTER_REQUIRE_ARRAY|FILTER_NULL_ON_FAILURE]));
+		assertType('array<int|false>|false', filter_var($mixed, FILTER_VALIDATE_INT, ['flags' => FILTER_REQUIRE_ARRAY]));
+		assertType('array<int|null>|null', filter_var($mixed, FILTER_VALIDATE_INT, ['flags' => FILTER_REQUIRE_ARRAY|FILTER_NULL_ON_FAILURE]));
+		assertType('array<string, int|false>', filter_var($stringMixedMap, FILTER_VALIDATE_INT, ['flags' => FILTER_REQUIRE_ARRAY]));
+		assertType('array<string, int|null>', filter_var($stringMixedMap, FILTER_VALIDATE_INT, ['flags' => FILTER_REQUIRE_ARRAY|FILTER_NULL_ON_FAILURE]));
 
 		assertType('array<17>', filter_var(17, FILTER_VALIDATE_INT, ['flags' => FILTER_FORCE_ARRAY]));
 		assertType('array<17>', filter_var(17, FILTER_VALIDATE_INT, ['flags' => FILTER_FORCE_ARRAY|FILTER_NULL_ON_FAILURE]));
@@ -41,10 +41,10 @@ public function doFoo($mixed, array $stringMixedMap): void
 		assertType('null', filter_var(17, FILTER_VALIDATE_INT, ['flags' => FILTER_REQUIRE_ARRAY|FILTER_FORCE_ARRAY|FILTER_NULL_ON_FAILURE]));
 		assertType('false', filter_var('foo', FILTER_VALIDATE_INT, ['flags' => FILTER_REQUIRE_ARRAY|FILTER_FORCE_ARRAY]));
 		assertType('null', filter_var('foo', FILTER_VALIDATE_INT, ['flags' => FILTER_REQUIRE_ARRAY|FILTER_FORCE_ARRAY|FILTER_NULL_ON_FAILURE]));
-		assertType('array<int>|false', filter_var($mixed, FILTER_VALIDATE_INT, ['flags' => FILTER_REQUIRE_ARRAY|FILTER_FORCE_ARRAY]));
-		assertType('array<int>|null', filter_var($mixed, FILTER_VALIDATE_INT, ['flags' => FILTER_REQUIRE_ARRAY|FILTER_FORCE_ARRAY|FILTER_NULL_ON_FAILURE]));
-		assertType('array<string, int>|false', filter_var($stringMixedMap, FILTER_VALIDATE_INT, ['flags' => FILTER_REQUIRE_ARRAY|FILTER_FORCE_ARRAY]));
-		assertType('array<string, int>|null', filter_var($stringMixedMap, FILTER_VALIDATE_INT, ['flags' => FILTER_REQUIRE_ARRAY|FILTER_FORCE_ARRAY|FILTER_NULL_ON_FAILURE]));
+		assertType('array<int|false>|false', filter_var($mixed, FILTER_VALIDATE_INT, ['flags' => FILTER_REQUIRE_ARRAY|FILTER_FORCE_ARRAY]));
+		assertType('array<int|null>|null', filter_var($mixed, FILTER_VALIDATE_INT, ['flags' => FILTER_REQUIRE_ARRAY|FILTER_FORCE_ARRAY|FILTER_NULL_ON_FAILURE]));
+		assertType('array<string, int|false>', filter_var($stringMixedMap, FILTER_VALIDATE_INT, ['flags' => FILTER_REQUIRE_ARRAY|FILTER_FORCE_ARRAY]));
+		assertType('array<string, int|null>', filter_var($stringMixedMap, FILTER_VALIDATE_INT, ['flags' => FILTER_REQUIRE_ARRAY|FILTER_FORCE_ARRAY|FILTER_NULL_ON_FAILURE]));
 
 		assertType('0|int<17, 19>', filter_var($mixed, FILTER_VALIDATE_INT, ['options' => ['default' => 0, 'min_range' => 17, 'max_range' => 19]]));
 
diff --git a/tests/PHPStan/Rules/Functions/CallToFunctionParametersRuleTest.php b/tests/PHPStan/Rules/Functions/CallToFunctionParametersRuleTest.php
@@ -2329,6 +2329,11 @@ public function testBug13434(): void
 		$this->analyse([__DIR__ . '/data/bug-13434.php'], []);
 	}
 
+	public function testBug11863(): void
+	{
+		$this->analyse([__DIR__ . '/data/bug-11863.php'], []);
+	}
+
 	public function testBug13556(): void
 	{
 		$this->checkExplicitMixed = true;
diff --git a/tests/PHPStan/Rules/Functions/data/bug-11863.php b/tests/PHPStan/Rules/Functions/data/bug-11863.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace Bug11863;
+
+$ips = ['0.0.0.0', '1.2.3.4', '10.0.0.1'];
+
+$ips = array_filter(
+	filter_var(
+		$ips,
+		FILTER_VALIDATE_IP,
+		FILTER_REQUIRE_ARRAY
+	)
+);

Original file line number	Diff line number	Diff line change
`@@ -139,10 +139,11 @@ public function getType(Type $inputType, ?Type $filterType, ?Type $flagsType): T`
`139`	`139`	`}`
`140`	`140`
`141`	`141`	`if ($inputType->isScalar()->no() && $inputType->isNull()->no()) {`
`142`		`- return $defaultType;`
	`142`	`+ $exactType = $defaultType;`
	`143`	`+ } else {`
	`144`	`+ $exactType = $this->determineExactType($inputType, $filterValue, $defaultType, $flagsType);`
`143`	`145`	`}`
`144`	`146`
`145`		`- $exactType = $this->determineExactType($inputType, $filterValue, $defaultType, $flagsType);`
`146`	`147`	`$type = $exactType ?? $this->getFilterTypeMap()[$filterValue] ?? $mixedType;`
`147`	`148`	`$type = $this->applyRangeOptions($type, $options, $defaultType);`
`148`	`149`
`@@ -156,16 +157,19 @@ public function getType(Type $inputType, ?Type $filterType, ?Type $flagsType): T`
`156`	`157`	`$type = TypeCombinator::intersect($type, $accessory);`
`157`	`158`	`}`
`158`	`159`
`159`		`- if ($hasRequireArrayFlag) {`
`160`		`- $type = new ArrayType($inputArrayKeyType ?? $mixedType, $type);`
`161`		`- }`
`162`		`-`
`163`	`160`	`if ($exactType === null \|\| $hasOptions->maybe() \|\| (!$inputType->equals($type) && $inputType->isSuperTypeOf($type)->yes())) {`
`164`	`161`	`if ($defaultType->isSuperTypeOf($type)->no()) {`
`165`	`162`	`$type = TypeCombinator::union($type, $defaultType);`
`166`	`163`	`}`
`167`	`164`	`}`
`168`	`165`
	`166`	`+ if ($hasRequireArrayFlag) {`
	`167`	`+ $type = new ArrayType($inputArrayKeyType ?? $mixedType, $type);`
	`168`	`+ if (!$inputIsArray->yes()) {`
	`169`	`+ $type = TypeCombinator::union($type, $defaultType);`
	`170`	`+ }`
	`171`	`+ }`
	`172`	`+`
`169`	`173`	`if (!$hasRequireArrayFlag && $hasForceArrayFlag) {`
`170`	`174`	`return new ArrayType($inputArrayKeyType ?? $mixedType, $type);`
`171`	`175`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`
`7`	`7`	`$var = $_GET["data"];`
`8`	`8`	`$res = filter_var($var, FILTER_VALIDATE_INT, FILTER_REQUIRE_ARRAY);`
`9`		`-assertType('array<int>\|false', $res);`
	`9`	`+assertType('array<int\|false>\|false', $res);`
`10`	`10`	`if (is_array($res) === false) {`
`11`	`11`	`throw new \RuntimeException();`
`12`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2329,6 +2329,11 @@ public function testBug13434(): void`
`2329`	`2329`	`$this->analyse([__DIR__ . '/data/bug-13434.php'], []);`
`2330`	`2330`	`}`
`2331`	`2331`
	`2332`	`+ public function testBug11863(): void`
	`2333`	`+ {`
	`2334`	`+ $this->analyse([__DIR__ . '/data/bug-11863.php'], []);`
	`2335`	`+ }`
	`2336`	`+`
`2332`	`2337`	`public function testBug13556(): void`
`2333`	`2338`	`{`
`2334`	`2339`	`$this->checkExplicitMixed = true;`