Copied!

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.

Cloneable Final Instantiable
  • Implements
    Psr\Http\Message\StreamInterface
    Stringable
Methods
public __construct ( int $hwm = 16384 )
 
  • param 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 0 to inform writers to slow down
    until the buffer has been drained by reading from it.
public __toString () : string
public close () : void
public detach ()
public eof () : bool
public getContents () : string
public getMetadata ( $key = NULL )
 
  • return mixed
public getSize () : ? int
public isReadable () : bool
public isSeekable () : bool
public isWritable () : bool
public read ( $length ) : string
 

Reads data from the buffer.

public rewind () : void
public seek ( $offset , $whence = 0 GuzzleHttp\Psr7\SEEK_SET) : void
public tell () : int
public write ( $string ) : int
 

Writes data to the buffer.

Properties
private $buffer
 
  • var string
private $hwm
 
  • var int
© 2022 Bruce Wells
Search Namespaces \ Classes
Configuration