kalanis\RemoteRequestPsr\Content\Stream

Complexity

Total Complexity

32

Size/Duplication

Total Lines	160
Duplicated Lines	0 %

Test Coverage

Coverage

95.95%

Importance

Changes	1
Bugs	0	Features	0

18 Methods

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

<?php

namespace kalanis\RemoteRequestPsr\Content;


use kalanis\RemoteRequest\RequestException;
use Psr\Http\Message\StreamInterface;
use RuntimeException;


/**
 * Class Address
 * @package kalanis\RemoteRequestPsr\Content
 * Simple implementation of URI interface as address
 *
 * @todo: note: for immutability it might need a pair of classes
 *      - one for immutability with interface and other with stored data; but not now
 */
class Stream implements StreamInterface
{
    /** @var resource|null */
    protected $localStream = null;
    protected int $offset = 0;

    /**
     * @param resource|string|int|float|null $source
     * @throws RequestException
     */
    public function __construct($source)
    {
        $this->localStream = is_resource($source) ? $source : $this->toStream($source);
    }

    /**
     * @param string|int|float|null $content
     * @throws RequestException
     * @return resource
     */
    protected function toStream($content)
    {
        $stream = fopen('php://temp', 'rb+');
        if (false === $stream) {
            // @codeCoverageIgnoreStart
            throw new RequestException('Problem with php internals');
        }
        // @codeCoverageIgnoreEnd
        fwrite($stream, strval($content));
        return $stream;
    }

    public function __toString(): string
    {
        try {
            return strval(stream_get_contents($this->getLocalStream(), -1, 0));
        } catch (RuntimeException $ex) {
            return '';
        }
    }

    public function close(): void
    {
        try {
            fclose($this->getLocalStream());
            $this->localStream = null;
            $this->offset = 0;
        } catch (RuntimeException $ex) {
            // nothing to do
        }
    }

    public function detach()
    {
        $stream = $this->localStream;
        $this->localStream = null;
        $this->offset = 0;
        return $stream;
    }

    public function getSize(): ?int
    {
        try {
            $data = fstat($this->getLocalStream());
            return (false !== $data) ? $data['size'] : null;
        } catch (RuntimeException $ex) {
            return null;
        }
    }

    public function tell(): int
    {
        return intval(ftell($this->getLocalStream()));
    }

    public function eof(): bool
    {
        return feof($this->getLocalStream());
    }

    public function isSeekable(): bool
    {
        $meta = stream_get_meta_data($this->getLocalStream());
        return $meta['seekable'];
    }

    public function seek(int $offset, int $whence = SEEK_SET): void
    {
        fseek($this->getLocalStream(), $offset, $whence);
        $this->offset = $this->tell();
    }

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

    public function isWritable(): bool
    {
        $meta = stream_get_meta_data($this->getLocalStream());
        return (
            (false !== stripos($meta['mode'], 'w'))
            || (false !== stripos($meta['mode'], 'a'))
            || (false !== stripos($meta['mode'], 'x'))
            || (false !== stripos($meta['mode'], 'c'))
        );
    }

    public function write(string $string): int
    {
        return intval(fwrite($this->getLocalStream(), $string));
    }

    public function isReadable(): bool
    {
        $meta = stream_get_meta_data($this->getLocalStream());
        return (
            (false !== stripos($meta['mode'], 'r'))
            || (false !== stripos($meta['mode'], '+'))
        );
    }

    public function read(int $length): string
    {
        $data = strval(stream_get_contents($this->getLocalStream(), $length, $this->offset));
        $this->offset += strlen($data);
        return $data;
    }

    public function getContents(): string
    {
        $data = strval(stream_get_contents($this->getLocalStream(), -1, $this->offset));
        $this->offset += strlen($data);
        return $data;
    }

    public function getMetadata(?string $key = null)
    {
        try {
            $data = stream_get_meta_data($this->getLocalStream());
            if (!is_null($key)) {
                return (isset($data[$key])) ? $data[$key] : null;
            } else {
                return $data;
            }
        } catch (RuntimeException $ex) {
            return null;
        }
    }

    /**
     * @throws RuntimeException
     * @return resource
     */
    protected function getLocalStream()
    {
        if (empty($this->localStream)) {
            throw new RuntimeException('No stream available!');
        }
        return $this->localStream;
    }
}