CHMLib\Reader\FileReader

Complexity

Total Complexity

18

Size/Duplication

Total Lines	127
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

58.97%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	19	6
A	__destruct()	0	7	2
A	getFilename()	0	4	1
A	setPosition()	0	6	2
A	getPosition()	0	9	2
A	getLength()	0	4	1
A	readString()	0	13	4

<?php

namespace CHMLib\Reader;

use Exception;

/**
 * Read data from a file.
 */
class FileReader extends Reader
{
    /**
     * The file name.
     *
     * @var string
     */
    protected $filename;

    /**
     * The file size.
     *
     * @var int
     */
    protected $length;

    /**
     * The open file descriptor.
     *
     * @var resource
     */
    protected $fd;

    /**
     * Initializes the instance.
     *
     * @param string $filename The file name to be read.
     *
     * @throws \Exception Throws an Exception in case of errors.
     */
    public function __construct($filename)
    {
        $this->filename = $filename;
        if (!is_file($this->filename)) {
            throw new Exception('File not found: '.$this->filename);
        }
        if (!is_readable($this->filename)) {
            throw new Exception('File not readable: '.$this->filename);
        }
        $this->length = @filesize($this->filename);
        if ($this->length === false || $this->length < 0) {
            throw new Exception('Failed to retrieve the size of the file '.$this->filename);
        }
        $this->fd = @fopen($this->filename, 'rb');
        if ($this->fd === false) {
            $this->fd = null;
            throw new Exception('Failed to open file '.$this->filename);
        }
    }

    /**
     * Destruct the instance.
     */
    public function __destruct()
    {
        if (isset($this->fd)) {
            @fclose($this->fd);

It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

            $this->fd = null;
        }
    }

    /**
     * Get the file name.
     *
     * @return string
     */
    public function getFilename()
    {
        return $this->filename;
    }

    /**
     * {@inheritdoc}
     *
     * @see \CHMLib\Reader\Reader::setPosition()
     */
    public function setPosition($position)
    {
        if (@fseek($this->fd, $position, SEEK_SET) !== 0) {
            throw new Exception('Failed to seek file to to position '.$position);
        }
    }

    /**
     * {@inheritdoc}
     *
     * @see \CHMLib\Reader\Reader::getPosition()
     */
    public function getPosition()
    {
        $result = @ftell($this->fd);
        if ($result === false) {
            throw new Exception('Failed to get the current file position');
        }

        return $result;
    }

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

    /**
     * {@inheritdoc}
     *
     * @see \CHMLib\Reader\Reader::readString()
     */
    public function readString($length)
    {
        if ($length === 0) {
            $result = '';
        } else {
            $result = @fread($this->fd, $length);
            if ($result === false || strlen($result) !== $length) {
                throw new Exception('Read after end-of-file');
            }
        }

        return $result;
    }
}