aedart/athenaeum-streams

Stream utilities

8.17.0 2024-11-28 08:52 UTC

Requires

• php: ^8.2
• aedart/athenaeum-contracts: ^8.17
• aedart/athenaeum-mime-types: ^8.17
• aedart/athenaeum-support: ^8.17
• psr/http-message: ^1.1

BSD-3-Clause

• Alin Eugen Deac

• stream
• utilities
• resource
• Athenaeum

README

The "streams" package offers an extended version of PSR-7's defined StreamInterface; a wrapper for common stream operations, mostly intended for file streams.

use Aedart\Streams\FileStream;

$stream = FileStream::open('my-file.txt')
    ->put('Hi there');

$more = FileStream::openMemory()
    ->put("\nMore things to show...")
    ->positionToStart();

$stream
    ->append($more);

echo (string) $stream; // Hi there
                       // More things to show...

Motivation

There are many good alternatives to this package. Sadly, some of those alternatives makes it unreasonably difficult to extend their offered functionality. Therefore, while this package offers similar or identical functionality as some of those alternatives, it allows you (and encourages you) to extend the functionality that is provided by this package.

use Aedart\Streams\FileStream;

class TranscriptFileStream extends FileStream
{
    // ...your domain-specific logic here ...
}

Documentation

Please read the official documentation for additional information.

Repository

The mono repository is located at github.com/aedart/athenaeum

Versioning

This package follows Semantic Versioning 2.0.0

License

BSD-3-Clause, Read the LICENSE file included in this package