One\Http\BufferStream

Complexity

Total Complexity

20

Size/Duplication

Total Lines	164
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	seek()	0	3	1
A	getMetadata()	0	6	3
A	__toString()	0	3	1
A	eof()	0	3	1
A	close()	0	3	1
A	isWritable()	0	3	1
A	detach()	0	3	1
A	write()	0	8	2
A	tell()	0	3	1
A	rewind()	0	3	1
A	getSize()	0	3	1
A	isReadable()	0	3	1
A	getContents()	0	5	1
A	__construct()	0	3	1
A	read()	0	13	2
A	isSeekable()	0	3	1

<?php declare(strict_types=1);

namespace One\Http;

use Psr\Http\Message\StreamInterface;

/**
 * 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.
 * @property mixed $hwm
 * @property mixed $buffer
 */
class BufferStream implements StreamInterface
{
    /**
     * High water mark
     * @var int
     */
    private $hwm;

    /**
     * buffer
     * @var string
     */
    private $buffer = '';

    /**
     * @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 false to inform writers to slow down
     *                 until the buffer has been drained by reading from it.
     */
    public function __construct(int $hwm = 16384)
    {
        $this->hwm = $hwm;
    }

    /**
     * @inheritdoc
     */
    public function __toString()
    {
        return $this->getContents();
    }

    /**
     * @inheritdoc
     */
    public function getContents()
    {
        $buffer = $this->buffer;
        $this->buffer = '';
        return $buffer;
    }

    /**
     * @inheritdoc
     */
    public function close(): void
    {
        $this->buffer = '';
    }

    /**
     * @inheritdoc
     */
    public function detach(): void
    {
        $this->close();
    }

    /**
     * @inheritdoc
     */
    public function getSize()
    {
        return strlen($this->buffer);
    }

    /**
     * @inheritdoc
     */
    public function isReadable()
    {
        return true;
    }

    /**
     * @inheritdoc
     */
    public function isWritable()
    {
        return true;
    }

    /**
     * @inheritdoc
     */
    public function isSeekable()
    {
        return false;
    }

    /**
     * @inheritdoc
     */
    public function rewind(): void
    {
        $this->seek(0);
    }

    /**
     * @inheritdoc
     */
    public function seek($offset, $whence = SEEK_SET): void
    {
        throw new \RuntimeException('Cannot seek a BufferStream');
    }

    /**
     * @inheritdoc
     */
    public function eof()
    {
        return strlen($this->buffer) === 0;
    }

    /**
     * @inheritdoc
     */
    public function tell(): void
    {
        throw new \RuntimeException('Cannot determine the position of a BufferStream');
    }

    /**
     * @inheritdoc
     */
    public function read($length)
    {
        $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;
    }

    /**
     * @inheritdoc
     */
    public function write($string)
    {
        $this->buffer .= $string;
        // TODO: What should happen here?
        if (strlen($this->buffer) >= $this->hwm) {
            throw new \RuntimeException('Fail');
        }
        return strlen($string);
    }

    /**
     * @inheritdoc
     */
    public function getMetadata($key = null)
    {
        if ($key === 'hwm') {
            return $this->hwm;
        }
        return $key ? null : [];
    }
}