GuzzleHttp\Psr7\LimitStream Class Reference

Decorator used to return only a subset of a stream. More...

Inheritance diagram for GuzzleHttp\Psr7\LimitStream:

Collaboration diagram for GuzzleHttp\Psr7\LimitStream:

Public Member Functions
	__construct (StreamInterface $stream, $limit=-1, $offset=0)
	eof ()
	Returns true if the stream is at the end of the stream. More...
	getSize ()
	Returns the size of the limited subset of data {Get the size of the stream if known. Returns int|null Returns the size in bytes if known, or null if unknown. }. More...
	seek ($offset, $whence=SEEK_SET)
	Allow for a bounded seek on the read limited stream {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.}. More...
	tell ()
	Give a relative tell() {Returns the current position of the file read/write pointer. Returns int Position of the file pointer Exceptions RuntimeException on error.}. More...
	setOffset ($offset)
	Set the offset to start limiting from. More...
	setLimit ($limit)
	Set the limit of bytes that the decorator allows to be read from the stream. More...
	read ($length)
	Read data from 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...
	write ($string)
	Write data to the stream. 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
	$offset
	$limit

Detailed Description

Decorator used to return only a subset of a stream.

Definition at line 10 of file LimitStream.php.

Constructor & Destructor Documentation

__construct()

GuzzleHttp\Psr7\LimitStream::__construct	(	StreamInterface	$stream,
			$limit = -1,
			$offset = 0
	)

Parameters

StreamInterface	$stream	Stream to wrap
int	$limit	Total number of bytes to allow to be read from the stream. Pass -1 for no limit.
int	$offset	Position to seek to before reading (only works on seekable streams).

Definition at line 27 of file LimitStream.php.

      {
        $this->stream = $stream;
        $this->setLimit($limit);
        $this->setOffset($offset);
    }

References GuzzleHttp\Psr7\LimitStream\$limit, GuzzleHttp\Psr7\LimitStream\$offset, GuzzleHttp\Psr7\$stream, GuzzleHttp\Psr7\LimitStream\setLimit(), and GuzzleHttp\Psr7\LimitStream\setOffset().

Here is the call graph for this function:

Member Function Documentation

eof()

GuzzleHttp\Psr7\LimitStream::eof

(

)

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

Returns

bool

Implements Psr\Http\Message\StreamInterface.

Definition at line 37 of file LimitStream.php.

    {
        // Always return true if the underlying stream is EOF
        if ($this->stream->eof()) {
            return true;
        }
 
        // No limit and the underlying stream is not at EOF
        if ($this->limit == -1) {
            return false;
        }
 
        return $this->stream->tell() >= $this->offset + $this->limit;
    }

References GuzzleHttp\Psr7\LimitStream\$limit.

getSize()

GuzzleHttp\Psr7\LimitStream::getSize

(

)

Returns the size of the limited subset of data {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 56 of file LimitStream.php.

    {
        if (null === ($length = $this->stream->getSize())) {
            return null;
        } elseif ($this->limit == -1) {
            return $length - $this->offset;
        } else {
            return min($this->limit, $length - $this->offset);
        }
    }

References GuzzleHttp\Psr7\LimitStream\$offset.

read()

int Limit the number of bytes that can be GuzzleHttp\Psr7\LimitStream::read

(

$length

)

Read data from the stream.

Parameters

int

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

Exceptions

RuntimeException if an error occurs.

Implements Psr\Http\Message\StreamInterface.

Definition at line 138 of file LimitStream.php.

    {
        if ($this->limit == -1) {
            return $this->stream->read($length);
        }
 
        // Check if the current position is less than the total allowed
        // bytes + original offset
        $remaining = ($this->offset + $this->limit) - $this->stream->tell();
        if ($remaining > 0) {
            // Only return the amount of requested data, ensuring that the byte
            // limit is not exceeded
            return $this->stream->read(min($remaining, $length));
        }
 
        return '';
    }

References GuzzleHttp\Psr7\LimitStream\$limit, and $remaining.

seek()

GuzzleHttp\Psr7\LimitStream::seek	(		$offset,
			$whence = SEEK_SET
	)

Allow for a bounded seek on the read limited stream {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 71 of file LimitStream.php.

    {
        if ($whence !== SEEK_SET || $offset < 0) {
            throw new \RuntimeException(sprintf(
                'Cannot seek to offset % with whence %s',
                $offset,
                $whence
            ));
        }
 
        $offset += $this->offset;
 
        if ($this->limit !== -1) {
            if ($offset > $this->offset + $this->limit) {
                $offset = $this->offset + $this->limit;
            }
        }
 
        $this->stream->seek($offset);
    }

References GuzzleHttp\Psr7\LimitStream\$limit, and GuzzleHttp\Psr7\LimitStream\$offset.

setLimit()

GuzzleHttp\Psr7\LimitStream::setLimit

(

$limit

)

Set the limit of bytes that the decorator allows to be read from the stream.

Parameters

int

$limit

Number of bytes to allow to be read from the stream. Use -1 for no limit.

Definition at line 133 of file LimitStream.php.

    {
        $this->limit = $limit;
    }

References GuzzleHttp\Psr7\LimitStream\$limit.

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

Here is the caller graph for this function:

setOffset()

GuzzleHttp\Psr7\LimitStream::setOffset

(

$offset

)

Set the offset to start limiting from.

Parameters

int

$offset

Offset to seek to and begin byte limiting from

Exceptions

RuntimeException if the stream cannot be seeked.

Definition at line 108 of file LimitStream.php.

    {
        $current = $this->stream->tell();
 
        if ($current !== $offset) {
            // If the stream cannot seek to the offset position, then read to it
            if ($this->stream->isSeekable()) {
                $this->stream->seek($offset);
            } elseif ($current > $offset) {
                throw new \RuntimeException("Could not seek to stream offset $offset");
            } else {
                $this->stream->read($offset - $current);
            }
        }
 
        $this->offset = $offset;
    }

References $current, and GuzzleHttp\Psr7\LimitStream\$offset.

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

Here is the caller graph for this function:

tell()

GuzzleHttp\Psr7\LimitStream::tell

(

)

Give a relative tell() {Returns the current position of the file read/write pointer.

Returns

int Position of the file pointer

Exceptions

RuntimeException on error.}.

Implements Psr\Http\Message\StreamInterface.

Definition at line 96 of file LimitStream.php.

    {
        return $this->stream->tell() - $this->offset;
    }

References GuzzleHttp\Psr7\LimitStream\$offset.

Field Documentation

$limit

GuzzleHttp\Psr7\LimitStream::$limit

private

Definition at line 18 of file LimitStream.php.

Referenced by GuzzleHttp\Psr7\LimitStream\__construct(), GuzzleHttp\Psr7\LimitStream\eof(), GuzzleHttp\Psr7\LimitStream\read(), GuzzleHttp\Psr7\LimitStream\seek(), and GuzzleHttp\Psr7\LimitStream\setLimit().

$offset

GuzzleHttp\Psr7\LimitStream::$offset

private

Definition at line 15 of file LimitStream.php.

Referenced by GuzzleHttp\Psr7\LimitStream\__construct(), GuzzleHttp\Psr7\LimitStream\getSize(), GuzzleHttp\Psr7\LimitStream\seek(), GuzzleHttp\Psr7\LimitStream\setOffset(), and GuzzleHttp\Psr7\LimitStream\tell().

---

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

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