dmt-software / aura-web-psr

src/Message/Stream.php

<?php

namespace DMT\Aura\Psr\Message;

use InvalidArgumentException;
use Psr\Http\Message\StreamInterface;
use RuntimeException;

/**
 * Class Stream
 *
 * @package DMT\Aura\Psr\Message
 */
class Stream implements StreamInterface
{
    /** readable mode */
    const MODE_READABLE = '~^(rw?|[acwx](?=b?\+))$~';
    /** writeable mode */
    const MODE_WRITEABLE = '~^([acwx]|r(?=b?[\+w]))$~';

    /** @var resource $resource */
    private $resource;
    /** @var array $metadata */
    private $metadata;

    /**
     * Stream constructor.
     *
     * @param string|resource $content
     */
    public function __construct($content)
    {
        if (!is_resource($content) && !is_string($content)) {

The condition is_string($content) is always true.

            throw new InvalidArgumentException('content string or resource expected');
        }

        $resource = $content;
        if (is_string($content)) {
            $resource = fopen('data://text/plain,' . $content, 'r+');
        }

        $this->resource = $resource;

It seems like $resource can also be of type string. However, the property $resource is declared as type resource. Maybe add an additional type check?

    }

    /**
     * Reads all data from the stream into a string, from the beginning to end.
     *
     * @return string
     */
    public function __toString()
    {
        try {
            $this->rewind();

            return $this->getContents();
        } catch (RuntimeException $exception) {
            return '';
        }
    }

    /**
     * Returns the remaining contents in a string
     *
     * @return string
     * @throws RuntimeException
     */
    public function getContents()
    {
        if (!is_resource($this->resource)) {
            throw new RuntimeException('could not read stream');
        }

        $contents = stream_get_contents($this->resource);
        if ($contents === false) {
            throw new RuntimeException('error whilst reading stream');
        }

        return $contents;
    }

    /**
     * Closes the stream and any underlying resources.
     *
     * @return void
     */
    public function close()
    {
        if (is_resource($this->resource)) {
            fclose($this->resource);
        }
    }

    /**
     * Separates any underlying resources from the stream.
     *
     * @return resource|null
     */
    public function detach()
    {
        if (!is_resource($this->resource)) {
            return null;
        }

        $handle = $this->resource;
        $this->close();

        return $handle;
    }

    /**
     * Get the size of the stream if known.
     *
     * @return int|null
     */
    public function getSize()
    {
        if (!is_resource($this->resource)) {
            return null;
        }

        return fstat($this->resource)['size'] ?? null;
    }

    /**
     * Returns the current position of the file read/write pointer
     *
     * @return int Position of the file pointer
     * @throws RuntimeException
     */
    public function tell()
    {
        if (!is_resource($this->resource)) {
            throw new RuntimeException('could not read stream');
        }

        $result = ftell($this->resource);
        if ($result === false) {
            throw new RuntimeException('could not determine stream position');
        }

        return $result;
    }

    /**
     * Returns true if the stream is at the end of the stream.
     *
     * @return bool
     */
    public function eof()
    {
        return is_resource($this->resource) ? feof($this->resource) : true;
    }

    /**
     * Returns whether or not the stream is seekable.
     *
     * @return bool
     */
    public function isSeekable()
    {
        return $this->getMetadata('seekable');

The expression return $this->getMetadata('seekable') also could return the type array which is incompatible with the documented return type boolean.

    }

    /**
     * Seek to a position in the stream.
     *
     * @param int $offset Stream offset
     * @param int $whence Specifies how the cursor position will be calculated based on the seek offset.
     * @throws RuntimeException on failure.
     */
    public function seek($offset, $whence = SEEK_SET)
    {
        if (!is_resource($this->resource)) {
            throw new RuntimeException('could not read stream');
        }

        if (!$this->isSeekable()) {
            throw new RuntimeException('stream is not seekable');
        }

        if (fseek($this->resource, $offset, (int)$whence) === -1) {
            throw new RuntimeException('unable to seek stream to position');
        }
    }

    /**
     * Seek to the beginning of the stream.
     *
     * @throws RuntimeException
     */
    public function rewind()
    {
        $this->seek(0);
    }

    /**
     * Returns whether or not the stream is writable.
     *
     * @return bool
     */
    public function isWritable()
    {
        return preg_match('~([acwx]|r(?=b?[+w]))~', $this->getMetadata('mode')) > 0;

It seems like $this->getMetadata('mode') can also be of type array and null; however, parameter $subject of preg_match() does only seem to accept string, maybe add an additional type check?

    }

    /**
     * Write data to the stream.
     *
     * @param string $string The string that is to be written.
     * @return int Returns the number of bytes written to the stream.
     * @throws RuntimeException on failure.
     */
    public function write($string)
    {
        if (!$this->isWritable()) {
            throw new RuntimeException('cannot write to stream');
        }

        $bytes = fwrite($this->resource, $string);
        if ($bytes === false) {
            throw new RuntimeException('error whilst writing to stream');
        }

        return $bytes;
    }

    /**
     * Returns whether or not the stream is readable.
     *
     * @return bool
     */
    public function isReadable()
    {
        return preg_match('~(rw?|[acwx](?=b?\+))~', $this->getMetadata('mode')) > 0;

It seems like $this->getMetadata('mode') can also be of type array and null; however, parameter $subject of preg_match() does only seem to accept string, maybe add an additional type check?

    }

    /**
     * Read data from the stream.
     *
     * @param int $length
     * @return string
     * @throws RuntimeException
     */
    public function read($length)
    {
        if (!$this->isReadable()) {
            throw new RuntimeException('could not read from stream');
        }

        if ((int)$length < 1) {
            return '';
        }

        $part = fread($this->resource, (int)$length);
        if ($part === false) {
            throw new RuntimeException('error whilst reading the stream');
        }

        return $part;
    }

    /**
     * Get stream metadata as an associative array or retrieve a specific key.
     *
     * @param string $key Specific metadata to retrieve.
     * @return array|mixed|null
     */
    public function getMetadata($key = null)
    {
        if (!is_resource($this->resource)) {
            return $key === null ? [] : null;
        }

        if (empty($this->metadata)) {
            $this->metadata = stream_get_meta_data($this->resource);
        }

        if ($key === null) {
            return $this->metadata;
        }

        if (!is_string($key)) {

The condition is_string($key) is always true.

            return null;
        }

        return $this->metadata[$key] ?? null;
    }

    /**
     * Close the internal handle.
     */
    public function __destruct()
    {
        $this->close();
    }
}