mini\Http\Message\Stream class

Documentation

Describes a data stream.

Typically, an instance will wrap a PHP stream; this interface provides a wrapper around the most common operations, including serialization of the entire stream to a string.

Inheritance

Implements: Psr\Http\Message\StreamInterface Stringable

Uses Traits: mini\Http\Message\StreamTrait

Properties (3)

protected mixed $stream
protected bool $active
protected int $offset

Methods (20)

public static cast()

Cast a value to a Stream instance.

public __construct()

Documentation missing

public static create()

Documentation missing

protected StreamTrait()

Configure the StreamTrait

public __toString()

Reads all data from the stream into a string, from the beginning to end.

public getContents()

Returns the remaining contents in a string

public close()

Closes the stream and any underlying resources.

public detach()

Separates any underlying resources from the stream.

public getSize()

Get the size of the stream if known.

public tell()

Returns the current position of the file read/write pointer

public eof()

Returns true if the stream is at the end of the stream.

public isSeekable()

Returns whether or not the stream is seekable.

public seek()

Seek to a position in the stream.

public rewind()

Seek to the beginning of the stream.

public isWritable()

Returns whether or not the stream is writable.

public write()

Write data to the stream.

public isReadable()

Returns whether or not the stream is readable.

public read()

Read data from the stream.

public getMetadata()

Get stream metadata as an associative array or retrieve a specific key.

protected assertUsable()

Documentation missing

Source

src/Http/Message/Stream.php:13-78