willwashburn/stream

model a sequence of data elements made available over time

Stream :rowboat:

model a sequence of data elements made available over time, _(*1)

Usage

Write and read (or peek) from a string of characters., _(*2)

$stream = new \WillWashburn\Stream\Stream();
$stream->write('foo');

$stream->read(3); //foo

$stream->write('bar');
$stream->write('bang');

$stream->read(4); // barb
$stream->peek(3); // ang
$stream->read(3); // ang

I mostly use this when buffering responses from curl requests., _(*3)

```PHP, <sub>(*4)</sub>

$stream = new WillWashburn\Stream\Stream;, <sub>(*5)</sub>

curl_setopt($ch, CURLOPT_WRITEFUNCTION, function ($ch, $str) use (& $stream, $url) {, <sub>(*6)</sub>

$stream->write($str);

try {
    // do something with the stream
    $characters = $stream->read(100);

    // tell curl to stop the transfer when we find what we're looking for
    if(strpos($characters,'string im looking for') !==false) {
        return -1;
    }
}
catch (StreamBufferTooSmallException $e) {
    // The buffer ended, so keep getting more
    return strlen($str);
}

//  We return -1 to abort the transfer when we have enough buffered
return -1;

});, <sub>(*7)</sub>

```, <sub>(*8)</sub>

Installation

Use composer, <sub>(*9)</sub>

composer require willwashburn/stream, <sub>(*10)</sub>

Alternatively, add "willwashburn/stream": "~1.0.0" to your composer.json, <sub>(*11)</sub>

Change Log

• v1.0.0 - Basic stream model