\GuzzleHttp\Psr7BufferStream

Provides a buffer stream that can be written to to fill a buffer, and read from to remove bytes from the buffer.

This stream returns a "hwm" metadata value that tells upstream consumers what the configured high water mark of the stream is, or the maximum preferred size of the buffer.

Summary

Methods
Properties
Constants
__construct()
__toString()
getContents()
close()
detach()
getSize()
isReadable()
isWritable()
isSeekable()
rewind()
seek()
eof()
tell()
read()
write()
getMetadata()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$hwm
$buffer
N/A

Properties

$hwm

$hwm

$buffer

$buffer

Methods

__construct()

__construct(int  $hwm = 16384) : mixed

Parameters

int $hwm

High water mark, representing the preferred maximum buffer size. If the size of the buffer exceeds the high water mark, then calls to write will continue to succeed but will return false to inform writers to slow down until the buffer has been drained by reading from it.

Returns

mixed —

__toString()

__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.

Returns

string —

getContents()

getContents() : string

Returns the remaining contents in a string

Returns

string —

close()

close() : void

Closes the stream and any underlying resources.

detach()

detach() : resource|null

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

getSize()

getSize() : int|null

Get the size of the stream if known.

Returns

int|null —

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

isReadable()

isReadable() : bool

Returns whether or not the stream is readable.

Returns

bool —

isWritable()

isWritable() : bool

Returns whether or not the stream is writable.

Returns

bool —

isSeekable()

isSeekable() : bool

Returns whether or not the stream is seekable.

Returns

bool —

rewind()

rewind() : mixed

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).

Returns

mixed —

seek()

seek(mixed  $offset, mixed  $whence = SEEK_SET) : mixed

Seek to a position in the stream.

Parameters

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

Returns

mixed —

eof()

eof() : bool

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

Returns

bool —

tell()

tell() : int

Returns the current position of the file read/write pointer

Returns

int —

Position of the file pointer

read()

read(mixed  $length) : string

Reads data from the buffer.

Parameters

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

string —

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

write()

write(mixed  $string) : int

Writes data to the buffer.

Parameters

mixed $string

The string that is to be written.

Returns

int —

Returns the number of bytes written to the stream.

getMetadata()

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.

Parameters

mixed $key

Specific metadata to retrieve.

Returns

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.