RegexArrayShapeMatcher - fix capturing item-array-shapes for preg_match_all

Author: staabm

src/Type/Php/RegexArrayShapeMatcher.php

@@ -394,15 +394,19 @@ private function isGroupOptional(RegexCapturingGroup $captureGroup, TrinaryLogic
 	private function createGroupValueType(RegexCapturingGroup $captureGroup, TrinaryLogic $wasMatched, int $flags, bool $isTrailingOptional, bool $isLastGroup, bool $matchesAll): Type
 	{
 		if ($matchesAll) {
-			$groupValueType = $this->getValueType($captureGroup->getType(), $flags, $matchesAll);
-
-			if (!$isTrailingOptional && $this->containsUnmatchedAsNull($flags, $matchesAll) && !$captureGroup->isOptional()) {
+			if (!$this->containsSetOrder($flags) && !$this->containsUnmatchedAsNull($flags, $matchesAll) && $captureGroup->isOptional()) {
+				$groupValueType = $this->getValueType(
+					TypeCombinator::union($captureGroup->getType(), new ConstantStringType('')),
+					$flags,
+					$matchesAll,
+				);
 				$groupValueType = TypeCombinator::removeNull($groupValueType);
+			} else {
+				$groupValueType = $this->getValueType($captureGroup->getType(), $flags, $matchesAll);
 			}
 
-			if (!$this->containsSetOrder($flags) && !$this->containsUnmatchedAsNull($flags, $matchesAll) && $captureGroup->isOptional()) {
+			if (!$isTrailingOptional && $this->containsUnmatchedAsNull($flags, $matchesAll) && !$captureGroup->isOptional()) {
 				$groupValueType = TypeCombinator::removeNull($groupValueType);
-				$groupValueType = TypeCombinator::union($groupValueType, new ConstantStringType(''));
 			}
 
 			if ($this->containsPatternOrder($flags)) {
@@ -474,6 +478,8 @@ private function getValueType(Type $baseType, int $flags, bool $matchesAll): Typ
 		$offsetType = IntegerRangeType::fromInterval(0, null);
 		if ($this->containsUnmatchedAsNull($flags, $matchesAll)) {
 			$valueType = TypeCombinator::addNull($valueType);
+		}
+		if ($this->containsUnmatchedAsNull($flags, $matchesAll) || $matchesAll) {
 			// unmatched groups return -1 as offset
 			$offsetType = IntegerRangeType::fromInterval(-1, null);
 		}

tests/PHPStan/Analyser/nsrt/preg_match_all_shapes.php

@@ -112,13 +112,13 @@ function (string $size): void {
 
 function (string $size): void {
 	if (preg_match_all('/ab(?P<num>\d+)(?P<suffix>ab)?/', $size, $matches, PREG_SET_ORDER|PREG_OFFSET_CAPTURE)) {
-		assertType("list<array{0: array{string, int<0, max>}, num: array{numeric-string, int<0, max>}, 1: array{numeric-string, int<0, max>}, suffix?: array{'ab', int<0, max>}, 2?: array{'ab', int<0, max>}}>", $matches);
+		assertType("list<array{0: array{string, int<-1, max>}, num: array{numeric-string, int<-1, max>}, 1: array{numeric-string, int<-1, max>}, suffix?: array{'ab', int<-1, max>}, 2?: array{'ab', int<-1, max>}}>", $matches);
 	}
 };
 
 function (string $size): void {
 	if (preg_match_all('/ab(?P<num>\d+)(?P<suffix>ab)?/', $size, $matches, PREG_PATTERN_ORDER|PREG_OFFSET_CAPTURE)) {
-		assertType("array{0: list<array{string, int<0, max>}>, num: list<array{numeric-string, int<0, max>}>, 1: list<array{numeric-string, int<0, max>}>, suffix: list<''|array{'ab', int<0, max>}>, 2: list<''|array{'ab', int<0, max>}>}", $matches);
+		assertType("array{0: list<array{string, int<-1, max>}>, num: list<array{numeric-string, int<-1, max>}>, 1: list<array{numeric-string, int<-1, max>}>, suffix: list<array{''|'ab', int<-1, max>}>, 2: list<array{''|'ab', int<-1, max>}>}", $matches);
 	}
 };
 
@@ -142,7 +142,7 @@ public function sayHello(string $content): void
 			return;
 		}
 
-		assertType('array{list<array{string, int<0, max>}>}', $matches);
+		assertType('array{list<array{string, int<-1, max>}>}', $matches);
 	}
 
 	public function sayFoo(string $content): void
@@ -162,4 +162,16 @@ public function sayBar(string $content): void
 
 		assertType('array{list<string>}', $matches);
 	}
+
+	function doFoobar(string $s): void {
+		if (preg_match_all('/(foo)?(bar)?(baz)?/', $s, $matches, PREG_OFFSET_CAPTURE)) {
+			assertType("array{list<array{string, int<-1, max>}>, list<array{''|'foo', int<-1, max>}>, list<array{''|'bar', int<-1, max>}>, list<array{''|'baz', int<-1, max>}>}", $matches);
+		}
+	}
+
+	function doFoobarNull(string $s): void {
+		if (preg_match_all('/(foo)?(bar)?(baz)?/', $s, $matches, PREG_OFFSET_CAPTURE|PREG_UNMATCHED_AS_NULL)) {
+			assertType("array{list<array{string|null, int<-1, max>}>, list<array{'foo'|null, int<-1, max>}>, list<array{'bar'|null, int<-1, max>}>, list<array{'baz'|null, int<-1, max>}>}", $matches);
+		}
+	}
 }