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.

Abstract Interface
public abstract __toString () : string

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.

  • see
  • return string
public abstract close ()

Closes the stream and any underlying resources.

  • return void
public abstract detach ()

Separates any underlying resources from the stream.

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

  • return resource | null Underlying PHP stream, if any
public abstract eof ()

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

  • return bool
public abstract getContents ()

Returns the remaining contents in a string

  • return string
  • throws RuntimeException if unable to read or an error occurs while reading.
public abstract getMetadata ( $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.

  • link
  • param string $key Specific metadata to retrieve.
  • return 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.
public abstract getSize ()

Get the size of the stream if known.

  • return int | null Returns the size in bytes if known, or null if unknown.
public abstract isReadable ()

Returns whether or not the stream is readable.

  • return bool
public abstract isSeekable ()

Returns whether or not the stream is seekable.

  • return bool
public abstract isWritable ()

Returns whether or not the stream is writable.

  • return bool
public abstract read ( $length )

Read data from the stream.

  • param 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 string Returns the data read from the stream, or an empty string if no bytes are available.
  • throws RuntimeException if an error occurs.
public abstract 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).

public abstract seek ( $offset , $whence = 0 Psr\Http\Message\SEEK_SET)

Seek to a position in the stream.

  • link
  • param int $offset Stream offset
  • param 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.
  • throws RuntimeException on failure.
public abstract tell ()

Returns the current position of the file read/write pointer

  • return int Position of the file pointer
  • throws RuntimeException on error.
public abstract write ( $string )

Write data to the stream.

  • param string $string The string that is to be written.
  • return int Returns the number of bytes written to the stream.
  • throws RuntimeException on failure.
© 2021 Bruce Wells
Search Namespaces \ Classes