feat improve for flag & non-empty-string

phpstan · ondrejmirtes · May 16, 2025 · Dec 25, 2024 · Dec 25, 2024 · Dec 25, 2024
commit c4e76c901063978bdae497292941117641b20ca0
diff --git a/src/Type/Php/PregSplitDynamicReturnTypeExtension.php b/src/Type/Php/PregSplitDynamicReturnTypeExtension.php
@@ -8,6 +8,7 @@
 use PHPStan\TrinaryLogic;
 use PHPStan\Type\Accessory\AccessoryArrayListType;
 use PHPStan\Type\Accessory\AccessoryNonEmptyStringType;
+use PHPStan\Type\Accessory\NonEmptyArrayType;
 use PHPStan\Type\ArrayType;
 use PHPStan\Type\BitwiseFlagHelper;
 use PHPStan\Type\Constant\ConstantArrayType;
@@ -92,29 +93,49 @@ public function getTypeFromFunctionCall(FunctionReflection $functionReflection,
 				$stringType = new StringType();
 			}
 
-			if ($flagArg !== null && $this->bitwiseFlagAnalyser->bitwiseOrContainsConstant($flagArg->value, $scope, 'PREG_SPLIT_OFFSET_CAPTURE')->yes()) {
-				$type = new ArrayType(
-					new IntegerType(),
-					new ConstantArrayType([new ConstantIntegerType(0), new ConstantIntegerType(1)], [$stringType, IntegerRangeType::fromInterval(0, null)], [2], [], TrinaryLogic::createYes()),
-				);
-				return TypeUtils::toBenevolentUnion(
-					TypeCombinator::union(
-						TypeCombinator::intersect($type, new AccessoryArrayListType()),
-						new ConstantBooleanType(false)
-					)
-				);
+			$capturedArrayType = new ConstantArrayType(
+				[
+					new ConstantIntegerType(0),
+					new ConstantIntegerType(1)], [$stringType, IntegerRangeType::fromInterval(0, null)
+				],
+				[2],
+				[],
+				TrinaryLogic::createYes()
+			);
+			$valueType = $stringType;
+			if ($flagArg !== null) {
+				$flagState = $this->bitwiseFlagAnalyser->bitwiseOrContainsConstant($flagArg->value, $scope, 'PREG_SPLIT_OFFSET_CAPTURE');
-				$flagState = $this->bitwiseFlagAnalyser->bitwiseOrContainsConstant($flagArg->value, $scope, 'PREG_SPLIT_OFFSET_CAPTURE');
+				$capturesOffset = $this->bitwiseFlagAnalyser->bitwiseOrContainsConstant($flagArg->value, $scope, 'PREG_SPLIT_OFFSET_CAPTURE');
-				$flagState = $this->bitwiseFlagAnalyser->bitwiseOrContainsConstant($flagArg->value, $scope, 'PREG_SPLIT_OFFSET_CAPTURE');
+				$capturesOffset = $this->bitwiseFlagAnalyser->bitwiseOrContainsConstant($flagArg->value, $scope, 'PREG_SPLIT_OFFSET_CAPTURE');
+				if ($flagState->yes()) {
+					return TypeUtils::toBenevolentUnion(
+						TypeCombinator::union(
+							TypeCombinator::intersect(
+								new ArrayType(new IntegerType(), $capturedArrayType),
+								new AccessoryArrayListType()
+							),
+							new ConstantBooleanType(false)
+						)
+					);
+				}
+				if ($flagState->maybe()) {
+					$valueType = TypeCombinator::union(new StringType(), $capturedArrayType);
+				}
 			}
 
-			if ($flagArg !== null && $this->bitwiseFlagAnalyser->bitwiseOrContainsConstant($flagArg->value, $scope, 'PREG_SPLIT_NO_EMPTY')->yes()) {
-				return TypeUtils::toBenevolentUnion(
-					TypeCombinator::union(
-						TypeCombinator::intersect(new ArrayType(new MixedType(), $stringType), new AccessoryArrayListType()),
-						new ConstantBooleanType(false)
-					)
+			$arrayType = TypeCombinator::intersect(new ArrayType(new MixedType(), $valueType), new AccessoryArrayListType());
+			if ($subjectType->isNonEmptyString()->yes()) {
+				$arrayType = TypeCombinator::intersect(
+					$arrayType,
+					new NonEmptyArrayType(),
+					new AccessoryArrayListType(),
 				);
 			}
 
-			return null;
+			return TypeUtils::toBenevolentUnion(
+				TypeCombinator::union(
+					$arrayType,
+					new ConstantBooleanType(false)
+				)
+			);
 		}
 
 		$resultTypes = [];

diff --git a/tests/PHPStan/Analyser/nsrt/preg_split.php b/tests/PHPStan/Analyser/nsrt/preg_split.php
@@ -6,6 +6,41 @@
 
 class HelloWorld
 {
+	public function doFoo()
+	{
+		assertType('*ERROR*', preg_split('/[0-9a]', '1-2-3'));
+		assertType("array{''}", preg_split('/-/', ''));
+		assertType("array{}", preg_split('/-/', '', -1, PREG_SPLIT_NO_EMPTY));
+		assertType("array{array{'', 0}}", preg_split('/-/', '', -1, PREG_SPLIT_OFFSET_CAPTURE));
+		assertType("array{}", preg_split('/-/', '', -1, PREG_SPLIT_NO_EMPTY | PREG_SPLIT_OFFSET_CAPTURE));
+		assertType("array{'1', '2', '3'}", preg_split('/-/', '1-2-3'));
+		assertType("array{'1', '2', '3'}", preg_split('/-/', '1-2-3', -1, PREG_SPLIT_NO_EMPTY));
+		assertType("array{'1', '3'}", preg_split('/-/', '1--3', -1, PREG_SPLIT_NO_EMPTY));
+		assertType("array{array{'1', 0}, array{'2', 2}, array{'3', 4}}", preg_split('/-/', '1-2-3', -1, PREG_SPLIT_OFFSET_CAPTURE));
+		assertType("array{array{'1', 0}, array{'2', 2}, array{'3', 4}}", preg_split('/-/', '1-2-3', -1, PREG_SPLIT_NO_EMPTY | PREG_SPLIT_OFFSET_CAPTURE));
+		assertType("array{array{'1', 0}, array{'', 2}, array{'3', 3}}", preg_split('/-/', '1--3', -1, PREG_SPLIT_OFFSET_CAPTURE));
+		assertType("array{array{'1', 0}, array{'3', 3}}", preg_split('/-/', '1--3', -1, PREG_SPLIT_NO_EMPTY | PREG_SPLIT_OFFSET_CAPTURE));
+	}
+
+	/**
+	 * @param non-empty-string $nonEmptySubject
+	 */
+	public function doWithVariables(string $pattern, string $subject, string $nonEmptySubject, int $offset, int $flags): void
+	{
+		assertType('(list<array{string, int<0, max>}|string>|false)', preg_split($pattern, $subject, $offset, $flags));
+		assertType('(list<array{string, int<0, max>}|string>|false)', preg_split("//", $subject, $offset, $flags));
+
+		assertType('(non-empty-list<array{string, int<0, max>}|string>|false)', preg_split($pattern, $nonEmptySubject, $offset, $flags));
+		assertType('(non-empty-list<array{string, int<0, max>}|string>|false)', preg_split("//", $nonEmptySubject, $offset, $flags));
+
+		assertType('(non-empty-list<string>|false)', preg_split("//", $nonEmptySubject));
+
+		assertType('(non-empty-list<array{string, int<0, max>}|string>|false)', preg_split($pattern, "1-2-3", $offset, $flags));
+		assertType('(list<array{string, int<0, max>}|string>|false)', preg_split($pattern, $subject, -1, $flags));
+		assertType('(list<non-empty-string>|false)', preg_split($pattern, $subject, $offset, PREG_SPLIT_NO_EMPTY));
+		assertType('(list<array{string, int<0, max>}>|false)', preg_split($pattern, $subject, $offset, PREG_SPLIT_OFFSET_CAPTURE));
+	}
+
 	/**
 	 * @param string $pattern
 	 * @param string $subject
@@ -36,34 +71,4 @@ public static function dynamicFlags($pattern, $subject, $limit = -1)
 
 		assertType('(list<array{string, int<0, max>}>|false)', preg_split($pattern, $subject, $limit, $flags));
 	}
-
-	public function doFoo()
-	{
-		assertType('*ERROR*', preg_split('/[0-9a]', '1-2-3'));
-		assertType("array{''}", preg_split('/-/', ''));
-		assertType("array{'1', '2', '3'}", preg_split('/-/', '1-2-3'));
-		assertType("array{'1', '2', '3'}", preg_split('/-/', '1-2-3', -1, PREG_SPLIT_NO_EMPTY));
-		assertType("array{'1', '3'}", preg_split('/-/', '1--3', -1, PREG_SPLIT_NO_EMPTY));
-		assertType("array{array{'1', 0}, array{'2', 2}, array{'3', 4}}", preg_split('/-/', '1-2-3', -1, PREG_SPLIT_OFFSET_CAPTURE));
-		assertType("array{array{'1', 0}, array{'2', 2}, array{'3', 4}}", preg_split('/-/', '1-2-3', -1, PREG_SPLIT_NO_EMPTY | PREG_SPLIT_OFFSET_CAPTURE));
-		assertType("array{array{'1', 0}, array{'', 2}, array{'3', 3}}", preg_split('/-/', '1--3', -1, PREG_SPLIT_OFFSET_CAPTURE));
-		assertType("array{array{'1', 0}, array{'3', 3}}", preg_split('/-/', '1--3', -1, PREG_SPLIT_NO_EMPTY | PREG_SPLIT_OFFSET_CAPTURE));
-	}
-
-	/**
-	 * @param non-empty-string $nonEmptySubject
-	 */
-	public function doWithVariables(string $pattern, string $subject, string $nonEmptySubject, int $offset, int $flags): void
-	{
-		assertType('(list<array{string, int<0, max>}|string>|false)', preg_split($pattern, $subject, $offset, $flags));
-		assertType('(list<array{string, int<0, max>}|string>|false)', preg_split("//", $subject, $offset, $flags));
-
-		assertType('(list<array{string, int<0, max>}|string>|false)', preg_split($pattern, $nonEmptySubject, $offset, $flags));
-		assertType('(list<array{string, int<0, max>}|string>|false)', preg_split("//", $nonEmptySubject, $offset, $flags));
-
-		assertType('(list<array{string, int<0, max>}|string>|false)', preg_split($pattern, "1-2-3", $offset, $flags));
-		assertType('(list<array{string, int<0, max>}|string>|false)', preg_split($pattern, $subject, -1, $flags));
-		assertType('(list<non-empty-string>|false)', preg_split($pattern, $subject, $offset, PREG_SPLIT_NO_EMPTY));
-		assertType('(list<array{string, int<0, max>}>|false)', preg_split($pattern, $subject, $offset, PREG_SPLIT_OFFSET_CAPTURE));
-	}
 }