RegexArrayShapeMatcher - Fix optional groups with PREG_UNMATCHED_AS_NULL

Author: staabm

src/Type/Php/RegexArrayShapeMatcher.php

@@ -121,10 +121,13 @@ private function matchRegex(string $regex, ?int $flags, TrinaryLogic $wasMatched
 				$flags ?? 0,
 			);
 
-			return TypeCombinator::union(
-				new ConstantArrayType([new ConstantIntegerType(0)], [new StringType()], [0], [], true),
-				$combiType,
-			);
+			if (!$this->containsUnmatchedAsNull($flags ?? 0)) {
+				$combiType = TypeCombinator::union(
+					new ConstantArrayType([new ConstantIntegerType(0)], [new StringType()], [0], [], true),
+					$combiType,
+				);
+			}
+			return $combiType;
 		} elseif (
 			$wasMatched->yes()
 			&& $onlyTopLevelAlternationId !== null

tests/PHPStan/Analyser/nsrt/bug-11311-php72.php

@@ -19,3 +19,12 @@ function doUnmatchedAsNull(string $s): void {
 	assertType('array{}|array{0: string, 1?: string, 2?: string, 3?: string}', $matches);
 }
 
+// see https://3v4l.org/VeDob#veol
+function unmatchedAsNullWithOptionalGroup(string $s): void {
+	if (preg_match('/Price: (£|€)?\d+/', $s, $matches, PREG_UNMATCHED_AS_NULL)) {
+		assertType('array{0: string, 1?: string}', $matches);
+	} else {
+		assertType('array{}', $matches);
+	}
+	assertType('array{}|array{0: string, 1?: string}', $matches);
+}

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

@@ -17,3 +17,15 @@ function doUnmatchedAsNull(string $s): void {
 	}
 	assertType('array{}|array{string, string|null, string|null, string|null}', $matches);
 }
+
+// see https://3v4l.org/VeDob
+function unmatchedAsNullWithOptionalGroup(string $s): void {
+	if (preg_match('/Price: (£|€)?\d+/', $s, $matches, PREG_UNMATCHED_AS_NULL)) {
+		// with PREG_UNMATCHED_AS_NULL the offset 1 will always exist. It is correct that it's nullable because it's optional though
+		assertType('array{string, string|null}', $matches);
+	} else {
+		assertType('array{}', $matches);
+	}
+	assertType('array{}|array{string, string|null}', $matches);
+}
+

tests/PHPStan/Analyser/nsrt/preg_match_shapes.php

@@ -383,3 +383,13 @@ function bug11323b(string $s): void
 	}
 	assertType('array{}|array{0: string, currency: string, 1: string}', $matches);
 }
+
+function unmatchedAsNullWithMandatoryGroup(string $s): void {
+	if (preg_match('/Price: (?<currency>£|€)\d+/', $s, $matches, PREG_UNMATCHED_AS_NULL)) {
+		assertType('array{0: string, currency: string, 1: string}', $matches);
+	} else {
+		assertType('array{}', $matches);
+	}
+	assertType('array{}|array{0: string, currency: string, 1: string}', $matches);
+}
+