TypehintHelper::decideTypeFromReflection should accept correct ancest…

…or ClassReflection, not just class name
phpstan · Apr 4, 2023 · 297a9fe · 297a9fe
1 parent b439fed
commit 297a9fe
Show file tree

Hide file tree

Showing 6 changed files with 40 additions and 22 deletions.
diff --git a/src/Reflection/Php/PhpClassReflectionExtension.php b/src/Reflection/Php/PhpClassReflectionExtension.php
@@ -749,7 +749,7 @@ private function createMethod(
 		$nativeReturnType = TypehintHelper::decideTypeFromReflection(
 			$methodReflection->getReturnType(),
 			null,
-			$declaringClass->getName(),
+			$declaringClass,
 		);
 		$phpDocReturnType = $this->getPhpDocReturnType($phpDocBlockClassReflection, $resolvedPhpDoc, $nativeReturnType);
 		$phpDocThrowType = $resolvedPhpDoc->getThrowsTag() !== null ? $resolvedPhpDoc->getThrowsTag()->getType() : null;

diff --git a/src/Reflection/Php/PhpMethodReflection.php b/src/Reflection/Php/PhpMethodReflection.php
@@ -345,7 +345,7 @@ private function getReturnType(): Type
 			$this->returnType = TypehintHelper::decideTypeFromReflection(
 				$returnType,
 				$this->phpDocReturnType,
-				$this->declaringClass->getName(),
+				$this->declaringClass,
 			);
 		}
 
@@ -367,7 +367,7 @@ private function getNativeReturnType(): Type
 			$this->nativeReturnType = TypehintHelper::decideTypeFromReflection(
 				$this->reflection->getReturnType(),
 				null,
-				$this->declaringClass->getName(),
+				$this->declaringClass,
 			);
 		}
 

diff --git a/src/Reflection/Php/PhpPropertyReflection.php b/src/Reflection/Php/PhpPropertyReflection.php
@@ -87,7 +87,7 @@ public function getReadableType(): Type
 			$this->type = TypehintHelper::decideTypeFromReflection(
 				$this->nativeType,
 				$this->phpDocType,
-				$this->declaringClass->getName(),
+				$this->declaringClass,
 			);
 		}
 
@@ -134,7 +134,7 @@ public function getNativeType(): Type
 			$this->finalNativeType = TypehintHelper::decideTypeFromReflection(
 				$this->nativeType,
 				null,
-				$this->declaringClass->getName(),
+				$this->declaringClass,
 			);
 		}
 

diff --git a/src/Type/TypehintHelper.php b/src/Type/TypehintHelper.php
@@ -2,6 +2,7 @@
 
 namespace PHPStan\Type;
 
+use PHPStan\Reflection\ClassReflection;
 use PHPStan\Reflection\ReflectionProviderStaticAccessor;
 use PHPStan\ShouldNotHappenException;
 use PHPStan\Type\Constant\ConstantBooleanType;
@@ -13,14 +14,15 @@
 use function array_map;
 use function count;
 use function get_class;
+use function is_string;
 use function sprintf;
 use function str_ends_with;
 use function strtolower;
 
 class TypehintHelper
 {
 
-	private static function getTypeObjectFromTypehint(string $typeString, ?string $selfClass): Type
+	private static function getTypeObjectFromTypehint(string $typeString, ClassReflection|string|null $selfClass): Type
 	{
 		switch (strtolower($typeString)) {
 			case 'int':
@@ -48,20 +50,36 @@ private static function getTypeObjectFromTypehint(string $typeString, ?string $s
 			case 'mixed':
 				return new MixedType(true);
 			case 'self':
+				if ($selfClass instanceof ClassReflection) {
+					$selfClass = $selfClass->getName();
+				}
 				return $selfClass !== null ? new ObjectType($selfClass) : new ErrorType();
 			case 'parent':
 				$reflectionProvider = ReflectionProviderStaticAccessor::getInstance();
-				if ($selfClass !== null && $reflectionProvider->hasClass($selfClass)) {
-					$classReflection = $reflectionProvider->getClass($selfClass);
-					if ($classReflection->getParentClass() !== null) {
-						return new ObjectType($classReflection->getParentClass()->getName());
+				if (is_string($selfClass)) {
+					if ($reflectionProvider->hasClass($selfClass)) {
+						$selfClass = $reflectionProvider->getClass($selfClass);
+					} else {
+						$selfClass = null;
+					}
+				}
+				if ($selfClass !== null) {
+					if ($selfClass->getParentClass() !== null) {
+						return new ObjectType($selfClass->getParentClass()->getName());
 					}
 				}
 				return new NonexistentParentClassType();
 			case 'static':
 				$reflectionProvider = ReflectionProviderStaticAccessor::getInstance();
-				if ($selfClass !== null && $reflectionProvider->hasClass($selfClass)) {
-					return new StaticType($reflectionProvider->getClass($selfClass));
+				if (is_string($selfClass)) {
+					if ($reflectionProvider->hasClass($selfClass)) {
+						 $selfClass = $reflectionProvider->getClass($selfClass);
+					} else {
+						$selfClass = null;
+					}
+				}
+				if ($selfClass !== null) {
+					return new StaticType($selfClass);
 				}
 
 				return new ErrorType();
@@ -78,7 +96,7 @@ private static function getTypeObjectFromTypehint(string $typeString, ?string $s
 	public static function decideTypeFromReflection(
 		?ReflectionType $reflectionType,
 		?Type $phpDocType = null,
-		?string $selfClass = null,
+		ClassReflection|string|null $selfClass = null,
 		bool $isVariadic = false,
 	): Type
 	{

diff --git a/tests/PHPStan/Rules/Methods/MethodSignatureRuleTest.php b/tests/PHPStan/Rules/Methods/MethodSignatureRuleTest.php
@@ -384,7 +384,7 @@ public function testBug7652(): void
 		$this->reportStatic = true;
 		$this->analyse([__DIR__ . '/data/bug-7652.php'], [
 			[
-				'Return type mixed of method Bug7652\Options::offsetGet() is not covariant with tentative return type mixed of method ArrayAccess::offsetGet().',
+				'Return type mixed of method Bug7652\Options::offsetGet() is not covariant with tentative return type mixed of method ArrayAccess<key-of<TArray of array>,value-of<TArray of array>>::offsetGet().',
 				23,
 				'Make it covariant, or use the #[\ReturnTypeWillChange] attribute to temporarily suppress the error.',
 			],

diff --git a/tests/PHPStan/Rules/Methods/OverridingMethodRuleTest.php b/tests/PHPStan/Rules/Methods/OverridingMethodRuleTest.php
@@ -120,7 +120,7 @@ public function testOverridingFinalMethod(int $phpVersion, string $contravariant
 				280,
 			],
 			[
-				'Parameter #1 $index (int) of method OverridingFinalMethod\FixedArrayOffsetExists::offsetExists() is not ' . $contravariantMessage . ' with parameter #1 $offset (mixed) of method ArrayAccess::offsetExists().',
+				'Parameter #1 $index (int) of method OverridingFinalMethod\FixedArrayOffsetExists::offsetExists() is not ' . $contravariantMessage . ' with parameter #1 $offset (mixed) of method ArrayAccess<int,mixed>::offsetExists().',
 				313,
 			],
 		];
@@ -472,37 +472,37 @@ public function dataTentativeReturnTypes(): array
 				80100,
 				[
 					[
-						'Return type mixed of method TentativeReturnTypes\Foo::getIterator() is not covariant with tentative return type Traversable of method IteratorAggregate::getIterator().',
+						'Return type mixed of method TentativeReturnTypes\Foo::getIterator() is not covariant with tentative return type Traversable of method IteratorAggregate<mixed,mixed>::getIterator().',
 						8,
 						'Make it covariant, or use the #[\ReturnTypeWillChange] attribute to temporarily suppress the error.',
 					],
 					[
-						'Return type string of method TentativeReturnTypes\Lorem::getIterator() is not covariant with tentative return type Traversable of method IteratorAggregate::getIterator().',
+						'Return type string of method TentativeReturnTypes\Lorem::getIterator() is not covariant with tentative return type Traversable of method IteratorAggregate<mixed,mixed>::getIterator().',
 						40,
 						'Make it covariant, or use the #[\ReturnTypeWillChange] attribute to temporarily suppress the error.',
 					],
 					[
-						'Return type mixed of method TentativeReturnTypes\UntypedIterator::current() is not covariant with tentative return type mixed of method Iterator::current().',
+						'Return type mixed of method TentativeReturnTypes\UntypedIterator::current() is not covariant with tentative return type mixed of method Iterator<mixed,mixed>::current().',
 						75,
 						'Make it covariant, or use the #[\ReturnTypeWillChange] attribute to temporarily suppress the error.',
 					],
 					[
-						'Return type mixed of method TentativeReturnTypes\UntypedIterator::next() is not covariant with tentative return type void of method Iterator::next().',
+						'Return type mixed of method TentativeReturnTypes\UntypedIterator::next() is not covariant with tentative return type void of method Iterator<mixed,mixed>::next().',
 						79,
 						'Make it covariant, or use the #[\ReturnTypeWillChange] attribute to temporarily suppress the error.',
 					],
 					[
-						'Return type mixed of method TentativeReturnTypes\UntypedIterator::key() is not covariant with tentative return type mixed of method Iterator::key().',
+						'Return type mixed of method TentativeReturnTypes\UntypedIterator::key() is not covariant with tentative return type mixed of method Iterator<mixed,mixed>::key().',
 						83,
 						'Make it covariant, or use the #[\ReturnTypeWillChange] attribute to temporarily suppress the error.',
 					],
 					[
-						'Return type mixed of method TentativeReturnTypes\UntypedIterator::valid() is not covariant with tentative return type bool of method Iterator::valid().',
+						'Return type mixed of method TentativeReturnTypes\UntypedIterator::valid() is not covariant with tentative return type bool of method Iterator<mixed,mixed>::valid().',
 						87,
 						'Make it covariant, or use the #[\ReturnTypeWillChange] attribute to temporarily suppress the error.',
 					],
 					[
-						'Return type mixed of method TentativeReturnTypes\UntypedIterator::rewind() is not covariant with tentative return type void of method Iterator::rewind().',
+						'Return type mixed of method TentativeReturnTypes\UntypedIterator::rewind() is not covariant with tentative return type void of method Iterator<mixed,mixed>::rewind().',
 						91,
 						'Make it covariant, or use the #[\ReturnTypeWillChange] attribute to temporarily suppress the error.',
 					],