Make PhpClassReflection::getProperty() always return PhpPropertyReflection

Author: ondrejmirtes

src/Reflection/Php/PhpClassReflectionExtension.php

@@ -25,7 +25,6 @@
 use PHPStan\Reflection\Deprecation\DeprecationProvider;
 use PHPStan\Reflection\ExtendedFunctionVariant;
 use PHPStan\Reflection\ExtendedMethodReflection;
-use PHPStan\Reflection\ExtendedPropertyReflection;
 use PHPStan\Reflection\InitializerExprContext;
 use PHPStan\Reflection\MethodReflection;
 use PHPStan\Reflection\MethodsClassReflectionExtension;
@@ -69,7 +68,7 @@ final class PhpClassReflectionExtension
 	implements PropertiesClassReflectionExtension, MethodsClassReflectionExtension
 {
 
-	/** @var ExtendedPropertyReflection[][] */
+	/** @var PhpPropertyReflection[][] */
 	private array $propertiesIncludingAnnotations = [];
 
 	/** @var PhpPropertyReflection[][] */
@@ -159,7 +158,7 @@ public function hasProperty(ClassReflection $classReflection, string $propertyNa
 		return $classReflection->getNativeReflection()->hasProperty($propertyName);
 	}
 
-	public function getProperty(ClassReflection $classReflection, string $propertyName): ExtendedPropertyReflection
+	public function getProperty(ClassReflection $classReflection, string $propertyName): PhpPropertyReflection
 	{
 		if (!isset($this->propertiesIncludingAnnotations[$classReflection->getCacheKey()][$propertyName])) {
 			$this->propertiesIncludingAnnotations[$classReflection->getCacheKey()][$propertyName] = $this->createProperty($classReflection, $propertyName, true);
@@ -171,7 +170,6 @@ public function getProperty(ClassReflection $classReflection, string $propertyNa
 	public function getNativeProperty(ClassReflection $classReflection, string $propertyName): PhpPropertyReflection
 	{
 		if (!isset($this->nativeProperties[$classReflection->getCacheKey()][$propertyName])) {
-			/** @var PhpPropertyReflection $property */
 			$property = $this->createProperty($classReflection, $propertyName, false);
 			$this->nativeProperties[$classReflection->getCacheKey()][$propertyName] = $property;
 		}
@@ -183,7 +181,7 @@ private function createProperty(
 		ClassReflection $classReflection,
 		string $propertyName,
 		bool $includingAnnotations,
-	): ExtendedPropertyReflection
+	): PhpPropertyReflection
 	{
 		$propertyReflection = $classReflection->getNativeReflection()->getProperty($propertyName);
 		$propertyName = $propertyReflection->getName();
@@ -230,31 +228,6 @@ private function createProperty(
 		$isFinal = $classReflection->isFinal() || $propertyReflection->isFinal();
 		$isAllowedPrivateMutation = false;
 
-		if (
-			$includingAnnotations
-			&& !$declaringClassReflection->isEnum()
-			&& $this->annotationsPropertiesClassReflectionExtension->hasProperty($classReflection, $propertyName)
-		) {
-			$hierarchyDistances = $classReflection->getClassHierarchyDistances();
-			$annotationProperty = $this->annotationsPropertiesClassReflectionExtension->getProperty($classReflection, $propertyName);
-			if (!isset($hierarchyDistances[$annotationProperty->getDeclaringClass()->getName()])) {
-				throw new ShouldNotHappenException();
-			}
-
-			$distanceDeclaringClass = $propertyReflection->getDeclaringClass()->getName();
-			$propertyTrait = $this->findPropertyTrait($propertyReflection);
-			if ($propertyTrait !== null) {
-				$distanceDeclaringClass = $propertyTrait;
-			}
-			if (!isset($hierarchyDistances[$distanceDeclaringClass])) {
-				throw new ShouldNotHappenException();
-			}
-
-			if ($hierarchyDistances[$annotationProperty->getDeclaringClass()->getName()] <= $hierarchyDistances[$distanceDeclaringClass]) {
-				return $annotationProperty;
-			}
-		}
-
 		$docComment = $propertyReflection->getDocComment() !== false
 			? $propertyReflection->getDocComment()
 			: null;
@@ -423,6 +396,46 @@ private function createProperty(
 			}
 		}
 
+		if (
+			$includingAnnotations
+			&& !$declaringClassReflection->isEnum()
+			&& $this->annotationsPropertiesClassReflectionExtension->hasProperty($classReflection, $propertyName)
+		) {
+			$hierarchyDistances = $classReflection->getClassHierarchyDistances();
+			$annotationProperty = $this->annotationsPropertiesClassReflectionExtension->getProperty($classReflection, $propertyName);
+			if (!isset($hierarchyDistances[$annotationProperty->getDeclaringClass()->getName()])) {
+				throw new ShouldNotHappenException();
+			}
+
+			$distanceDeclaringClass = $propertyReflection->getDeclaringClass()->getName();
+			$propertyTrait = $this->findPropertyTrait($propertyReflection);
+			if ($propertyTrait !== null) {
+				$distanceDeclaringClass = $propertyTrait;
+			}
+			if (!isset($hierarchyDistances[$distanceDeclaringClass])) {
+				throw new ShouldNotHappenException();
+			}
+
+			if ($hierarchyDistances[$annotationProperty->getDeclaringClass()->getName()] <= $hierarchyDistances[$distanceDeclaringClass]) {
+				return new PhpPropertyReflection(
+					$annotationProperty->getDeclaringClass(),
+					$declaringTrait,
+					$nativeType,
+					$annotationProperty->getPhpDocType(),
+					$propertyReflection,
+					$getHook,
+					$setHook,
+					$deprecatedDescription,
+					$isDeprecated,
+					$isInternal,
+					$isReadOnlyByPhpDoc,
+					$isAllowedPrivateMutation,
+					$this->attributeReflectionFactory->fromNativeReflection($propertyReflection->getAttributes(), InitializerExprContext::fromClass($declaringClassReflection->getName(), $declaringClassReflection->getFileName())),
+					$isFinal,
+				);
+			}
+		}
+
 		return new PhpPropertyReflection(
 			$declaringClassReflection,
 			$declaringTrait,

tests/PHPStan/Analyser/LegacyNodeScopeResolverTest.php

@@ -1841,7 +1841,7 @@ public static function dataProperties(): array
 				'$this->overriddenReadOnlyProperty',
 			],
 			[
-				'string',
+				'DOMElement|null',
 				'$this->documentElement',
 			],
 		];

tests/PHPStan/Rules/Properties/AccessPropertiesInAssignRuleTest.php

@@ -130,7 +130,12 @@ public function testObjectShapes(): void
 
 	public function testConflictingAnnotationProperty(): void
 	{
-		$this->analyse([__DIR__ . '/data/conflicting-annotation-property.php'], []);
+		$this->analyse([__DIR__ . '/data/conflicting-annotation-property.php'], [
+			[
+				'Access to private property ConflictingAnnotationProperty\PropertyWithAnnotation::$test.',
+				27,
+			],
+		]);
 	}
 
 	public function testBug10477(): void

tests/PHPStan/Rules/Properties/AccessPropertiesRuleTest.php

@@ -947,7 +947,12 @@ public function testConflictingAnnotationProperty(): void
 		$this->checkThisOnly = false;
 		$this->checkUnionTypes = true;
 		$this->checkDynamicProperties = true;
-		$this->analyse([__DIR__ . '/data/conflicting-annotation-property.php'], []);
+		$this->analyse([__DIR__ . '/data/conflicting-annotation-property.php'], [
+			[
+				'Access to private property ConflictingAnnotationProperty\PropertyWithAnnotation::$test.',
+				26,
+			],
+		]);
 	}
 
 	#[RequiresPhp('>= 8.1')]