CSVelte\Traits\IsSeekable

Complexity

Total Complexity

3

Size/Duplication

Total Lines	39
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

50%

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	seekLine()	0	4	1
A	assertIsSeekable()	0	6	2
	getName()	0	1	?
	isSeekable()	0	1	?
	seek()	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 IsSeekable Trait.
 *
 * Seek 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 IsSeekable
{
    /**
     * Seek to specific line (beginning).
     *
     * Seek to the line specified by $offset, starting from the $whence line.
     *
     * @param int $offset Offset to seek to
     * @param int $whence Position from whence to seek from
     * @param string $eol The line terminator string/char
     * @return boolean True if successful
     * @throws CSVelte\Exception\NotYetImplementedException because it isn't
     *     implemented yet
     */
    public function seekLine($offset, $whence = SEEK_SET, $eol = PHP_EOL)

The parameter $offset is not used and could be removed.

The parameter $whence is not used and could be removed.

The parameter $eol is not used and could be removed.

    {
        throw new NotYetImplementedException("This method not yet implemented.");
    }

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

    abstract public function getName();

    abstract public function isSeekable();

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

    abstract public function seek($offset, $whence);

}