Palmtree\Csv\Reader

Complexity

Total Complexity

21

Size/Duplication

Total Lines	193
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	2

Test Coverage

Coverage

14.04%

Importance

Changes	3
Bugs	0	Features	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	read()	0	6	1
A	getHeaders()	0	4	1
A	getHeader()	0	8	2
A	addFormatter()	0	6	1
A	addFormatters()	0	8	2
A	getFormatter()	0	10	2
A	getEscapeCharacter()	0	4	1
A	setEscapeCharacter()	0	6	1
A	getNextRow()	0	18	2
A	current()	0	4	1
A	next()	0	4	1
A	key()	0	4	1
A	valid()	0	6	1
A	rewind()	0	14	3
A	count()	0	4	1

<?php

namespace Palmtree\Csv;

use Palmtree\Csv\Formatter\FormatterInterface;
use Palmtree\Csv\Formatter\StringFormatter;
use Palmtree\Csv\Row\Row;

/**
 * Reads a CSV file by loading each line into memory
 * one at a time.
 */
class Reader extends AbstractCsv implements \Iterator, \Countable
{
    public static $defaultFormatter = StringFormatter::class;

    protected $fopenMode = 'r';
    /** @var FormatterInterface[] */
    protected $formatters = [];
    /** @var int */
    protected $index = 0;
    /** @var Row */
    protected $headers;
    /** @var Row */
    protected $row;
    /** @var string */
    protected $escapeCharacter = "\0";

    /**
     * @param $file
     *
     * @return Reader
     */
    public static function read($file)
    {
        $csv = new static($file);

        return $csv;
    }

    /**
     * @return Row
     */
    public function getHeaders()
    {
        return $this->headers;
    }

    public function getHeader($key)
    {
        if (!isset($this->headers[$key])) {
            return $key;
        }

        return $this->headers[$key];
    }

    /**
     * @param mixed              $key
     * @param FormatterInterface $formatter Formatter instance.
     *
     * @return $this
     */
    public function addFormatter($key, FormatterInterface $formatter)
    {
        $this->formatters[$key] = $formatter;

        return $this;
    }

    /**
     * @param array|\Traversable $formatters
     *
     * @return $this
     */
    public function addFormatters($formatters)
    {
        foreach ($formatters as $key => $formatter) {
            $this->addFormatter($key, $formatter);
        }

        return $this;
    }

    /**
     * @param mixed $key
     *
     * @return FormatterInterface
     */
    public function getFormatter($key)
    {
        if (!isset($this->formatters[$key])) {
            $class = static::$defaultFormatter;

            $this->formatters[$key] = new $class();
        }

        return $this->formatters[$key];
    }

    /**
     * @return string
     */
    public function getEscapeCharacter()
    {
        return $this->escapeCharacter;
    }

    /**
     * @param string $escapeCharacter
     *
     * @return AbstractCsv
     */
    public function setEscapeCharacter($escapeCharacter)
    {
        $this->escapeCharacter = $escapeCharacter;

        return $this;
    }

    /**
     * Reads the next line in the CSV file
     * and returns a Row object from it.
     *
     * @return Row
     */
    protected function getNextRow()
    {
        $cells = fgetcsv(
            $this->getFileHandle(),
            null,
            $this->getDelimiter(),
            $this->getEnclosure(),
            $this->getEscapeCharacter()
        );

        if (!is_array($cells)) {
            return null;
        }

        $row = new Row($cells, $this);

        return $row;
    }

    /**
     * @inheritDoc
     */
    public function current()
    {
        return $this->row;
    }

    /**
     * @inheritDoc
     */
    public function next()
    {
        ++$this->index;
    }

    /**
     * @inheritDoc
     */
    public function key()
    {
        return $this->index;
    }

    /**
     * @inheritDoc
     */
    public function valid()
    {
        $this->row = $this->getNextRow();

        return $this->row instanceof Row;
    }

    /**
     * @inheritDoc
     */
    public function rewind()
    {
        if ($this->getFileHandle()) {
            rewind($this->getFileHandle());
        } else {
            $this->createFileHandle();
        }

        $this->index = 0;

        if ($this->hasHeaders()) {
            $this->headers = $this->getNextRow();
        }
    }

    /**
     * @inheritDoc
     */
    public function count()
    {
        return count(iterator_to_array($this));
    }
}