codementality/stream-util

Helper utilities for dealing with streams. Forked and updated version of twistor/stream-util.

v2.0.0 2025-01-15 02:52 UTC

Requires

• php: >=8.2.0

Requires (Dev)

• phpunit/phpunit: ^11.5.3

Replaces

• twistor/stream-util: 1.0.1

MIT

• Chris Leppanen
• Lisa Ridley

README

This is a forked and updated version of the original package, twistor/stream-util.

Helper functions for dealing with streams.

Installation

composer require codementality/stream-util

Usage

use Codementality\StreamUtil;

$stream = fopen('php://temp', 'w+b');

fwrite($stream, 'asdfasfdas');

$cloned = StreamUtil::copy($stream, false); // Passing in true (the default),
                                            // will close the input stream.

StreamUtil::getSize($stream); // 10

StreamUtil::isAppendable($stream); // false

StreamUtil::isReadable($stream); // true

StreamUtil::isSeekable($stream); // true

StreamUtil::isWritable($stream); // true

StreamUtil::tryRewind($stream);  // true

StreamUtil::trySeek($stream, 0, SEEK_END); // true

// Metadata helpers.
StreamUtil::getMetaDataKey($stream, 'blocked') // false

StreamUtil::getUri($stream); // php://temp

StreamUtil::getUsuableUri($stream); // Returns a URI that can be used
                                    // with fopen().
                                    // false in this case.

// Mode helpers.
StreamUtil::modeIsAppendable('w+'); // false

StreamUtil::modeIsAppendOnly('a+'); // false

StreamUtil::modeIsReadable('w+');   // true

StreamUtil::modeIsReadOnly('r');    // true

StreamUtil::modeIsWritable('r+');   // true

StreamUtil::modeIsWriteOnly('w');   // true