wyrihaximus/react-stream-base64

Base64 stream encoders/decoders for ReactPHP

1.1.0 2019-01-01 17:38 UTC

Requires

• php: ^7.2
• react/stream: ^1.1.0

Requires (Dev)

• api-clients/cs-fixer-config: ^1.1
• api-clients/test-utilities: ^5.4
• react/promise-stream: ^1.0 || ^0.1.1

MIT

• Cees-Jan Kiewiet

README

Installation

To install via Composer, use the command below, it will automatically detect the latest version and bind it with ^.

composer require wyrihaximus/react-stream-base64 

Usage

All streams in this package are decorators about the stream you want to encode or decode.

Readable stream decode:

$streamToDecode = new ThroughStream();
$stream = new ReadableStreamBase64Decode($streamToDecode);
$stream->on('data', function ($data) {
    echo $data; // foo.bar
});
$streamToDecode->write('Zm9vLmJhcg==');

Readable stream encode:

$streamToEncode = new ThroughStream();
$stream = new ReadableStreamBase64Encode($streamToEncode);
$stream->on('data', function ($data) {
    echo $data; // Zm9vLmJhcg==
});
$streamToEncode->write('foo.bar');

Writable stream decode:

$streamToDecode = new ThroughStream();
$stream = new WritableStreamBase64Decode($streamToDecode);
$stream->write('Zm9vLmJhcg=='); // Writes foo.bar to $streamToDecode

Writable stream encode:

$streamToEncode = new ThroughStream();
$stream = new WritableStreamBase64Encode($streamToEncode);
$stream->write('foo.bar'); // Writes Zm9vLmJhcg== to $streamToEncode

Contributing

Please see CONTRIBUTING for details.

License

Copyright 2017 Cees-Jan Kiewiet

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.