Mihail / yii-multiparser

Commit f9c436f1068e9b8f6ac6751332dd060aa04d03af

Authored by Mihail
1 parent 6d2c80fe

edid 4 chapter of documentation

Showing 1 changed file with 9 additions and 9 deletions   Show diff stats
Inline Side-by-side
README.md
  Show/Hide comments   View file @f9c436f
... ... @@ -51,10 +51,10 @@ Yii::$app->multiparser->getConfiguration($file_extension, 'basic_column');
51 51 ```
52 52  
53 53 4.3. На третьем указываются настройки парсера в виде конфигурационного массива YII.
54   -Данный массив имеет один обязательный элемент с ключем – class, в котором указывается имя парсера, который будет обрабатывать данный тип файлов. Таким образом можно указать свой класс парсера, или использовать классы входящие в пакет, например для csv это класс - 'yii\multiparser\CsvParser'.
  54 +Данный массив имеет один обязательный элемент с ключем – class, в котором указывается имя парсера, который будет обрабатывать данный тип файлов. Таким образом можно указать свой класс парсера, или использовать классы входящие в пакет, например для csv это класс - `yii\multiparser\CsvParser`.
55 55 При использовании встроенного класса (или наследуемые от него) в данном массиве можно установить следующие атрибуты в качестве настроек:
56   -4.3.1. converter_conf – array. Настройки конвертера. Детально описано в п.5.
57   -4.3.2. keys – array. В этом параметре можно назначить имена колонкам файла. Например:
  56 +- 4.3.1. converter_conf – array. Настройки конвертера. Детально описано в п.5.
  57 +- 4.3.2. keys – array. В этом параметре можно назначить имена колонкам файла. Например:
58 58 ```php
59 59 'keys' => [
60 60 0 => 'Description',
... ... @@ -64,12 +64,12 @@ Yii::$app->multiparser->getConfiguration($file_extension, 'basic_column');
64 64 4 => 'Count',
65 65 ]
66 66 ```
67   -При такой настройке результирующий массив будет ассоциативным, где в колонке массива с ключем ‘'Brand'’ – будут значения из четвертой колонки файла.
68   -4.3.3. has_header_row – bolean. Признак, имеет ли файл заголовок в первой значимой строке, если true - первая значимая строка будет пропущена и не попадет в результирующий массив. По умолчанию – true.
69   -4.3.4. first_line – integer. Номер строки с которой начинается парсинг. Если установлен аттрибут has_header_row, тогда следующая строка за данной, будет считаться заголовком и будет пропущена. По умолчанию – 0.
70   -4.3.5. last_line – integer. Номер строки по которую будет произведен парсинг. Если = 0, парсинг будет производится до конца файла. По умолчанию – 0.
71   -4.3.6. min_column_quantity - integer. Количество заполненных колонок строки начала файла. Если строка имеет не меньше заполненных колонок чем указано в параметре, данная строка считается значимой и с неё начинается парсинг файла. Используется при старте парсинга для определения начала файла. Имеет смысл только при first_line =0. По умолчанию – 5. То есть парсинг начнется с первой строки файла, которая имеет не меньше 5 колонок с данными.
72   -4.3.7. empty_lines_quantity - integer. Количество пустых строк, что бы определить конец файла. Имеет смысл только при first_line =0. По умолчанию – 3. То есть парсинг закончится на строке, после которой встретятся три пустых строки.
  67 +При такой настройке результирующий массив будет ассоциативным, где в колонке массива с ключем `'Brand'` – будут значения из четвертой колонки файла.
  68 +- 4.3.3. `has_header_row – bolean`. Признак, имеет ли файл заголовок в первой значимой строке, если true - первая значимая строка будет пропущена и не попадет в результирующий массив. По умолчанию – true.
  69 +- 4.3.4. `first_line – integer`. Номер строки с которой начинается парсинг. Если установлен аттрибут has_header_row, тогда следующая строка за данной, будет считаться заголовком и будет пропущена. По умолчанию – 0.
  70 +- 4.3.5. `last_line – integer`. Номер строки по которую будет произведен парсинг. Если = 0, парсинг будет производится до конца файла. По умолчанию – 0.
  71 +- 4.3.6. `min_column_quantity - integer`. Количество заполненных колонок строки начала файла. Если строка имеет не меньше заполненных колонок чем указано в параметре, данная строка считается значимой и с неё начинается парсинг файла. Используется при старте парсинга для определения начала файла. Имеет смысл только при first_line =0. По умолчанию – 5. То есть парсинг начнется с первой строки файла, которая имеет не меньше 5 колонок с данными.
  72 +- 4.3.7. `empty_lines_quantity - integer`. Количество пустых строк, что бы определить конец файла. Имеет смысл только при first_line =0. По умолчанию – 3. То есть парсинг закончится на строке, после которой встретятся три пустых строки.
73 73  
74 74 ###5. Конвертер.###
75 75 В состав пакета входит конвертер который позволяет осуществлять преобразования прочитанных данных в процессе парсинга. Таким образом можно получить очищенные и преобразованные данные в результирующем массиве. Простейшим примером, такого преобразования может служит смена кодировки. По умолчанию конвертер входящий в пакет осуществляет смену кодировки с 'windows-1251' в 'UTF-8'.
... ...