Allow @phpstan-use and @use tags to be declared into class phpdoc

phpstan · Sep 21, 2023 · 592ea4c · 592ea4c
1 parent fbc09b5
commit 592ea4c
Show file tree

Hide file tree

Showing 4 changed files with 67 additions and 25 deletions.
diff --git a/src/Rules/Generics/UsedTraitsRule.php b/src/Rules/Generics/UsedTraitsRule.php
@@ -11,6 +11,8 @@
 use PHPStan\Type\FileTypeMapper;
 use PHPStan\Type\Type;
 use function array_map;
+use function array_merge;
+use function is_null;
 use function sprintf;
 use function strtolower;
 use function ucfirst;
@@ -44,18 +46,18 @@ public function processNode(Node $node, Scope $scope): array
 		if ($scope->isInTrait()) {
 			$traitName = $scope->getTraitReflection()->getName();
 		}
-		$useTags = [];
-		$docComment = $node->getDocComment();
-		if ($docComment !== null) {
-			$resolvedPhpDoc = $this->fileTypeMapper->getResolvedPhpDoc(
+		$classResolvedPhpDoc = $scope->getClassReflection()->getResolvedPhpDoc();
+		$docComment = $node->getDocComment()?->getText();
+		$useTags = array_merge(
+			is_null($classResolvedPhpDoc) ? [] : $classResolvedPhpDoc->getUsesTags(),
+			is_null($docComment) ? [] : $this->fileTypeMapper->getResolvedPhpDoc(
 				$scope->getFile(),
 				$className,
 				$traitName,
 				null,
-				$docComment->getText(),
-			);
-			$useTags = $resolvedPhpDoc->getUsesTags();
-		}
+				$docComment,
+			)->getUsesTags(),
+		);
 
 		$typeDescription = strtolower($scope->getClassReflection()->getClassTypeDescription());
 		$description = sprintf('%s %s', $typeDescription, SprintfHelper::escapeFormatString($className));

diff --git a/src/Type/FileTypeMapper.php b/src/Type/FileTypeMapper.php
@@ -32,6 +32,7 @@
 use function is_array;
 use function is_callable;
 use function is_file;
+use function is_null;
 use function ltrim;
 use function md5;
 use function sprintf;
@@ -421,7 +422,7 @@ private function createNameScopeMap(
 		$constUses = [];
 		$this->processNodes(
 			$this->phpParser->parseFile($fileName),
-			function (Node $node) use ($fileName, $lookForTrait, $phpDocNodeMap, &$traitFound, $traitMethodAliases, $originalClassFileName, &$nameScopeMap, &$classStack, &$typeAliasStack, &$namespace, &$functionStack, &$uses, &$typeMapStack, &$constUses): ?int {
+			function (Node $node) use ($fileName, $lookForTrait, $phpDocNodeMap, &$traitFound, $traitMethodAliases, $originalClassFileName, &$nameScopeMap, &$classStack, &$typeAliasStack, &$namespace, &$functionStack, &$uses, &$typeMapStack, &$constUses, &$classNode, &$classUseTags): ?int {
 				if ($node instanceof Node\Stmt\ClassLike) {
 					if ($traitFound && $fileName === $originalClassFileName) {
 						return self::SKIP_NODE;
@@ -460,6 +461,8 @@ function (Node $node) use ($fileName, $lookForTrait, $phpDocNodeMap, &$traitFoun
 						}
 						$classStack[] = $className;
 						$classNameScopeKey = $this->getNameScopeKey($originalClassFileName, $className, $lookForTrait, null);
+						$classNode = $node;
+						$classUseTags = null;
 						if (array_key_exists($classNameScopeKey, $phpDocNodeMap)) {
 							$typeAliasStack[] = $this->getTypeAliasesMap($phpDocNodeMap[$classNameScopeKey]);
 						} else {
@@ -629,7 +632,7 @@ function (Node $node) use ($fileName, $lookForTrait, $phpDocNodeMap, &$traitFoun
 						);
 						$finalTraitPhpDocMap = [];
 						foreach ($traitPhpDocMap as $nameScopeTraitKey => $callback) {
-							$finalTraitPhpDocMap[$nameScopeTraitKey] = function () use ($callback, $traitReflection, $fileName, $className, $lookForTrait, $useDocComment): NameScope {
+							$finalTraitPhpDocMap[$nameScopeTraitKey] = function () use ($callback, $traitReflection, $fileName, $className, $lookForTrait, $useDocComment, &$classNode, &$classUseTags): NameScope {
 								/** @var NameScope $original */
 								$original = $callback();
 								if (!$traitReflection->isGeneric()) {
@@ -639,27 +642,38 @@ function (Node $node) use ($fileName, $lookForTrait, $phpDocNodeMap, &$traitFoun
 								$traitTemplateTypeMap = $traitReflection->getTemplateTypeMap();
 
 								$useType = null;
-								if ($useDocComment !== null) {
-									$useTags = $this->getResolvedPhpDoc(
+								if (is_null($classUseTags)) {
+									$classDocComment = $classNode?->getDocComment()?->getText();
+									$classUseTags = is_null($classDocComment) ? [] : $this->getResolvedPhpDoc(
+										$fileName,
+										$className,
+										null,
+										null,
+										$classDocComment,
+									)->getUsesTags();
+								}
+								$useTags = array_merge(
+									$classUseTags,
+									is_null($useDocComment) ? [] : $this->getResolvedPhpDoc(
 										$fileName,
 										$className,
 										$lookForTrait,
 										null,
 										$useDocComment,
-									)->getUsesTags();
-									foreach ($useTags as $useTag) {
-										$useTagType = $useTag->getType();
-										if (!$useTagType instanceof GenericObjectType) {
-											continue;
-										}
-
-										if ($useTagType->getClassName() !== $traitReflection->getName()) {
-											continue;
-										}
-
-										$useType = $useTagType;
-										break;
+									)->getUsesTags(),
+								);
+								foreach ($useTags as $useTag) {
+									$useTagType = $useTag->getType();
+									if (!$useTagType instanceof GenericObjectType) {
+										continue;
 									}
+
+									if ($useTagType->getClassName() !== $traitReflection->getName()) {
+										continue;
+									}
+
+									$useType = $useTagType;
+									break;
 								}
 
 								if ($useType === null) {

diff --git a/tests/PHPStan/Rules/Generics/UsedTraitsRuleTest.php b/tests/PHPStan/Rules/Generics/UsedTraitsRuleTest.php
@@ -59,6 +59,10 @@ public function testRule(): void
 				'Call-site variance annotation of covariant Throwable in generic type UsedTraits\GenericTrait<covariant Throwable> in PHPDoc tag @use is not allowed.',
 				69,
 			],
+			[
+				'Type int in generic type UsedTraits\GenericTrait<int> in PHPDoc tag @use is not subtype of template type T of object of trait UsedTraits\GenericTrait.',
+				91,
+			],
 		]);
 	}
 

diff --git a/tests/PHPStan/Rules/Generics/data/used-traits.php b/tests/PHPStan/Rules/Generics/data/used-traits.php
@@ -69,3 +69,25 @@ class Dolor
 	use GenericTrait;
 
 }
+
+/**
+ * @template T of object
+ * @use GenericTrait<T>
+ */
+class Sit
+{
+
+	use GenericTrait;
+
+}
+
+/**
+ * @template T of int
+ * @use GenericTrait<T>
+ */
+class Amet
+{
+
+	use GenericTrait;
+
+}