Issei\StreamedCsvResponse\CsvWriter

Complexity

Total Complexity

12

Size/Duplication

Total Lines	88
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

97.22%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	15	3
A	__destruct()	0	4	1
A	writeRow()	0	16	3
B	formatCell()	0	20	5

<?php

namespace Issei\StreamedCsvResponse;

/**
 * Writes the csv row to stdout.
 *
 * {@internal Don't use this in user-land code }}
 *
 * @author Issei Murasawa <issei.m7@gmail.com>
 */
class CsvWriter
{
    /**
     * @var resource
     */
    private $out;

    /**
     * @var string|null
     */
    private $encodeTo;

    /**
     * @var string[]
     */
    private $charsNeedingEnclosing;

    public function __construct($encodeTo = null)
    {
        $this->out = fopen('php://output', 'wt');

        if (null !== $encodeTo && 'UTF-8' !== strtoupper($encodeTo)) {
            $this->encodeTo = $encodeTo;
        }

        $this->charsNeedingEnclosing = array(
            ',',  // separator
            '"',  // enclosure & escaper
            "\n",
            "\r",
        );
    }

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

    /**
     * Writes the csv to stdout.
     *
     * @param array|\Traversable $row
     */
    public function writeRow($row)
    {
        Assert::isIterable($row, 'Every value of $rows should be an array or an instance of \Traversable.');

        $separator = '';

        foreach ($row as $cell) {
            fwrite($this->out, $separator . $this->formatCell($cell));

            if ('' === $separator) {
                $separator = ',';
            }
        }

        fwrite($this->out, "\r\n");
    }

    /**
     * Returns the formatted cell.
     *
     * @param string $cell
     *
     * @return string
     */
    private function formatCell($cell)
    {
        if ('' === $cell) {
            return $cell;
        }

        // auto encoding
        if (null !== $this->encodeTo) {
            $cell = mb_convert_encoding($cell, $this->encodeTo, 'UTF-8');
        }

        foreach ($this->charsNeedingEnclosing as $charNeedingEnclosing) {
            if (false !== strpos($cell, $charNeedingEnclosing)) {
                // enclosing
                return '"' . str_replace('"', '""', $cell) . '"';
            }
        }

        return $cell;
    }
}