KLYgarage / onesdk

src/Http/Stream.php

<?php declare(strict_types=1);

namespace One\Http;

class Stream implements \Psr\Http\Message\StreamInterface
{
    /**
     * Stream
     * @var \Psr\Http\Message\StreamInterface
     */
    private $stream;

    /**
     * Size
     * @var int
     */
    private $size;

    /**
     * Seekable
     * @var bool
     */
    private $seekable;

    /**
     * Readable
     * @var bool
     */
    private $readable;

    /**
     * Writeable
     * @var bool
     */
    private $writable;

    /**
     * uri
     * @var \One\Uri
     */
    private $uri;

    /**
     * Custom meta data
     * @var mixed
     */
    private $customMetadata;

    /**
     * array Hash of readable and writable stream types
     * @var array<string[]>
     */
    private static $readWriteHash = [
        'read' => [
            'r' => true, 'w+' => true, 'r+' => true, 'x+' => true, 'c+' => true,
            'rb' => true, 'w+b' => true, 'r+b' => true, 'x+b' => true,
            'c+b' => true, 'rt' => true, 'w+t' => true, 'r+t' => true,
            'x+t' => true, 'c+t' => true, 'a+' => true,
        ],
        'write' => [
            'w' => true, 'w+' => true, 'rw' => true, 'r+' => true, 'x+' => true,
            'c+' => true, 'wb' => true, 'w+b' => true, 'r+b' => true,
            'x+b' => true, 'c+b' => true, 'w+t' => true, 'r+t' => true,
            'x+t' => true, 'c+t' => true, 'a' => true, 'a+' => true,
        ],
    ];

    /**
     * This constructor accepts an associative array of options.
     *
     * - size: (int) If a read stream would otherwise have an indeterminate
     *   size, but the size is known due to foreknowledge, then you can
     *   provide that size, in bytes.
     * - metadata: (array) Any additional metadata to return when the metadata
     *   of the stream is accessed.
     *
     * @param bool|resource $stream  Stream resource to wrap.
     * @param array    $options Associative array of options.
     *
     * @throws \InvalidArgumentException if the stream is not a stream resource
     */
    public function __construct($stream, $options = [])
    {
        if (! is_resource($stream)) {
            throw new \InvalidArgumentException('Stream must be a resource');
        }

        if (isset($options['size'])) {
            $this->size = $options['size'];
        }

        $this->customMetadata = $options['metadata']
        ?? [];

        $this->stream = $stream;

It seems like $stream of type resource is incompatible with the declared type Psr\Http\Message\StreamInterface of property $stream.

        $meta = stream_get_meta_data($this->stream);
        $this->seekable = $meta['seekable'];
        $this->readable = isset(self::$readWriteHash['read'][$meta['mode']]);
        $this->writable = isset(self::$readWriteHash['write'][$meta['mode']]);
        $this->uri = $this->getMetadata('uri');

It seems like $this->getMetadata('uri') can also be of type array. However, the property $uri is declared as type One\Uri. Maybe add an additional type check?

    }

    /**
     * Closes the stream when the destructed
     */
    public function __destruct()
    {
        $this->close();
    }

    /**
     * @inheritDoc
     */
    public function __toString()
    {
        try {
            $this->seek(0);
            return (string) stream_get_contents($this->stream);

$this->stream of type Psr\Http\Message\StreamInterface is incompatible with the type resource expected by parameter $stream of stream_get_contents().

        } catch (\Throwable $e) {
            return '';
        }
    }

    /**
     * @inheritDoc
     */
    public function getContents()
    {
        if (! isset($this->stream)) {
            throw new \RuntimeException('Stream is detached');
        }

        $contents = stream_get_contents($this->stream);

$this->stream of type Psr\Http\Message\StreamInterface is incompatible with the type resource expected by parameter $stream of stream_get_contents().

        if ($contents === false) {
            throw new \RuntimeException('Unable to read stream contents');
        }

        return $contents;
    }

    /**
     * @inheritDoc
     */
    public function close(): void
    {
        if (isset($this->stream)) {
            if (is_resource($this->stream)) {

The condition is_resource($this->stream) is always false.

                fclose($this->stream);
            }
            $this->detach();
        }
    }

    /**
     * @inheritDoc
     */
    public function detach()
    {
        if (! isset($this->stream)) {
            return null;
        }

        $result = $this->stream;
        unset($this->stream);
        $this->size = $this->uri = null;
        $this->readable = $this->writable = $this->seekable = false;

        return $result;

The expression return $result returns the type Psr\Http\Message\StreamInterface which is incompatible with the return type mandated by Psr\Http\Message\StreamInterface::detach() of null|resource.

    }

    /**
     * @inheritDoc
     */
    public function getSize()
    {
        if ($this->size !== null) {
            return $this->size;
        }

        if (! isset($this->stream)) {
            return null;
        }

        // Clear the stat cache if the stream has a URI
        if ($this->uri) {
            clearstatcache(true, $this->uri);
        }

        $stats = fstat($this->stream);

$this->stream of type Psr\Http\Message\StreamInterface is incompatible with the type resource expected by parameter $stream of fstat().

        if (isset($stats['size'])) {
            $this->size = $stats['size'];
            return $this->size;
        }

        return null;
    }

    /**
     * @inheritDoc
     */
    public function isReadable()
    {
        return $this->readable;
    }

    /**
     * @inheritDoc
     */
    public function isWritable()
    {
        return $this->writable;
    }

    /**
     * @inheritDoc
     */
    public function isSeekable()
    {
        return $this->seekable;
    }

    /**
     * @inheritDoc
     */
    public function eof()
    {
        if (! isset($this->stream)) {
            throw new \RuntimeException('Stream is detached');
        }

        return feof($this->stream);

$this->stream of type Psr\Http\Message\StreamInterface is incompatible with the type resource expected by parameter $stream of feof().

    }

    /**
     * @inheritDoc
     */
    public function tell()
    {
        if (! isset($this->stream)) {
            throw new \RuntimeException('Stream is detached');
        }

        $result = ftell($this->stream);

$this->stream of type Psr\Http\Message\StreamInterface is incompatible with the type resource expected by parameter $stream of ftell().

        if ($result === false) {
            throw new \RuntimeException('Unable to determine stream position');
        }

        return $result;
    }

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

    /**
     * @inheritDoc
     */
    public function seek($offset, $whence = SEEK_SET): void
    {
        if (! isset($this->stream)) {
            throw new \RuntimeException('Stream is detached');
        }
        if (! $this->seekable) {
            throw new \RuntimeException('Stream is not seekable');
        }
        if (fseek($this->stream, $offset, $whence) === -1) {

$this->stream of type Psr\Http\Message\StreamInterface is incompatible with the type resource expected by parameter $stream of fseek().

            throw new \RuntimeException('Unable to seek to stream position '
                . $offset . ' with whence ' . var_export($whence, true));
        }
    }

    /**
     * @inheritDoc
     */
    public function read($length)
    {
        if (! isset($this->stream)) {
            throw new \RuntimeException('Stream is detached');
        }
        if (! $this->readable) {
            throw new \RuntimeException('Cannot read from non-readable stream');
        }
        if ($length < 0) {
            throw new \RuntimeException('Length parameter cannot be negative');
        }

        if ($length === 0) {
            return '';
        }

        $string = fread($this->stream, $length);

$this->stream of type Psr\Http\Message\StreamInterface is incompatible with the type resource expected by parameter $stream of fread().

        if ($string === false) {
            throw new \RuntimeException('Unable to read from stream');
        }

        return $string;
    }

    /**
     * @inheritDoc
     */
    public function write($string)
    {
        if (! isset($this->stream)) {
            throw new \RuntimeException('Stream is detached');
        }
        if (! $this->writable) {
            throw new \RuntimeException('Cannot write to a non-writable stream');
        }

        // We can't know the size after writing anything
        $this->size = null;
        $result = fwrite($this->stream, $string);

$this->stream of type Psr\Http\Message\StreamInterface is incompatible with the type resource expected by parameter $stream of fwrite().

        if ($result === false) {
            throw new \RuntimeException('Unable to write to stream');
        }

        return $result;
    }

    /**
     * @inheritDoc
     */
    public function getMetadata($key = null)
    {
        if (! isset($this->stream)) {
            return $key ? null : [];
        } elseif (! $key) {
            return $this->customMetadata + stream_get_meta_data($this->stream);

$this->stream of type Psr\Http\Message\StreamInterface is incompatible with the type resource expected by parameter $stream of stream_get_meta_data().

        } elseif (isset($this->customMetadata[$key])) {
            return $this->customMetadata[$key];
        }

        $meta = stream_get_meta_data($this->stream);

        return $meta[$key] ?? null;
    }
}