$source
$source : callable
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.
$source : callable
$size : int
$tellPos : int
$metadata : array
$buffer : \GuzzleHttp\Psr7\BufferStream
__construct(callable $source, array $options = []) : mixed
| 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:
|
__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.
seek(mixed $offset, mixed $whence = SEEK_SET) : mixed
Seek to a position in the stream.
| mixed | $offset | Stream offset |
| mixed | $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 |
read(mixed $length) : string
Read data from the stream.
| mixed | $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 the data read from the stream, or an empty string if no bytes are available.
getMetadata(mixed $key = null) : array|mixed|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.
| mixed | $key | Specific metadata to retrieve. |
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.