CsvParser.php
6.75 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
<?php
/**
*/
namespace yii\multiparser;
/**
* Class CsvParser
* @package yii\multiparser
*/
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;
/** @var array - конфигурация конвертера значений */
public $converter_conf = [];
/** @var array - конвертер созданный по конфигурации */
public $converter = NULL;
/**
* метод устанвливает нужные настройки объекта 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();
}
$this->setupConverter();
}
/**
* устанавливает конвертер значений согласно конфигурационным настройкам
*/
public function setupConverter()
{
if (!count($this->converter_conf)) {
$this->converter = new CSVConverter();
if ($this->hasHeaderRow) {
// если у файла есть заголовок, то в результате имеем ассоциативный массив
$this->converter_conf['hasKey'] = 1;
}
$this->converter->configuration = $this->converter_conf;
}
}
/**
* определяет первую значимую строку,
* считывается файл пока в нем не встретится строка с непустыми колонками
* в количестве указанном в атрибуте 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)) {
//
throw new \ErrorException("Invalid columns detected on line # {$current_line}", 0, 1, $this->file->getBasename(), $current_line);
}
$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)) {
// попытаемся конвертировать прочитанные занчения согдасно конфигурации котнвертера значений
// \common\components\CustomVarDamp::dump($row,1);
$row = $this->convert($row);
// \common\components\CustomVarDamp::dump($row,2);
if ($this->first_column) {
$row = array_slice($row, $this->first_column);
}
}
if (is_null($row))
$row = false;
return $row;
}
/**
* @param $arr
* @return mixed
* преобразовует значения прочитанного массива в нужные типы, согласно конфигурации конвертера
*/
protected function convert($arr)
{
$result = $arr;
$converter = $this->converter;
if (!is_null($converter)) {
$result = $converter->convertByConfiguration( $arr );
}
return $result;
}
}