Mihail / yii-multiparser

Commit 4177051121d4cf69286f84b87615bab988b9f3ce

Authored by Mihail
1 parent 61323a64

edit documentation

Showing 1 changed file with 31 additions and 0 deletions   Show diff stats
Inline Side-by-side
1 #YII2 Multiparser 1 #YII2 Multiparser
  2 +==================
2 3
3 4
4 Flexible bunch of parsers for YII 2. 5 Flexible bunch of parsers for YII 2.
@@ -9,3 +10,33 @@ The Multiparser library has the following requirements: @@ -9,3 +10,33 @@ The Multiparser library has the following requirements:
9 10
10 - artweb/multiparser 11 - artweb/multiparser
11 12
  13 +##Documentation##
  14 +
  15 +###1. Общие сведения###
  16 +Парсер позволяет отпарсить содержимое файла в массив. Парсер поддерживает csv, xml, xls, xlsx, txt расширения. Для каждого расширения необходимо описать правила парсинга в конфигурационном файле (см. п.4). Для одного расширения можно указать несколько сценариев (использование двух сценариев описано в п.3. в вложенном примере к парсеру).
  17 +###2. Установка###
  18 +После копирования пакета в проект необходимо установить парсер как компонент YII. Для этого необходимо составить конфигурационный файл – config.php. Примерами могут служить файл который вложен в пакет или конфигурационный файл, который скомпонован для работы примера (п. 3). Далее в файле common/config/main.php – добавить компонент:
  19 +
  20 +```php
  21 +$mp_configuration = require(path to config.php);
  22 +return [
  23 + …
  24 + …
  25 + 'multiparser'=>[
  26 + 'class' => 'yii\multiparser\YiiMultiparser',
  27 + 'configuration' => $mp_configuration,
  28 + ],
  29 + ],
  30 +];
  31 +```
  32 +После этого парсер можно запускать следующим образом:
  33 +```php
  34 +$data = Yii::$app->multiparser->parse( file_path );
  35 +```
  36 +
  37 +###3. Установка примера.###
  38 +###4. Описание конфигурационного файла.###
  39 +###5. Дополнительные возможности.###
  40 +
  41 +
  42 +