Psr\Http\Message\StreamInterface Interface Reference

Describes a data stream. More...

Inheritance diagram for Psr\Http\Message\StreamInterface:

Collaboration diagram for Psr\Http\Message\StreamInterface:

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

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 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 ILIAS\Filesystem\Stream\Stream, Slim\Http\Stream, GuzzleHttp\Psr7\Stream, GuzzleHttp\Psr7\FnStream, ZipStream\Stream, 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 Slim\Http\Stream, GuzzleHttp\Psr7\CachingStream, GuzzleHttp\Psr7\Stream, ILIAS\Filesystem\Stream\Stream, GuzzleHttp\Psr7\FnStream, GuzzleHttp\Psr7\AppendStream, GuzzleHttp\Psr7\PumpStream, GuzzleHttp\Psr7\BufferStream, 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.

Returns

resource|null Underlying PHP stream, if any

Implemented in Slim\Http\Stream, ILIAS\Filesystem\Stream\Stream, GuzzleHttp\Psr7\Stream, GuzzleHttp\Psr7\AppendStream, GuzzleHttp\Psr7\FnStream, GuzzleHttp\Psr7\PumpStream, GuzzleHttp\Psr7\BufferStream, and ZipStream\Stream.

Referenced by ILIAS\Filesystem\Stream\Streams\ofPsr7Stream(), ILIAS\Filesystem\Provider\FlySystem\FlySystemFileStreamAccess\putStream(), ILIAS\Filesystem\Provider\FlySystem\FlySystemFileStreamAccess\updateStream(), and ILIAS\Filesystem\Provider\FlySystem\FlySystemFileStreamAccess\writeStream().

Here is the caller graph for this function:

eof()

Psr\Http\Message\StreamInterface::eof

(

)

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

Returns

bool

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

Referenced by GuzzleHttp\Psr7\copy_to_stream(), GuzzleHttp\Psr7\copy_to_string(), ZipStream\File\deflateData(), GuzzleHttp\Psr7\hash(), ZipStream\File\processStreamWithComputedHeader(), GuzzleHttp\Psr7\readline(), and ZipStream\File\readStream().

Here is the caller graph for this function:

getContents()

Psr\Http\Message\StreamInterface::getContents

(

)

Returns the remaining contents in a string.

Returns

string

Exceptions

Implemented in Slim\Http\Stream, ILIAS\Filesystem\Stream\Stream, ZipStream\Stream, GuzzleHttp\Psr7\FnStream, 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 ILIAS\Filesystem\Stream\Stream, GuzzleHttp\Psr7\Stream, GuzzleHttp\Psr7\AppendStream, GuzzleHttp\Psr7\FnStream, GuzzleHttp\Psr7\PumpStream, GuzzleHttp\Psr7\BufferStream, ZipStream\Stream, and Slim\Http\Stream.

Referenced by ilCountPDFPagesPreProcessors\process(), and ILIAS\FileUpload\Processor\VirusScannerPreProcessor\process().

Here is the caller graph for this function:

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 Slim\Http\Stream, ILIAS\Filesystem\Stream\Stream, GuzzleHttp\Psr7\Stream, ZipStream\Stream, GuzzleHttp\Psr7\AppendStream, GuzzleHttp\Psr7\FnStream, GuzzleHttp\Psr7\PumpStream, GuzzleHttp\Psr7\LimitStream, GuzzleHttp\Psr7\BufferStream, and GuzzleHttp\Psr7\CachingStream.

Referenced by GuzzleHttp\Psr7\MultipartStream\createElement().

Here is the caller graph for this function:

isReadable()

Psr\Http\Message\StreamInterface::isReadable

(

)

Returns whether or not the stream is readable.

Returns

bool

Implemented in Slim\Http\Stream, ILIAS\Filesystem\Stream\Stream, ZipStream\Stream, GuzzleHttp\Psr7\AppendStream, GuzzleHttp\Psr7\Stream, GuzzleHttp\Psr7\FnStream, GuzzleHttp\Psr7\PumpStream, and GuzzleHttp\Psr7\BufferStream.

Referenced by GuzzleHttp\Psr7\AppendStream\addStream(), and GuzzleHttp\Psr7\StreamWrapper\getResource().

Here is the caller graph for this function:

isSeekable()

Psr\Http\Message\StreamInterface::isSeekable

(

)

Returns whether or not the stream is seekable.

Returns

bool

Implemented in Slim\Http\Stream, GuzzleHttp\Psr7\AppendStream, ILIAS\Filesystem\Stream\Stream, GuzzleHttp\Psr7\Stream, GuzzleHttp\Psr7\FnStream, ZipStream\Stream, GuzzleHttp\Psr7\PumpStream, GuzzleHttp\Psr7\BufferStream, and GuzzleHttp\Psr7\NoSeekStream.

Referenced by GuzzleHttp\Psr7\AppendStream\addStream().

Here is the caller graph for this function:

isWritable()

Psr\Http\Message\StreamInterface::isWritable

(

)

Returns whether or not the stream is writable.

Returns

bool

Implemented in Slim\Http\Stream, ILIAS\Filesystem\Stream\Stream, GuzzleHttp\Psr7\AppendStream, ZipStream\Stream, GuzzleHttp\Psr7\Stream, GuzzleHttp\Psr7\FnStream, GuzzleHttp\Psr7\PumpStream, GuzzleHttp\Psr7\BufferStream, and GuzzleHttp\Psr7\MultipartStream.

Referenced by GuzzleHttp\Psr7\StreamWrapper\getResource().

Here is the caller graph for this function:

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.

Returns

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

Exceptions

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

Referenced by GuzzleHttp\Psr7\InflateStream\__construct(), GuzzleHttp\Psr7\copy_to_stream(), GuzzleHttp\Psr7\copy_to_string(), GuzzleHttp\Psr7\InflateStream\getLengthOfPossibleFilenameHeader(), GuzzleHttp\Psr7\hash(), ILIAS\FileUpload\Processor\BlacklistFileHeaderPreProcessor\process(), ILIAS\FileUpload\Processor\WhitelistFileHeaderPreProcessor\process(), ZipStream\File\processStreamWithComputedHeader(), GuzzleHttp\Psr7\readline(), and ZipStream\File\readStream().

Here is the caller graph for this function:

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() on failure.

Implemented in Slim\Http\Stream, ILIAS\Filesystem\Stream\Stream, GuzzleHttp\Psr7\Stream, ZipStream\Stream, GuzzleHttp\Psr7\AppendStream, GuzzleHttp\Psr7\FnStream, GuzzleHttp\Psr7\PumpStream, GuzzleHttp\Psr7\BufferStream, GuzzleHttp\Psr7\CachingStream, and ZipStream\DeflateStream.

Referenced by GuzzleHttp\Psr7\hash(), ILIAS\FileUpload\Processor\PreProcessorManagerImpl\process(), and ZipStream\File\processStreamWithComputedHeader().

Here is the caller graph for this function:

seek()

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

Seek to a position in the stream.

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. on failure.

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

Referenced by GuzzleHttp\Psr7\hash().

Here is the caller graph for this function:

tell()

Psr\Http\Message\StreamInterface::tell

(

)

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

Returns

int Position of the file pointer

Exceptions

Implemented in Slim\Http\Stream, GuzzleHttp\Psr7\Stream, ILIAS\Filesystem\Stream\Stream, ZipStream\Stream, GuzzleHttp\Psr7\LimitStream, GuzzleHttp\Psr7\AppendStream, GuzzleHttp\Psr7\FnStream, GuzzleHttp\Psr7\BufferStream, and GuzzleHttp\Psr7\PumpStream.

Referenced by GuzzleHttp\Psr7\CachingStream\cacheEntireStream(), GuzzleHttp\Psr7\hash(), GuzzleHttp\Psr7\CachingStream\seek(), and GuzzleHttp\Psr7\CachingStream\write().

Here is the caller graph for this function:

write()

Psr\Http\Message\StreamInterface::write

(

$string

)

Write data to the stream.

Parameters

string

$string

The string that is to be written.

Returns

int Returns the number of bytes written to the stream.

Exceptions

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

Referenced by GuzzleHttp\Psr7\copy_to_stream().

Here is the caller graph for this function:

---

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

• libs/composer/vendor/psr/http-message/src/StreamInterface.php