Palmtree\Csv\Writer

Complexity

Total Complexity

15

Size/Duplication

Total Lines	101
Duplicated Lines	0 %

Test Coverage

Coverage

47.5%

Importance

Changes	17
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	write()	0	5	1
A	getContents()	0	15	3
A	setHeaders()	0	7	1
A	setData()	0	9	2
A	getOpenMode()	0	3	1
A	addRow()	0	14	4
A	addHeader()	0	9	1
A	addRows()	0	4	2

<?php

declare(strict_types=1);

namespace Palmtree\Csv;

/**
 * Writes an array to a CSV file.
 */
class Writer extends AbstractCsvDocument
{
    private array $headers = [];

    public static function write(string $filePath, array $data): void
    {
        $writer = new self($filePath);
        $writer->setData($data);
        $writer->closeDocument();
    }

    /**
     * Sets headers and all rows on the CSV file and
     * then closes the file handle.
     *
     * Uses the first row's keys as headers.
     */
    public function setData(array $data): self
    {
        if ($this->hasHeaders) {
            $this->setHeaders(array_keys(reset($data)));
        }

        $this->addRows($data);

        return $this;
    }

    public function setHeaders(array $headers): self
    {
        $this->headers = $headers;

        $this->addRow($this->headers);

        return $this;
    }

    public function addHeader(string $header): self
    {
        $headers = $this->headers;

        $headers[] = $header;

        $this->setHeaders($headers);

        return $this;
    }

    /**
     * Adds multiple rows of data to the CSV file.
     */
    public function addRows(array $rows): void
    {
        foreach ($rows as $row) {
            $this->addRow($row);
        }
    }

    /**
     * Adds a row of data to the CSV file.
     *
     * @param array $row Row of data to add to the file.
     *
     * @return bool Whether the row was written to the file.
     */
    public function addRow(array $row): bool
    {
        if ($this->hasHeaders && empty($this->headers)) {
            $this->setHeaders(array_keys($row));
        }

        $result = $this->getDocument()->fwriteCsv($row);

        if ($result === 0) {
            // @todo: handle error
            return false;
        }

        return true;
    }

    public function getContents(): string
    {
        $this->getDocument()->trimFinalLineEnding();

        if (($size = $this->getDocument()->getSize()) === 0) {
            return '';
        }

        $this->getDocument()->fseek(0);

        if (($data = $this->getDocument()->fread($size)) === false) {
            return '';
        }

        return $data;
    }

    protected function getOpenMode(): string
    {
        return 'w+';
    }
}