Add support for template bound null type

Co-authored-by: Ondřej Mirtes <[email protected]>

Author: SplotyCode

phpstan-baseline.neon

@@ -1251,6 +1251,12 @@ parameters:
 			count: 2
 			path: src/Type/Generic/TemplateMixedType.php
 
+		-
+			message: '#^Doing instanceof PHPStan\\Type\\IntersectionType is error\-prone and deprecated\.$#'
+			identifier: phpstanApi.instanceofType
+			count: 3
+			path: src/Type/Generic/TemplateNullType.php
+
 		-
 			message: '#^Doing instanceof PHPStan\\Type\\IntersectionType is error\-prone and deprecated\.$#'
 			identifier: phpstanApi.instanceofType
@@ -1335,6 +1341,12 @@ parameters:
 			count: 1
 			path: src/Type/Generic/TemplateTypeFactory.php
 
+		-
+			message: '#^Doing instanceof PHPStan\\Type\\NullType is error\-prone and deprecated\. Use Type\:\:isNull\(\) instead\.$#'
+			identifier: phpstanApi.instanceofType
+			count: 1
+			path: src/Type/Generic/TemplateTypeFactory.php
+
 		-
 			message: '#^Doing instanceof PHPStan\\Type\\ObjectShapeType is error\-prone and deprecated\. Use Type\:\:isObject\(\) and Type\:\:hasProperty\(\) instead\.$#'
 			identifier: phpstanApi.instanceofType

src/Rules/Generics/TemplateTypeCheck.php

@@ -28,6 +28,7 @@
 use PHPStan\Type\IterableType;
 use PHPStan\Type\KeyOfType;
 use PHPStan\Type\MixedType;
+use PHPStan\Type\NullType;
 use PHPStan\Type\ObjectShapeType;
 use PHPStan\Type\ObjectType;
 use PHPStan\Type\ObjectWithoutClassType;
@@ -132,6 +133,7 @@ public function check(
 				&& $boundTypeClass !== GenericObjectType::class
 				&& $boundTypeClass !== KeyOfType::class
 				&& $boundTypeClass !== IterableType::class
+				&& $boundTypeClass !== NullType::class
 				&& !$boundType instanceof UnionType
 				&& !$boundType instanceof IntersectionType
 				&& !$boundType instanceof TemplateType

src/Type/Generic/TemplateNullType.php

@@ -0,0 +1,37 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Type\Generic;
+
+use PHPStan\Type\NullType;
+use PHPStan\Type\Traits\UndecidedComparisonCompoundTypeTrait;
+use PHPStan\Type\Type;
+
+final class TemplateNullType extends NullType implements TemplateType
+{
+
+	/** @use TemplateTypeTrait<NullType> */
+	use TemplateTypeTrait;
+	use UndecidedComparisonCompoundTypeTrait;
+
+	/**
+	 * @param non-empty-string $name
+	 */
+	public function __construct(
+		TemplateTypeScope $scope,
+		TemplateTypeStrategy $templateTypeStrategy,
+		TemplateTypeVariance $templateTypeVariance,
+		string $name,
+		NullType $bound,
+		?Type $default,
+	)
+	{
+		parent::__construct();
+		$this->scope = $scope;
+		$this->strategy = $templateTypeStrategy;
+		$this->variance = $templateTypeVariance;
+		$this->name = $name;
+		$this->bound = $bound;
+		$this->default = $default;
+	}
+
+}

src/Type/Generic/TemplateTypeFactory.php

@@ -15,6 +15,7 @@
 use PHPStan\Type\IterableType;
 use PHPStan\Type\KeyOfType;
 use PHPStan\Type\MixedType;
+use PHPStan\Type\NullType;
 use PHPStan\Type\ObjectShapeType;
 use PHPStan\Type\ObjectType;
 use PHPStan\Type\ObjectWithoutClassType;
@@ -112,6 +113,10 @@ public static function create(TemplateTypeScope $scope, string $name, ?Type $bou
 			return new TemplateIterableType($scope, $strategy, $variance, $name, $bound, $default);
 		}
 
+		if ($bound instanceof NullType && ($boundClass === NullType::class || $bound instanceof TemplateType)) {
+			return new TemplateNullType($scope, $strategy, $variance, $name, $bound, $default);
+		}
+
 		return new TemplateMixedType($scope, $strategy, $variance, $name, new MixedType(true), $default);
 	}
 

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

@@ -0,0 +1,53 @@
+<?php // lint >= 8.0
+
+declare(strict_types = 1);
+
+namespace Bug12894;
+
+use Closure;
+
+/**
+ * @template TValue of object|null
+ */
+interface Dependency
+{
+
+	/**
+	 * @return TValue
+	 */
+	public function __invoke(): object|null;
+
+}
+
+interface DependencyResolver
+{
+
+	/**
+	 * @template V of object|null
+	 * @template D of Dependency<V>
+	 *
+	 * @param D $dependency
+	 *
+	 * @return V
+	 */
+	public function resolve(Dependency $dependency): object|null;
+
+}
+
+class Resolver implements DependencyResolver
+{
+	/**
+	 * @var Closure(object|null): void
+	 */
+	protected Closure $run;
+
+	public function resolve(Dependency $dependency): object|null {
+		$resolved = $dependency();
+		\PHPStan\Testing\assertType('V of object|null (method Bug12894\DependencyResolver::resolve(), argument)', $resolved);
+		$result = is_object($resolved) ? 1 : 2;
+		\PHPStan\Testing\assertType('V of object (method Bug12894\DependencyResolver::resolve(), argument)|V of null (method Bug12894\DependencyResolver::resolve(), argument)', $resolved);
+		($this->run)($resolved);
+		return $resolved;
+	}
+
+}

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

@@ -0,0 +1,17 @@
+<?php declare(strict_types = 1);
+
+namespace Bug12989;
+
+/**
+ * @template T of int|null
+ * @phpstan-param T $b
+ * @phpstan-return int|T
+ */
+function a(?int $b): ?int
+{
+	if ($b === null) {
+		\PHPStan\Testing\assertType('T of null (function Bug12989\a(), argument)', $b);
+		return $b;
+	}
+	return $b;
+}

tests/PHPStan/Rules/Comparison/MatchExpressionRuleTest.php

@@ -435,4 +435,11 @@ public function testPropertyHooks(): void
 		]);
 	}
 
+
+	#[RequiresPhp('>= 8.1')]
+	public function testBug13048(): void
+	{
+		$this->analyse([__DIR__ . '/data/bug-13048.php'], []);
+	}
+
 }

tests/PHPStan/Rules/Comparison/data/bug-13048.php

@@ -0,0 +1,21 @@
+<?php // lint >= 8.1
+
+namespace Bug13048;
+
+enum IndexBy {
+	case A;
+	case B;
+}
+
+/**
+ * @template T of IndexBy|null
+ * @param T $indexBy
+ */
+function run(?IndexBy $indexBy = null): ?string
+{
+	return match ($indexBy) {
+		IndexBy::A => 'by A',
+		IndexBy::B => 'by B',
+		null => null,
+	};
+}

tests/PHPStan/Rules/Generics/FunctionTemplateTypeRuleTest.php

@@ -56,10 +56,6 @@ public function testRule(): void
 				'PHPDoc tag @template T for function FunctionTemplateType\resourceBound() with bound type resource is not supported.',
 				50,
 			],
-			[
-				'PHPDoc tag @template T for function FunctionTemplateType\nullNotSupported() with bound type null is not supported.',
-				68,
-			],
 			[
 				'Call-site variance of covariant int in generic type FunctionTemplateType\GenericCovariant<covariant int> in PHPDoc tag @template U is redundant, template type T of class FunctionTemplateType\GenericCovariant has the same variance.',
 				94,

tests/PHPStan/Rules/Generics/data/function-template.php

@@ -65,7 +65,7 @@ function nakano()
 }
 
 /** @template T of null */
-function nullNotSupported()
+function nullSupported()
 {
 
 }