Palmtree\Csv\AbstractCsvDocument

Complexity

Total Complexity

16

Size/Duplication

Total Lines	122
Duplicated Lines	0 %

Test Coverage

Coverage

50.98%

Importance

Changes	2
Bugs	0	Features	0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	setEscapeCharacter()	0	7	1
A	setEnclosure()	0	7	1
A	getDelimiter()	0	3	1
A	getEscapeCharacter()	0	3	1
A	setDocument()	0	7	1
A	__destruct()	0	3	1
A	setHasHeaders()	0	5	1
A	getDocument()	0	3	1
A	hasHeaders()	0	3	1
A	closeDocument()	0	3	1
A	setFilePath()	0	5	1
A	createDocument()	0	12	1
A	getEnclosure()	0	3	1
A	setDelimiter()	0	7	1
A	getFilePath()	0	3	1

<?php

declare(strict_types=1);

namespace Palmtree\Csv;

abstract class AbstractCsvDocument
{
    protected string $filePath;
    protected bool $hasHeaders = true;
    protected string $delimiter = ',';
    protected string $enclosure = '"';
    protected string $escapeCharacter = "\0";
    private ?CsvFileObject $document = null;

    public function __construct(string $filePath, bool $hasHeaders = true)
    {
        $this->filePath = $filePath;
        $this->setHasHeaders($hasHeaders);
    }

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

    abstract protected function getOpenMode(): string;

    /**
     * Closes the document by setting our reference to null to ensure its destructor is called.
     */
    public function closeDocument(): void
    {
        $this->document = null;
    }

    public function setDocument(?CsvFileObject $document = null): self
    {
        $this->closeDocument();

        $this->document = $document;

        return $this;
    }

    public function getDocument(): CsvFileObject
    {
        return $this->document ??= $this->createDocument();
    }

    public function getFilePath(): string
    {
        return $this->filePath;
    }

    public function setFilePath(string $filePath): self
    {
        $this->filePath = $filePath;

        return $this;
    }

    public function hasHeaders(): bool
    {
        return $this->hasHeaders;
    }

    public function setHasHeaders(bool $hasHeaders): self
    {
        $this->hasHeaders = $hasHeaders;

        return $this;
    }

    public function getDelimiter(): string
    {
        return $this->delimiter;
    }

    public function setDelimiter(string $delimiter): self
    {
        $this->delimiter = $delimiter;

        $this->getDocument()->setCsvControl($this->delimiter, $this->enclosure, $this->escapeCharacter);

        return $this;
    }

    public function getEnclosure(): string
    {
        return $this->enclosure;
    }

    public function setEnclosure(string $enclosure): self
    {
        $this->enclosure = $enclosure;

        $this->getDocument()->setCsvControl($this->delimiter, $this->enclosure, $this->escapeCharacter);

        return $this;
    }

    public function getEscapeCharacter(): string
    {
        return $this->escapeCharacter;
    }

    public function setEscapeCharacter(string $escapeCharacter): self
    {
        $this->escapeCharacter = $escapeCharacter;

        $this->getDocument()->setCsvControl($this->delimiter, $this->enclosure, $this->escapeCharacter);

        return $this;
    }

    private function createDocument(): CsvFileObject
    {
        $this->closeDocument();

        $document = new CsvFileObject($this->filePath, $this->getOpenMode());

        $document->setFlags(\SplFileObject::READ_CSV);
        $document->setCsvControl($this->delimiter, $this->enclosure, $this->escapeCharacter);

        $this->document = $document;

        return $document;
    }
}