InvalidThrowsPhpDocValueRule: support @phpstan-require-extends

RobertMe · web-flow · commit 5ee375ea3ace · 2024-01-27T15:38:16.000+01:00
diff --git a/src/Rules/PhpDoc/InvalidThrowsPhpDocValueRule.php b/src/Rules/PhpDoc/InvalidThrowsPhpDocValueRule.php
@@ -8,6 +8,9 @@
 use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\Type\FileTypeMapper;
 use PHPStan\Type\ObjectType;
+use PHPStan\Type\Type;
+use PHPStan\Type\TypeCombinator;
+use PHPStan\Type\UnionType;
 use PHPStan\Type\VerbosityLevel;
 use Throwable;
 use function sprintf;
@@ -60,8 +63,7 @@ public function processNode(Node $node, Scope $scope): array
 			return [];
 		}
 
-		$isThrowsSuperType = (new ObjectType(Throwable::class))->isSuperTypeOf($phpDocThrowsType);
-		if ($isThrowsSuperType->yes()) {
+		if ($this->isThrowsValid($phpDocThrowsType)) {
 			return [];
 		}
 
@@ -73,4 +75,29 @@ public function processNode(Node $node, Scope $scope): array
 		];
 	}
 
+	private function isThrowsValid(Type $phpDocThrowsType): bool
+	{
+		$throwType = new ObjectType(Throwable::class);
+		if ($phpDocThrowsType instanceof UnionType) {
+			foreach ($phpDocThrowsType->getTypes() as $innerType) {
+				if (!$this->isThrowsValid($innerType)) {
+					return false;
+				}
+			}
+
+			return true;
+		}
+
+		$toIntersectWith = [];
+		foreach ($phpDocThrowsType->getObjectClassReflections() as $classReflection) {
+			foreach ($classReflection->getRequireExtendsTags() as $requireExtendsTag) {
+				$toIntersectWith[] = $requireExtendsTag->getType();
+			}
+		}
+
+		return $throwType->isSuperTypeOf(
+			TypeCombinator::intersect($phpDocThrowsType, ...$toIntersectWith),
+		)->yes();
+	}
+
 }
diff --git a/tests/PHPStan/Rules/PhpDoc/InvalidThrowsPhpDocValueRuleTest.php b/tests/PHPStan/Rules/PhpDoc/InvalidThrowsPhpDocValueRuleTest.php
@@ -77,6 +77,28 @@ public function testInheritedPhpDocs(): void
 		]);
 	}
 
+	public function testThrowsWithRequireExtends(): void
+	{
+		$this->analyse([__DIR__ . '/data/throws-with-require.php'], [
+			[
+				'PHPDoc tag @throws with type ThrowsWithRequire\\RequiresExtendsStdClassInterface is not subtype of Throwable',
+				25,
+			],
+			[
+				'PHPDoc tag @throws with type DateTimeInterface|ThrowsWithRequire\\RequiresExtendsExceptionInterface is not subtype of Throwable',
+				39,
+			],
+			[
+				'PHPDoc tag @throws with type Exception|ThrowsWithRequire\\RequiresExtendsStdClassInterface is not subtype of Throwable',
+				46,
+			],
+			[
+				'PHPDoc tag @throws with type Iterator&ThrowsWithRequire\\RequiresExtendsStdClassInterface is not subtype of Throwable',
+				74,
+			],
+		]);
+	}
+
 	public function dataMergeInheritedPhpDocs(): array
 	{
 		return [
diff --git a/tests/PHPStan/Rules/PhpDoc/data/throws-with-require.php b/tests/PHPStan/Rules/PhpDoc/data/throws-with-require.php
@@ -0,0 +1,76 @@
+<?php
+
+namespace ThrowsWithRequire;
+
+/**
+ * @phpstan-require-extends \Exception
+ */
+interface RequiresExtendsExceptionInterface {}
+
+/**
+ * @phpstan-require-extends \stdClass
+ */
+interface RequiresExtendsStdClassInterface {}
+
+/**
+ * @throws RequiresExtendsExceptionInterface
+ */
+function requiresExtendsExceptionThrows()
+{
+}
+
+/**
+ * @throws RequiresExtendsStdClassInterface
+ */
+function requiresExtendsStdClassThrows()
+{
+}
+
+/**
+ * @throws \Exception|RequiresExtendsExceptionInterface
+ */
+function unionExceptionAndRequiresExtendsExceptionThrows()
+{
+}
+
+/**
+ * @throws \DateTimeInterface|RequiresExtendsExceptionInterface
+ */
+function notThrowableUnionDateTimeInterfaceAndRequiresExtendsExceptionThrows()
+{
+}
+
+/**
+ * @throws \Exception|RequiresExtendsStdClassInterface
+ */
+function notThrowableUnionExceptionAndRequiresExtendsStdClassThrows()
+{
+}
+
+/**
+ * @throws \Exception&RequiresExtendsExceptionInterface
+ */
+function intersectionExceptionAndRequiresExtendsExceptionThrows()
+{
+}
+
+/**
+ * @throws \DateTimeInterface&RequiresExtendsExceptionInterface
+ */
+function intersectionDateTimeInterfaceAndRequiresExtendsExceptionThrows()
+{
+}
+
+/**
+ * @throws \Exception&RequiresExtendsStdClassInterface
+ */
+function intersectionExceptionAndRequiresExtendsStdClassThrows()
+{
+}
+
+/**
+ * @throws \Iterator&RequiresExtendsStdClassInterface
+ */
+function notThrowableIntersectionIteratorAndRequiresExtendsStdClassThrows()
+{
+}
