Inheritance diagram for Psr\Http\Message\StreamInterface:

Public Member Functions
	__toString ()

	close ()

	detach ()

	eof ()

	getContents ()

	getMetadata ($key=null)

	getSize ()

	isReadable ()

	isSeekable ()

	isWritable ()

	read ($length)

	rewind ()

	seek ($offset, $whence=SEEK_SET)

	tell ()

	write ($string)

Detailed Description

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.

Definition at line 12 of file vendor/psr/http-message/src/StreamInterface.php.

Member Function Documentation

◆ __toString()

Psr\Http\Message\StreamInterface::__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.

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

Returns: string

Implemented in Http\Message\Encoding\FilteredStream, GuzzleHttp\Psr7\FnStream, GuzzleHttp\Psr7\Stream, Http\Message\Stream\BufferedStream, GuzzleHttp\Psr7\PumpStream, GuzzleHttp\Psr7\AppendStream, and GuzzleHttp\Psr7\BufferStream.

◆ close()

Psr\Http\Message\StreamInterface::close ( )

Closes the stream and any underlying resources.

Returns: void

Implemented in GuzzleHttp\Psr7\CachingStream, GuzzleHttp\Psr7\Stream, GuzzleHttp\Psr7\FnStream, Http\Message\Stream\BufferedStream, GuzzleHttp\Psr7\AppendStream, GuzzleHttp\Psr7\PumpStream, and GuzzleHttp\Psr7\BufferStream.

◆ detach()

Psr\Http\Message\StreamInterface::detach ( )

Separates any underlying resources from the stream.

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

Returns: resource|null Underlying PHP stream, if any

Implemented in GuzzleHttp\Psr7\Stream, GuzzleHttp\Psr7\FnStream, Http\Message\Stream\BufferedStream, GuzzleHttp\Psr7\AppendStream, GuzzleHttp\Psr7\PumpStream, and GuzzleHttp\Psr7\BufferStream.

◆ eof()

Psr\Http\Message\StreamInterface::eof ( )

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

Returns: bool

Implemented in GuzzleHttp\Psr7\Stream, Http\Message\Stream\BufferedStream, GuzzleHttp\Psr7\AppendStream, GuzzleHttp\Psr7\CachingStream, Http\Message\Encoding\FilteredStream, GuzzleHttp\Psr7\FnStream, GuzzleHttp\Psr7\PumpStream, GuzzleHttp\Psr7\BufferStream, and GuzzleHttp\Psr7\LimitStream.

◆ getContents()

Psr\Http\Message\StreamInterface::getContents ( )

Returns the remaining contents in a string

Returns: string

Exceptions

Implemented in Http\Message\Stream\BufferedStream, GuzzleHttp\Psr7\FnStream, Http\Message\Encoding\FilteredStream, GuzzleHttp\Psr7\PumpStream, GuzzleHttp\Psr7\Stream, GuzzleHttp\Psr7\AppendStream, and GuzzleHttp\Psr7\BufferStream.

◆ getMetadata()

Psr\Http\Message\StreamInterface::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.

string $key Specific metadata to retrieve. 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.

Implemented in Http\Message\Stream\BufferedStream, GuzzleHttp\Psr7\Stream, GuzzleHttp\Psr7\AppendStream, GuzzleHttp\Psr7\FnStream, GuzzleHttp\Psr7\PumpStream, and GuzzleHttp\Psr7\BufferStream.

◆ getSize()

Psr\Http\Message\StreamInterface::getSize ( )

Get the size of the stream if known.

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

Implemented in Http\Message\Encoding\FilteredStream, GuzzleHttp\Psr7\Stream, GuzzleHttp\Psr7\AppendStream, Http\Message\Stream\BufferedStream, GuzzleHttp\Psr7\FnStream, GuzzleHttp\Psr7\PumpStream, GuzzleHttp\Psr7\LimitStream, GuzzleHttp\Psr7\BufferStream, and GuzzleHttp\Psr7\CachingStream.

◆ isReadable()

Psr\Http\Message\StreamInterface::isReadable ( )

Returns whether or not the stream is readable.

Returns: bool

Implemented in GuzzleHttp\Psr7\AppendStream, Http\Message\Stream\BufferedStream, GuzzleHttp\Psr7\Stream, GuzzleHttp\Psr7\FnStream, GuzzleHttp\Psr7\PumpStream, and GuzzleHttp\Psr7\BufferStream.

◆ isSeekable()

Psr\Http\Message\StreamInterface::isSeekable ( )

Returns whether or not the stream is seekable.

Returns: bool

Implemented in GuzzleHttp\Psr7\AppendStream, Http\Message\Encoding\FilteredStream, GuzzleHttp\Psr7\Stream, Http\Message\Stream\BufferedStream, GuzzleHttp\Psr7\FnStream, GuzzleHttp\Psr7\PumpStream, GuzzleHttp\Psr7\BufferStream, and GuzzleHttp\Psr7\NoSeekStream.

◆ isWritable()

Psr\Http\Message\StreamInterface::isWritable ( )

Returns whether or not the stream is writable.

Returns: bool

Implemented in GuzzleHttp\Psr7\AppendStream, Http\Message\Stream\BufferedStream, GuzzleHttp\Psr7\Stream, GuzzleHttp\Psr7\FnStream, GuzzleHttp\Psr7\PumpStream, GuzzleHttp\Psr7\BufferStream, and GuzzleHttp\Psr7\MultipartStream.

◆ read()

Psr\Http\Message\StreamInterface::read ( $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.