Implement isNull() on Type

staabm · web-flow · commit d9d1263a52ba · 2022-11-07T14:18:08.000+01:00
diff --git a/src/Analyser/MutatingScope.php b/src/Analyser/MutatingScope.php
@@ -875,7 +875,7 @@ private function resolveType(Expr $node): Type
 					$node->left instanceof Node\Expr\PropertyFetch
 					|| $node->left instanceof Node\Expr\StaticPropertyFetch
 				)
-				&& $rightType instanceof NullType
+				&& $rightType->isNull()->yes()
 				&& !$this->hasPropertyNativeType($node->left)
 			) {
 				return new BooleanType();
@@ -886,7 +886,7 @@ private function resolveType(Expr $node): Type
 					$node->right instanceof Node\Expr\PropertyFetch
 					|| $node->right instanceof Node\Expr\StaticPropertyFetch
 				)
-				&& $leftType instanceof NullType
+				&& $leftType->isNull()->yes()
 				&& !$this->hasPropertyNativeType($node->right)
 			) {
 				return new BooleanType();
diff --git a/src/Analyser/NodeScopeResolver.php b/src/Analyser/NodeScopeResolver.php
@@ -2167,7 +2167,7 @@ static function (?Type $offsetType, Type $valueType, bool $optional) use (&$arra
 							$thisType = null;
 							if (isset($expr->getArgs()[1])) {
 								$argType = $scope->getType($expr->getArgs()[1]->value);
-								if ($argType instanceof NullType) {
+								if ($argType->isNull()->yes()) {
 									$thisType = null;
 								} else {
 									$thisType = $argType;
diff --git a/src/Reflection/Php/PhpParameterFromParserNodeReflection.php b/src/Reflection/Php/PhpParameterFromParserNodeReflection.php
@@ -5,7 +5,6 @@
 use PHPStan\Reflection\ParameterReflectionWithPhpDocs;
 use PHPStan\Reflection\PassedByReference;
 use PHPStan\Type\MixedType;
-use PHPStan\Type\NullType;
 use PHPStan\Type\Type;
 use PHPStan\Type\TypeCombinator;
 use PHPStan\Type\TypehintHelper;
@@ -43,7 +42,7 @@ public function getType(): Type
 		if ($this->type === null) {
 			$phpDocType = $this->phpDocType;
 			if ($phpDocType !== null && $this->defaultValue !== null) {
-				if ($this->defaultValue instanceof NullType) {
+				if ($this->defaultValue->isNull()->yes()) {
 					$inferred = $phpDocType->inferTemplateTypes($this->defaultValue);
 					if ($inferred->isEmpty()) {
 						$phpDocType = TypeCombinator::addNull($phpDocType);
diff --git a/src/Reflection/Php/PhpParameterReflection.php b/src/Reflection/Php/PhpParameterReflection.php
@@ -8,7 +8,6 @@
 use PHPStan\Reflection\ParameterReflectionWithPhpDocs;
 use PHPStan\Reflection\PassedByReference;
 use PHPStan\Type\MixedType;
-use PHPStan\Type\NullType;
 use PHPStan\Type\Type;
 use PHPStan\Type\TypeCombinator;
 use PHPStan\Type\TypehintHelper;
@@ -52,7 +51,7 @@ public function getType(): Type
 					$this->reflection->getDefaultValueExpression(),
 					InitializerExprContext::fromReflectionParameter($this->reflection),
 				);
-				if ($defaultValueType instanceof NullType) {
+				if ($defaultValueType->isNull()->yes()) {
 					$phpDocType = TypeCombinator::addNull($phpDocType);
 				}
 			}
diff --git a/src/Rules/Operators/InvalidComparisonOperationRule.php b/src/Rules/Operators/InvalidComparisonOperationRule.php
@@ -11,7 +11,6 @@
 use PHPStan\Type\ErrorType;
 use PHPStan\Type\FloatType;
 use PHPStan\Type\IntegerType;
-use PHPStan\Type\NullType;
 use PHPStan\Type\ObjectWithoutClassType;
 use PHPStan\Type\Type;
 use PHPStan\Type\TypeCombinator;
@@ -106,7 +105,7 @@ private function isPossiblyNullableObjectType(Scope $scope, Node\Expr $expr): bo
 			return false;
 		}
 
-		if (TypeCombinator::containsNull($type) && !$type instanceof NullType) {
+		if (TypeCombinator::containsNull($type) && !$type->isNull()->yes()) {
 			$type = TypeCombinator::removeNull($type);
 		}
 
@@ -127,7 +126,7 @@ private function isPossiblyNullableArrayType(Scope $scope, Node\Expr $expr): boo
 			static fn (Type $type): bool => $type->isArray()->yes(),
 		)->getType();
 
-		if (TypeCombinator::containsNull($type) && !$type instanceof NullType) {
+		if (TypeCombinator::containsNull($type) && !$type->isNull()->yes()) {
 			$type = TypeCombinator::removeNull($type);
 		}
 
diff --git a/src/Rules/RuleLevelHelper.php b/src/Rules/RuleLevelHelper.php
@@ -169,7 +169,7 @@ public function findTypeToCheck(
 			return new FoundTypeResult(new ErrorType(), [], [], null);
 		}
 		$type = $scope->getType($var);
-		if (!$this->checkNullables && !$type instanceof NullType) {
+		if (!$this->checkNullables && !$type->isNull()->yes()) {
 			$type = TypeCombinator::removeNull($type);
 		}
 
diff --git a/src/Rules/TooWideTypehints/TooWideArrowFunctionReturnTypehintRule.php b/src/Rules/TooWideTypehints/TooWideArrowFunctionReturnTypehintRule.php
@@ -7,7 +7,6 @@
 use PHPStan\Node\InArrowFunctionNode;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
-use PHPStan\Type\NullType;
 use PHPStan\Type\UnionType;
 use PHPStan\Type\VerbosityLevel;
 use function sprintf;
@@ -40,7 +39,7 @@ public function processNode(Node $node, Scope $scope): array
 		}
 
 		$returnType = $scope->getType($expr);
-		if ($returnType instanceof NullType) {
+		if ($returnType->isNull()->yes()) {
 			return [];
 		}
 		$messages = [];
diff --git a/src/Rules/TooWideTypehints/TooWideClosureReturnTypehintRule.php b/src/Rules/TooWideTypehints/TooWideClosureReturnTypehintRule.php
@@ -7,7 +7,6 @@
 use PHPStan\Node\ClosureReturnStatementsNode;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
-use PHPStan\Type\NullType;
 use PHPStan\Type\TypeCombinator;
 use PHPStan\Type\UnionType;
 use PHPStan\Type\VerbosityLevel;
@@ -62,7 +61,7 @@ public function processNode(Node $node, Scope $scope): array
 		}
 
 		$returnType = TypeCombinator::union(...$returnTypes);
-		if ($returnType instanceof NullType) {
+		if ($returnType->isNull()->yes()) {
 			return [];
 		}
 
diff --git a/src/Rules/TooWideTypehints/TooWideFunctionReturnTypehintRule.php b/src/Rules/TooWideTypehints/TooWideFunctionReturnTypehintRule.php
@@ -10,7 +10,6 @@
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\ShouldNotHappenException;
-use PHPStan\Type\NullType;
 use PHPStan\Type\TypeCombinator;
 use PHPStan\Type\UnionType;
 use PHPStan\Type\VerbosityLevel;
@@ -71,7 +70,7 @@ public function processNode(Node $node, Scope $scope): array
 				continue;
 			}
 
-			if ($type instanceof NullType && !$node->hasNativeReturnTypehint()) {
+			if ($type->isNull()->yes() && !$node->hasNativeReturnTypehint()) {
 				foreach ($node->getExecutionEnds() as $executionEnd) {
 					if ($executionEnd->getStatementResult()->isAlwaysTerminating()) {
 						continue;
diff --git a/src/Rules/TooWideTypehints/TooWideMethodReturnTypehintRule.php b/src/Rules/TooWideTypehints/TooWideMethodReturnTypehintRule.php
@@ -11,7 +11,6 @@
 use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\ShouldNotHappenException;
 use PHPStan\Type\Constant\ConstantBooleanType;
-use PHPStan\Type\NullType;
 use PHPStan\Type\TypeCombinator;
 use PHPStan\Type\UnionType;
 use PHPStan\Type\VerbosityLevel;
@@ -80,7 +79,7 @@ public function processNode(Node $node, Scope $scope): array
 		$returnType = TypeCombinator::union(...$returnTypes);
 		if (
 			!$method->isPrivate()
-			&& ($returnType instanceof NullType || $returnType instanceof ConstantBooleanType)
+			&& ($returnType->isNull()->yes() || $returnType instanceof ConstantBooleanType)
 			&& !$isFirstDeclaration
 		) {
 			return [];
@@ -92,7 +91,7 @@ public function processNode(Node $node, Scope $scope): array
 				continue;
 			}
 
-			if ($type instanceof NullType && !$node->hasNativeReturnTypehint()) {
+			if ($type->isNull()->yes() && !$node->hasNativeReturnTypehint()) {
 				foreach ($node->getExecutionEnds() as $executionEnd) {
 					if ($executionEnd->getStatementResult()->isAlwaysTerminating()) {
 						continue;
diff --git a/src/Type/Accessory/AccessoryArrayListType.php b/src/Type/Accessory/AccessoryArrayListType.php
@@ -252,6 +252,11 @@ public function isList(): TrinaryLogic
 		return TrinaryLogic::createYes();
 	}
 
+	public function isNull(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	public function isTrue(): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();
diff --git a/src/Type/Accessory/AccessoryLiteralStringType.php b/src/Type/Accessory/AccessoryLiteralStringType.php
@@ -166,6 +166,11 @@ public function toArrayKey(): Type
 		return $this;
 	}
 
+	public function isNull(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	public function isTrue(): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();
diff --git a/src/Type/Accessory/AccessoryNonEmptyStringType.php b/src/Type/Accessory/AccessoryNonEmptyStringType.php
@@ -166,6 +166,11 @@ public function toArrayKey(): Type
 		return $this;
 	}
 
+	public function isNull(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	public function isTrue(): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();
diff --git a/src/Type/Accessory/AccessoryNonFalsyStringType.php b/src/Type/Accessory/AccessoryNonFalsyStringType.php
@@ -166,6 +166,11 @@ public function toArrayKey(): Type
 		return $this;
 	}
 
+	public function isNull(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	public function isTrue(): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();
diff --git a/src/Type/Accessory/AccessoryNumericStringType.php b/src/Type/Accessory/AccessoryNumericStringType.php
@@ -169,6 +169,11 @@ public function toArrayKey(): Type
 		return new IntegerType();
 	}
 
+	public function isNull(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	public function isTrue(): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();
diff --git a/src/Type/Accessory/HasOffsetType.php b/src/Type/Accessory/HasOffsetType.php
@@ -169,6 +169,11 @@ public function isList(): TrinaryLogic
 		return TrinaryLogic::createMaybe();
 	}
 
+	public function isNull(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	public function isTrue(): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();
diff --git a/src/Type/Accessory/HasOffsetValueType.php b/src/Type/Accessory/HasOffsetValueType.php
@@ -220,6 +220,11 @@ public function isList(): TrinaryLogic
 		return TrinaryLogic::createMaybe();
 	}
 
+	public function isNull(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	public function isTrue(): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();
diff --git a/src/Type/Accessory/NonEmptyArrayType.php b/src/Type/Accessory/NonEmptyArrayType.php
@@ -237,6 +237,11 @@ public function isList(): TrinaryLogic
 		return TrinaryLogic::createMaybe();
 	}
 
+	public function isNull(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	public function isTrue(): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();
diff --git a/src/Type/Accessory/OversizedArrayType.php b/src/Type/Accessory/OversizedArrayType.php
@@ -236,6 +236,11 @@ public function isList(): TrinaryLogic
 		return TrinaryLogic::createMaybe();
 	}
 
+	public function isNull(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	public function isTrue(): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();
diff --git a/src/Type/ArrayType.php b/src/Type/ArrayType.php
@@ -260,6 +260,11 @@ public function isList(): TrinaryLogic
 		return TrinaryLogic::createMaybe();
 	}
 
+	public function isNull(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	public function isTrue(): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();
diff --git a/src/Type/BooleanType.php b/src/Type/BooleanType.php
@@ -88,6 +88,11 @@ public function toArrayKey(): Type
 		return new UnionType([new ConstantIntegerType(0), new ConstantIntegerType(1)]);
 	}
 
+	public function isNull(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	public function isTrue(): TrinaryLogic
 	{
 		return TrinaryLogic::createMaybe();
diff --git a/src/Type/CallableType.php b/src/Type/CallableType.php
@@ -322,6 +322,11 @@ public function isOversizedArray(): TrinaryLogic
 		return TrinaryLogic::createNo();
 	}
 
+	public function isNull(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	public function isTrue(): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();
diff --git a/src/Type/ClosureType.php b/src/Type/ClosureType.php
@@ -391,6 +391,11 @@ public function traverse(callable $cb): Type
 		);
 	}
 
+	public function isNull(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	public function isTrue(): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();
diff --git a/src/Type/FloatType.php b/src/Type/FloatType.php
@@ -121,6 +121,11 @@ public function toArrayKey(): Type
 		return new IntegerType();
 	}
 
+	public function isNull(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	public function isTrue(): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();
diff --git a/src/Type/IntegerType.php b/src/Type/IntegerType.php
@@ -88,6 +88,11 @@ public function toArrayKey(): Type
 		return $this;
 	}
 
+	public function isNull(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	public function isTrue(): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();
diff --git a/src/Type/IntersectionType.php b/src/Type/IntersectionType.php
@@ -613,6 +613,11 @@ public function isSmallerThanOrEqual(Type $otherType): TrinaryLogic
 		return $this->intersectResults(static fn (Type $type): TrinaryLogic => $type->isSmallerThanOrEqual($otherType));
 	}
 
+	public function isNull(): TrinaryLogic
+	{
+		return $this->intersectResults(static fn (Type $type): TrinaryLogic => $type->isNull());
+	}
+
 	public function isTrue(): TrinaryLogic
 	{
 		return $this->intersectResults(static fn (Type $type): TrinaryLogic => $type->isTrue());
diff --git a/src/Type/IterableType.php b/src/Type/IterableType.php
@@ -260,6 +260,11 @@ public function getLastIterableValueType(): Type
 		return $this->getItemType();
 	}
 
+	public function isNull(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	public function isTrue(): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();
diff --git a/src/Type/JustNullableTypeTrait.php b/src/Type/JustNullableTypeTrait.php
@@ -52,6 +52,11 @@ public function traverse(callable $cb): Type
 		return $this;
 	}
 
+	public function isNull(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	public function isTrue(): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();
diff --git a/src/Type/MixedType.php b/src/Type/MixedType.php
diff --git a/src/Type/NeverType.php b/src/Type/NeverType.php
diff --git a/src/Type/NullType.php b/src/Type/NullType.php
diff --git a/src/Type/ObjectType.php b/src/Type/ObjectType.php
diff --git a/src/Type/StaticType.php b/src/Type/StaticType.php
diff --git a/src/Type/StrictMixedType.php b/src/Type/StrictMixedType.php
diff --git a/src/Type/StringType.php b/src/Type/StringType.php
diff --git a/src/Type/Traits/LateResolvableTypeTrait.php b/src/Type/Traits/LateResolvableTypeTrait.php
diff --git a/src/Type/Traits/ObjectTypeTrait.php b/src/Type/Traits/ObjectTypeTrait.php
diff --git a/src/Type/Type.php b/src/Type/Type.php
diff --git a/src/Type/UnionType.php b/src/Type/UnionType.php
diff --git a/src/Type/VoidType.php b/src/Type/VoidType.php
diff --git a/tests/PHPStan/Type/MixedTypeTest.php b/tests/PHPStan/Type/MixedTypeTest.php

Original file line number	Diff line number	Diff line change
`@@ -169,7 +169,7 @@ public function findTypeToCheck(`
`169`	`169`	`return new FoundTypeResult(new ErrorType(), [], [], null);`
`170`	`170`	`}`
`171`	`171`	`$type = $scope->getType($var);`
`172`		`- if (!$this->checkNullables && !$type instanceof NullType) {`
	`172`	`+ if (!$this->checkNullables && !$type->isNull()->yes()) {`
`173`	`173`	`$type = TypeCombinator::removeNull($type);`
`174`	`174`	`}`
`175`	`175`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,6 @@`
`7`	`7`	`use PHPStan\Node\ClosureReturnStatementsNode;`
`8`	`8`	`use PHPStan\Rules\Rule;`
`9`	`9`	`use PHPStan\Rules\RuleErrorBuilder;`
`10`		`-use PHPStan\Type\NullType;`
`11`	`10`	`use PHPStan\Type\TypeCombinator;`
`12`	`11`	`use PHPStan\Type\UnionType;`
`13`	`12`	`use PHPStan\Type\VerbosityLevel;`
`@@ -62,7 +61,7 @@ public function processNode(Node $node, Scope $scope): array`
`62`	`61`	`}`
`63`	`62`
`64`	`63`	`$returnType = TypeCombinator::union(...$returnTypes);`
`65`		`- if ($returnType instanceof NullType) {`
	`64`	`+ if ($returnType->isNull()->yes()) {`
`66`	`65`	`return [];`
`67`	`66`	`}`
`68`	`67`