From b162c90633eace2f2499b32e8e6af8ea82d05e97 Mon Sep 17 00:00:00 2001 From: Mihail Date: Mon, 28 Dec 2015 15:44:03 +0200 Subject: [PATCH] edid documentation --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f11cddb..be70167 100644 --- a/README.md +++ b/README.md @@ -42,15 +42,19 @@ $data = Yii::$app->multiparser->parse( file_path ); 3.4. Файлы с данными для парсинга - examples\_data – содержимое необходимо скопировать в test\_data проекта. ###4. Описание конфигурационного файла.### +
 Конфигурационный файл представляет собой описание многомерного массива настроек (пример - examples\config.php). 
-    4.1. Элементами первого уровня массива указываются расширения файлов, с которыми компонент будет работать. Для каждого расширения определяется массив настроек парсинга данного типа файлов. Пакет поддерживает определение нескольких сценариев (несколько параллельных настроек) для одного типа файлов. 
+    4.1. Элементами первого уровня массива указываются расширения файлов, с которыми компонент будет работать. Для каждого расширения определяется массив настроек парсинга данного типа файлов. Пакет поддерживает определение нескольких сценариев (несколько параллельных настроек) для одного типа файлов.

4.2. Сценарии указываются на втором уровне. Так в примере к пакету используются два сценария – template – для файлов приложенных к пакету, и custom – для файлов выбранных пользователем. Также на этом уровне можно определить параметры, которые будут доступны для данного расширения. В примере используется эта возможность для определения колонок выбора соответствия отпарсенных колонок с эталонными колонками (параметр - basic_column). Вызов этого параметра можно осуществить следующим образом: +
```php Yii::$app->multiparser->getConfiguration($file_extension, 'basic_column'); ``` -

4.3. На третьем указываются настройки парсера в виде конфигурационного массива YII.

-Данный массив имеет один обязательный элемент с ключем – class, в котором указывается имя парсера, который будет обрабатывать данный тип файлов. Таким образом можно указать свой класс парсера, или использовать классы входящие в пакет, например для csv это класс - `yii\multiparser\CsvParser`. +
+    4.3. На третьем указываются настройки парсера в виде конфигурационного массива YII.

+Данный массив имеет один обязательный элемент с ключем – class, в котором указывается имя парсера, который будет обрабатывать данный тип файлов. Таким образом можно указать свой класс парсера, или использовать классы входящие в пакет, например для csv это класс -
+`yii\multiparser\CsvParser`. При использовании встроенного класса (или наследуемые от него) в данном массиве можно установить следующие атрибуты в качестве настроек:

4.3.1. converter_conf – array. Настройки конвертера. Детально описано в п.5.

4.3.2. keys – array. В этом параметре можно назначить имена колонкам файла. Например:

-- libgit2 0.21.4