[HttpFoundation] Add StreamedResponse::createFromTempFile()

alexandre-daubois · alexandre-daubois · commit b1a7fbf5e333 · 2023-10-11T10:23:50.000+02:00
diff --git a/src/Symfony/Component/HttpFoundation/CHANGELOG.md b/src/Symfony/Component/HttpFoundation/CHANGELOG.md
@@ -7,6 +7,7 @@ CHANGELOG
  * Make `HeaderBag::getDate()`, `Response::getDate()`, `getExpires()` and `getLastModified()` return a `DateTimeImmutable`
  * Support root-level `Generator` in `StreamedJsonResponse`
  * Add `UriSigner` from the HttpKernel component
+ * Add `StreamedResponse::createFromTempFile()`
 
 6.3
 ---
diff --git a/src/Symfony/Component/HttpFoundation/StreamedResponse.php b/src/Symfony/Component/HttpFoundation/StreamedResponse.php
@@ -29,6 +29,7 @@ class StreamedResponse extends Response
     protected $callback;
     protected $streamed;
     private bool $headersSent;
+    private static int $chunkSize = 8 * 1024;
 
     /**
      * @param int $status The HTTP status code (200 "OK" by default)
@@ -124,4 +125,29 @@ public function getContent(): string|false
     {
         return false;
     }
+
+    public static function createFromTempFile(\SplTempFileObject $file, int $status = 200, array $headers = [], int $chunkSize = null): static
+    {
+        if (null !== $chunkSize && 1 > $chunkSize) {
+            throw new \InvalidArgumentException(sprintf('Chunk size of streamed response from a temporary file must be at least 1, got %d.', $chunkSize));
+        }
+
+        return new self(static function () use ($file, $chunkSize) {
+            $out = fopen('php://output', 'w');
+
+            ignore_user_abort(true);
+
+            $file->rewind();
+            while (!$file->eof()) {
+                fwrite($out, $file->fread($chunkSize ?? static::$chunkSize));
+                flush();
+
+                if (connection_aborted()) {
+                    break;
+                }
+            }
+
+            fclose($out);
+        }, $status, $headers);
+    }
 }
diff --git a/src/Symfony/Component/HttpFoundation/Tests/StreamedResponseTest.php b/src/Symfony/Component/HttpFoundation/Tests/StreamedResponseTest.php
@@ -135,4 +135,29 @@ public function testSendInformationalResponse()
 
         $response->sendHeaders();
     }
+
+    public function testCreateFromTemporaryFileInvalidChunkSize()
+    {
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage('Chunk size of streamed response from a temporary file must be at least 1, got -10.');
+        StreamedResponse::createFromTempFile(new \SplTempFileObject(), chunkSize: -10);
+    }
+
+    public function testCreateFromTemporaryFile()
+    {
+        $file = new \SplTempFileObject();
+        $file->fwrite('foo,bar');
+
+        $response = StreamedResponse::createFromTempFile($file, 201, [
+            'Content-Type' => 'text/csv',
+        ]);
+
+        $this->assertSame(201, $response->getStatusCode());
+        $this->assertSame('text/csv', $response->headers->get('Content-Type'));
+
+        ob_start();
+        $response->sendContent();
+        $string = ob_get_clean();
+        $this->assertSame('foo,bar', $string);
+    }
 }
