Improve array_search inference

VincentLanglet · VincentLanglet · commit b7056396c6e1 · 2025-05-24T15:07:06.000+02:00
diff --git a/src/Type/Accessory/AccessoryArrayListType.php b/src/Type/Accessory/AccessoryArrayListType.php
@@ -241,7 +241,7 @@ public function reverseArray(TrinaryLogic $preserveKeys): Type
 		return new MixedType();
 	}
 
-	public function searchArray(Type $needleType): Type
+	public function searchArray(Type $needleType, TrinaryLogic $strict): Type
 	{
 		return new MixedType();
 	}
diff --git a/src/Type/Accessory/HasOffsetValueType.php b/src/Type/Accessory/HasOffsetValueType.php
@@ -262,11 +262,15 @@ public function reverseArray(TrinaryLogic $preserveKeys): Type
 		return new NonEmptyArrayType();
 	}
 
-	public function searchArray(Type $needleType): Type
+	public function searchArray(Type $needleType, TrinaryLogic $strict): Type
 	{
 		if (
 			$needleType instanceof ConstantScalarType && $this->valueType instanceof ConstantScalarType
-			&& $needleType->getValue() === $this->valueType->getValue()
+			&& (
+				$needleType->getValue() === $this->valueType->getValue()
+				// @phpstan-ignore equal.notAllowed
+				|| ($strict->no() && $needleType->getValue() == $this->valueType->getValue()) // phpcs:ignore
+			)
 		) {
 			return new UnionType([
 				new IntegerType(),
diff --git a/src/Type/Accessory/NonEmptyArrayType.php b/src/Type/Accessory/NonEmptyArrayType.php
@@ -218,7 +218,7 @@ public function reverseArray(TrinaryLogic $preserveKeys): Type
 		return $this;
 	}
 
-	public function searchArray(Type $needleType): Type
+	public function searchArray(Type $needleType, TrinaryLogic $strict): Type
 	{
 		return new MixedType();
 	}
diff --git a/src/Type/Accessory/OversizedArrayType.php b/src/Type/Accessory/OversizedArrayType.php
@@ -214,7 +214,7 @@ public function reverseArray(TrinaryLogic $preserveKeys): Type
 		return $this;
 	}
 
-	public function searchArray(Type $needleType): Type
+	public function searchArray(Type $needleType, TrinaryLogic $strict): Type
 	{
 		return new MixedType();
 	}
diff --git a/src/Type/ArrayType.php b/src/Type/ArrayType.php
@@ -601,8 +601,12 @@ public function reverseArray(TrinaryLogic $preserveKeys): Type
 		return $this;
 	}
 
-	public function searchArray(Type $needleType): Type
+	public function searchArray(Type $needleType, TrinaryLogic $strict): Type
 	{
+		if ($strict->yes() && $this->getIterableValueType()->isSuperTypeOf($needleType)->no()) {
+			return new ConstantBooleanType(false);
+		}
+
 		return TypeCombinator::union($this->getIterableKeyType(), new ConstantBooleanType(false));
 	}
 
diff --git a/src/Type/Constant/ConstantArrayType.php b/src/Type/Constant/ConstantArrayType.php
@@ -909,22 +909,31 @@ public function reverseArray(TrinaryLogic $preserveKeys): Type
 		return $builder->getArray();
 	}
 
-	public function searchArray(Type $needleType): Type
+	public function searchArray(Type $needleType, TrinaryLogic $strict): Type
 	{
 		$matches = [];
 		$hasIdenticalValue = false;
 
 		foreach ($this->valueTypes as $index => $valueType) {
-			$isNeedleSuperType = $valueType->isSuperTypeOf($needleType);
-			if ($isNeedleSuperType->no()) {
-				continue;
+			if ($strict->yes()) {
+				$isNeedleSuperType = $valueType->isSuperTypeOf($needleType);
+				if ($isNeedleSuperType->no()) {
+					continue;
+				}
 			}
 
-			if ($needleType instanceof ConstantScalarType && $valueType instanceof ConstantScalarType
-				&& $needleType->getValue() === $valueType->getValue()
-				&& !$this->isOptionalKey($index)
-			) {
-				$hasIdenticalValue = true;
+			if ($needleType instanceof ConstantScalarType && $valueType instanceof ConstantScalarType) {
+				// @phpstan-ignore equal.notAllowed
+				$isLooseEqual = $needleType->getValue() == $valueType->getValue(); // phpcs:ignore
+				if (!$isLooseEqual) {
+					continue;
+				}
+				if (
+					($strict->no() || $needleType->getValue() === $valueType->getValue())
+					&& !$this->isOptionalKey($index)
+				) {
+					$hasIdenticalValue = true;
+				}
 			}
 
 			$matches[] = $this->keyTypes[$index];
diff --git a/src/Type/IntersectionType.php b/src/Type/IntersectionType.php
@@ -819,9 +819,9 @@ public function reverseArray(TrinaryLogic $preserveKeys): Type
 		return $this->intersectTypes(static fn (Type $type): Type => $type->reverseArray($preserveKeys));
 	}
 
-	public function searchArray(Type $needleType): Type
+	public function searchArray(Type $needleType, TrinaryLogic $strict): Type
 	{
-		return $this->intersectTypes(static fn (Type $type): Type => $type->searchArray($needleType));
+		return $this->intersectTypes(static fn (Type $type): Type => $type->searchArray($needleType, $strict));
 	}
 
 	public function shiftArray(): Type
diff --git a/src/Type/MixedType.php b/src/Type/MixedType.php
@@ -264,7 +264,7 @@ public function reverseArray(TrinaryLogic $preserveKeys): Type
 		return new ArrayType(new MixedType($this->isExplicitMixed), new MixedType($this->isExplicitMixed));
 	}
 
-	public function searchArray(Type $needleType): Type
+	public function searchArray(Type $needleType, TrinaryLogic $strict): Type
 	{
 		if ($this->isArray()->no()) {
 			return new ErrorType();
diff --git a/src/Type/NeverType.php b/src/Type/NeverType.php
@@ -336,7 +336,7 @@ public function reverseArray(TrinaryLogic $preserveKeys): Type
 		return new NeverType();
 	}
 
-	public function searchArray(Type $needleType): Type
+	public function searchArray(Type $needleType, TrinaryLogic $strict): Type
 	{
 		return new NeverType();
 	}
diff --git a/src/Type/Php/ArraySearchFunctionDynamicReturnTypeExtension.php b/src/Type/Php/ArraySearchFunctionDynamicReturnTypeExtension.php
@@ -11,7 +11,6 @@
 use PHPStan\Type\NeverType;
 use PHPStan\Type\NullType;
 use PHPStan\Type\Type;
-use PHPStan\Type\TypeCombinator;
 use function count;
 
 final class ArraySearchFunctionDynamicReturnTypeExtension implements DynamicFunctionReturnTypeExtension
@@ -39,20 +38,14 @@ public function getTypeFromFunctionCall(FunctionReflection $functionReflection,
 		}
 
 		if ($argsCount < 3) {
-			return TypeCombinator::union($haystackArgType->getIterableKeyType(), new ConstantBooleanType(false));
-		}
-
-		$strictArgType = $scope->getType($functionCall->getArgs()[2]->value);
-		if (!$strictArgType->isTrue()->yes()) {
-			return TypeCombinator::union($haystackArgType->getIterableKeyType(), new ConstantBooleanType(false));
+			$strictArgType = new ConstantBooleanType(false);
+		} else {
+			$strictArgType = $scope->getType($functionCall->getArgs()[2]->value);
 		}
 
 		$needleArgType = $scope->getType($functionCall->getArgs()[0]->value);
-		if ($haystackArgType->getIterableValueType()->isSuperTypeOf($needleArgType)->no()) {
-			return new ConstantBooleanType(false);
-		}
 
-		return $haystackArgType->searchArray($needleArgType);
+		return $haystackArgType->searchArray($needleArgType, $strictArgType->isTrue());
 	}
 
 }
diff --git a/src/Type/StaticType.php b/src/Type/StaticType.php
@@ -450,9 +450,9 @@ public function reverseArray(TrinaryLogic $preserveKeys): Type
 		return $this->getStaticObjectType()->reverseArray($preserveKeys);
 	}
 
-	public function searchArray(Type $needleType): Type
+	public function searchArray(Type $needleType, TrinaryLogic $strict): Type
 	{
-		return $this->getStaticObjectType()->searchArray($needleType);
+		return $this->getStaticObjectType()->searchArray($needleType, $strict);
 	}
 
 	public function shiftArray(): Type
diff --git a/src/Type/Traits/LateResolvableTypeTrait.php b/src/Type/Traits/LateResolvableTypeTrait.php
@@ -298,9 +298,9 @@ public function reverseArray(TrinaryLogic $preserveKeys): Type
 		return $this->resolve()->reverseArray($preserveKeys);
 	}
 
-	public function searchArray(Type $needleType): Type
+	public function searchArray(Type $needleType, TrinaryLogic $strict): Type
 	{
-		return $this->resolve()->searchArray($needleType);
+		return $this->resolve()->searchArray($needleType, $strict);
 	}
 
 	public function shiftArray(): Type
diff --git a/src/Type/Traits/MaybeArrayTypeTrait.php b/src/Type/Traits/MaybeArrayTypeTrait.php
@@ -79,7 +79,7 @@ public function reverseArray(TrinaryLogic $preserveKeys): Type
 		return new ErrorType();
 	}
 
-	public function searchArray(Type $needleType): Type
+	public function searchArray(Type $needleType, TrinaryLogic $strict): Type
 	{
 		return new ErrorType();
 	}
diff --git a/src/Type/Traits/NonArrayTypeTrait.php b/src/Type/Traits/NonArrayTypeTrait.php
@@ -79,7 +79,7 @@ public function reverseArray(TrinaryLogic $preserveKeys): Type
 		return new ErrorType();
 	}
 
-	public function searchArray(Type $needleType): Type
+	public function searchArray(Type $needleType, TrinaryLogic $strict): Type
 	{
 		return new ErrorType();
 	}
diff --git a/src/Type/Type.php b/src/Type/Type.php
@@ -172,7 +172,7 @@ public function popArray(): Type;
 
 	public function reverseArray(TrinaryLogic $preserveKeys): Type;
 
-	public function searchArray(Type $needleType): Type;
+	public function searchArray(Type $needleType, TrinaryLogic $strict): Type;
 
 	public function shiftArray(): Type;
 
diff --git a/src/Type/UnionType.php b/src/Type/UnionType.php
@@ -779,9 +779,9 @@ public function reverseArray(TrinaryLogic $preserveKeys): Type
 		return $this->unionTypes(static fn (Type $type): Type => $type->reverseArray($preserveKeys));
 	}
 
-	public function searchArray(Type $needleType): Type
+	public function searchArray(Type $needleType, TrinaryLogic $strict): Type
 	{
-		return $this->unionTypes(static fn (Type $type): Type => $type->searchArray($needleType));
+		return $this->unionTypes(static fn (Type $type): Type => $type->searchArray($needleType, $strict));
 	}
 
 	public function shiftArray(): Type
diff --git a/tests/PHPStan/Analyser/nsrt/array-search.php b/tests/PHPStan/Analyser/nsrt/array-search.php
@@ -30,7 +30,7 @@ public function normalArrays(array $arr, string $string): void
 
 		if (array_key_exists(17, $arr) && $arr[17] === 'foo') {
 			assertType('int', array_search('foo', $arr, true));
-			assertType('int|false', array_search('foo', $arr));
+			assertType('int', array_search('foo', $arr));
 			assertType('int|false', array_search($string, $arr, true));
 		}
 	}
@@ -39,25 +39,33 @@ public function constantArrays(array $arr, string $string): void
 	{
 		/** @var array{'a', 'b', 'c'} $arr */
 		assertType('1', array_search('b', $arr, true));
-		assertType('0|1|2|false', array_search('b', $arr));
+		assertType('1', array_search('b', $arr));
 		assertType('0|1|2|false', array_search($string, $arr, true));
+		assertType('0|1|2|false', array_search($string, $arr, false));
 
 		/** @var array{} $arr */
 		assertType('false', array_search('b', $arr, true));
 		assertType('false', array_search('b', $arr));
 		assertType('false', array_search($string, $arr, true));
+		assertType('false', array_search($string, $arr, false));
+
+		/** @var array{1, '1', '2'} $arr */
+		assertType('1', array_search('1', $arr, true));
+		assertType('0|1', array_search('1', $arr));
+		assertType('1|2|false', array_search($string, $arr, true));
+		assertType('0|1|2|false', array_search($string, $arr, false));
 	}
 
 	public function constantArraysWithOptionalKeys(array $arr, string $string): void
 	{
 		/** @var array{0: 'a', 1?: 'b', 2: 'c'} $arr */
 		assertType('1|false', array_search('b', $arr, true));
-		assertType('0|1|2|false', array_search('b', $arr));
+		assertType('1|false', array_search('b', $arr));
 		assertType('0|1|2|false', array_search($string, $arr, true));
 
 		/** @var array{0: 'a', 1?: 'b', 2: 'b'} $arr */
 		assertType('1|2', array_search('b', $arr, true));
-		assertType('0|1|2|false', array_search('b', $arr));
+		assertType('1|2', array_search('b', $arr));
 		assertType('0|1|2|false', array_search($string, $arr, true));
 	}
 
diff --git a/tests/PHPStan/Analyser/nsrt/bug-3789.php b/tests/PHPStan/Analyser/nsrt/bug-3789.php
@@ -19,5 +19,5 @@ function doFoo(string $needle, array $haystack): void {
 	assertType('0|1|2', array_search('foo', $haystack, true));
 
 	assertType('0|1|2|false', array_search($needle, $haystack));
-	assertType('0|1|2|false', array_search('foo', $haystack));
+	assertType('0|1|2', array_search('foo', $haystack));
 }
diff --git a/tests/PHPStan/Analyser/nsrt/bug-7809.php b/tests/PHPStan/Analyser/nsrt/bug-7809.php
@@ -6,13 +6,13 @@
 use function PHPStan\Testing\assertType;
 
 function foo(bool $strict = false): void {
-	assertType('0|1|2|false', array_search('c', ['a', 'b', 'c'], $strict));
+	assertType('2', array_search('c', ['a', 'b', 'c'], $strict));
 }
 
 function bar(): void{
 	assertType('2', array_search('c', ['a', 'b', 'c'], true));
 }
 
 function baz(): void{
-	assertType('0|1|2|false', array_search('c', ['a', 'b', 'c'], false));
+	assertType('2', array_search('c', ['a', 'b', 'c'], false));
 }

Original file line number	Diff line number	Diff line change
`@@ -241,7 +241,7 @@ public function reverseArray(TrinaryLogic $preserveKeys): Type`
`241`	`241`	`return new MixedType();`
`242`	`242`	`}`
`243`	`243`
`244`		`- public function searchArray(Type $needleType): Type`
	`244`	`+ public function searchArray(Type $needleType, TrinaryLogic $strict): Type`
`245`	`245`	`{`
`246`	`246`	`return new MixedType();`
`247`	`247`	`}`
Original file line number	Diff line number	Diff line change
`@@ -218,7 +218,7 @@ public function reverseArray(TrinaryLogic $preserveKeys): Type`
`218`	`218`	`return $this;`
`219`	`219`	`}`
`220`	`220`
`221`		`- public function searchArray(Type $needleType): Type`
	`221`	`+ public function searchArray(Type $needleType, TrinaryLogic $strict): Type`
`222`	`222`	`{`
`223`	`223`	`return new MixedType();`
`224`	`224`	`}`
Original file line number	Diff line number	Diff line change
`@@ -214,7 +214,7 @@ public function reverseArray(TrinaryLogic $preserveKeys): Type`
`214`	`214`	`return $this;`
`215`	`215`	`}`
`216`	`216`
`217`		`- public function searchArray(Type $needleType): Type`
	`217`	`+ public function searchArray(Type $needleType, TrinaryLogic $strict): Type`
`218`	`218`	`{`
`219`	`219`	`return new MixedType();`
`220`	`220`	`}`
Original file line number	Diff line number	Diff line change
`@@ -601,8 +601,12 @@ public function reverseArray(TrinaryLogic $preserveKeys): Type`
`601`	`601`	`return $this;`
`602`	`602`	`}`
`603`	`603`
`604`		`- public function searchArray(Type $needleType): Type`
	`604`	`+ public function searchArray(Type $needleType, TrinaryLogic $strict): Type`
`605`	`605`	`{`
	`606`	`+ if ($strict->yes() && $this->getIterableValueType()->isSuperTypeOf($needleType)->no()) {`
	`607`	`+ return new ConstantBooleanType(false);`
	`608`	`+ }`
	`609`	`+`
`606`	`610`	`return TypeCombinator::union($this->getIterableKeyType(), new ConstantBooleanType(false));`
`607`	`611`	`}`
`608`	`612`
Original file line number	Diff line number	Diff line change
`@@ -819,9 +819,9 @@ public function reverseArray(TrinaryLogic $preserveKeys): Type`
`819`	`819`	`return $this->intersectTypes(static fn (Type $type): Type => $type->reverseArray($preserveKeys));`
`820`	`820`	`}`
`821`	`821`
`822`		`- public function searchArray(Type $needleType): Type`
	`822`	`+ public function searchArray(Type $needleType, TrinaryLogic $strict): Type`
`823`	`823`	`{`
`824`		`- return $this->intersectTypes(static fn (Type $type): Type => $type->searchArray($needleType));`
	`824`	`+ return $this->intersectTypes(static fn (Type $type): Type => $type->searchArray($needleType, $strict));`
`825`	`825`	`}`
`826`	`826`
`827`	`827`	`public function shiftArray(): Type`
Original file line number	Diff line number	Diff line change
`@@ -264,7 +264,7 @@ public function reverseArray(TrinaryLogic $preserveKeys): Type`
`264`	`264`	`return new ArrayType(new MixedType($this->isExplicitMixed), new MixedType($this->isExplicitMixed));`
`265`	`265`	`}`
`266`	`266`
`267`		`- public function searchArray(Type $needleType): Type`
	`267`	`+ public function searchArray(Type $needleType, TrinaryLogic $strict): Type`
`268`	`268`	`{`
`269`	`269`	`if ($this->isArray()->no()) {`
`270`	`270`	`return new ErrorType();`
Original file line number	Diff line number	Diff line change
`@@ -336,7 +336,7 @@ public function reverseArray(TrinaryLogic $preserveKeys): Type`
`336`	`336`	`return new NeverType();`
`337`	`337`	`}`
`338`	`338`
`339`		`- public function searchArray(Type $needleType): Type`
	`339`	`+ public function searchArray(Type $needleType, TrinaryLogic $strict): Type`
`340`	`340`	`{`
`341`	`341`	`return new NeverType();`
`342`	`342`	`}`