Palmtree\Csv\CsvFileObject

Complexity

Total Complexity

17

Size/Duplication

Total Lines	129
Duplicated Lines	0 %

Test Coverage

Coverage

18.6%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	getLineEnding()	0	3	1
A	fwriteCsv()	0	11	2
A	getCsvString()	0	14	3
A	setLineEnding()	0	5	1
A	getSize()	0	9	2
A	escapeEnclosure()	0	11	3
A	getBytesWritten()	0	3	1
A	__destruct()	0	3	1
A	trimFinalLineEnding()	0	10	3

<?php

namespace Palmtree\Csv;

class CsvFileObject extends \SplFileObject
{
    protected $bytesWritten = 0;
    protected $lineEnding = "\r\n";

    public function fwriteCsv(array $row, $delimiter = null, $enclosure = null)
    {
        $bytes = $this->fwrite($this->getCsvString($row, $delimiter, $enclosure));

        if ($bytes === false) {
            return false;
        }

        $this->bytesWritten += $bytes;

        return $bytes;
    }

    public function __destruct()
    {
        $this->trimFinalLineEnding();
    }

    /**
     * Returns a string representation of a row to be written
     * as a line in a CSV file.
     *
     * @param array $row
     *
     * @param       $delimiter
     * @param       $enclosure
     *
     * @return string
     */
    protected function getCsvString(array $row, $delimiter, $enclosure)
    {
        $csvControl = $this->getCsvControl();

        $delimiter = $delimiter ? : $csvControl[0];
        $enclosure = $enclosure ? : $csvControl[1];

        $result = $enclosure;
        $result .= implode($enclosure . $delimiter . $enclosure, self::escapeEnclosure($row, $enclosure));
        $result .= $enclosure;

        $result .= $this->getLineEnding();

        return $result;
    }

    /**
     * @return int
     */
    public function getBytesWritten()
    {
        return (int)$this->bytesWritten;
    }

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

    /**
     * @param string $lineEnding
     *
     * @return CsvFileObject
     */
    public function setLineEnding($lineEnding)
    {
        $this->lineEnding = $lineEnding;

        return $this;
    }

    public function getSize()
    {
        try {
            $size = parent::getSize();
        } catch (\RuntimeException $exception) {
            $size = $this->fstat()['size'];
        }

        return $size;
    }

    /**
     * Trims the line ending delimiter from the end of the CSV file.
     * RFC-4180 states CSV files should not contain a trailing new line.
     */
    public function trimFinalLineEnding()
    {
        if ($this->getBytesWritten() > 0) {
            // Only trim the file if it ends with the line ending delimiter.
            $length = strlen($this->getLineEnding());

            $this->fseek(-$length, SEEK_END);

            if ($this->fread($length) === $this->getLineEnding()) {
                $this->ftruncate($this->getBytesWritten() - $length);
            }
        }
    }

    /**
     * Escapes the enclosure character recursively.
     * RFC-4180 states the enclosure character (usually double quotes) should be
     * escaped by itself, so " becomes "".
     *
     * @param mixed $data Array or string of data to escape.
     *
     * @param       $enclosure
     *
     * @return mixed Escaped data
     */
    protected static function escapeEnclosure($data, $enclosure)
    {
        if (is_array($data)) {
            foreach ($data as $key => $value) {
                $data[$key] = self::escapeEnclosure($value, $enclosure);
            }
        } else {
            $data = str_replace($enclosure, str_repeat($enclosure, 2), $data);
        }

        return $data;
    }
}