Wandu\Http\Psr\Stream\IteratorStream

Complexity

Total Complexity

22

Size/Duplication

Total Lines	170
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

64.71%

Importance

Changes	1
Bugs	0	Features	1

17 Methods

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

<?php
namespace Wandu\Http\Psr\Stream;

use IteratorAggregate;
use Psr\Http\Message\StreamInterface;
use RuntimeException;
use Traversable;

class IteratorStream implements StreamInterface, IteratorAggregate
{
    /** @var \Iterator */
    protected $iterator;

    /** @var string */
    protected $cachedContents;

    /** @var bool */
    protected $isEof = false;

    /**
     * @param \Traversable $iterator
     */
    public function __construct(Traversable $iterator)
    {
        $this->iterator = $iterator;

$iterator is of type object<Traversable>, but the property $iterator was declared to be of type object<Iterator>. Are you sure that you always receive this specific sub-class here, or does it make sense to add an instanceof check?

    }

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

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

    /**
     * {@inheritdoc}
     */
    public function close()
    {
        throw new RuntimeException('can not use the close method.');
    }

    /**
     * {@inheritdoc}
     */
    public function detach()
    {
        throw new RuntimeException('can not use the detach method.');
    }

    /**
     * {@inheritdoc}
     */
    public function getSize()
    {
        throw new RuntimeException('IteratorStream cannot getSize.');
    }

    /**
     * {@inheritdoc}
     */
    public function tell()
    {
        throw new RuntimeException('IteratorStream cannot tell.');
    }

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

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

    /**
     * {@inheritdoc}
     */
    public function seek($offset, $whence = SEEK_SET)
    {
        throw new RuntimeException('IteratorStream cannot seek.');
    }

    /**
     * {@inheritdoc}
     */
    public function rewind()
    {
        $this->isEof = false;
    }

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

    /**
     * {@inheritdoc}
     */
    public function write($string)
    {
        throw new RuntimeException('IteratorStream cannot write.');
    }

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

    /**
     * {@inheritdoc}
     */
    public function read($length)
    {
        throw new RuntimeException('IteratorStream cannot read.');
    }

    /**
     * {@inheritdoc}
     */
    public function getContents()
    {
        if (!$this->eof()) {
            if (!isset($this->cachedContents)) {
                $contents = '';
                foreach ($this->iterator as $value) {
                    $contents .= $value;
                }
                $this->cachedContents = $contents;
            }
            $this->isEof = true;
            return $this->cachedContents;
        }
        return '';
    }

    /**
     * {@inheritdoc}
     */
    public function getMetadata($key = null)
    {
        $metadata = [
            'eof' => $this->eof(),
            'stream_type' => 'iterator',
            'seekable' => false
        ];
        if (!isset($key)) {
            return $metadata;
        }
        if (!array_key_exists($key, $metadata)) {
            return null;
        }
        return $metadata[$key];
    }
}