backend/components/parsers/CsvParser.php

<?php
/**
 */
//@ todo add exceptions
namespace backend\components\parsers;
use Yii;
use yii\base\ErrorException;
use common\components\debug\CustomVarDamp;
class CsvParser implements ParserInterface
{
    /** @var bool
    имеет ли файл заголовок который будет установлен ключами возвращемого массива*/
    public $hasHeaderRow = false;
    /** @var array - массив с заголовком,
     * если не указан и установлено свойство $hasHeaderRow - будет определен автоматически */
    public $keys;
    /** @var экземляр SplFileObject читаемого файла */
    public $file;
    /** @var int - первая строка с которой начинать парсить */
    public $first_line = 0;
    /** @var int - последняя строка до которой  парсить
     * если не указана, то парсинг происходит до конца файла*/
    public $last_line = 0;
    /** @var int - первая колонка файла с которой начнется парсинг */
    public $first_column = 0;
    /** @var string - разделитель csv */
    public $delimiter = ';';
    /** @var bool
    нужно ли искать автоматически первоую значисмую строку (не пустая строка)
     * иначе первая строка будет взята из аттрибута $first_line */
    public $auto_detect_first_line = false;
    /** @var int - количество значимых колонок, что бы определить первую значимую строку
     * используется при автоопределении первой строки*/
    public $min_column_quantity = 5;
    /**
   метод устанвливает нужные настройки объекта SplFileObject, для работы с csv
     */
    public function setup()
    {
        $this->file->setCsvControl($this->delimiter);
        $this->file->setFlags(\SplFileObject::READ_CSV);
        $this->file->setFlags(\SplFileObject::SKIP_EMPTY);
        if ($this->auto_detect_first_line) {
            $this->shiftToFirstValuableLine();
        }
    }
    /**
     * определяет первую значимую строку,
     * считывается файл пока в нем не встретится строка с непустыми колонками
     * в количестве указанном в атрибуте min_column_quantity
     * в результате выполнения курсор ресурса будет находится на последней незначимой строке
     */
    protected function shiftToFirstValuableLine()
    {
        $finish = false;
        while (!$finish) {
            $j = 0;
            $row = $this->readRow();
            if ($row === false) {
                continue;
            }
            for ($i = 1; $i <= count($row); $i++) {
                if ($row[$i - 1] <> '') {
                    $j++;
                }
                if ($j >= $this->min_column_quantity) {
                    break 2;
                }
            }
        }
    }
    /**
     * @return array - итоговый двумерный массив с результатом парсинга
     * метод считывает с открытого файла данные построчно
     */
    public function read()
    {
        $return = [];
        $current_line = 0;
        $this->keys = NULL;
        while (($row = $this->readRow()) !== FALSE) {
            $current_line++;
            if ($this->hasHeaderRow) {
                if ($this->keys === NULL) {
                    $this->keys = array_values($row);
                } else {
                    if (count($this->keys) !== count($row)) {
//
                        Yii::warning("Invalid columns detected on line #$current_line .");
                        return $return;
                    }
                    $return[] = array_combine($this->keys, $row);
                }
            }
            else
            {
                $return[] = $row;
            }
            // если у нас установлен лимит, при  его достижении прекращаем парсинг
            if (($this->last_line) && ($current_line > $this->last_line)) {
                break;
            }
        }
        $this->closeHandler();
        return $return;
    }
    protected function closeHandler()
    {
        $this->file = NULL;
    }
    /**
     * @return array - одномерный массив результата парсинга строки
     */
    protected function readRow()
    {
        $row = $this->file->fgetcsv();
        if (is_array($row) && $this->first_column) {
            $row = array_slice($row, $this->first_column);
        }
        if (is_null($row))
            $row = false;
        return $row;
    }
}