GuzzleHttp\Psr7\BufferStream Class Reference

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

Inheritance diagram for GuzzleHttp\Psr7\BufferStream:

Collaboration diagram for GuzzleHttp\Psr7\BufferStream:

Public Member Functions
	__construct ($hwm=16384)
	__toString ()
	Reads all data from the stream into a string, from the beginning to end. More...
	getContents ()
	Returns the remaining contents in a string. 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...
	isReadable ()
	Returns whether or not the stream is readable. More...
	isWritable ()
	Returns whether or not the stream is writable. More...
	isSeekable ()
	Returns whether or not the stream is seekable. More...
	rewind ()
	Seek to the beginning of the stream. More...
	seek ($offset, $whence=SEEK_SET)
	Seek to a position in the stream. More...
	eof ()
	Returns true if the stream is at the end of the stream. More...
	tell ()
	Returns the current position of the file read/write pointer. More...
	read ($length)
	Reads data from the buffer. More...
	write ($string)
	Writes data to the buffer. More...
	getMetadata ($key=null)
	Get stream metadata as an associative array or retrieve a specific key. More...

Private Attributes
	$hwm
	$buffer = ''

Detailed Description

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.

Definition at line 14 of file BufferStream.php.

Constructor & Destructor Documentation

__construct()

GuzzleHttp\Psr7\BufferStream::__construct

(

$hwm = 16384

)

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.

Definition at line 26 of file BufferStream.php.

References GuzzleHttp\Psr7\BufferStream\$hwm.

    {
        $this->hwm = $hwm;
    }

Member Function Documentation

__toString()

GuzzleHttp\Psr7\BufferStream::__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 31 of file BufferStream.php.

References GuzzleHttp\Psr7\BufferStream\getContents().

    {
        return $this->getContents();
    }

Here is the call graph for this function:

close()

GuzzleHttp\Psr7\BufferStream::close

(

)

Closes the stream and any underlying resources.

Returns

void

Implements Psr\Http\Message\StreamInterface.

Definition at line 44 of file BufferStream.php.

Referenced by GuzzleHttp\Psr7\BufferStream\detach().

    {
        $this->buffer = '';
    }

Here is the caller graph for this function:

detach()

GuzzleHttp\Psr7\BufferStream::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 49 of file BufferStream.php.

References GuzzleHttp\Psr7\BufferStream\close().

    {
        $this->close();
    }

Here is the call graph for this function:

eof()

GuzzleHttp\Psr7\BufferStream::eof

(

)

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

Returns

bool

Implements Psr\Http\Message\StreamInterface.

Definition at line 84 of file BufferStream.php.

    {
        return strlen($this->buffer) === 0;
    }

getContents()

GuzzleHttp\Psr7\BufferStream::getContents

(

)

Returns the remaining contents in a string.

Returns

string

Exceptions

Implements Psr\Http\Message\StreamInterface.

Definition at line 36 of file BufferStream.php.

References GuzzleHttp\Psr7\BufferStream\$buffer.

Referenced by GuzzleHttp\Psr7\BufferStream\__toString().

    {
        $buffer = $this->buffer;
        $this->buffer = '';

        return $buffer;
    }

Here is the caller graph for this function:

getMetadata()

GuzzleHttp\Psr7\BufferStream::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 129 of file BufferStream.php.

References GuzzleHttp\Psr7\BufferStream\$hwm, and $key.

    {
        if ($key == 'hwm') {
            return $this->hwm;
        }

        return $key ? null : [];
    }

getSize()

GuzzleHttp\Psr7\BufferStream::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 54 of file BufferStream.php.

    {
        return strlen($this->buffer);
    }

isReadable()

GuzzleHttp\Psr7\BufferStream::isReadable

(

)

Returns whether or not the stream is readable.

Returns

bool

Implements Psr\Http\Message\StreamInterface.

Definition at line 59 of file BufferStream.php.

    {
        return true;
    }

isSeekable()

GuzzleHttp\Psr7\BufferStream::isSeekable

(

)

Returns whether or not the stream is seekable.

Returns

bool

Implements Psr\Http\Message\StreamInterface.

Definition at line 69 of file BufferStream.php.

    {
        return false;
    }

isWritable()

GuzzleHttp\Psr7\BufferStream::isWritable

(

)

Returns whether or not the stream is writable.

Returns

bool

Implements Psr\Http\Message\StreamInterface.

Definition at line 64 of file BufferStream.php.

    {
        return true;
    }

read()

GuzzleHttp\Psr7\BufferStream::read

(

$length

)

Reads data from the buffer.

Implements Psr\Http\Message\StreamInterface.

Definition at line 97 of file BufferStream.php.

References GuzzleHttp\Psr7\BufferStream\$buffer, and $result.

    {
        $currentLength = strlen($this->buffer);

        if ($length >= $currentLength) {
            // No need to slice the buffer because we don't have enough data.
            $result = $this->buffer;
            $this->buffer = '';
        } else {
            // Slice up the result to provide a subset of the buffer.
            $result = substr($this->buffer, 0, $length);
            $this->buffer = substr($this->buffer, $length);
        }

        return $result;
    }

rewind()

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

Implements Psr\Http\Message\StreamInterface.

Definition at line 74 of file BufferStream.php.

References GuzzleHttp\Psr7\BufferStream\seek().

    {
        $this->seek(0);
    }

Here is the call graph for this function:

seek()

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

Implements Psr\Http\Message\StreamInterface.

Definition at line 79 of file BufferStream.php.

Referenced by GuzzleHttp\Psr7\BufferStream\rewind().

    {
        throw new \RuntimeException('Cannot seek a BufferStream');
    }

Here is the caller graph for this function:

tell()

GuzzleHttp\Psr7\BufferStream::tell

(

)

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

Returns

int Position of the file pointer

Exceptions

Implements Psr\Http\Message\StreamInterface.

Definition at line 89 of file BufferStream.php.

    {
        throw new \RuntimeException('Cannot determine the position of a BufferStream');
    }

write()

GuzzleHttp\Psr7\BufferStream::write

(

$string

)

Writes data to the buffer.

Implements Psr\Http\Message\StreamInterface.

Definition at line 117 of file BufferStream.php.

    {
        $this->buffer .= $string;

        // TODO: What should happen here?
        if (strlen($this->buffer) >= $this->hwm) {
            return false;
        }

        return strlen($string);
    }

Field Documentation

$buffer

GuzzleHttp\Psr7\BufferStream::$buffer = ''

private

Definition at line 17 of file BufferStream.php.

Referenced by GuzzleHttp\Psr7\BufferStream\getContents(), and GuzzleHttp\Psr7\BufferStream\read().

$hwm

GuzzleHttp\Psr7\BufferStream::$hwm

private

Definition at line 16 of file BufferStream.php.

Referenced by GuzzleHttp\Psr7\BufferStream\__construct(), and GuzzleHttp\Psr7\BufferStream\getMetadata().

---

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

• libs/composer/vendor/guzzlehttp/psr7/src/BufferStream.php