class LimitStream in Lockr 7.3

Decorator used to return only a subset of a stream

Hierarchy

• class \GuzzleHttp\Psr7\LimitStream implements StreamInterface uses StreamDecoratorTrait

File

vendor/guzzlehttp/psr7/src/LimitStream.php, line 10

Namespace

GuzzleHttp\Psr7

class LimitStream implements StreamInterface {
  use StreamDecoratorTrait;

  /** @var int Offset to start reading from */
  private $offset;

  /** @var int Limit the number of bytes that can be read */
  private $limit;

  /**
   * @param StreamInterface $stream Stream to wrap
   * @param int             $limit  Total number of bytes to allow to be read
   *                                from the stream. Pass -1 for no limit.
   * @param int             $offset Position to seek to before reading (only
   *                                works on seekable streams).
   */
  public function __construct(StreamInterface $stream, $limit = -1, $offset = 0) {
    $this->stream = $stream;
    $this
      ->setLimit($limit);
    $this
      ->setOffset($offset);
  }
  public function eof() {

    // 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;
  }

  /**
   * Returns the size of the limited subset of data
   * {@inheritdoc}
   */
  public function getSize() {
    if (null === ($length = $this->stream
      ->getSize())) {
      return null;
    }
    elseif ($this->limit == -1) {
      return $length - $this->offset;
    }
    else {
      return min($this->limit, $length - $this->offset);
    }
  }

  /**
   * Allow for a bounded seek on the read limited stream
   * {@inheritdoc}
   */
  public function seek($offset, $whence = SEEK_SET) {
    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);
  }

  /**
   * Give a relative tell()
   * {@inheritdoc}
   */
  public function tell() {
    return $this->stream
      ->tell() - $this->offset;
  }

  /**
   * Set the offset to start limiting from
   *
   * @param int $offset Offset to seek to and begin byte limiting from
   *
   * @throws \RuntimeException if the stream cannot be seeked.
   */
  public function setOffset($offset) {
    $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;
  }

  /**
   * Set the limit of bytes that the decorator allows to be read from the
   * stream.
   *
   * @param int $limit Number of bytes to allow to be read from the stream.
   *                   Use -1 for no limit.
   */
  public function setLimit($limit) {
    $this->limit = $limit;
  }
  public function read($length) {
    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 '';
  }

}

Members

Name	Modifiers	Type	Description	Overrides
LimitStream::$limit	private	property	@var int Limit the number of bytes that can be read
LimitStream::$offset	private	property	@var int Offset to start reading from
LimitStream::eof	public	function	Returns true if the stream is at the end of the stream. Overrides StreamDecoratorTrait::eof
LimitStream::getSize	public	function	Returns the size of the limited subset of data Overrides StreamDecoratorTrait::getSize
LimitStream::read	public	function	Read data from the stream. Overrides StreamDecoratorTrait::read
LimitStream::seek	public	function	Allow for a bounded seek on the read limited stream Overrides StreamDecoratorTrait::seek
LimitStream::setLimit	public	function	Set the limit of bytes that the decorator allows to be read from the stream.
LimitStream::setOffset	public	function	Set the offset to start limiting from
LimitStream::tell	public	function	Give a relative tell() Overrides StreamDecoratorTrait::tell
LimitStream::__construct	public	function	Overrides StreamDecoratorTrait::__construct
StreamDecoratorTrait::close	public	function		1
StreamDecoratorTrait::createStream	protected	function	Implement in subclasses to dynamically create streams when requested.	2
StreamDecoratorTrait::detach	public	function
StreamDecoratorTrait::getContents	public	function
StreamDecoratorTrait::getMetadata	public	function
StreamDecoratorTrait::isReadable	public	function
StreamDecoratorTrait::isSeekable	public	function		1
StreamDecoratorTrait::isWritable	public	function		1
StreamDecoratorTrait::rewind	public	function		1
StreamDecoratorTrait::write	public	function		2
StreamDecoratorTrait::__call	public	function	Allow decorators to implement custom methods
StreamDecoratorTrait::__get	public	function	Magic method used to create a new stream if streams are not added in the constructor of a decorator (e.g., LazyOpenStream).
StreamDecoratorTrait::__toString	public	function