Generate tentative types when appropriate

Author: nicolas-grekas

src/ProxyManager/Generator/MethodGenerator.php

@@ -7,12 +7,16 @@
 use Laminas\Code\Generator\DocBlockGenerator;
 use Laminas\Code\Generator\MethodGenerator as LaminasMethodGenerator;
 use Laminas\Code\Reflection\MethodReflection;
+use ReflectionException;
+use ReflectionMethod;
 
 /**
  * Method generator that fixes minor quirks in ZF2's method generator
  */
 class MethodGenerator extends LaminasMethodGenerator
 {
+    protected $hasTentativeReturnType = false;
+
     /**
      * @return static
      */
@@ -24,15 +28,72 @@ public static function fromReflectionWithoutBodyAndDocBlock(MethodReflection $re
         $method->setInterface(false);
         $method->setBody('');
 
+        if (\PHP_VERSION_ID < 80100) {
+            return $method;
+        }
+
+        /** @var callable(ReflectionMethod) : ReflectionMethod $getPrototype */
+        $getPrototype = \Closure::fromCallable([new ReflectionMethod(ReflectionMethod::class, 'getPrototype'), 'invoke']);
+
+        while (true) {
+            if ($reflectionMethod->hasTentativeReturnType()) {
+                $method->hasTentativeReturnType = true;
+                break;
+            }
+
+            if ($reflectionMethod->isAbstract()) {
+                break;
+            }
+
+            try {
+                $reflectionMethod = $getPrototype($reflectionMethod);
+            } catch (ReflectionException $e) {
+                break;
+            }
+        }
+
         return $method;
     }
 
-    /**
-     * {@inheritDoc} override needed to specify type in more detail
-     */
     public function getDocBlock(): ?DocBlockGenerator
     {
-        return parent::getDocBlock();
+        $docBlock = parent::getDocBlock();
+
+        if (! $this->hasTentativeReturnType) {
+            return $docBlock;
+        }
+
+        if ($docBlock === null) {
+            return new class ($this->getIndentation()) extends DocBlockGenerator {
+                public function __construct(string $indentation)
+                {
+                    $this->setIndentation($indentation);
+                }
+
+                public function generate(): string
+                {
+                    return $this->getIndentation() . '#[\ReturnTypeWillChange]' . self::LINE_FEED;
+                }
+            };
+        }
+
+        return new class ($docBlock) extends DocBlockGenerator {
+            public function __construct(DocBlockGenerator $docBlock)
+            {
+                $this->setShortDescription($docBlock->getShortDescription());
+                $this->setLongDescription($docBlock->getLongDescription());
+                $this->setTags($docBlock->getTags());
+                $this->setWordWrap($docBlock->getWordWrap());
+                $this->setSourceDirty($docBlock->isSourceDirty());
+                $this->setIndentation($docBlock->getIndentation());
+                $this->setSourceContent($docBlock->getSourceContent());
+            }
+
+            public function generate(): string
+            {
+                return parent::generate() . $this->getIndentation() . '#[\ReturnTypeWillChange]' . self::LINE_FEED;
+            }
+        };
     }
 
     /**

tests/language-feature-scripts/lazy-loading-value-holder-internal-php-classes.phpt

@@ -24,9 +24,11 @@ class PharMock extends Phar
     {
     }
 
-    public function compress($compression_type, $file_ext = null)
+    public function compress($compression_type, $file_ext = null): ?Phar
     {
         echo $compression_type;
+
+        return null;
     }
 }