Add signature for callable types (#1463)

* Add more precise types for the Stream classes

* Generate more precise type for streaming shape members

* Enforce defining callable signatures

Author: stof

phpstan.neon.dist

@@ -1,6 +1,7 @@
 parameters:
     level: 5
     treatPhpDocTypesAsCertain: false
+    checkMissingCallableSignature: true
     reportUnmatchedIgnoredErrors: false
     paths:
         - src

src/CodeGenerator/src/Generator/CodeGenerator/TypeGenerator.php

@@ -89,7 +89,7 @@ public function generateDocblock(StructureShape $shape, ClassName $shapeClassNam
                     $param = 'array<string, ' . $param . '>';
                 }
             } elseif ($member->isStreaming()) {
-                $param = 'string|resource|callable|iterable';
+                $param = 'string|resource|(callable(int): string)|iterable<string>';
             } elseif ('timestamp' === $param = $memberShape->getType()) {
                 $param = $isObject ? '\DateTimeImmutable' : '\DateTimeImmutable|string';
             } else {

src/CodeGenerator/src/Generator/InputGenerator.php

@@ -210,7 +210,7 @@ public function generate(Operation $operation): ClassName
                     $constructorBody .= strtr('$this->PROPERTY = $input["NAME"] ?? null;' . "\n", ['PROPERTY' => GeneratorHelper::normalizeName($member->getName()), 'NAME' => $member->getName()]);
                 }
             } elseif ($member->isStreaming()) {
-                $parameterType = 'string|resource|callable|iterable';
+                $parameterType = 'string|resource|(callable(int): string)|iterable<string>';
                 $returnType = null;
                 $constructorBody .= strtr('$this->PROPERTY = $input["NAME"] ?? null;' . "\n", ['PROPERTY' => GeneratorHelper::normalizeName($member->getName()), 'NAME' => $member->getName()]);
             } elseif ('timestamp' === $memberShape->getType()) {

src/Core/src/Stream/CallableStream.php

@@ -14,16 +14,28 @@
  */
 final class CallableStream implements ReadOnceResultStream, RequestStream
 {
+    /**
+     * @var callable(int): string
+     */
     private $content;
 
+    /**
+     * @var int
+     */
     private $chunkSize;
 
+    /**
+     * @param callable(int): string $content
+     */
     private function __construct(callable $content, int $chunkSize = 64 * 1024)
     {
         $this->content = $content;
         $this->chunkSize = $chunkSize;
     }
 
+    /**
+     * @param self|callable(int): string $content
+     */
     public static function create($content, int $chunkSize = 64 * 1024): CallableStream
     {
         if ($content instanceof self) {

src/Core/src/Stream/IterableStream.php

@@ -13,13 +13,22 @@
  */
 final class IterableStream implements ReadOnceResultStream, RequestStream
 {
+    /**
+     * @var iterable<string>
+     */
     private $content;
 
+    /**
+     * @param iterable<string> $content
+     */
     private function __construct(iterable $content)
     {
         $this->content = $content;
     }
 
+    /**
+     * @param self|iterable<string> $content
+     */
     public static function create($content): IterableStream
     {
         if ($content instanceof self) {

src/Core/src/Stream/RequestStream.php

@@ -8,6 +8,8 @@
  * @author Jérémy Derussé <[email protected]>
  *
  * @internal
+ *
+ * @extends \IteratorAggregate<string>
  */
 interface RequestStream extends \IteratorAggregate
 {

src/Core/src/Stream/ResourceStream.php

@@ -20,12 +20,18 @@ final class ResourceStream implements RequestStream
 
     private $chunkSize;
 
+    /**
+     * @param resource $content
+     */
     private function __construct($content, int $chunkSize = 64 * 1024)
     {
         $this->content = $content;
         $this->chunkSize = $chunkSize;
     }
 
+    /**
+     * @param self|resource $content
+     */
     public static function create($content, int $chunkSize = 64 * 1024): ResourceStream
     {
         if ($content instanceof self) {

src/Core/src/Stream/RewindableStream.php

@@ -17,10 +17,13 @@
  */
 final class RewindableStream implements RequestStream
 {
+    /**
+     * @var RequestStream
+     */
     private $content;
 
     /**
-     * @var RequestStream
+     * @var RequestStream|null
      */
     private $fallback;
 

src/Core/src/Stream/StreamFactory.php

@@ -11,6 +11,9 @@
  */
 class StreamFactory
 {
+    /**
+     * @param string|resource|(callable(int): string)|iterable<string>|null $content
+     */
     public static function create($content, int $preferredChunkSize = 64 * 1024): RequestStream
     {
         if (null === $content || \is_string($content)) {

src/Core/src/Stream/StringStream.php

@@ -22,6 +22,9 @@ private function __construct(string $content)
         $this->content = $content;
     }
 
+    /**
+     * @param RequestStream|string $content
+     */
     public static function create($content): StringStream
     {
         if ($content instanceof self) {