Blame view

README.md 1.97 KB
e9ecd908   Mihail   init commit
1
  #YII2 Multiparser
41770511   Mihail   edit documentation
2
  ==================
e9ecd908   Mihail   init commit
3
4
5
6
7
8
9
10
11
12
  
  
  Flexible bunch of parsers for YII 2.
  
  ##Requirements##
  
  The Multiparser library has the following requirements:
  
   - artweb/multiparser
  
41770511   Mihail   edit documentation
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
  ##Documentation##
  
  ###1.	Общие сведения###
  Парсер позволяет отпарсить содержимое файла в массив. Парсер поддерживает csv, xml, xls, xlsx, txt расширения. Для каждого расширения необходимо описать правила парсинга в конфигурационном файле (см. п.4). Для одного расширения можно указать несколько сценариев (использование двух сценариев описано в п.3. в вложенном примере к парсеру).
  ###2.	Установка###
  После копирования пакета в проект необходимо установить парсер как компонент YII. Для этого необходимо составить конфигурационный файл – config.php. Примерами могут служить файл который вложен в пакет или конфигурационный файл, который скомпонован для работы примера (п. 3). Далее в файле common/config/main.php – добавить компонент:
  
  ```php
  $mp_configuration = require(path to config.php);
  return [
  
  
          'multiparser'=>[
              'class' => 'yii\multiparser\YiiMultiparser',
              'configuration' => $mp_configuration,
          ],
      ],
  ];
  ```
  После этого парсер можно запускать следующим образом:
  ```php
  $data = Yii::$app->multiparser->parse( file_path );
  ```
  
  ###3.	Установка примера.###
  ###4.	Описание конфигурационного файла.###
  ###5.	Дополнительные возможности.###