Fix

Author: VincentLanglet

src/Rules/PhpDoc/VarTagTypeRuleHelper.php

@@ -7,11 +7,13 @@
 use PHPStan\Analyser\NameScope;
 use PHPStan\Analyser\Scope;
 use PHPStan\Node\Expr\GetOffsetValueTypeExpr;
+use PHPStan\PhpDoc\NameScopeAlreadyBeingCreatedException;
 use PHPStan\PhpDoc\Tag\VarTag;
 use PHPStan\PhpDoc\TypeNodeResolver;
 use PHPStan\Rules\IdentifierRuleError;
 use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\Type\ArrayType;
+use PHPStan\Type\FileTypeMapper;
 use PHPStan\Type\Generic\GenericObjectType;
 use PHPStan\Type\MixedType;
 use PHPStan\Type\ObjectType;
@@ -28,6 +30,7 @@ final class VarTagTypeRuleHelper
 
 	public function __construct(
 		private TypeNodeResolver $typeNodeResolver,
+		private FileTypeMapper $fileTypeMapper,
 		private bool $checkTypeAgainstPhpDocType,
 		private bool $strictWideningCheck,
 	)
@@ -82,7 +85,7 @@ public function checkExprType(Scope $scope, Node\Expr $expr, Type $varTagType):
 		$errors = [];
 		$exprNativeType = $scope->getNativeType($expr);
 		$containsPhpStanType = $this->containsPhpStanType($varTagType);
-		if ($this->shouldVarTagTypeBeReported($expr, $exprNativeType, $varTagType)) {
+		if ($this->shouldVarTagTypeBeReported($scope, $expr, $exprNativeType, $varTagType)) {
 			$verbosity = VerbosityLevel::getRecommendedLevelByType($exprNativeType, $varTagType);
 			$errors[] = RuleErrorBuilder::message(sprintf(
 				'PHPDoc tag @var with type %s is not subtype of native type %s.',
@@ -92,7 +95,7 @@ public function checkExprType(Scope $scope, Node\Expr $expr, Type $varTagType):
 		} else {
 			$exprType = $scope->getType($expr);
 			if (
-				$this->shouldVarTagTypeBeReported($expr, $exprType, $varTagType)
+				$this->shouldVarTagTypeBeReported($scope, $expr, $exprType, $varTagType)
 				&& ($this->checkTypeAgainstPhpDocType || $containsPhpStanType)
 			) {
 				$verbosity = VerbosityLevel::getRecommendedLevelByType($exprType, $varTagType);
@@ -133,22 +136,22 @@ private function containsPhpStanType(Type $type): bool
 		return false;
 	}
 
-	private function shouldVarTagTypeBeReported(Node\Expr $expr, Type $type, Type $varTagType): bool
+	private function shouldVarTagTypeBeReported(Scope $scope, Node\Expr $expr, Type $type, Type $varTagType): bool
 	{
 		if ($expr instanceof Expr\Array_) {
 			if ($expr->items === []) {
 				$type = new ArrayType(new MixedType(), new MixedType());
 			}
 
-			return !$this->isAtLeastMaybeSuperTypeOfVarType($type, $varTagType);
+			return !$this->isAtLeastMaybeSuperTypeOfVarType($scope, $type, $varTagType);
 		}
 
 		if ($expr instanceof Expr\ConstFetch) {
-			return !$this->isAtLeastMaybeSuperTypeOfVarType($type, $varTagType);
+			return !$this->isAtLeastMaybeSuperTypeOfVarType($scope, $type, $varTagType);
 		}
 
 		if ($expr instanceof Node\Scalar) {
-			return !$this->isAtLeastMaybeSuperTypeOfVarType($type, $varTagType);
+			return !$this->isAtLeastMaybeSuperTypeOfVarType($scope, $type, $varTagType);
 		}
 
 		if ($expr instanceof Expr\New_) {
@@ -157,64 +160,87 @@ private function shouldVarTagTypeBeReported(Node\Expr $expr, Type $type, Type $v
 			}
 		}
 
-		return $this->checkType($type, $varTagType);
+		return $this->checkType($scope, $type, $varTagType);
 	}
 
-	private function checkType(Type $type, Type $varTagType, int $depth = 0): bool
+	private function checkType(Scope $scope, Type $type, Type $varTagType, int $depth = 0): bool
 	{
 		if ($this->strictWideningCheck) {
-			return !$this->isSuperTypeOfVarType($type, $varTagType);
+			return !$this->isSuperTypeOfVarType($scope, $type, $varTagType);
 		}
 
 		if ($type->isConstantArray()->yes()) {
 			if ($type->isIterableAtLeastOnce()->no()) {
 				$type = new ArrayType(new MixedType(), new MixedType());
-				return !$this->isAtLeastMaybeSuperTypeOfVarType($type, $varTagType);
+				return !$this->isAtLeastMaybeSuperTypeOfVarType($scope, $type, $varTagType);
 			}
 		}
 
 		if ($type->isIterable()->yes() && $varTagType->isIterable()->yes()) {
-			if (!$this->isAtLeastMaybeSuperTypeOfVarType($type, $varTagType)) {
+			if (!$this->isAtLeastMaybeSuperTypeOfVarType($scope, $type, $varTagType)) {
 				return true;
 			}
 
 			$innerType = $type->getIterableValueType();
 			$innerVarTagType = $varTagType->getIterableValueType();
 
 			if ($type->equals($innerType) || $varTagType->equals($innerVarTagType)) {
-				return !$this->isSuperTypeOfVarType($innerType, $innerVarTagType);
+				return !$this->isSuperTypeOfVarType($scope, $innerType, $innerVarTagType);
 			}
 
-			return $this->checkType($innerType, $innerVarTagType, $depth + 1);
+			return $this->checkType($scope, $innerType, $innerVarTagType, $depth + 1);
 		}
 
 		if ($depth === 0 && $type->isConstantValue()->yes()) {
-			return !$this->isAtLeastMaybeSuperTypeOfVarType($type, $varTagType);
+			return !$this->isAtLeastMaybeSuperTypeOfVarType($scope, $type, $varTagType);
 		}
 
-		return !$this->isSuperTypeOfVarType($type, $varTagType);
+		return !$this->isSuperTypeOfVarType($scope, $type, $varTagType);
 	}
 
-	private function isSuperTypeOfVarType(Type $type, Type $varTagType): bool
+	private function isSuperTypeOfVarType(Scope $scope, Type $type, Type $varTagType): bool
 	{
 		if ($type->isSuperTypeOf($varTagType)->yes()) {
 			return true;
 		}
 
-		$type = $this->typeNodeResolver->resolve($type->toPhpDocNode(), new NameScope(null, []));
+		try {
+			$type = $this->typeNodeResolver->resolve($type->toPhpDocNode(), $this->createNameScope($scope));
+		} catch (NameScopeAlreadyBeingCreatedException) {
+			return false;
+		}
 
 		return $type->isSuperTypeOf($varTagType)->yes();
 	}
 
-	private function isAtLeastMaybeSuperTypeOfVarType(Type $type, Type $varTagType): bool
+	private function isAtLeastMaybeSuperTypeOfVarType(Scope $scope, Type $type, Type $varTagType): bool
 	{
 		if (!$type->isSuperTypeOf($varTagType)->no()) {
 			return true;
 		}
 
-		$type = $this->typeNodeResolver->resolve($type->toPhpDocNode(), new NameScope(null, []));
+		try {
+			$type = $this->typeNodeResolver->resolve($type->toPhpDocNode(), $this->createNameScope($scope));
+		} catch (NameScopeAlreadyBeingCreatedException) {
+			return false;
+		}
 
 		return !$type->isSuperTypeOf($varTagType)->no();
 	}
 
+	/**
+	 * @throws NameScopeAlreadyBeingCreatedException
+	 */
+	private function createNameScope(Scope $scope): NameScope
+	{
+		$function = $scope->getFunction();
+
+		return $this->fileTypeMapper->getNameScope(
+			$scope->getFile(),
+			$scope->isInClass() ? $scope->getClassReflection()->getName() : null,
+			$scope->isInTrait() ? $scope->getTraitReflection()->getName() : null,
+			$function !== null ? $function->getName() : null,
+		);
+	}
+
 }

tests/PHPStan/Rules/PhpDoc/VarTagChangedExpressionTypeRuleTest.php

@@ -5,6 +5,7 @@
 use PHPStan\PhpDoc\TypeNodeResolver;
 use PHPStan\Rules\Rule;
 use PHPStan\Testing\RuleTestCase;
+use PHPStan\Type\FileTypeMapper;
 
 /**
  * @extends RuleTestCase<VarTagChangedExpressionTypeRule>
@@ -16,6 +17,7 @@ protected function getRule(): Rule
 	{
 		return new VarTagChangedExpressionTypeRule(new VarTagTypeRuleHelper(
 			self::getContainer()->getByType(TypeNodeResolver::class),
+			self::getContainer()->getByType(FileTypeMapper::class),
 			true,
 			true,
 		));

tests/PHPStan/Rules/PhpDoc/WrongVariableNameInVarTagRuleTest.php

@@ -26,6 +26,7 @@ protected function getRule(): Rule
 			self::getContainer()->getByType(FileTypeMapper::class),
 			new VarTagTypeRuleHelper(
 				self::getContainer()->getByType(TypeNodeResolver::class),
+				self::getContainer()->getByType(FileTypeMapper::class),
 				$this->checkTypeAgainstPhpDocType,
 				$this->strictWideningCheck,
 			),