Streams Laravel Package

Getting Started

This package provides PSR-7-compliant stream wrapper implementations for PHP—specifically, it supplies lightweight, reusable stream classes (Stream, BufferedStream, TemporaryStream, etc.) that implement Psr\Http\Message\StreamInterface. Since it's a subtree split of the Spiral Framework’s Streams component and is now archived/readonly, it's primarily useful in legacy Spiral applications or projects requiring minimal PSR-7 stream dependencies.

To begin:

1. Require via Composer: composer require spiral/streams
2. Implement PSR-7 StreamInterface usage wherever streams are needed (e.g., HTTP clients, middleware, file processing)
3. Start with Spiral\Streams\Stream::create($resourceOrString) to instantiate streams from strings or resources

The most common first use case is as a dependency for PSR-17/PSR-15/PSR-7 tooling—e.g., creating response bodies or request payloads in middleware.

Implementation Patterns

• Consistent Stream Construction: Use Stream::create() instead of manually instantiating—this handles resource detection and proper initialization.
• Memory Optimization: Use BufferedStream for streams that require repeated reads without seeking or copying.
• Temporary Workflows: For file upload staging, temp-streaming, or in-memory transformation pipelines, TemporaryStream provides safe temp file handling.
• Integration with frameworks: Though Spiral is the original consumer, these streams integrate cleanly with any PSR-15 middleware stack (e.g., Slim, Laminas Stratigility, Symfony HTTP kernel) or HTTP client (e.g., Guzzle’s stream factory can consume them).

Typical workflow:

$stream = Spiral\Streams\Stream::create(fopen('php://temp', 'r+'));
$stream->write(json_encode($payload));
$response = new Response($stream, 200, ['Content-Type' => 'application/json']);

Gotchas and Tips

• ⚠️ Last release in 2019: This package is effectively unmaintained. Consider substituting symfony/http-foundation’s StreamedResponse, nyholm/psr7, or guzzlehttp/psr7 for new projects—these have broader ecosystem support and active maintenance.
• ⚠️ Subtree split artifact: As a read-only split, this does not include the full Spiral Framework’s internal utilities (e.g., no StreamDecoratorTrait or advanced adapters). Only core stream classes are present.
• 🔧 Resource handling: Be cautious with fopen()-returned resources—ensure they’re binary-safe ('rb' or 'r+b') to avoid line-ending translation issues on Windows.
• 🔍 Debugging: Use $stream->detach() to retrieve the underlying resource for logging or third-party tools (e.g., stream_get_contents()).
• 🛠️ Extensibility: Since it’s PSR-7-only, extend by composing the Stream class—e.g., wrap it in a decorator to add encryption or compression. Avoid subclassing unless needed; composition is safer and more testable.
• 📦 Composer conflicts: Due to its age and split nature, may conflict with modern PSR-7 implementations. Pin version explicitly if used in legacy contexts: "spiral/streams": "^1.0"