[BCB] Parameter $isList in ConstantArrayType constructor can only…

… be `TrinaryLogic`
phpstan · Sep 29, 2024 · e75996b · e75996b
1 parent 45b4a85
commit e75996b
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 20 deletions.
diff --git a/UPGRADING.md b/UPGRADING.md
@@ -273,3 +273,4 @@ Instead of `PHPStanTestCase::createBroker()`, call `PHPStanTestCase::createRefle
   * Remove `TypeUtils::getEnumCaseObjects()`, use [`Type::getEnumCases()`](https://apiref.phpstan.org/2.0.x/PHPStan.Type.Type.html#_getEnumCases) instead
   * Remove `TypeUtils::containsCallable()`, use [`Type::isCallable()`](https://apiref.phpstan.org/2.0.x/PHPStan.Type.Type.html#_isCallable) instead
 * Removed `Scope::doNotTreatPhpDocTypesAsCertain()`, use `getNativeType()` instead
+* Parameter `$isList` in `ConstantArrayType` constructor can only be `TrinaryLogic`, no longer bool
diff --git a/src/Type/Constant/ConstantArrayType.php b/src/Type/Constant/ConstantArrayType.php
@@ -59,7 +59,6 @@
 use function count;
 use function implode;
 use function in_array;
-use function is_bool;
 use function is_int;
 use function is_string;
 use function min;
@@ -108,7 +107,7 @@ public function __construct(
 		private array $valueTypes,
 		int|array $nextAutoIndexes = [0],
 		private array $optionalKeys = [],
-		bool|TrinaryLogic $isList = false,
+		?TrinaryLogic $isList = null,
 	)
 	{
 		assert(count($keyTypes) === count($valueTypes));
@@ -124,8 +123,8 @@ public function __construct(
 			$isList = TrinaryLogic::createYes();
 		}
 
-		if (is_bool($isList)) {
-			$isList = TrinaryLogic::createFromBoolean($isList);
+		if ($isList === null) {
+			$isList = TrinaryLogic::createNo();
 		}
 		$this->isList = $isList;
 	}

diff --git a/src/Type/Php/RegexArrayShapeMatcher.php b/src/Type/Php/RegexArrayShapeMatcher.php
@@ -149,7 +149,7 @@ private function matchRegex(string $regex, ?int $flags, TrinaryLogic $wasMatched
 			if (!$this->containsUnmatchedAsNull($flags, $matchesAll)) {
 				// positive match has a subject but not any capturing group
 				$combiType = TypeCombinator::union(
-					new ConstantArrayType([new ConstantIntegerType(0)], [$this->createSubjectValueType($flags, $matchesAll)], [1], [], true),
+					new ConstantArrayType([new ConstantIntegerType(0)], [$this->createSubjectValueType($flags, $matchesAll)], [1], [], TrinaryLogic::createYes()),
 					$combiType,
 				);
 			}
@@ -214,7 +214,7 @@ private function matchRegex(string $regex, ?int $flags, TrinaryLogic $wasMatched
 				)
 			) {
 				// positive match has a subject but not any capturing group
-				$combiTypes[] = new ConstantArrayType([new ConstantIntegerType(0)], [$this->createSubjectValueType($flags, $matchesAll)], [1], [], true);
+				$combiTypes[] = new ConstantArrayType([new ConstantIntegerType(0)], [$this->createSubjectValueType($flags, $matchesAll)], [1], [], TrinaryLogic::createYes());
 			}
 
 			return TypeCombinator::union(...$combiTypes);

diff --git a/tests/PHPStan/Type/Constant/ConstantArrayTypeTest.php b/tests/PHPStan/Type/Constant/ConstantArrayTypeTest.php
@@ -886,14 +886,14 @@ public function dataValuesArray(): iterable
 			], [
 				new ConstantStringType('a'),
 				new ConstantStringType('b'),
-			], [20], [], false),
+			], [20], [], TrinaryLogic::createNo()),
 			new ConstantArrayType([
 				new ConstantIntegerType(0),
 				new ConstantIntegerType(1),
 			], [
 				new ConstantStringType('a'),
 				new ConstantStringType('b'),
-			], [2], [], true),
+			], [2], [], TrinaryLogic::createYes()),
 		];
 
 		yield 'optional-1' => [
@@ -909,7 +909,7 @@ public function dataValuesArray(): iterable
 				new ConstantStringType('c'),
 				new ConstantStringType('d'),
 				new ConstantStringType('e'),
-			], [15], [1, 3], false),
+			], [15], [1, 3], TrinaryLogic::createNo()),
 			new ConstantArrayType([
 				new ConstantIntegerType(0),
 				new ConstantIntegerType(1),
@@ -922,7 +922,7 @@ public function dataValuesArray(): iterable
 				new UnionType([new ConstantStringType('c'), new ConstantStringType('d'), new ConstantStringType('e')]),
 				new UnionType([new ConstantStringType('d'), new ConstantStringType('e')]),
 				new ConstantStringType('e'),
-			], [3, 4, 5], [3, 4], true),
+			], [3, 4, 5], [3, 4], TrinaryLogic::createYes()),
 		];
 
 		yield 'optional-2' => [
@@ -938,7 +938,7 @@ public function dataValuesArray(): iterable
 				new ConstantStringType('c'),
 				new ConstantStringType('d'),
 				new ConstantStringType('e'),
-			], [15], [0, 2, 4], false),
+			], [15], [0, 2, 4], TrinaryLogic::createNo()),
 			new ConstantArrayType([
 				new ConstantIntegerType(0),
 				new ConstantIntegerType(1),
@@ -951,7 +951,7 @@ public function dataValuesArray(): iterable
 				new UnionType([new ConstantStringType('c'), new ConstantStringType('d'), new ConstantStringType('e')]),
 				new UnionType([new ConstantStringType('d'), new ConstantStringType('e')]),
 				new ConstantStringType('e'),
-			], [2, 3, 4, 5], [2, 3, 4], true),
+			], [2, 3, 4, 5], [2, 3, 4], TrinaryLogic::createYes()),
 		];
 
 		yield 'optional-at-end-and-list' => [
@@ -963,7 +963,7 @@ public function dataValuesArray(): iterable
 				new ConstantStringType('a'),
 				new ConstantStringType('b'),
 				new ConstantStringType('c'),
-			], [11, 12, 13], [1, 2], true),
+			], [11, 12, 13], [1, 2], TrinaryLogic::createYes()),
 			new ConstantArrayType([
 				new ConstantIntegerType(0),
 				new ConstantIntegerType(1),
@@ -972,7 +972,7 @@ public function dataValuesArray(): iterable
 				new ConstantStringType('a'),
 				new ConstantStringType('b'),
 				new ConstantStringType('c'),
-			], [1, 2, 3], [1, 2], true),
+			], [1, 2, 3], [1, 2], TrinaryLogic::createYes()),
 		];
 
 		yield 'optional-at-end-but-not-list' => [
@@ -984,7 +984,7 @@ public function dataValuesArray(): iterable
 				new ConstantStringType('a'),
 				new ConstantStringType('b'),
 				new ConstantStringType('c'),
-			], [11, 12, 13], [1, 2], false),
+			], [11, 12, 13], [1, 2], TrinaryLogic::createNo()),
 			new ConstantArrayType([
 				new ConstantIntegerType(0),
 				new ConstantIntegerType(1),
@@ -993,7 +993,7 @@ public function dataValuesArray(): iterable
 				new ConstantStringType('a'),
 				new UnionType([new ConstantStringType('b'), new ConstantStringType('c')]),
 				new ConstantStringType('c'),
-			], [1, 2, 3], [1, 2], true),
+			], [1, 2, 3], [1, 2], TrinaryLogic::createYes()),
 		];
 	}
 

diff --git a/tests/PHPStan/Type/TypeGetFiniteTypesTest.php b/tests/PHPStan/Type/TypeGetFiniteTypesTest.php
@@ -3,6 +3,7 @@
 namespace PHPStan\Type;
 
 use PHPStan\Testing\PHPStanTestCase;
+use PHPStan\TrinaryLogic;
 use PHPStan\Type\Constant\ConstantArrayType;
 use PHPStan\Type\Constant\ConstantBooleanType;
 use PHPStan\Type\Constant\ConstantIntegerType;
@@ -96,28 +97,28 @@ public function dataGetFiniteTypes(): iterable
 				], [
 					new ConstantBooleanType(true),
 					new ConstantBooleanType(true),
-				], 2, [], true),
+				], 2, [], TrinaryLogic::createYes()),
 				new ConstantArrayType([
 					new ConstantIntegerType(0),
 					new ConstantIntegerType(1),
 				], [
 					new ConstantBooleanType(true),
 					new ConstantBooleanType(false),
-				], 2, [], true),
+				], 2, [], TrinaryLogic::createYes()),
 				new ConstantArrayType([
 					new ConstantIntegerType(0),
 					new ConstantIntegerType(1),
 				], [
 					new ConstantBooleanType(false),
 					new ConstantBooleanType(true),
-				], 2, [], true),
+				], 2, [], TrinaryLogic::createYes()),
 				new ConstantArrayType([
 					new ConstantIntegerType(0),
 					new ConstantIntegerType(1),
 				], [
 					new ConstantBooleanType(false),
 					new ConstantBooleanType(false),
-				], 2, [], true),
+				], 2, [], TrinaryLogic::createYes()),
 			],
 		];
 	}