GuzzleHttp\Psr7\DroppingStream Class Reference

Stream decorator that begins dropping data once the size of the underlying stream becomes too full. More...

Inheritance diagram for GuzzleHttp\Psr7\DroppingStream:

Collaboration diagram for GuzzleHttp\Psr7\DroppingStream:

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

Private Attributes
	$maxLength

Detailed Description

Stream decorator that begins dropping data once the size of the underlying stream becomes too full.

Definition at line 10 of file DroppingStream.php.

Constructor & Destructor Documentation

__construct()

GuzzleHttp\Psr7\DroppingStream::__construct	(	StreamInterface	$stream,
			$maxLength
	)

Parameters

StreamInterface	$stream	Underlying stream to decorate.
int	$maxLength	Maximum size before dropping data.

Definition at line 20 of file DroppingStream.php.

References GuzzleHttp\Psr7\DroppingStream\$maxLength, and GuzzleHttp\Psr7\$stream.

    {
        $this->stream = $stream;
        $this->maxLength = $maxLength;
    }

Member Function Documentation

write()

GuzzleHttp\Psr7\DroppingStream::write

(

$string

)

Write data to the stream.

Parameters

string

$string

The string that is to be written.

Returns

int Returns the number of bytes written to the stream.

Exceptions

Implements Psr\Http\Message\StreamInterface.

Definition at line 26 of file DroppingStream.php.

    {
        $diff = $this->maxLength - $this->stream->getSize();

        // Begin returning 0 when the underlying stream is too large.
        if ($diff <= 0) {
            return 0;
        }

        // Write the stream or a subset of the stream if needed.
        if (strlen($string) < $diff) {
            return $this->stream->write($string);
        }

        return $this->stream->write(substr($string, 0, $diff));
    }

Field Documentation

$maxLength

GuzzleHttp\Psr7\DroppingStream::$maxLength

private

Definition at line 14 of file DroppingStream.php.

Referenced by GuzzleHttp\Psr7\DroppingStream\__construct().

---

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

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