1. interface
  2. Psr
  3. \
  4. Http
  5. \
  6. Message
  7. \
  8. StreamInterface

StreamInterface

interface StreamInterface (View source)

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.

Methods

string
__toString()

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

void
close()

Closes the stream and any underlying resources.

resource|null
detach()

Separates any underlying resources from the stream.

int|null
getSize()

Get the size of the stream if known.

int
tell()

Returns the current position of the file read/write pointer

bool
eof()

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

bool
isSeekable()

Returns whether or not the stream is seekable.

seek(int $offset, int $whence = SEEK_SET)

Seek to a position in the stream.

rewind()

Seek to the beginning of the stream.

bool
isWritable()

Returns whether or not the stream is writable.

int
write(string $string)

Write data to the stream.

bool
isReadable()

Returns whether or not the stream is readable.

string
read(int $length)

Read data from the stream.

string
getContents()

Returns the remaining contents in a string

array|mixed|null
getMetadata(string $key = null)

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

Details

at line 28
string __toString()

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

This method MUST attempt to seek to the beginning of the stream before reading data and read the stream until the end is reached.

Warning: This could attempt to load a large amount of data into memory.

This method MUST NOT raise an exception in order to conform with PHP's string casting operations.

Return Value

string

See also

http://php.net/manual/en/language.oop5.magic.php#object.tostring

at line 35
void close()

Closes the stream and any underlying resources.

Return Value

void

at line 44
resource|null detach()

Separates any underlying resources from the stream.

After the stream has been detached, the stream is in an unusable state.

Return Value

resource|null Underlying PHP stream, if any

at line 51
int|null getSize()

Get the size of the stream if known.

Return Value

int|null Returns the size in bytes if known, or null if unknown.

at line 59
int tell()

Returns the current position of the file read/write pointer

Return Value

int Position of the file pointer

Exceptions

RuntimeException on error.

at line 66
bool eof()

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

Return Value

bool

at line 73
bool isSeekable()

Returns whether or not the stream is seekable.

Return Value

bool

at line 87
seek(int $offset, int $whence = SEEK_SET)

Seek to a position in the stream.

Parameters

int $offset Stream offset
int $whence Specifies how the cursor position will be calculated based on the seek offset. Valid values are identical to the built-in PHP $whence values for fseek(). SEEK_SET: Set position equal to offset bytes SEEK_CUR: Set position to current location plus offset SEEK_END: Set position to end-of-stream plus offset.

Exceptions

RuntimeException on failure.

at line 99
rewind()

Seek to the beginning of the stream.

If the stream is not seekable, this method will raise an exception; otherwise, it will perform a seek(0).

Exceptions

RuntimeException on failure.

See also

seek()

at line 106
bool isWritable()

Returns whether or not the stream is writable.

Return Value

bool

at line 115
int write(string $string)

Write data to the stream.

Parameters

string $string The string that is to be written.

Return Value

int Returns the number of bytes written to the stream.

Exceptions

RuntimeException on failure.

at line 122
bool isReadable()

Returns whether or not the stream is readable.

Return Value

bool

at line 134
string read(int $length)

Read data from the stream.

Parameters

int $length Read up to $length bytes from the object and return them. Fewer than $length bytes may be returned if underlying stream call returns fewer bytes.

Return Value

string Returns the data read from the stream, or an empty string if no bytes are available.

Exceptions

RuntimeException if an error occurs.

at line 143
string getContents()

Returns the remaining contents in a string

Return Value

string

Exceptions

RuntimeException if unable to read or an error occurs while reading.

at line 157
array|mixed|null getMetadata(string $key = null)

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

The keys returned are identical to the keys returned from PHP's stream_get_meta_data() function.

Parameters

string $key Specific metadata to retrieve.

Return Value

array|mixed|null Returns an associative array if no key is provided. Returns a specific key value if a key is provided and the value is found, or null if the key is not found.