Make null-safe shortcircuiting optional

phpstan · Sep 24, 2021 · be93bda · be93bda
1 parent 6568103
commit be93bda
Show file tree

Hide file tree

Showing 29 changed files with 82 additions and 33 deletions.
diff --git a/src/Rules/Arrays/ArrayDestructuringRule.php b/src/Rules/Arrays/ArrayDestructuringRule.php
@@ -66,7 +66,8 @@ private function getErrors(Scope $scope, Expr $var, Expr $expr): array
 			'',
 			static function (Type $varType): bool {
 				return $varType->isArray()->yes();
-			}
+			},
+			false
 		);
 		$exprType = $exprTypeResult->getType();
 		if ($exprType instanceof ErrorType) {

diff --git a/src/Rules/Arrays/IterableInForeachRule.php b/src/Rules/Arrays/IterableInForeachRule.php
@@ -36,7 +36,8 @@ public function processNode(Node $node, Scope $scope): array
 			'Iterating over an object of an unknown class %s.',
 			static function (Type $type): bool {
 				return $type->isIterable()->yes();
-			}
+			},
+			false
 		);
 		$type = $typeResult->getType();
 		if ($type instanceof ErrorType) {

diff --git a/src/Rules/Arrays/NonexistentOffsetInArrayDimFetchCheck.php b/src/Rules/Arrays/NonexistentOffsetInArrayDimFetchCheck.php
@@ -47,7 +47,8 @@ public function check(
 			$unknownClassPattern,
 			static function (Type $type) use ($dimType): bool {
 				return $type->hasOffsetValueType($dimType)->yes();
-			}
+			},
+			true
 		);
 		$type = $typeResult->getType();
 		if ($type instanceof ErrorType) {

diff --git a/src/Rules/Arrays/NonexistentOffsetInArrayDimFetchRule.php b/src/Rules/Arrays/NonexistentOffsetInArrayDimFetchRule.php
@@ -54,7 +54,8 @@ public function processNode(\PhpParser\Node $node, Scope $scope): array
 			$unknownClassPattern,
 			static function (Type $type): bool {
 				return $type->isOffsetAccessible()->yes();
-			}
+			},
+			true
 		);
 		$isOffsetAccessibleType = $isOffsetAccessibleTypeResult->getType();
 		if ($isOffsetAccessibleType instanceof ErrorType) {

diff --git a/src/Rules/Arrays/OffsetAccessAssignOpRule.php b/src/Rules/Arrays/OffsetAccessAssignOpRule.php
@@ -49,7 +49,8 @@ public function processNode(\PhpParser\Node $node, Scope $scope): array
 			static function (Type $varType) use ($potentialDimType): bool {
 				$arrayDimType = $varType->setOffsetValueType($potentialDimType, new MixedType());
 				return !($arrayDimType instanceof ErrorType);
-			}
+			},
+			true
 		);
 		$varType = $varTypeResult->getType();
 
@@ -61,7 +62,8 @@ static function (Type $varType) use ($potentialDimType): bool {
 				static function (Type $dimType) use ($varType): bool {
 					$arrayDimType = $varType->setOffsetValueType($dimType, new MixedType());
 					return !($arrayDimType instanceof ErrorType);
-				}
+				},
+				true
 			);
 			$dimType = $dimTypeResult->getType();
 			if ($varType->hasOffsetValueType($dimType)->no()) {

diff --git a/src/Rules/Arrays/OffsetAccessAssignmentRule.php b/src/Rules/Arrays/OffsetAccessAssignmentRule.php
@@ -46,7 +46,8 @@ public function processNode(\PhpParser\Node $node, Scope $scope): array
 			static function (Type $varType) use ($potentialDimType): bool {
 				$arrayDimType = $varType->setOffsetValueType($potentialDimType, new MixedType());
 				return !($arrayDimType instanceof ErrorType);
-			}
+			},
+			true
 		);
 		$varType = $varTypeResult->getType();
 		if ($varType instanceof ErrorType) {
@@ -64,7 +65,8 @@ static function (Type $varType) use ($potentialDimType): bool {
 				static function (Type $dimType) use ($varType): bool {
 					$arrayDimType = $varType->setOffsetValueType($dimType, new MixedType());
 					return !($arrayDimType instanceof ErrorType);
-				}
+				},
+				true
 			);
 			$dimType = $dimTypeResult->getType();
 		} else {

diff --git a/src/Rules/Arrays/OffsetAccessValueAssignmentRule.php b/src/Rules/Arrays/OffsetAccessValueAssignmentRule.php
@@ -61,7 +61,8 @@ public function processNode(\PhpParser\Node $node, Scope $scope): array
 			static function (Type $varType) use ($assignedValueType): bool {
 				$result = $varType->setOffsetValueType(new MixedType(), $assignedValueType);
 				return !($result instanceof ErrorType);
-			}
+			},
+			true
 		);
 		$arrayType = $arrayTypeResult->getType();
 		if ($arrayType instanceof ErrorType) {

diff --git a/src/Rules/Arrays/UnpackIterableInArrayRule.php b/src/Rules/Arrays/UnpackIterableInArrayRule.php
@@ -50,7 +50,8 @@ public function processNode(Node $node, Scope $scope): array
 				'',
 				static function (Type $type): bool {
 					return $type->isIterable()->yes();
-				}
+				},
+				false
 			);
 			$type = $typeResult->getType();
 			if ($type instanceof ErrorType) {

diff --git a/src/Rules/Cast/EchoRule.php b/src/Rules/Cast/EchoRule.php
@@ -40,7 +40,8 @@ public function processNode(Node $node, Scope $scope): array
 				'',
 				static function (Type $type): bool {
 					return !$type->toString() instanceof ErrorType;
-				}
+				},
+				false
 			);
 
 			if ($typeResult->getType() instanceof ErrorType

diff --git a/src/Rules/Cast/InvalidCastRule.php b/src/Rules/Cast/InvalidCastRule.php
@@ -62,7 +62,8 @@ static function (Type $type) use ($castTypeCallback): bool {
 				}
 
 				return !$castType instanceof ErrorType;
-			}
+			},
+			false
 		);
 		$type = $typeResult->getType();
 		if ($type instanceof ErrorType) {

diff --git a/src/Rules/Cast/InvalidPartOfEncapsedStringRule.php b/src/Rules/Cast/InvalidPartOfEncapsedStringRule.php
@@ -48,7 +48,8 @@ public function processNode(Node $node, Scope $scope): array
 				'',
 				static function (Type $type): bool {
 					return !$type->toString() instanceof ErrorType;
-				}
+				},
+				false
 			);
 			$partType = $typeResult->getType();
 			if ($partType instanceof ErrorType) {

diff --git a/src/Rules/Cast/PrintRule.php b/src/Rules/Cast/PrintRule.php
@@ -37,7 +37,8 @@ public function processNode(Node $node, Scope $scope): array
 			'',
 			static function (Type $type): bool {
 				return !$type->toString() instanceof ErrorType;
-			}
+			},
+			false
 		);
 
 		if (!$typeResult->getType() instanceof ErrorType

diff --git a/src/Rules/Classes/ClassConstantRule.php b/src/Rules/Classes/ClassConstantRule.php
@@ -122,7 +122,8 @@ public function processNode(Node $node, Scope $scope): array
 				sprintf('Access to constant %s on an unknown class %%s.', SprintfHelper::escapeFormatString($constantName)),
 				static function (Type $type) use ($constantName): bool {
 					return $type->canAccessConstants()->yes() && $type->hasConstant($constantName)->yes();
-				}
+				},
+				true
 			);
 			$classType = $classTypeResult->getType();
 			if ($classType instanceof ErrorType) {

diff --git a/src/Rules/FunctionCallParametersCheck.php b/src/Rules/FunctionCallParametersCheck.php
@@ -234,7 +234,8 @@ public function check(
 					'',
 					static function (Type $type): bool {
 						return $type->isIterable()->yes();
-					}
+					},
+					true
 				);
 				$iterableTypeResultType = $iterableTypeResult->getType();
 				if (

diff --git a/src/Rules/Functions/CallCallablesRule.php b/src/Rules/Functions/CallCallablesRule.php
@@ -57,7 +57,8 @@ public function processNode(
 			'Invoking callable on an unknown class %s.',
 			static function (Type $type): bool {
 				return $type->isCallable()->yes();
-			}
+			},
+			true
 		);
 		$type = $typeResult->getType();
 		if ($type instanceof ErrorType) {

diff --git a/src/Rules/Functions/ImplodeFunctionRule.php b/src/Rules/Functions/ImplodeFunctionRule.php
@@ -64,7 +64,8 @@ public function processNode(Node $node, Scope $scope): array
 			'',
 			static function (Type $type): bool {
 				return !$type->getIterableValueType()->toString() instanceof ErrorType;
-			}
+			},
+			false
 		);
 
 		if ($typeResult->getType() instanceof ErrorType

diff --git a/src/Rules/Methods/CallMethodsRule.php b/src/Rules/Methods/CallMethodsRule.php
@@ -58,13 +58,15 @@ public function processNode(Node $node, Scope $scope): array
 		}
 
 		$name = $node->name->name;
+
 		$typeResult = $this->ruleLevelHelper->findTypeToCheck(
 			$scope,
 			$node->var,
 			sprintf('Call to method %s() on an unknown class %%s.', SprintfHelper::escapeFormatString($name)),
 			static function (Type $type) use ($name): bool {
 				return $type->canCallMethods()->yes() && $type->hasMethod($name)->yes();
-			}
+			},
+			true
 		);
 		$type = $typeResult->getType();
 		if ($type instanceof ErrorType) {

diff --git a/src/Rules/Methods/CallStaticMethodsRule.php b/src/Rules/Methods/CallStaticMethodsRule.php
@@ -154,7 +154,8 @@ public function processNode(Node $node, Scope $scope): array
 				sprintf('Call to static method %s() on an unknown class %%s.', SprintfHelper::escapeFormatString($methodName)),
 				static function (Type $type) use ($methodName): bool {
 					return $type->canCallMethods()->yes() && $type->hasMethod($methodName)->yes();
-				}
+				},
+				true
 			);
 			$classType = $classTypeResult->getType();
 			if ($classType instanceof ErrorType) {

diff --git a/src/Rules/Methods/CallToMethodStatementWithoutSideEffectsRule.php b/src/Rules/Methods/CallToMethodStatementWithoutSideEffectsRule.php
@@ -50,7 +50,8 @@ public function processNode(Node $node, Scope $scope): array
 			'',
 			static function (Type $type) use ($methodName): bool {
 				return $type->canCallMethods()->yes() && $type->hasMethod($methodName)->yes();
-			}
+			},
+			true
 		);
 		$calledOnType = $typeResult->getType();
 		if ($calledOnType instanceof ErrorType) {

diff --git a/src/Rules/Methods/CallToStaticMethodStatementWithoutSideEffectsRule.php b/src/Rules/Methods/CallToStaticMethodStatementWithoutSideEffectsRule.php
@@ -64,7 +64,8 @@ public function processNode(Node $node, Scope $scope): array
 				'',
 				static function (Type $type) use ($methodName): bool {
 					return $type->canCallMethods()->yes() && $type->hasMethod($methodName)->yes();
-				}
+				},
+				true
 			);
 			$calledOnType = $typeResult->getType();
 			if ($calledOnType instanceof ErrorType) {

diff --git a/src/Rules/Operators/InvalidBinaryOperationRule.php b/src/Rules/Operators/InvalidBinaryOperationRule.php
@@ -77,7 +77,8 @@ public function processNode(\PhpParser\Node $node, Scope $scope): array
 				$scope,
 				$left,
 				'',
-				$callback
+				$callback,
+				false
 			)->getType();
 			if ($leftType instanceof ErrorType) {
 				return [];
@@ -87,7 +88,8 @@ public function processNode(\PhpParser\Node $node, Scope $scope): array
 				$scope,
 				$right,
 				'',
-				$callback
+				$callback,
+				false
 			)->getType();
 			if ($rightType instanceof ErrorType) {
 				return [];

diff --git a/src/Rules/Operators/InvalidComparisonOperationRule.php b/src/Rules/Operators/InvalidComparisonOperationRule.php
@@ -74,7 +74,7 @@ private function isNumberType(Scope $scope, Node\Expr $expr): bool
 			return $acceptedType->accepts($type, true)->yes();
 		};
 
-		$type = $this->ruleLevelHelper->findTypeToCheck($scope, $expr, '', $onlyNumber)->getType();
+		$type = $this->ruleLevelHelper->findTypeToCheck($scope, $expr, '', $onlyNumber, false)->getType();
 
 		if (
 			$type instanceof ErrorType
@@ -96,7 +96,8 @@ private function isObjectType(Scope $scope, Node\Expr $expr): bool
 			'',
 			static function (Type $type) use ($acceptedType): bool {
 				return $acceptedType->isSuperTypeOf($type)->yes();
-			}
+			},
+			false
 		)->getType();
 
 		if ($type instanceof ErrorType) {
@@ -119,7 +120,8 @@ private function isArrayType(Scope $scope, Node\Expr $expr): bool
 			'',
 			static function (Type $type): bool {
 				return $type->isArray()->yes();
-			}
+			},
+			false
 		)->getType();
 
 		return !($type instanceof ErrorType) && $type->isArray()->yes();

diff --git a/src/Rules/Properties/AccessPropertiesRule.php b/src/Rules/Properties/AccessPropertiesRule.php
@@ -76,7 +76,8 @@ private function processSingleProperty(Scope $scope, PropertyFetch $node, string
 			sprintf('Access to property $%s on an unknown class %%s.', SprintfHelper::escapeFormatString($name)),
 			static function (Type $type) use ($name): bool {
 				return $type->canAccessProperties()->yes() && $type->hasProperty($name)->yes();
-			}
+			},
+			true
 		);
 		$type = $typeResult->getType();
 		if ($type instanceof ErrorType) {

diff --git a/src/Rules/Properties/AccessStaticPropertiesRule.php b/src/Rules/Properties/AccessStaticPropertiesRule.php
@@ -150,7 +150,8 @@ private function processSingleProperty(Scope $scope, StaticPropertyFetch $node,
 				sprintf('Access to static property $%s on an unknown class %%s.', SprintfHelper::escapeFormatString($name)),
 				static function (Type $type) use ($name): bool {
 					return $type->canAccessProperties()->yes() && $type->hasProperty($name)->yes();
-				}
+				},
+				true
 			);
 			$classType = $classTypeResult->getType();
 			if ($classType instanceof ErrorType) {

diff --git a/src/Rules/RuleLevelHelper.php b/src/Rules/RuleLevelHelper.php
@@ -132,7 +132,8 @@ public function findTypeToCheck(
 		Scope $scope,
 		Expr $var,
 		string $unknownClassErrorPattern,
-		callable $unionTypeCriteriaCallback
+		callable $unionTypeCriteriaCallback,
+		bool $shouldShortCircuitNullSafeOperator = false
 	): FoundTypeResult
 	{
 		if ($this->checkThisOnly && !$this->isThis($var)) {
@@ -143,7 +144,7 @@ public function findTypeToCheck(
 			$type = \PHPStan\Type\TypeCombinator::removeNull($type);
 		}
 
-		if (TypeCombinator::containsNull($type)) {
+		if ($shouldShortCircuitNullSafeOperator && TypeCombinator::containsNull($type)) {
 			$type = $scope->getType(NullsafeOperatorHelper::getNullsafeShortcircuitedExpr($var));
 		}
 

diff --git a/src/Rules/Variables/ThrowTypeRule.php b/src/Rules/Variables/ThrowTypeRule.php
@@ -40,7 +40,8 @@ public function processNode(Node $node, Scope $scope): array
 			'Throwing object of an unknown class %s.',
 			static function (Type $type) use ($throwableType): bool {
 				return $throwableType->isSuperTypeOf($type)->yes();
-			}
+			},
+			false
 		);
 
 		$foundType = $typeResult->getType();

diff --git a/src/Rules/Variables/VariableCloningRule.php b/src/Rules/Variables/VariableCloningRule.php
@@ -38,7 +38,8 @@ public function processNode(Node $node, Scope $scope): array
 			'Cloning object of an unknown class %s.',
 			static function (Type $type): bool {
 				return $type->isCloneable()->yes();
-			}
+			},
+			false
 		);
 		$type = $typeResult->getType();
 		if ($type instanceof ErrorType) {

diff --git a/tests/PHPStan/Rules/Arrays/ArrayDestructuringRuleTest.php b/tests/PHPStan/Rules/Arrays/ArrayDestructuringRuleTest.php
@@ -45,6 +45,10 @@ public function testRule(): void
 				'Offset \'a\' does not exist on array(\'b\' => 1).',
 				22,
 			],
+			[
+				'Cannot use array destructuring on array|null.',
+				27,
+			],
 		]);
 	}
 

diff --git a/tests/PHPStan/Rules/Arrays/data/array-destructuring.php b/tests/PHPStan/Rules/Arrays/data/array-destructuring.php
@@ -22,4 +22,17 @@ public function doBar(): void
 		['a' => $a] = ['b' => 1];
 	}
 
+	public function doFooBar(?Bar $bar): void
+	{
+		[$a] = $bar?->getArray();
+	}
+
+}
+
+class Bar
+{
+	public function getArray(): array
+	{
+		return [];
+	}
 }