OverridingMethodRule - search for method prototype in traits

phpstan · Nov 13, 2023 · 2df14af · 2df14af
1 parent 22e21f0
commit 2df14af
Show file tree

Hide file tree

Showing 18 changed files with 158 additions and 3 deletions.
diff --git a/src/Php/PhpVersion.php b/src/Php/PhpVersion.php
@@ -247,4 +247,9 @@ public function supportsNativeTypesInClassConstants(): bool
 		return $this->versionId >= 80300;
 	}
 
+	public function supportsAbstractTraitMethods(): bool
+	{
+		return $this->versionId >= 80000;
+	}
+
 }
diff --git a/src/Reflection/Annotations/AnnotationMethodReflection.php b/src/Reflection/Annotations/AnnotationMethodReflection.php
@@ -140,4 +140,9 @@ public function returnsByReference(): TrinaryLogic
 		return TrinaryLogic::createMaybe();
 	}
 
+	public function isAbstract(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 }
diff --git a/src/Reflection/Dummy/ChangedTypeMethodReflection.php b/src/Reflection/Dummy/ChangedTypeMethodReflection.php
@@ -9,6 +9,7 @@
 use PHPStan\Reflection\ParametersAcceptorWithPhpDocs;
 use PHPStan\TrinaryLogic;
 use PHPStan\Type\Type;
+use function is_bool;
 
 class ChangedTypeMethodReflection implements ExtendedMethodReflection
 {
@@ -110,4 +111,14 @@ public function returnsByReference(): TrinaryLogic
 		return $this->reflection->returnsByReference();
 	}
 
+	public function isAbstract(): TrinaryLogic
+	{
+		$abstract = $this->reflection->isAbstract();
+		if (is_bool($abstract)) {
+			return TrinaryLogic::createFromBoolean($abstract);
+		}
+
+		return $abstract;
+	}
+
 }
diff --git a/src/Reflection/Dummy/DummyConstructorReflection.php b/src/Reflection/Dummy/DummyConstructorReflection.php
@@ -121,4 +121,9 @@ public function isFinalByKeyword(): TrinaryLogic
 		return TrinaryLogic::createMaybe();
 	}
 
+	public function isAbstract(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 }
diff --git a/src/Reflection/Dummy/DummyMethodReflection.php b/src/Reflection/Dummy/DummyMethodReflection.php
@@ -113,4 +113,9 @@ public function returnsByReference(): TrinaryLogic
 		return TrinaryLogic::createMaybe();
 	}
 
+	public function isAbstract(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 }
diff --git a/src/Reflection/ExtendedMethodReflection.php b/src/Reflection/ExtendedMethodReflection.php
@@ -35,4 +35,6 @@ public function returnsByReference(): TrinaryLogic;
 
 	public function isFinalByKeyword(): TrinaryLogic;
 
+	public function isAbstract(): TrinaryLogic|bool;
+
 }
diff --git a/src/Reflection/Native/NativeMethodReflection.php b/src/Reflection/Native/NativeMethodReflection.php
@@ -56,9 +56,9 @@ public function isPublic(): bool
 		return $this->reflection->isPublic();
 	}
 
-	public function isAbstract(): bool
+	public function isAbstract(): TrinaryLogic
 	{
-		return $this->reflection->isAbstract();
+		return TrinaryLogic::createFromBoolean($this->reflection->isAbstract());
 	}
 
 	public function getPrototype(): ClassMemberReflection

diff --git a/src/Reflection/Php/ClosureCallMethodReflection.php b/src/Reflection/Php/ClosureCallMethodReflection.php
@@ -18,6 +18,7 @@
 use PHPStan\Type\Type;
 use function array_map;
 use function array_unshift;
+use function is_bool;
 
 final class ClosureCallMethodReflection implements ExtendedMethodReflection
 {
@@ -152,4 +153,14 @@ public function returnsByReference(): TrinaryLogic
 		return $this->nativeMethodReflection->returnsByReference();
 	}
 
+	public function isAbstract(): TrinaryLogic
+	{
+		$abstract = $this->nativeMethodReflection->isAbstract();
+		if (is_bool($abstract)) {
+			return TrinaryLogic::createFromBoolean($abstract);
+		}
+
+		return $abstract;
+	}
+
 }
diff --git a/src/Reflection/Php/EnumCasesMethodReflection.php b/src/Reflection/Php/EnumCasesMethodReflection.php
@@ -125,4 +125,9 @@ public function returnsByReference(): TrinaryLogic
 		return TrinaryLogic::createNo();
 	}
 
+	public function isAbstract(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 }
diff --git a/src/Reflection/Php/PhpMethodFromParserNodeReflection.php b/src/Reflection/Php/PhpMethodFromParserNodeReflection.php
@@ -163,4 +163,9 @@ public function returnsByReference(): TrinaryLogic
 		return TrinaryLogic::createFromBoolean($this->getClassMethod()->returnsByRef());
 	}
 
+	public function isAbstract(): TrinaryLogic
+	{
+		return TrinaryLogic::createFromBoolean($this->getClassMethod()->isAbstract());
+	}
+
 }
diff --git a/src/Reflection/ResolvedMethodReflection.php b/src/Reflection/ResolvedMethodReflection.php
@@ -9,6 +9,7 @@
 use PHPStan\Type\Generic\TemplateTypeVariance;
 use PHPStan\Type\Generic\TemplateTypeVarianceMap;
 use PHPStan\Type\Type;
+use function is_bool;
 
 class ResolvedMethodReflection implements ExtendedMethodReflection
 {
@@ -163,4 +164,14 @@ public function returnsByReference(): TrinaryLogic
 		return $this->reflection->returnsByReference();
 	}
 
+	public function isAbstract(): TrinaryLogic
+	{
+		$abstract = $this->reflection->isAbstract();
+		if (is_bool($abstract)) {
+			return TrinaryLogic::createFromBoolean($abstract);
+		}
+
+		return $abstract;
+	}
+
 }
diff --git a/src/Reflection/Type/IntersectionTypeMethodReflection.php b/src/Reflection/Type/IntersectionTypeMethodReflection.php
@@ -16,6 +16,7 @@
 use function array_map;
 use function count;
 use function implode;
+use function is_bool;
 
 class IntersectionTypeMethodReflection implements ExtendedMethodReflection
 {
@@ -186,4 +187,9 @@ public function returnsByReference(): TrinaryLogic
 		return TrinaryLogic::lazyMaxMin($this->methods, static fn (ExtendedMethodReflection $method): TrinaryLogic => $method->returnsByReference());
 	}
 
+	public function isAbstract(): TrinaryLogic
+	{
+		return TrinaryLogic::lazyMaxMin($this->methods, static fn (ExtendedMethodReflection $method): TrinaryLogic => is_bool($method->isAbstract()) ? TrinaryLogic::createFromBoolean($method->isAbstract()) : $method->isAbstract());
+	}
+
 }
diff --git a/src/Reflection/Type/UnionTypeMethodReflection.php b/src/Reflection/Type/UnionTypeMethodReflection.php
@@ -168,4 +168,9 @@ public function returnsByReference(): TrinaryLogic
 		return TrinaryLogic::lazyExtremeIdentity($this->methods, static fn (ExtendedMethodReflection $method): TrinaryLogic => $method->returnsByReference());
 	}
 
+	public function isAbstract(): TrinaryLogic
+	{
+		return TrinaryLogic::lazyExtremeIdentity($this->methods, static fn (ExtendedMethodReflection $method): TrinaryLogic => is_bool($method->isAbstract()) ? TrinaryLogic::createFromBoolean($method->isAbstract()) : $method->isAbstract());
+	}
+
 }
diff --git a/src/Reflection/WrappedExtendedMethodReflection.php b/src/Reflection/WrappedExtendedMethodReflection.php
@@ -135,4 +135,9 @@ public function returnsByReference(): TrinaryLogic
 		return TrinaryLogic::createMaybe();
 	}
 
+	public function isAbstract(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 }
diff --git a/src/Rules/Methods/OverridingMethodRule.php b/src/Rules/Methods/OverridingMethodRule.php
@@ -20,6 +20,7 @@
 use PHPStan\Type\VerbosityLevel;
 use function array_merge;
 use function count;
+use function is_bool;
 use function sprintf;
 use function strtolower;
 
@@ -274,6 +275,24 @@ private function findPrototype(ClassReflection $classReflection, string $methodN
 			}
 		}
 
+		if ($this->phpVersion->supportsAbstractTraitMethods()) {
+			foreach ($classReflection->getTraits(true) as $trait) {
+				if (!$trait->hasNativeMethod($methodName)) {
+					continue;
+				}
+
+				$method = $trait->getNativeMethod($methodName);
+				$isAbstract = $method->isAbstract();
+				if (is_bool($isAbstract)) {
+					if ($isAbstract) {
+						return $method;
+					}
+				} elseif ($isAbstract->yes()) {
+					return $method;
+				}
+			}
+		}
+
 		$parentClass = $classReflection->getParentClass();
 		if ($parentClass === null) {
 			return null;
@@ -293,7 +312,12 @@ private function findPrototype(ClassReflection $classReflection, string $methodN
 			if ($method->getName() === $declaringClass->getConstructor()->getName()) {
 				$prototype = $method->getPrototype();
 				if ($prototype instanceof PhpMethodReflection || $prototype instanceof MethodPrototypeReflection || $prototype instanceof NativeMethodReflection) {
-					if (!$prototype->isAbstract()) {
+					$abstract = $prototype->isAbstract();
+					if (is_bool($abstract)) {
+						if (!$abstract) {
+							return null;
+						}
+					} elseif (!$abstract->yes()) {
 						return null;
 					}
 				}

diff --git a/src/Rules/Methods/StaticMethodCallCheck.php b/src/Rules/Methods/StaticMethodCallCheck.php
@@ -140,6 +140,9 @@ public function check(
 				$nativeMethodReflection = $classReflection->getNativeMethod($methodName);
 				if ($nativeMethodReflection instanceof PhpMethodReflection || $nativeMethodReflection instanceof NativeMethodReflection) {
 					$isAbstract = $nativeMethodReflection->isAbstract();
+					if ($isAbstract instanceof TrinaryLogic) {
+						$isAbstract = $isAbstract->yes();
+					}
 				}
 			}
 		} else {

diff --git a/tests/PHPStan/Rules/Methods/OverridingMethodRuleTest.php b/tests/PHPStan/Rules/Methods/OverridingMethodRuleTest.php
@@ -709,4 +709,19 @@ public function testBug9615(): void
 		]);
 	}
 
+	public function testTraits(): void
+	{
+		$errors = [];
+		if (PHP_VERSION_ID >= 80000) {
+			$errors = [
+				[
+					'Parameter #1 $i (int) of method OverridingTraitMethods\Bar::doBar() is not contravariant with parameter #1 $i (string) of method OverridingTraitMethods\Foo::doBar().',
+					27,
+				],
+			];
+		}
+		$this->phpVersionId = PHP_VERSION_ID;
+		$this->analyse([__DIR__ . '/data/overriding-trait-methods.php'], $errors);
+	}
+
 }
diff --git a/tests/PHPStan/Rules/Methods/data/overriding-trait-methods.php b/tests/PHPStan/Rules/Methods/data/overriding-trait-methods.php
@@ -0,0 +1,32 @@
+<?php // lint >= 8.0
+
+namespace OverridingTraitMethods;
+
+trait Foo
+{
+
+	public function doFoo(string $i): int
+	{
+
+	}
+
+	abstract public function doBar(string $i): int;
+
+}
+
+class Bar
+{
+
+	use Foo;
+
+	public function doFoo(int $i): string
+	{
+		// ok, trait method not abstract
+	}
+
+	public function doBar(int $i): int
+	{
+		// error
+	}
+
+}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -35,4 +35,6 @@ public function returnsByReference(): TrinaryLogic;

		public function isFinalByKeyword(): TrinaryLogic;

		public function isAbstract(): TrinaryLogic\|bool;

		}