CHMLib\Reader\StringReader

Complexity

Total Complexity

9

Size/Duplication

Total Lines	87
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

50%

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	readString()	0	13	3
A	setPosition()	0	7	3
A	getPosition()	0	4	1
A	getLength()	0	4	1

<?php

namespace CHMLib\Reader;

use Exception;

/**
 * Read data from a raw string of bytes.
 */
class StringReader extends Reader
{
    /**
     * The raw string of bytes.
     *
     * @var string
     */
    protected $string;

    /**
     * The current position in the string.
     *
     * @var int
     */
    protected $position;

    /**
     * The string length.
     *
     * @var int
     */
    protected $length;

    /**
     * Initializes the instance.
     *
     * @param string $string The raw string containing the data to be read.
     */
    public function __construct($string)
    {
        $this->string = (string) $string;
        $this->position = 0;
        $this->length = strlen($this->string);
    }

    /**
     * {@inheritdoc}
     *
     * @see Reader::setPosition()
     */
    public function setPosition($position)
    {
        if ($position < 0 || $position > $this->length) {
            throw new Exception('Failed to seek string to to position '.$position);
        }
        $this->position = $position;
    }

    /**
     * {@inheritdoc}
     *
     * @see Reader::getPosition()
     */
    public function getPosition()
    {
        return $this->position;
    }

    /**
     * {@inheritdoc}
     *
     * @see Reader::getLength()
     */
    public function getLength()
    {
        return $this->length;
    }

    /**
     * {@inheritdoc}
     *
     * @see Reader::readString()
     */
    public function readString($length)
    {
        if (!$length) {
            $result = '';
        } elseif ($this->position + $length > $this->length) {
            throw new Exception('Read after end-of-string');
        } else {
            $result = substr($this->string, $this->position, $length);
            $this->position += $length;
        }

        return $result;
    }
}