Mihail / yii-multiparser

Commit 53582aebc1fe6b9db6f396672058fb47cfaa286e

Authored by Mihail
1 parent b162c906

edid documentation

Showing 1 changed file with 8 additions and 12 deletions   Show diff stats
Inline Side-by-side
README.md
  Show/Hide comments   View file @53582ae
... ... @@ -42,22 +42,18 @@ $data = Yii::$app->multiparser->parse( file_path );
42 42 3.4. Файлы с данными для парсинга - examples\_data – содержимое необходимо скопировать в test\_data проекта.
43 43  
44 44 ###4. Описание конфигурационного файла.###
45   -<pre>
46 45 Конфигурационный файл представляет собой описание многомерного массива настроек (пример - examples\config.php).
47 46 4.1. Элементами первого уровня массива указываются расширения файлов, с которыми компонент будет работать. Для каждого расширения определяется массив настроек парсинга данного типа файлов. Пакет поддерживает определение нескольких сценариев (несколько параллельных настроек) для одного типа файлов.</p>
48 47 4.2. Сценарии указываются на втором уровне. Так в примере к пакету используются два сценария – template – для файлов приложенных к пакету, и custom – для файлов выбранных пользователем.
49 48 Также на этом уровне можно определить параметры, которые будут доступны для данного расширения. В примере используется эта возможность для определения колонок выбора соответствия отпарсенных колонок с эталонными колонками (параметр - basic_column). Вызов этого параметра можно осуществить следующим образом:
50   -</pre>
51 49 ```php
52 50 Yii::$app->multiparser->getConfiguration($file_extension, 'basic_column');
53 51 ```
54   -<pre>
55   - 4.3. На третьем указываются настройки парсера в виде конфигурационного массива YII.</p>
56   -Данный массив имеет один обязательный элемент с ключем – class, в котором указывается имя парсера, который будет обрабатывать данный тип файлов. Таким образом можно указать свой класс парсера, или использовать классы входящие в пакет, например для csv это класс - </pre>
57   -`yii\multiparser\CsvParser`.
  52 +<p>4.3. На третьем указываются настройки парсера в виде конфигурационного массива YII.</p>
  53 +Данный массив имеет один обязательный элемент с ключем – class, в котором указывается имя парсера, который будет обрабатывать данный тип файлов. Таким образом можно указать свой класс парсера, или использовать классы входящие в пакет, например для csv это класс - `yii\multiparser\CsvParser`.
58 54 При использовании встроенного класса (или наследуемые от него) в данном массиве можно установить следующие атрибуты в качестве настроек:
59   - <p>4.3.1. converter_conf – array. Настройки конвертера. Детально описано в п.5.</p>
60   - <p>4.3.2. keys – array. В этом параметре можно назначить имена колонкам файла. Например:</p>
  55 + <p>&nbsp 4.3.1. converter_conf – array. Настройки конвертера. Детально описано в п.5.</p>
  56 + <p>&nbsp 4.3.2. keys – array. В этом параметре можно назначить имена колонкам файла. Например:</p>
61 57 ```php
62 58 'keys' => [
63 59 0 => 'Description',
... ... @@ -68,10 +64,10 @@ Yii::$app-&gt;multiparser-&gt;getConfiguration($file_extension, &#39;basic_column&#39;);
68 64 ]
69 65 ```
70 66 При такой настройке результирующий массив будет ассоциативным, где в колонке массива с ключем `'Brand'` – будут значения из четвертой колонки файла.
71   - <p>4.3.3. `has_header_row – bolean`. Признак, имеет ли файл заголовок в первой значимой строке, если true - первая значимая строка будет пропущена и не попадет в результирующий массив. По умолчанию – true.</p>
72   - <p>4.3.4. `first_line – integer`. Номер строки с которой начинается парсинг. Если установлен аттрибут has_header_row, тогда следующая строка за данной, будет считаться заголовком и будет пропущена. По умолчанию – 0.</p>
73   - <p>4.3.5. `last_line – integer`. Номер строки по которую будет произведен парсинг. Если = 0, парсинг будет производится до конца файла. По умолчанию – 0.</p>
74   - <p>4.3.6. `min_column_quantity - integer`. Количество заполненных колонок строки начала файла. Если строка имеет не меньше заполненных колонок чем указано в параметре, данная строка считается значимой и с неё начинается парсинг файла. Используется при старте парсинга для определения начала файла. Имеет смысл только при first_line =0. По умолчанию – 5. То есть парсинг начнется с первой строки файла, которая имеет не меньше 5 колонок с данными.</p>
  67 + <p>&nbsp 4.3.3. `has_header_row – bolean`. Признак, имеет ли файл заголовок в первой значимой строке, если true - первая значимая строка будет пропущена и не попадет в результирующий массив. По умолчанию – true.</p>
  68 + <p>&nbsp 4.3.4. `first_line – integer`. Номер строки с которой начинается парсинг. Если установлен аттрибут has_header_row, тогда следующая строка за данной, будет считаться заголовком и будет пропущена. По умолчанию – 0.</p>
  69 + <p>&nbsp 4.3.5. `last_line – integer`. Номер строки по которую будет произведен парсинг. Если = 0, парсинг будет производится до конца файла. По умолчанию – 0.</p>
  70 + <p>&nbsp 4.3.6. `min_column_quantity - integer`. Количество заполненных колонок строки начала файла. Если строка имеет не меньше заполненных колонок чем указано в параметре, данная строка считается значимой и с неё начинается парсинг файла. Используется при старте парсинга для определения начала файла. Имеет смысл только при first_line =0. По умолчанию – 5. То есть парсинг начнется с первой строки файла, которая имеет не меньше 5 колонок с данными.</p>
75 71 <p>4.3.7. `empty_lines_quantity - integer`. Количество пустых строк, что бы определить конец файла. Имеет смысл только при first_line =0. По умолчанию – 3. То есть парсинг закончится на строке, после которой встретятся три пустых строки.</p>
76 72  
77 73 ###5. Конвертер.###
... ...