Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kusabi/stream
A PSR-7 and PSR-17 conforming stream wrapper library for PHP
https://github.com/kusabi/stream
php psr psr-17 psr-7 stream wrapper
Last synced: 4 days ago
JSON representation
A PSR-7 and PSR-17 conforming stream wrapper library for PHP
- Host: GitHub
- URL: https://github.com/kusabi/stream
- Owner: kusabi
- License: mit
- Created: 2019-07-12T06:37:03.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2020-10-31T13:18:34.000Z (about 4 years ago)
- Last Synced: 2024-11-17T15:29:34.209Z (2 months ago)
- Topics: php, psr, psr-17, psr-7, stream, wrapper
- Language: PHP
- Homepage:
- Size: 23.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Contributing: .github/contributing.md
- Code of conduct: .github/code_of_conduct.md
Awesome Lists containing this project
README
# Stream wrapper
[](https://codecov.io/gh/kusabi/stream)
[](https://img.shields.io/github/license/kusabi/stream.svg)
[](https://img.shields.io/github/release/kusabi/stream.svg)
[](https://img.shields.io/github/tag/kusabi/stream.svg)
[](https://img.shields.io/github/issues/kusabi/stream.svg)
[](https://img.shields.io/github/languages/code-size/kusabi/stream.svg)
An implementation of a [PSR-7](https://www.php-fig.org/psr/psr-7/) & [PSR-17](https://www.php-fig.org/psr/psr-17/) conforming Stream library
## Installation
Installation is simple using composer.
```bash
composer require kusabi/stream
```
Or simply add it to your `composer.json` file
```json
{
"require": {
"kusabi/stream": "^1.0"
}
}
```
## Using streams
The Stream class is a very basic wrapper around a stream resource.
```php
use Kusabi\Stream\Stream;
// Instantiate a Uri instance
$stream = new Stream(fopen('php://stdin', 'r'));
// Fetch the properties of the Stream
$stream->getContents(); // Get everything from the current pointer to the end of the stream
$stream->getSize(); // Get the size of the stream in bytes
$stream->isSeekable();
$stream->isReadable();
$stream->isWritable();
$stream->seek($offset, $whence = SEEK_SET); // Move the pointer around in the stream
$stream->tell(); // Where is the pointer in the stream
$stream->rewind(); // Set the pointer to the beginning of the stream
$stream->read($length); // Read the next $length character from the stream
$stream->write($string); // Write data into the stream. Returns the number of bytes written
$stream->getMetadata($key = null); // Get all the metadata, or a particular key
$stream->getStat($key = null); // Get all the fstat entries, or a particular key
$stream->isLocal(); // Determine if the stream url is local using `stream_is_local()`
$stream->getLine($length = null, $ending = "\n"); // Fetch a line up to a length or delimiter (which ever comes first)
$stream->pipe(Stream $stream); // Copy the contents of one stream into another
(string) $stream; // Rewind and get all the contents from the stream
```
## Using the stream factory
The Stream factory can be used to create the Stream instance too.
```php
use Kusabi\Stream\StreamFactory;
// Instantiate a Uri instance
$factory = new StreamFactory();
$stream = $factory->createStream('temp resource with data in it');
$stream = $factory->createStreamFromFile('file.txt');
$stream = $factory->createStreamFromResource(fopen('php://stdin', 'r'));
```