[BCB] ClassPropertyNode::getNativeType() return type changed from AST node to Type

ondrejmirtes · ondrejmirtes · commit 9e7f39ed4ca6 · 2024-10-01T11:18:21.000+02:00
diff --git a/UPGRADING.md b/UPGRADING.md
@@ -299,3 +299,4 @@ Instead of `PHPStanTestCase::createBroker()`, call `PHPStanTestCase::createRefle
   * Added more methods around PHPDoc types and native types to the (new) `ClassConstantReflection`
   * Interface `GlobalConstantReflection` renamed to `ConstantReflection`
 * Renamed interfaces and classes from `*WithPhpDocs` to `Extended*`
+* `ClassPropertyNode::getNativeType()` return type changed from AST node to `Type|null
diff --git a/src/Analyser/NodeScopeResolver.php b/src/Analyser/NodeScopeResolver.php
@@ -170,6 +170,7 @@
 use PHPStan\Type\NullType;
 use PHPStan\Type\ObjectType;
 use PHPStan\Type\ObjectWithoutClassType;
+use PHPStan\Type\ParserNodeTypeToPHPStanType;
 use PHPStan\Type\ResourceType;
 use PHPStan\Type\StaticType;
 use PHPStan\Type\StaticTypeFactory;
@@ -648,7 +649,7 @@ private function processStmtNode(
 					$nodeCallback(new ClassPropertyNode(
 						$param->var->name,
 						$param->flags,
-						$param->type,
+						$param->type !== null ? ParserNodeTypeToPHPStanType::resolve($param->type, $scope->getClassReflection()) : null,
 						null,
 						$phpDoc,
 						$phpDocParameterTypes[$param->var->name] ?? null,
@@ -899,13 +900,13 @@ private function processStmtNode(
 					new ClassPropertyNode(
 						$propertyName,
 						$stmt->flags,
-						$stmt->type,
+						$stmt->type !== null ? ParserNodeTypeToPHPStanType::resolve($stmt->type, $scope->getClassReflection()) : null,
 						$prop->default,
 						$docComment,
 						$phpDocType,
 						false,
 						false,
-						$prop,
+						$stmt,
 						$isReadOnly,
 						$scope->isInTrait(),
 						$scope->getClassReflection()->isReadOnly(),
diff --git a/src/Dependency/DependencyResolver.php b/src/Dependency/DependencyResolver.php
@@ -22,7 +22,6 @@
 use PHPStan\Reflection\ReflectionProvider;
 use PHPStan\Type\ClosureType;
 use PHPStan\Type\FileTypeMapper;
-use PHPStan\Type\ParserNodeTypeToPHPStanType;
 use PHPStan\Type\Type;
 use function array_merge;
 use function count;
@@ -85,9 +84,8 @@ public function resolveDependencies(Node $node, Scope $scope): NodeDependencies
 				}
 			}
 		} elseif ($node instanceof ClassPropertyNode) {
-			$nativeTypeNode = $node->getNativeType();
-			if ($nativeTypeNode !== null) {
-				$nativeType = ParserNodeTypeToPHPStanType::resolve($nativeTypeNode, $node->getClassReflection());
+			$nativeType = $node->getNativeType();
+			if ($nativeType !== null) {
 				foreach ($nativeType->getReferencedClasses() as $referencedClass) {
 					$this->addClassToDependencies($referencedClass, $dependenciesReflections);
 				}
diff --git a/src/Node/ClassPropertyNode.php b/src/Node/ClassPropertyNode.php
@@ -5,8 +5,6 @@
 use PhpParser\Modifiers;
 use PhpParser\Node;
 use PhpParser\Node\Expr;
-use PhpParser\Node\Identifier;
-use PhpParser\Node\Name;
 use PhpParser\NodeAbstract;
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\Type\Type;
@@ -20,13 +18,13 @@ final class ClassPropertyNode extends NodeAbstract implements VirtualNode
 	public function __construct(
 		private string $name,
 		private int $flags,
-		private Identifier|Name|Node\ComplexType|null $type,
+		private ?Type $type,
 		private ?Expr $default,
 		private ?string $phpDoc,
 		private ?Type $phpDocType,
 		private bool $isPromoted,
 		private bool $isPromotedFromTrait,
-		Node $originalNode,
+		private Node\Stmt\Property|Node\Param $originalNode,
 		private bool $isReadonlyByPhpDoc,
 		private bool $isDeclaredInTrait,
 		private bool $isReadonlyClass,
@@ -113,12 +111,17 @@ public function isAllowedPrivateMutation(): bool
 		return $this->isAllowedPrivateMutation;
 	}
 
+	public function getNativeType(): ?Type
+	{
+		return $this->type;
+	}
+
 	/**
-	 * @return Identifier|Name|Node\ComplexType|null
+	 * @return Node\Identifier|Node\Name|Node\ComplexType|null
 	 */
-	public function getNativeType()
+	public function getNativeTypeNode()
 	{
-		return $this->type;
+		return $this->originalNode->type;
 	}
 
 	public function getClassReflection(): ClassReflection
diff --git a/src/Rules/PhpDoc/IncompatiblePropertyPhpDocTypeRule.php b/src/Rules/PhpDoc/IncompatiblePropertyPhpDocTypeRule.php
@@ -10,7 +10,6 @@
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\Type\Generic\TemplateType;
-use PHPStan\Type\ParserNodeTypeToPHPStanType;
 use PHPStan\Type\VerbosityLevel;
 use function array_merge;
 use function sprintf;
@@ -62,33 +61,35 @@ public function processNode(Node $node, Scope $scope): array
 			))->identifier('property.unresolvableType')->build();
 		}
 
-		$nativeType = ParserNodeTypeToPHPStanType::resolve($node->getNativeType(), $classReflection);
-		$isSuperType = $nativeType->isSuperTypeOf($phpDocType);
-		if ($isSuperType->no()) {
-			$messages[] = RuleErrorBuilder::message(sprintf(
-				'%s for property %s::$%s with type %s is incompatible with native type %s.',
-				$description,
-				$classReflection->getDisplayName(),
-				$propertyName,
-				$phpDocType->describe(VerbosityLevel::typeOnly()),
-				$nativeType->describe(VerbosityLevel::typeOnly()),
-			))->identifier('property.phpDocType')->build();
-
-		} elseif ($isSuperType->maybe()) {
-			$errorBuilder = RuleErrorBuilder::message(sprintf(
-				'%s for property %s::$%s with type %s is not subtype of native type %s.',
-				$description,
-				$classReflection->getDisplayName(),
-				$propertyName,
-				$phpDocType->describe(VerbosityLevel::typeOnly()),
-				$nativeType->describe(VerbosityLevel::typeOnly()),
-			))->identifier('property.phpDocType');
-
-			if ($phpDocType instanceof TemplateType) {
-				$errorBuilder->tip(sprintf('Write @template %s of %s to fix this.', $phpDocType->getName(), $nativeType->describe(VerbosityLevel::typeOnly())));
+		$nativeType = $node->getNativeType();
+		if ($nativeType !== null) {
+			$isSuperType = $nativeType->isSuperTypeOf($phpDocType);
+			if ($isSuperType->no()) {
+				$messages[] = RuleErrorBuilder::message(sprintf(
+					'%s for property %s::$%s with type %s is incompatible with native type %s.',
+					$description,
+					$classReflection->getDisplayName(),
+					$propertyName,
+					$phpDocType->describe(VerbosityLevel::typeOnly()),
+					$nativeType->describe(VerbosityLevel::typeOnly()),
+				))->identifier('property.phpDocType')->build();
+
+			} elseif ($isSuperType->maybe()) {
+				$errorBuilder = RuleErrorBuilder::message(sprintf(
+					'%s for property %s::$%s with type %s is not subtype of native type %s.',
+					$description,
+					$classReflection->getDisplayName(),
+					$propertyName,
+					$phpDocType->describe(VerbosityLevel::typeOnly()),
+					$nativeType->describe(VerbosityLevel::typeOnly()),
+				))->identifier('property.phpDocType');
+
+				if ($phpDocType instanceof TemplateType) {
+					$errorBuilder->tip(sprintf('Write @template %s of %s to fix this.', $phpDocType->getName(), $nativeType->describe(VerbosityLevel::typeOnly())));
+				}
+
+				$messages[] = $errorBuilder->build();
 			}
-
-			$messages[] = $errorBuilder->build();
 		}
 
 		$className = SprintfHelper::escapeFormatString($classReflection->getDisplayName());
diff --git a/src/Rules/Properties/OverridingPropertyRule.php b/src/Rules/Properties/OverridingPropertyRule.php
@@ -9,7 +9,6 @@
 use PHPStan\Reflection\Php\PhpPropertyReflection;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
-use PHPStan\Type\ParserNodeTypeToPHPStanType;
 use PHPStan\Type\VerbosityLevel;
 use function array_merge;
 use function count;
@@ -104,8 +103,9 @@ public function processNode(Node $node, Scope $scope): array
 		}
 
 		$typeErrors = [];
+		$nativeType = $node->getNativeType();
 		if ($prototype->hasNativeType()) {
-			if ($node->getNativeType() === null) {
+			if ($nativeType === null) {
 				$typeErrors[] = RuleErrorBuilder::message(sprintf(
 					'Property %s::$%s overriding property %s::$%s (%s) should also have native type %s.',
 					$classReflection->getDisplayName(),
@@ -116,7 +116,6 @@ public function processNode(Node $node, Scope $scope): array
 					$prototype->getNativeType()->describe(VerbosityLevel::typeOnly()),
 				))->identifier('property.missingNativeType')->nonIgnorable()->build();
 			} else {
-				$nativeType = ParserNodeTypeToPHPStanType::resolve($node->getNativeType(), $classReflection);
 				if (!$prototype->getNativeType()->equals($nativeType)) {
 					$typeErrors[] = RuleErrorBuilder::message(sprintf(
 						'Type %s of property %s::$%s is not the same as type %s of overridden property %s::$%s.',
@@ -129,12 +128,12 @@ public function processNode(Node $node, Scope $scope): array
 					))->identifier('property.nativeType')->nonIgnorable()->build();
 				}
 			}
-		} elseif ($node->getNativeType() !== null) {
+		} elseif ($nativeType !== null) {
 			$typeErrors[] = RuleErrorBuilder::message(sprintf(
 				'Property %s::$%s (%s) overriding property %s::$%s should not have a native type.',
 				$classReflection->getDisplayName(),
 				$node->getName(),
-				ParserNodeTypeToPHPStanType::resolve($node->getNativeType(), $classReflection)->describe(VerbosityLevel::typeOnly()),
+				$nativeType->describe(VerbosityLevel::typeOnly()),
 				$prototype->getDeclaringClass()->getDisplayName(),
 				$node->getName(),
 			))->identifier('property.extraNativeType')->nonIgnorable()->build();
diff --git a/src/Rules/Types/InvalidTypesInUnionRule.php b/src/Rules/Types/InvalidTypesInUnionRule.php
@@ -69,11 +69,11 @@ private function processFunctionLikeNode(Node\FunctionLike $functionLike): array
 	 */
 	private function processClassPropertyNode(ClassPropertyNode $classPropertyNode): array
 	{
-		if (!$classPropertyNode->getNativeType() instanceof Node\ComplexType) {
+		if (!$classPropertyNode->getNativeTypeNode() instanceof Node\ComplexType) {
 			return [];
 		}
 
-		return $this->processComplexType($classPropertyNode->getNativeType());
+		return $this->processComplexType($classPropertyNode->getNativeTypeNode());
 	}
 
 	/**

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,6 @@`
`22`	`22`	`use PHPStan\Reflection\ReflectionProvider;`
`23`	`23`	`use PHPStan\Type\ClosureType;`
`24`	`24`	`use PHPStan\Type\FileTypeMapper;`
`25`		`-use PHPStan\Type\ParserNodeTypeToPHPStanType;`
`26`	`25`	`use PHPStan\Type\Type;`
`27`	`26`	`use function array_merge;`
`28`	`27`	`use function count;`
`@@ -85,9 +84,8 @@ public function resolveDependencies(Node $node, Scope $scope): NodeDependencies`
`85`	`84`	`}`
`86`	`85`	`}`
`87`	`86`	`} elseif ($node instanceof ClassPropertyNode) {`
`88`		`- $nativeTypeNode = $node->getNativeType();`
`89`		`- if ($nativeTypeNode !== null) {`
`90`		`- $nativeType = ParserNodeTypeToPHPStanType::resolve($nativeTypeNode, $node->getClassReflection());`
	`87`	`+ $nativeType = $node->getNativeType();`
	`88`	`+ if ($nativeType !== null) {`
`91`	`89`	`foreach ($nativeType->getReferencedClasses() as $referencedClass) {`
`92`	`90`	`$this->addClassToDependencies($referencedClass, $dependenciesReflections);`
`93`	`91`	`}`
Original file line number	Diff line number	Diff line change
`@@ -69,11 +69,11 @@ private function processFunctionLikeNode(Node\FunctionLike $functionLike): array`
`69`	`69`	`*/`
`70`	`70`	`private function processClassPropertyNode(ClassPropertyNode $classPropertyNode): array`
`71`	`71`	`{`
`72`		`- if (!$classPropertyNode->getNativeType() instanceof Node\ComplexType) {`
	`72`	`+ if (!$classPropertyNode->getNativeTypeNode() instanceof Node\ComplexType) {`
`73`	`73`	`return [];`
`74`	`74`	`}`
`75`	`75`
`76`		`- return $this->processComplexType($classPropertyNode->getNativeType());`
	`76`	`+ return $this->processComplexType($classPropertyNode->getNativeTypeNode());`
`77`	`77`	`}`
`78`	`78`
`79`	`79`	`/**`