Psr\Http\Message\StreamInterface Interface Reference

Inheritance diagram for Psr\Http\Message\StreamInterface:

Public Member Functions
	__toString ()
	Reads all data from the stream into a string, from the beginning to end.
	close ()
	Closes the stream and any underlying resources.
	detach ()
	Separates any underlying resources from the stream.
	eof ()
	Returns true if the stream is at the end of the stream.
	getContents ()
	Returns the remaining contents in a string.
	getMetadata ($key=null)
	Get stream metadata as an associative array or retrieve a specific key.
	getSize ()
	Get the size of the stream if known.
	isReadable ()
	Returns whether or not the stream is readable.
	isSeekable ()
	Returns whether or not the stream is seekable.
	isWritable ()
	Returns whether or not the stream is writable.
	read ($length)
	Read data from the stream.
	rewind ()
	Seek to the beginning of the stream.
	seek ($offset, $whence=SEEK_SET)
	Seek to a position in the stream.
	tell ()
	Returns the current position of the file read/write pointer.
	write ($string)
	Write data to the stream.

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

Return values

string

Implemented in GuzzleHttp\Psr7\AppendStream, GuzzleHttp\Psr7\BufferStream, GuzzleHttp\Psr7\FnStream, GuzzleHttp\Psr7\PumpStream, GuzzleHttp\Psr7\Stream, and ZipStream\Stream.

close()

Psr\Http\Message\StreamInterface::close

(

)

Closes the stream and any underlying resources.

Return values

void

Implemented in GuzzleHttp\Psr7\AppendStream, GuzzleHttp\Psr7\BufferStream, GuzzleHttp\Psr7\CachingStream, GuzzleHttp\Psr7\FnStream, GuzzleHttp\Psr7\PumpStream, GuzzleHttp\Psr7\Stream, and ZipStream\Stream.

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.

Return values

resource|null

Underlying PHP stream, if any

Implemented in GuzzleHttp\Psr7\AppendStream, GuzzleHttp\Psr7\BufferStream, GuzzleHttp\Psr7\FnStream, GuzzleHttp\Psr7\PumpStream, GuzzleHttp\Psr7\Stream, and ZipStream\Stream.

eof()

Psr\Http\Message\StreamInterface::eof

(

)

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

Return values

bool

Implemented in GuzzleHttp\Psr7\AppendStream, GuzzleHttp\Psr7\BufferStream, GuzzleHttp\Psr7\CachingStream, GuzzleHttp\Psr7\FnStream, GuzzleHttp\Psr7\LimitStream, GuzzleHttp\Psr7\PumpStream, GuzzleHttp\Psr7\Stream, and ZipStream\Stream.

getContents()

Psr\Http\Message\StreamInterface::getContents

(

)

Returns the remaining contents in a string.

Return values

string

Exceptions

RuntimeException

if unable to read or an error occurs while reading.

Implemented in GuzzleHttp\Psr7\AppendStream, GuzzleHttp\Psr7\BufferStream, GuzzleHttp\Psr7\FnStream, GuzzleHttp\Psr7\PumpStream, GuzzleHttp\Psr7\Stream, and ZipStream\Stream.

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.

@externalurl http://php.net/manual/en/function.stream-get-meta-data.php

Parameters

string

$key

Specific metadata to retrieve.

Return values

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 GuzzleHttp\Psr7\AppendStream, GuzzleHttp\Psr7\BufferStream, GuzzleHttp\Psr7\FnStream, GuzzleHttp\Psr7\PumpStream, GuzzleHttp\Psr7\Stream, and ZipStream\Stream.

getSize()

Psr\Http\Message\StreamInterface::getSize

(

)

Get the size of the stream if known.

Return values

int|null

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

Implemented in GuzzleHttp\Psr7\AppendStream, GuzzleHttp\Psr7\BufferStream, GuzzleHttp\Psr7\CachingStream, GuzzleHttp\Psr7\FnStream, GuzzleHttp\Psr7\LimitStream, GuzzleHttp\Psr7\PumpStream, GuzzleHttp\Psr7\Stream, and ZipStream\Stream.

isReadable()

Psr\Http\Message\StreamInterface::isReadable

(

)

Returns whether or not the stream is readable.

Return values

bool

Implemented in GuzzleHttp\Psr7\AppendStream, GuzzleHttp\Psr7\BufferStream, GuzzleHttp\Psr7\FnStream, GuzzleHttp\Psr7\PumpStream, GuzzleHttp\Psr7\Stream, and ZipStream\Stream.

isSeekable()

Psr\Http\Message\StreamInterface::isSeekable

(

)

Returns whether or not the stream is seekable.

Return values

bool

Implemented in GuzzleHttp\Psr7\AppendStream, GuzzleHttp\Psr7\BufferStream, GuzzleHttp\Psr7\FnStream, GuzzleHttp\Psr7\NoSeekStream, GuzzleHttp\Psr7\PumpStream, GuzzleHttp\Psr7\Stream, and ZipStream\Stream.

isWritable()

Psr\Http\Message\StreamInterface::isWritable

(

)

Returns whether or not the stream is writable.

Return values

bool

Implemented in GuzzleHttp\Psr7\AppendStream, GuzzleHttp\Psr7\BufferStream, GuzzleHttp\Psr7\FnStream, GuzzleHttp\Psr7\MultipartStream, GuzzleHttp\Psr7\PumpStream, GuzzleHttp\Psr7\Stream, and ZipStream\Stream.

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.

Return values

string

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

Exceptions

RuntimeException

if an error occurs.

Implemented in GuzzleHttp\Psr7\AppendStream, GuzzleHttp\Psr7\BufferStream, GuzzleHttp\Psr7\CachingStream, GuzzleHttp\Psr7\FnStream, GuzzleHttp\Psr7\LimitStream, GuzzleHttp\Psr7\PumpStream, GuzzleHttp\Psr7\Stream, and ZipStream\Stream.

rewind()

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

See also

seek() @externalurl http://www.php.net/manual/en/function.fseek.php

Exceptions

RuntimeException

on failure.

Implemented in GuzzleHttp\Psr7\AppendStream, GuzzleHttp\Psr7\BufferStream, GuzzleHttp\Psr7\CachingStream, GuzzleHttp\Psr7\FnStream, GuzzleHttp\Psr7\PumpStream, GuzzleHttp\Psr7\Stream, and ZipStream\Stream.

seek()

Psr\Http\Message\StreamInterface::seek	(		$offset,
			$whence = SEEK_SET )

Seek to a position in the stream.

@externalurl http://www.php.net/manual/en/function.fseek.php

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.

Implemented in GuzzleHttp\Psr7\AppendStream, GuzzleHttp\Psr7\BufferStream, GuzzleHttp\Psr7\CachingStream, GuzzleHttp\Psr7\FnStream, GuzzleHttp\Psr7\LimitStream, GuzzleHttp\Psr7\NoSeekStream, GuzzleHttp\Psr7\PumpStream, GuzzleHttp\Psr7\Stream, and ZipStream\Stream.

tell()

Psr\Http\Message\StreamInterface::tell

(

)

Returns the current position of the file read/write pointer.

Return values

int	Position of the file pointer

Exceptions

RuntimeException

on error.

Implemented in GuzzleHttp\Psr7\AppendStream, GuzzleHttp\Psr7\BufferStream, GuzzleHttp\Psr7\FnStream, GuzzleHttp\Psr7\LimitStream, GuzzleHttp\Psr7\PumpStream, GuzzleHttp\Psr7\Stream, and ZipStream\Stream.

write()

Psr\Http\Message\StreamInterface::write

(

$string

)

Write data to the stream.

Parameters

string

$string

The string that is to be written.

Return values

int	Returns the number of bytes written to the stream.

Exceptions

RuntimeException

on failure.

Implemented in GuzzleHttp\Psr7\AppendStream, GuzzleHttp\Psr7\BufferStream, GuzzleHttp\Psr7\CachingStream, GuzzleHttp\Psr7\DroppingStream, GuzzleHttp\Psr7\FnStream, GuzzleHttp\Psr7\PumpStream, GuzzleHttp\Psr7\Stream, and ZipStream\Stream.

---

The documentation for this interface was generated from the following file:

• lib/psr/http-message/src/StreamInterface.php