CSVelte\Traits\IsReadable

Complexity

Total Complexity

9

Size/Duplication

Total Lines	62
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
C	readLine()	0	24	7
A	assertIsReadable()	0	6	2
	getName()	0	1	?
	isReadable()	0	1	?
	read()	0	1	?
	eof()	0	1	?

<?php
/**
 * CSVelte: Slender, elegant CSV for PHP.
 *
 * Inspired by Python's CSV module and Frictionless Data and the W3C's CSV
 * standardization efforts, CSVelte was written in an effort to take all the
 * suck out of working with CSV.
 *
 * @version   v0.2
 * @copyright Copyright (c) 2016 Luke Visinoni <luke.visinoni@gmail.com>
 * @author    Luke Visinoni <luke.visinoni@gmail.com>
 * @license   https://github.com/deni-zen/csvelte/blob/master/LICENSE The MIT License (MIT)
 */
namespace CSVelte\Traits;

use CSVelte\Exception\IOException;

/**
 * IO IsReadable Trait.
 *
 * Read methods shared between CSVelte\IO classes.
 *
 * @package    CSVelte
 * @subpackage CSVelte\Traits
 * @copyright  (c) 2016, Luke Visinoni <luke.visinoni@gmail.com>
 * @author     Luke Visinoni <luke.visinoni@gmail.com>
 * @since      v0.2
 */
trait IsReadable
{
    /**
     * Read single line.
     * Read the next line from the file (moving the internal pointer down a line).
     * Returns multiple lines if newline character(s) fall within a quoted string.
     *
     * @param string|array A string or array of strings to be used as EOL char/sequence
     * @param int Maximum number of bytes to return (line will be truncated to this -1 if set)
     * @return string A single line read from the file.
     * @throws CSVelte\Exception\IOException
     * @todo Should this add a newline if maxlength is reached?
     * @todo I could actually buffer this by reading x chars at a time and doing
     *     the same thing with looping char by char if this is too IO intensive.
     */
    public function readLine($eol = PHP_EOL, $maxLength = null)
    {
        $size = 0;
        $buffer = false;
        if (!is_array($eol)) $eol = array($eol);
        while (!$this->eof()) {
            // Using a loose equality here to match on '' and false.
            if (null == ($byte = $this->read(1))) {
                return $buffer;
            }
            $buffer .= $byte;
            // Break when a new line is found or the max length - 1 is reached
            if (array_reduce($eol, function($carry, $eol) use ($buffer) {
                if (!$carry) {
                    $eollen = 0 - strlen($eol);
                    return (substr($buffer, $eollen) === $eol);
                }
                return true;
            }, false) || ++$size === $maxLength - 1) {
                break;
            }
        }
        return $buffer;
    }

    /**
     * Assert that this file/stream object is readable.
     *
     * @return void
     * @throws CSVelte\Exception\IOException if stream isn't readable
     */
    protected function assertIsReadable()
    {
        if (!$this->isReadable()) {
            throw new IOException("Stream not readable: " . $this->getName(), IOException::ERR_NOT_READABLE);
        }
    }

    abstract public function getName();

    abstract public function isReadable();

Using PHP4-style constructors that are named like the class is not recommend; better use the more explicit __construct method.

    abstract public function read($length);

    abstract public function eof();

}