TableParser.php
7.27 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
<?php
/**
* Created by PhpStorm.
* User: Tsurkanov
* Date: 22.10.2015
* Time: 15:53
*/
namespace common\components\parsers;
use common\components\CustomVarDamp;
abstract class TableParser extends Parser
{
/**
* @var array - текущий отпарсенный ряд
*/
protected $row = [];
/** @var int - первая строка с которой начинать парсить */
public $first_line = 0;
/** @var int - последняя строка до которой парсить
* если не указана, то парсинг происходит до конца файла*/
public $last_line = 0;
/** @var int - первая колонка файла с которой начнется парсинг */
public $first_column = 0;
/** @var bool
нужно ли искать автоматически первоую значисмую строку (не пустая строка)
* иначе первая строка будет взята из аттрибута $first_line */
public $auto_detect_first_line = false;
/** @var int - количество значимых колонок, что бы определить первую значимую строку
* используется при автоопределении первой строки*/
public $min_column_quantity = 5;
/** @var int - количество пустых строк, что бы определить конец файла,
* такое количеество подряд пустых строк считается концом файла*/
public $empty_lines_quantity = 3;
/** @var int - номер текущей строки парсера */
protected $current_row_number = 0;
protected abstract function isEmptyRow();
protected abstract function isEmptyColumn($column_value);
protected abstract function readRow();
protected abstract function setResult();
public function read()
{
if ($this->auto_detect_first_line) {
$this->shiftToFirstValuableLine();
}
// будем считать количество пустых строк подряд - при достижении $empty_lines_quantity - считаем что это конец файла и выходим
$empty_lines = 0;
while ($empty_lines < $this->empty_lines_quantity) {
// прочтем строку из файла
$this->readRow();
if ($this->isEmptyRow()) {
//счетчик пустых строк
$empty_lines++;
$this->current_row_number++;
continue;
}
// уберем пустые колонки из ряда
if ($this->keys === NULL) {
$this->filterRow();
}
$this->adjustRowToSettings();
// строка не пустая, имеем прочитанный массив значений
$this->current_row_number++;
// для первой строки утановим ключи из заголовка
if (!$this->setKeysFromHeader()) {
$this->setResult();
}
// если у нас установлен лимит, при его достижении прекращаем парсинг
if ($this->isLastLine())
break;
// обнуляем счетчик, так как считаюся пустые строки ПОДРЯД
$empty_lines = 0;
}
}
/**
* определяет первую значимую строку,
* считывается файл пока в нем не встретится строка с непустыми колонками
* в количестве указанном в атрибуте min_column_quantity
* в результате выполнения $current_row_number будет находится на последней незначимой строке
*/
protected function shiftToFirstValuableLine()
{
do {
$this->current_row_number++;
$this->readRow();
} while ($this->isEmptyRow());
// @todo - сделать опционально
// код для того что бы парсить первую строку, закомментировано как предполагается что первая значимая строка это заголовок
// $this->current_row_number --;
// $this->file->seek( $this->current_row_number );
}
/**
* @return array - одномерный массив результата парсинга строки
*/
protected function adjustRowToSettings()
{
// если есть заголовок, то перед конвертацией его нужно назначить
if ($this->keys !== NULL) {
// adjust row to keys
$this->adjustRowToKeys();
// назначим заголовок
$this->row = array_combine($this->keys, $this->row);
}
// попытаемся конвертировать прочитанные значения согласно конфигурации котнвертера значений
$this->row = $this->convert($this->row);
// обрежем массив к первой значимой колонке
if ($this->first_column) {
$this->row = array_slice($this->row, $this->first_column);
}
}
protected function setKeysFromHeader()
{
if ($this->has_header_row) {
// в файле есть заголовок, но он еще не назначен - назначим
if ($this->keys === NULL) {
$this->keys = array_values($this->row);
return true;
}
}
return false;
}
protected function filterRow()
{
// если есть заголовок - все значения нужны, не фильтруем
if ($this->has_header_row || !is_array($this->row)) {
return;
}
$this->row = array_filter($this->row, function ($val) {
return !$this->isEmptyColumn($val);
});
}
protected function isLastLine()
{
if (($this->last_line) && ($this->current_row_number > $this->last_line)) {
return true;
}
return false;
}
protected function adjustRowToKeys()
{
//уберем из ряда те колонки которых нет в ключах
$this->row = array_intersect_key($this->row, $this->keys);
$keys_count = count($this->keys);
$column_count = count($this->row);
if ($keys_count != $column_count) {
// найдем колонки которых нет в ряде но есть ключах
$arr_diff = array_diff_key($this->keys, $this->row);
foreach ($arr_diff as $key => $value) {
// колонки которых нет в ряде но есть ключах, добавим их с пустым значением
$this->row[$key] = '';
}
}
}
}