fab2s\YaEtl\Loaders\File\CsvExtractor

Complexity

Total Complexity

12

Size/Duplication

Total Lines	79
Duplicated Lines	0 %

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	writeCsvLine()	0	3	1
B	getTraversable()	0	22	6
A	__construct()	0	4	1
A	getFirstRecord()	0	16	4

<?php

/*
 * This file is part of YaEtl.
 *     (c) Fabrice de Stefanis / https://github.com/fab2s/YaEtl
 * This source file is licensed under the MIT license which you will
 * find in the LICENSE file or at https://opensource.org/licenses/MIT
 */

namespace fab2s\YaEtl\Loaders\File;

use fab2s\NodalFlow\NodalFlowException;
use fab2s\NodalFlow\YaEtlException;
use fab2s\YaEtl\Extractors\File\FileExtractorAbstract;
use fab2s\YaEtl\Traits\CsvHandlerTrait;

/**
 * Class CsvExtractor
 */
class CsvExtractor extends FileExtractorAbstract
{
    use CsvHandlerTrait;

    /**
     * CsvLoader constructor.
     *
     * @param resource|string $input
     * @param string|null     $delimiter
     * @param string|null     $enclosure
     * @param string|null     $escape
     *
     * @throws NodalFlowException
     * @throws YaEtlException
     */
    public function __construct($input, $delimiter = null, $enclosure = null, $escape = null)
    {
        parent::__construct($input);
        $this->initCsvOptions($delimiter, $enclosure, $escape);
    }

    /**
     * @param mixed $param
     *
     * @return \Generator
     */
    public function getTraversable($param = null)
    {
        if (!$this->extract($param) || false === ($firstRecord = $this->getFirstRecord())) {
            return;
        }

        $firstRecord = str_getcsv($firstRecord, $this->delimiter, $this->enclosure, $this->escape);
        if ($this->useHeader) {
            $this->header = $firstRecord;
        } else {
            yield $firstRecord;
        }

        while (false !== ($record = fgetcsv($this->handle, 0, $this->delimiter, $this->enclosure, $this->escape))) {
            if ($this->useHeader) {
                $record = array_combine($this->header, $record);

It seems like $this->header can also be of type null; however, parameter $keys of array_combine() does only seem to accept array, maybe add an additional type check?

            }

            yield $record;
        }

        $this->releaseHandle();
    }

    /**
     * @return string|false
     */
    protected function getFirstRecord()
    {
        while (false !== ($line = fgets($this->handle))) {

It seems like $this->handle can also be of type false; however, parameter $handle of fgets() does only seem to accept resource, maybe add an additional type check?

            if ($line = $this->trimBom(trim($line))) {
                // obey excel sep
                if (strpos($line, 'sep=') === 0) {
                    $this->useSep    = true;
                    $this->delimiter = $line[4];
                    continue;
                }

                return $line;
            }
        }

        return false;
    }

    /**
     * @param array $record
     *
     * @return bool|int
     */
    protected function writeCsvLine(array $record)
    {
        return fputcsv($this->handle, $record, $this->delimiter, $this->enclosure, $this->escape);

It seems like $this->handle can also be of type false; however, parameter $handle of fputcsv() does only seem to accept resource, maybe add an additional type check?

    }
}