GravityMedia\Stream\Stream

Complexity

Total Complexity

85

Size/Duplication

Total Lines	848
Duplicated Lines	9.67 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

100%

Importance

Changes	14
Bugs	1	Features	6

45 Methods

Rating	Name	Duplication	Size	Complexity
A	fromResource()	0	10	2
A	bindResource()	0	17	2
A	isLocal()	0	4	1
A	isReadable()	0	4	1
A	isWritable()	0	4	1
A	isSeekable()	0	4	1
A	getUri()	0	4	1
A	getStat()	0	15	3
A	getSize()	0	8	2
A	eof()	0	8	2
A	tell()	0	8	2
A	seek()	0	16	4
A	rewind()	0	4	1
A	alignData()	0	10	3
A	read()	17	17	4
A	readUInt8()	0	5	1
A	readInt16()	0	5	1
A	readUInt16()	16	16	3
A	readUInt24()	0	5	1
A	readInt32()	0	5	1
A	readInt48()	0	10	2
A	readUInt48()	0	5	1
A	readInt64()	0	5	1
A	write()	17	17	4
A	writeUInt8()	0	4	1
A	writeInt16()	0	4	1
A	writeUInt16()	0	15	3
A	writeUInt24()	0	4	1
A	writeInt48()	0	8	2
A	writeUInt48()	0	6	1
A	writeInt64()	0	4	1
A	truncate()	0	12	3
A	close()	0	4	1
A	getByteOrder()	0	8	2
A	setByteOrder()	0	10	2
A	getMachineByteOrder()	0	13	3
A	readInt8()	0	5	1
A	readInt24()	0	10	2
A	readUInt32()	16	16	3
A	readUInt64()	16	16	3
A	writeInt8()	0	4	1
A	writeInt24()	0	8	2
A	writeInt32()	0	4	1
A	writeUInt32()	0	15	3
A	writeUInt64()	0	15	3

<?php
/**
 * This file is part of the stream package
 *
 * @author Daniel Schröder <daniel.schroeder@gravitymedia.de>
 */

namespace GravityMedia\Stream;

use GravityMedia\Stream\Exception;

/**
 * Stream class.
 *
 * @package GravityMedia\Stream
 */
class Stream
{
    /**
     * @var string[]
     */
    private static $readModes = ['r', 'w+', 'r+', 'x+', 'c+', 'rb', 'w+b', 'r+b', 'x+b', 'c+b', 'rt', 'w+t',
        'r+t', 'x+t', 'c+t', 'a+'];

    /**
     * @var string[]
     */
    private static $writeModes = ['w', 'w+', 'rw', 'r+', 'x+', 'c+', 'wb', 'w+b', 'r+b', 'x+b', 'c+b', 'w+t',
        'r+t', 'x+t', 'c+t', 'a', 'a+'];

    /**
     * @var resource
     */
    protected $resource;

    /**
     * @var bool
     */
    protected $local;

    /**
     * @var bool
     */
    protected $readable;

    /**
     * @var bool
     */
    protected $writable;

    /**
     * @var bool
     */
    protected $seekable;

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

    /**
     * @var int
     */
    protected $byteOrder;

    /**
     * @var int
     */
    protected static $machineByteOrder;

    /**
     * Create stream object from resource.
     *
     * @param resource $resource
     *
     * @throws Exception\InvalidArgumentException An exception will be thrown for invalid resource arguments.
     *
     * @return static
     */
    public static function fromResource($resource)
    {
        if (!is_resource($resource)) {
            throw new Exception\InvalidArgumentException('Invalid resource');
        }

        $stream = new static();

        return $stream->bindResource($resource);
    }

    /**
     * Bind resource to stream and gather meta data.
     *
     * @param resource $resource The resource to bind to the stream.
     *
     * @throws Exception\InvalidArgumentException An exception will be thrown for invalid resource arguments.
     *
     * @return $this
     */
    public function bindResource($resource)
    {
        if (!is_resource($resource)) {
            throw new Exception\InvalidArgumentException('Invalid resource');
        }

        $metaData = stream_get_meta_data($resource);

        $this->resource = $resource;
        $this->local = stream_is_local($resource);
        $this->readable = in_array($metaData['mode'], self::$readModes);
        $this->writable = in_array($metaData['mode'], self::$writeModes);
        $this->seekable = $metaData['seekable'];
        $this->uri = $metaData['uri'];

        return $this;
    }

    /**
     * Return whether the stream is local.
     *
     * @return bool
     */
    public function isLocal()
    {
        return $this->local;
    }

    /**
     * Return whether read access on the stream will be granted.
     *
     * @return bool
     */
    public function isReadable()
    {
        return $this->readable;
    }

    /**
     * Return whether write access on the stream will be granted.
     *
     * @return bool
     */
    public function isWritable()
    {
        return $this->writable;
    }

    /**
     * Return whether the stream can be sought.
     *
     * @return bool
     */
    public function isSeekable()
    {
        return $this->seekable;
    }

    /**
     * Get the URI or filename associated with the stream.
     *
     * @return string
     */
    public function getUri()
    {
        return $this->uri;
    }

    /**
     * Get the byte order for integer handling.
     *
     * @return int
     */
    public function getByteOrder()
    {
        if (null === $this->byteOrder) {
            return ByteOrder::MACHINE_ENDIAN;
        }

        return $this->byteOrder;
    }

    /**
     * Set the byte order for integer handling.
     *
     * @param int $byteOrder The byte order to set. Must be one of the constants defined by the byte order enum.
     *
     * @throws Exception\InvalidArgumentException An exception will be thrown for invalid byte order arguments.
     *
     * @return $this
     */
    public function setByteOrder($byteOrder)
    {
        if (!in_array($byteOrder, ByteOrder::values(), true)) {
            throw new Exception\InvalidArgumentException('Invalid byte order');
        }

        $this->byteOrder = $byteOrder;

        return $this;
    }

    /**
     * Get the machine byte order.
     *
     * @return int
     */
    public function getMachineByteOrder()
    {
        if (null === static::$machineByteOrder) {
            static::$machineByteOrder = ByteOrder::BIG_ENDIAN;

            list(, $value) = @unpack('s', "\x01\x00");
            if (1 === $value) {
                static::$machineByteOrder = ByteOrder::LITTLE_ENDIAN;
            }
        }

        return static::$machineByteOrder;
    }

    /**
     * Get information about the stream.
     *
     * @param string $info The information to retrieve.
     *
     * @throws Exception\IOException An exception will be thrown for invalid stream resources.
     *
     * @return int
     */
    protected function getStat($info)
    {
        if (!is_resource($this->resource)) {
            throw new Exception\IOException('Invalid stream resource');
        }

        $uri = $this->getUri();
        if (is_string($uri)) {
            clearstatcache(true, $uri);
        }

        $stat = fstat($this->resource);

        return $stat[$info];
    }

    /**
     * Get size of the stream in bytes
     *
     * @throws Exception\BadMethodCallException An exception will be thrown for non-local streams.
     * @throws Exception\IOException            An exception will be thrown for invalid stream resources.
     *
     * @return int
     */
    public function getSize()
    {
        if (!$this->isLocal()) {
            throw new Exception\BadMethodCallException('Stream not local');
        }

        return $this->getStat('size');
    }

    /**
     * Return whether the end of the stream was reached.
     *
     * @throws Exception\IOException An exception will be thrown for invalid stream resources.
     *
     * @return bool
     * @link   http://www.php.net/manual/en/function.feof.php
     */
    public function eof()
    {
        if (!is_resource($this->resource)) {
            throw new Exception\IOException('Invalid stream resource');
        }

        return feof($this->resource);
    }

    /**
     * Return the current position of the stream.
     *
     * @throws Exception\IOException An exception will be thrown for invalid stream resources.
     *
     * @return int
     * @link   http://www.php.net/manual/en/function.ftell.php
     */
    public function tell()
    {
        if (!is_resource($this->resource)) {
            throw new Exception\IOException('Invalid stream resource');
        }

        return ftell($this->resource);
    }

    /**
     * Seek and return the position of the stream.
     *
     * @param int $offset The offset.
     * @param int $whence Either SEEK_SET (which is default), SEEK_CUR or SEEK_END.
     *
     * @throws Exception\BadMethodCallException An exception will be thrown for non-seekable streams.
     * @throws Exception\IOException            An exception will be thrown for invalid stream resources or when the
     *                                          position could not be set.
     *
     * @return int
     * @link   http://www.php.net/manual/en/function.fseek.php
     */
    public function seek($offset, $whence = SEEK_SET)
    {
        if (!$this->isSeekable()) {
            throw new Exception\BadMethodCallException('Stream not seekable');
        }

        if (!is_resource($this->resource)) {
            throw new Exception\IOException('Invalid stream resource');
        }

        if (fseek($this->resource, $offset, $whence) < 0) {
            throw new Exception\IOException('Unexpected result of operation');
        }

        return $this->tell();
    }

    /**
     * Rewind the position of the stream.
     *
     * @throws Exception\BadMethodCallException An exception will be thrown for non-seekable streams.
     * @throws Exception\IOException            An exception will be thrown for invalid stream resources or when the
     *                                          position could not be set.
     *
     * @return int
     */
    public function rewind()
    {
        return $this->seek(0);
    }

    /**
     * Align the data in relation to the byte order.
     *
     * @param string $data
     *
     * @return string
     */
    protected function alignData($data)
    {
        if ($this->getByteOrder() !== ByteOrder::MACHINE_ENDIAN
            && $this->getByteOrder() !== $this->getMachineByteOrder()
        ) {
            return strrev($data);
        }

        return $data;
    }

    /**
     * Read up to $length number of bytes of data from the stream.
     *
     * @param int $length The maximum number of bytes to read.
     *
     * @throws Exception\BadMethodCallException An exception will be thrown for non-readable streams.
     * @throws Exception\IOException            An exception will be thrown for invalid stream resources or when the
     *                                          data could not be read.
     *
     * @return string
     * @link   http://www.php.net/manual/en/function.fread.php
     */
    public function read($length)

This method seems to be duplicated in your project.

    {
        if (!$this->isReadable()) {
            throw new Exception\BadMethodCallException('Stream not readable');
        }

        if (!is_resource($this->resource)) {
            throw new Exception\IOException('Invalid stream resource');
        }

        $data = @fread($this->resource, $length);
        if (false === $data) {
            throw new Exception\IOException('Unexpected result of operation');
        }

        return $data;
    }

    /**
     * Read signed 8-bit integer (char) data from the stream.
     *
     * @throws Exception\BadMethodCallException An exception will be thrown for non-readable streams.
     * @throws Exception\IOException            An exception will be thrown for invalid stream resources or when the
     *                                          data could not be read.
     *
     * @return int
     */
    public function readInt8()
    {
        list(, $value) = @unpack('c', $this->read(1));
        return $value;
    }

    /**
     * Read unsigned 8-bit integer (char) data from the stream.
     *
     * @throws Exception\BadMethodCallException An exception will be thrown for non-readable streams.
     * @throws Exception\IOException            An exception will be thrown for invalid stream resources or when the
     *                                          data could not be read.
     *
     * @return int
     */
    public function readUInt8()
    {
        list(, $value) = @unpack('C', $this->read(1));
        return $value;
    }

    /**
     * Read signed 16-bit integer (short) data from the stream.
     *
     * @throws Exception\BadMethodCallException An exception will be thrown for non-readable streams.
     * @throws Exception\IOException            An exception will be thrown for invalid stream resources or when the
     *                                          data could not be read.
     *
     * @return int
     */
    public function readInt16()
    {
        list(, $value) = @unpack('s', $this->alignData($this->read(2)));
        return $value;
    }

    /**
     * Read unsigned 16-bit integer (short) data from the stream.
     *
     * @throws Exception\BadMethodCallException An exception will be thrown for non-readable streams.
     * @throws Exception\IOException            An exception will be thrown for invalid stream resources or when the
     *                                          data could not be read.
     *
     * @return int
     */
    public function readUInt16()

This method seems to be duplicated in your project.

    {
        switch ($this->getByteOrder()) {
            case ByteOrder::BIG_ENDIAN:
                $format = 'n';
                break;
            case ByteOrder::LITTLE_ENDIAN:
                $format = 'v';
                break;
            default:
                $format = 'S';
        }

        list(, $value) = @unpack($format, $this->read(2));
        return $value;
    }

    /**
     * Read signed 24-bit integer data from the stream.
     *
     * @throws Exception\BadMethodCallException An exception will be thrown for non-readable streams.
     * @throws Exception\IOException            An exception will be thrown for invalid stream resources or when the
     *                                          data could not be read.
     *
     * @return int
     */
    public function readInt24()
    {
        $value = $this->readUInt24();

        if ($value & 0x800000) {
            $value -= 0x1000000;
        }

        return $value;
    }

    /**
     * Read unsigned 24-bit integer data from the stream.
     *
     * @throws Exception\BadMethodCallException An exception will be thrown for non-readable streams.
     * @throws Exception\IOException            An exception will be thrown for invalid stream resources or when the
     *                                          data could not be read.
     *
     * @return int
     */
    public function readUInt24()
    {
        $values = @unpack('C3', $this->alignData($this->read(3)));
        return $values[1] | $values[2] << 8 | $values[3] << 16;
    }

    /**
     * Read signed 32-bit integer (long) data from the stream.
     *
     * @throws Exception\BadMethodCallException An exception will be thrown for non-readable streams.
     * @throws Exception\IOException            An exception will be thrown for invalid stream resources or when the
     *                                          data could not be read.
     *
     * @return int
     */
    public function readInt32()
    {
        list(, $value) = @unpack('l', $this->alignData($this->read(4)));
        return $value;
    }

    /**
     * Read unsigned 32-bit integer (long) data from the stream.
     *
     * @throws Exception\BadMethodCallException An exception will be thrown for non-readable streams.
     * @throws Exception\IOException            An exception will be thrown for invalid stream resources or when the
     *                                          data could not be read.
     *
     * @return int
     */
    public function readUInt32()

This method seems to be duplicated in your project.

    {
        switch ($this->getByteOrder()) {
            case ByteOrder::BIG_ENDIAN:
                $format = 'N';
                break;
            case ByteOrder::LITTLE_ENDIAN:
                $format = 'V';
                break;
            default:
                $format = 'L';
        }

        list(, $value) = @unpack($format, $this->read(4));
        return $value;
    }

    /**
     * Read signed 48-bit integer data from the stream.
     *
     * @throws Exception\BadMethodCallException An exception will be thrown for non-readable streams.
     * @throws Exception\IOException            An exception will be thrown for invalid stream resources or when the
     *                                          data could not be read.
     *
     * @return int
     */
    public function readInt48()
    {
        $value = $this->readUInt48();

        if ($value & 0x800000000000) {
            $value -= 0x1000000000000;
        }

        return $value;
    }

    /**
     * Read unsigned 48-bit integer data from the stream.
     *
     * @throws Exception\BadMethodCallException An exception will be thrown for non-readable streams.
     * @throws Exception\IOException            An exception will be thrown for invalid stream resources or when the
     *                                          data could not be read.
     *
     * @return int
     */
    public function readUInt48()
    {
        $values = @unpack('C6', $this->alignData($this->read(6)));
        return $values[1] | $values[2] << 8 | $values[3] << 16 | $values[4] << 24 | $values[5] << 32 | $values[6] << 40;
    }

    /**
     * Read signed 64-bit integer (long long) data from the stream.
     *
     * @throws Exception\BadMethodCallException An exception will be thrown for non-readable streams.
     * @throws Exception\IOException            An exception will be thrown for invalid stream resources or when the
     *                                          data could not be read.
     *
     * @return int
     */
    public function readInt64()
    {
        list(, $value) = @unpack('q', $this->alignData($this->read(8)));
        return $value;
    }

    /**
     * Read unsigned 64-bit integer (long long) data from the stream.
     *
     * @throws Exception\BadMethodCallException An exception will be thrown for non-readable streams.
     * @throws Exception\IOException            An exception will be thrown for invalid stream resources or when the
     *                                          data could not be read.
     *
     * @return int
     */
    public function readUInt64()

This method seems to be duplicated in your project.

    {
        switch ($this->getByteOrder()) {
            case ByteOrder::BIG_ENDIAN:
                $format = 'J';
                break;
            case ByteOrder::LITTLE_ENDIAN:
                $format = 'P';
                break;
            default:
                $format = 'Q';
        }

        list(, $value) = @unpack($format, $this->read(8));
        return $value;
    }

    /**
     * Write data to the stream and return the number of bytes written.
     *
     * @param string $data The data
     *
     * @throws Exception\BadMethodCallException An exception will be thrown for non-writable streams.
     * @throws Exception\IOException            An exception will be thrown for invalid stream resources or when the
     *                                          data could not be written.
     *
     * @return int
     * @link   http://www.php.net/manual/en/function.fwrite.php
     */
    public function write($data)

This method seems to be duplicated in your project.

    {
        if (!$this->isWritable()) {
            throw new Exception\BadMethodCallException('Stream not writable');
        }

        if (!is_resource($this->resource)) {
            throw new Exception\IOException('Invalid stream resource');
        }

        $length = @fwrite($this->resource, $data);
        if (false === $length) {
            throw new Exception\IOException('Unexpected result of operation');
        }

        return $length;
    }

    /**
     * Write signed 8-bit integer (char) data to the stream
     *
     * @param int $value The value
     *
     * @return int
     */
    public function writeInt8($value)
    {
        return $this->write(pack('c', $value));
    }

    /**
     * Write unsigned 8-bit integer (char) data to the stream
     *
     * @param int $value The value
     *
     * @return int
     */
    public function writeUInt8($value)
    {
        return $this->write(pack('C', $value));
    }

    /**
     * Write signed 16-bit integer (short) data to the stream
     *
     * @param int $value The value
     *
     * @return int
     */
    public function writeInt16($value)
    {
        return $this->write($this->alignData(pack('s', $value)));
    }

    /**
     * Write unsigned 16-bit integer (short) data to the stream
     *
     * @param int $value The value
     *
     * @return int
     */
    public function writeUInt16($value)
    {
        switch ($this->getByteOrder()) {
            case ByteOrder::BIG_ENDIAN:
                $format = 'n';
                break;
            case ByteOrder::LITTLE_ENDIAN:
                $format = 'v';
                break;
            default:
                $format = 'S';
        }

        return $this->write(pack($format, $value));
    }

    /**
     * Write signed 24-bit integer data to the stream
     *
     * @param int $value The value
     *
     * @return int
     */
    public function writeInt24($value)
    {
        if ($value & 0x7fffff) {
            $value += 0x1000000;
        }

        return $this->writeUInt24($value);
    }

    /**
     * Write unsigned 24-bit integer data to the stream
     *
     * @param int $value The value
     *
     * @return int
     */
    public function writeUInt24($value)
    {
        return $this->write($this->alignData(pack('C3', $value, $value >> 8, $value >> 16)));
    }

    /**
     * Write signed 32-bit integer (long) data to the stream
     *
     * @param int $value The value
     *
     * @return int
     */
    public function writeInt32($value)
    {
        return $this->write($this->alignData(pack('l', $value)));
    }

    /**
     * Write unsigned 32-bit integer (long) data to the stream
     *
     * @param int $value The value
     *
     * @return int
     */
    public function writeUInt32($value)
    {
        switch ($this->getByteOrder()) {
            case ByteOrder::BIG_ENDIAN:
                $format = 'N';
                break;
            case ByteOrder::LITTLE_ENDIAN:
                $format = 'V';
                break;
            default:
                $format = 'L';
        }

        return $this->write(pack($format, $value));
    }

    /**
     * Write signed 48-bit integer data to the stream
     *
     * @param int $value The value
     *
     * @return int
     */
    public function writeInt48($value)
    {
        if ($value & 0x7fffffffffff) {
            $value += 0x1000000000000;
        }

        return $this->writeUInt48($value);
    }

    /**
     * Write unsigned 48-bit integer data to the stream
     *
     * @param int $value The value
     *
     * @return int
     */
    public function writeUInt48($value)
    {
        return $this->write($this->alignData(
            pack('C6', $value, $value >> 8, $value >> 16, $value >> 24, $value >> 32, $value >> 40)
        ));
    }

    /**
     * Write signed 64-bit integer (long long) data to the stream
     *
     * @param int $value The value
     *
     * @return int
     */
    public function writeInt64($value)
    {
        return $this->write($this->alignData(pack('q', $value)));
    }

    /**
     * Write unsigned 64-bit integer (long long) data to the stream
     *
     * @param int $value The value
     *
     * @return int
     */
    public function writeUInt64($value)
    {
        switch ($this->getByteOrder()) {
            case ByteOrder::BIG_ENDIAN:
                $format = 'J';
                break;
            case ByteOrder::LITTLE_ENDIAN:
                $format = 'P';
                break;
            default:
                $format = 'Q';
        }

        return $this->write(pack($format, $value));
    }

    /**
     * Truncate the stream to a given length.
     *
     * @param int $size The size to truncate to.
     *
     * @throws Exception\BadMethodCallException An exception will be thrown for non-writable streams.
     * @throws Exception\IOException            An exception will be thrown for invalid stream resources or when the
     *                                          stream could not be truncated.
     *
     * @return bool
     * @link   http://www.php.net/manual/en/function.ftruncate.php
     */
    public function truncate($size)
    {
        if (!$this->isWritable()) {
            throw new Exception\BadMethodCallException('Stream not writable');
        }

        if (!is_resource($this->resource)) {
            throw new Exception\IOException('Invalid stream resource');
        }

        return @ftruncate($this->resource, $size);
    }

    /**
     * Close the stream.
     *
     * @return bool
     * @link   http://www.php.net/manual/en/function.fclose.php
     */
    public function close()
    {
        return @fclose($this->resource);
    }
}