Stubs - no need to repeat inherited methods

src/PhpDoc/StubPhpDocProvider.php

@@ -171,7 +171,7 @@ public function findFunctionPhpDoc(string $functionName): ?ResolvedPhpDocBlock
 		return null;
 	}
 
-	private function isKnownClass(string $className): bool
+	public function isKnownClass(string $className): bool
 	{
 		$this->initializeKnownElements();
 

src/Reflection/ClassReflection.php

@@ -817,7 +817,7 @@ private function getTemplateTags(): array
 	/**
 	 * @return array<string,ClassReflection>
 	 */
-	private function getAncestors(): array
+	public function getAncestors(): array
 	{
 		$ancestors = $this->ancestors;
 

src/Reflection/Php/PhpClassReflectionExtension.php

@@ -429,7 +429,7 @@ private function createMethod(
 				$stubPhpDocParameterTypes = [];
 				$stubPhpDocParameterVariadicity = [];
 				if (count($variantNames) === 1) {
-					$stubPhpDoc = $this->stubPhpDocProvider->findMethodPhpDoc($declaringClassName, $methodReflection->getName());
+					$stubPhpDoc = $this->findMethodPhpDocIncludingAncestors($declaringClassName, $methodReflection->getName());
 					if ($stubPhpDoc !== null) {
 						$stubPhpDocString = $stubPhpDoc->getPhpDocString();
 						$templateTypeMap = $declaringClass->getActiveTemplateTypeMap();
@@ -486,7 +486,7 @@ private function createMethod(
 		}
 
 		$declaringTraitName = $this->findMethodTrait($methodReflection);
-		$resolvedPhpDoc = $this->stubPhpDocProvider->findMethodPhpDoc($declaringClassName, $methodReflection->getName());
+		$resolvedPhpDoc = $this->findMethodPhpDocIncludingAncestors($declaringClassName, $methodReflection->getName());
 		$stubPhpDocString = null;
 		if ($resolvedPhpDoc === null) {
 			if ($declaringClass->getFileName() !== false) {
@@ -866,4 +866,37 @@ private function getPhpDocReturnType(ClassReflection $phpDocBlockClassReflection
 		return null;
 	}
 
+	private function findMethodPhpDocIncludingAncestors(string $declaringClassName, string $methodName): ?ResolvedPhpDocBlock
+	{
+		$resolved = $this->stubPhpDocProvider->findMethodPhpDoc($declaringClassName, $methodName);
+		if ($resolved !== null) {
+			return $resolved;
+		}
+		if (!$this->stubPhpDocProvider->isKnownClass($declaringClassName)) {
+			return null;
+		}
+		if (!$this->reflectionProvider->hasClass($declaringClassName)) {
+			return null;
+		}
+
+		$ancestors = $this->reflectionProvider->getClass($declaringClassName)->getAncestors();
+		foreach ($ancestors as $ancestor) {
+			if ($ancestor->getName() === $declaringClassName) {
+				continue;
+			}
+			if (!$ancestor->hasNativeMethod($methodName)) {
+				continue;
+			}
+
+			$resolved = $this->stubPhpDocProvider->findMethodPhpDoc($ancestor->getName(), $methodName);
+			if ($resolved === null) {
+				continue;
+			}
+
+			return $resolved;
+		}
+
+		return null;
+	}
+
 }

stubs/ArrayObject.php

@@ -50,31 +50,6 @@ class ArrayObject implements IteratorAggregate, ArrayAccess
 	 */
 	public function __construct($input = null, $flags = 0, $iterator_class = "ArrayIterator") { }
 
-	/**
-	 * @param TKey $index
-	 * @return bool
-	 */
-	public function offsetExists($index) { }
-
-	/**
-	 * @param TKey $index
-	 * @return TValue
-	 */
-	public function offsetGet($index) { }
-
-	/**
-	 * @param TKey $index
-	 * @param TValue $newval
-	 * @return void
-	 */
-	public function offsetSet($index, $newval) { }
-
-	/**
-	 * @param TKey $index
-	 * @return void
-	 */
-	public function offsetUnset($index) { }
-
 	/**
 	 * @param TValue $value
 	 * @return void

stubs/iterable.php

@@ -56,16 +56,6 @@ public function key();
 class Generator implements Iterator
 {
 
-	/**
-	 * @return TValue
-	 */
-	public function current() {}
-
-	/**
-	 * @return TKey
-	 */
-	public function key() {}
-
 	/**
 	 * @return TReturn
 	 */
@@ -95,16 +85,6 @@ class SimpleXMLElement implements Traversable
 interface SeekableIterator extends Iterator
 {
 
-	/**
-	 * @return TValue
-	 */
-	public function current();
-
-	/**
-	 * @return TKey
-	 */
-	public function key();
-
 }
 
 /**
@@ -122,31 +102,6 @@ class ArrayIterator implements SeekableIterator, ArrayAccess, Countable, Seriali
 	 */
 	public function __construct($array = array(), $flags = 0) { }
 
-	/**
-	 * @param TKey $index
-	 * @return bool
-	 */
-	public function offsetExists($index) { }
-
-	/**
-	 * @param TKey $index
-	 * @return TValue
-	 */
-	public function offsetGet($index) { }
-
-	/**
-	 * @param TKey $index
-	 * @param TValue $newval
-	 * @return void
-	 */
-	public function offsetSet($index, $newval) { }
-
-	/**
-	 * @param TKey $index
-	 * @return void
-	 */
-	public function offsetUnset($index) { }
-
 	/**
 	 * @param TValue $value
 	 * @return void
@@ -170,16 +125,6 @@ public function uasort($cmp_function) { }
 	 */
 	public function uksort($cmp_function) { }
 
-	/**
-	 * @return TValue
-	 */
-	public function current();
-
-	/**
-	 * @return TKey
-	 */
-	public function key();
-
 }
 
 class DOMDocument

tests/PHPStan/Levels/data/stubs-methods-3.json

@@ -0,0 +1,22 @@
+[
+    {
+        "message": "Return type (string) of method StubsIntegrationTest\\AnotherInterfaceExtendingInterfaceWithStubPhpDoc::doFoo() should be compatible with return type (int) of method StubsIntegrationTest\\InterfaceWithStubPhpDoc::doFoo()",
+        "line": 68,
+        "ignorable": true
+    },
+    {
+        "message": "Anonymous function should return int but returns string.",
+        "line": 74,
+        "ignorable": true
+    },
+    {
+        "message": "Return type (string) of method StubsIntegrationTest\\YetAnotherClassExtendingInterfaceWithStubPhpDoc::doFoo() should be compatible with return type (int) of method StubsIntegrationTest\\InterfaceWithStubPhpDoc::doFoo()",
+        "line": 119,
+        "ignorable": true
+    },
+    {
+        "message": "Anonymous function should return int but returns string.",
+        "line": 128,
+        "ignorable": true
+    }
+]

tests/PHPStan/Levels/data/stubs-methods-4.json

@@ -0,0 +1,22 @@
+[
+    {
+        "message": "Strict comparison using === between int and array() will always evaluate to false.",
+        "line": 47,
+        "ignorable": true
+    },
+    {
+        "message": "Strict comparison using === between int and array() will always evaluate to false.",
+        "line": 58,
+        "ignorable": true
+    },
+    {
+        "message": "Strict comparison using === between int and array() will always evaluate to false.",
+        "line": 89,
+        "ignorable": true
+    },
+    {
+        "message": "Strict comparison using === between int and array() will always evaluate to false.",
+        "line": 108,
+        "ignorable": true
+    }
+]

tests/PHPStan/Levels/data/stubs-methods.php

@@ -31,3 +31,99 @@ function (FooChild $fooChild) {
 	$string = $fooChild->doFoo('test');
 	$fooChild->doFoo($string);
 };
+
+interface InterfaceWithStubPhpDoc
+{
+
+	/**
+	 * @return string
+	 */
+	public function doFoo();
+
+}
+
+function (InterfaceWithStubPhpDoc $stub): int
+{
+	$stub->doFoo() === [];
+	return $stub->doFoo(); // stub wins
+};
+
+interface InterfaceExtendingInterfaceWithStubPhpDoc extends InterfaceWithStubPhpDoc
+{
+
+}
+
+function (InterfaceExtendingInterfaceWithStubPhpDoc $stub): int
+{
+	$stub->doFoo() === [];
+	return $stub->doFoo(); // stub wins
+};
+
+interface AnotherInterfaceExtendingInterfaceWithStubPhpDoc extends InterfaceWithStubPhpDoc
+{
+
+	/**
+	 * @return string
+	 */
+	public function doFoo();
+
+}
+
+function (AnotherInterfaceExtendingInterfaceWithStubPhpDoc $stub): int
+{
+	return $stub->doFoo(); // implementation wins - string -> int mismatch reported
+};
+
+class ClassExtendingInterfaceWithStubPhpDoc implements InterfaceWithStubPhpDoc
+{
+
+	public function doFoo()
+	{
+		throw new \Exception();
+	}
+
+}
+
+function (ClassExtendingInterfaceWithStubPhpDoc $stub): int
+{
+	$stub->doFoo() === [];
+	return $stub->doFoo(); // stub wins
+};
+
+class AnotherClassExtendingInterfaceWithStubPhpDoc implements InterfaceWithStubPhpDoc
+{
+
+	/**
+	 * @return string
+	 */
+	public function doFoo()
+	{
+		throw new \Exception();
+	}
+
+}
+
+function (AnotherClassExtendingInterfaceWithStubPhpDoc $stub): int
+{
+	$stub->doFoo() === [];
+	return $stub->doFoo(); // stub wins
+};
+
+/** This one is missing in the stubs */
+class YetAnotherClassExtendingInterfaceWithStubPhpDoc implements InterfaceWithStubPhpDoc
+{
+
+	/**
+	 * @return string
+	 */
+	public function doFoo()
+	{
+		throw new \Exception();
+	}
+
+}
+
+function (YetAnotherClassExtendingInterfaceWithStubPhpDoc $stub): int
+{
+	return $stub->doFoo(); // implementation wins - string -> int mismatch reported
+};

tests/notAutoloaded/stubs-methods.php

@@ -32,3 +32,23 @@ public function doFoo(Collection $collection): void
 	}
 
 }
+
+interface InterfaceWithStubPhpDoc
+{
+
+	/**
+	 * @return int
+	 */
+	public function doFoo();
+
+}
+
+class ClassExtendingInterfaceWithStubPhpDoc implements InterfaceWithStubPhpDoc
+{
+
+}
+
+class AnotherClassExtendingInterfaceWithStubPhpDoc implements InterfaceWithStubPhpDoc
+{
+
+}