Inheritance diagram for GuzzleHttp\Psr7\PumpStream:

Public Member Functions
	__construct (callable $source, array $options=[])

	__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

Provides a read only stream that pumps data from a PHP callable.

When invoking the provided callable, the PumpStream will pass the amount of data requested to read to the callable. The callable can choose to ignore this value and return fewer or more bytes than requested. Any extra data returned by the provided callable is buffered internally until drained using the read() function of the PumpStream. The provided callable MUST return false when there is no more data to read.

Definition at line 16 of file PumpStream.php.

Constructor & Destructor Documentation

◆ __construct()

GuzzleHttp\Psr7\PumpStream::__construct	(	callable	$source,
		array	$options = `[]`
	)

Parameters

callable	$source	Source of the stream data. The callable MAY accept an integer argument used to control the amount of data to return. The callable MUST return a string when called, or false on error or EOF.
array	$options	Stream options: metadata: Hash of metadata to use with stream. size: Size of the stream, if known.

Definition at line 58 of file PumpStream.php.

Member Function Documentation

◆ __toString()

GuzzleHttp\Psr7\PumpStream::__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

Implements Psr\Http\Message\StreamInterface.

Definition at line 66 of file PumpStream.php.

References GuzzleHttp\Psr7\copy_to_string().

◆ close()

GuzzleHttp\Psr7\PumpStream::close ( )

Closes the stream and any underlying resources.

Returns: void

Implements Psr\Http\Message\StreamInterface.

Definition at line 75 of file PumpStream.php.

References GuzzleHttp\Psr7\PumpStream\detach().

◆ detach()

GuzzleHttp\Psr7\PumpStream::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

Implements Psr\Http\Message\StreamInterface.

Definition at line 80 of file PumpStream.php.

Referenced by GuzzleHttp\Psr7\PumpStream\close().

◆ eof()

GuzzleHttp\Psr7\PumpStream::eof ( )

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

Returns: bool

Implements Psr\Http\Message\StreamInterface.

Definition at line 96 of file PumpStream.php.

Referenced by GuzzleHttp\Psr7\PumpStream\getContents().

◆ getContents()

GuzzleHttp\Psr7\PumpStream::getContents ( )

Returns the remaining contents in a string

Returns: string

Exceptions

Implements Psr\Http\Message\StreamInterface.

Definition at line 147 of file PumpStream.php.

References GuzzleHttp\Psr7\PumpStream\eof(), and GuzzleHttp\Psr7\PumpStream\read().

◆ getMetadata()

GuzzleHttp\Psr7\PumpStream::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.

Implements Psr\Http\Message\StreamInterface.

Definition at line 157 of file PumpStream.php.

◆ getSize()

GuzzleHttp\Psr7\PumpStream::getSize ( )

Get the size of the stream if known.

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

Implements Psr\Http\Message\StreamInterface.

Definition at line 86 of file PumpStream.php.

◆ isReadable()

GuzzleHttp\Psr7\PumpStream::isReadable ( )

Returns whether or not the stream is readable.

Returns: bool

Implements Psr\Http\Message\StreamInterface.

Definition at line 126 of file PumpStream.php.

◆ isSeekable()

GuzzleHttp\Psr7\PumpStream::isSeekable ( )

Returns whether or not the stream is seekable.

Returns: bool

Implements Psr\Http\Message\StreamInterface.

Definition at line 101 of file PumpStream.php.

◆ isWritable()

GuzzleHttp\Psr7\PumpStream::isWritable ( )

Returns whether or not the stream is writable.

Returns: bool

Implements Psr\Http\Message\StreamInterface.

Definition at line 116 of file PumpStream.php.

◆ read()

GuzzleHttp\Psr7\PumpStream::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.