Commit b162c90633eace2f2499b32e8e6af8ea82d05e97
1 parent
f1c8a3ee
edid documentation
Showing
1 changed file
with
7 additions
and
3 deletions
Show diff stats
README.md
| ... | ... | @@ -42,15 +42,19 @@ $data = Yii::$app->multiparser->parse( file_path ); |
| 42 | 42 | 3.4. Файлы с данными для парсинга - examples\_data – содержимое необходимо скопировать в test\_data проекта. |
| 43 | 43 | |
| 44 | 44 | ###4. Описание конфигурационного файла.### |
| 45 | +<pre> | |
| 45 | 46 | Конфигурационный файл представляет собой описание многомерного массива настроек (пример - examples\config.php). |
| 46 | - 4.1. Элементами первого уровня массива указываются расширения файлов, с которыми компонент будет работать. Для каждого расширения определяется массив настроек парсинга данного типа файлов. Пакет поддерживает определение нескольких сценариев (несколько параллельных настроек) для одного типа файлов. | |
| 47 | + 4.1. Элементами первого уровня массива указываются расширения файлов, с которыми компонент будет работать. Для каждого расширения определяется массив настроек парсинга данного типа файлов. Пакет поддерживает определение нескольких сценариев (несколько параллельных настроек) для одного типа файлов.</p> | |
| 47 | 48 | 4.2. Сценарии указываются на втором уровне. Так в примере к пакету используются два сценария – template – для файлов приложенных к пакету, и custom – для файлов выбранных пользователем. |
| 48 | 49 | Также на этом уровне можно определить параметры, которые будут доступны для данного расширения. В примере используется эта возможность для определения колонок выбора соответствия отпарсенных колонок с эталонными колонками (параметр - basic_column). Вызов этого параметра можно осуществить следующим образом: |
| 50 | +</pre> | |
| 49 | 51 | ```php |
| 50 | 52 | Yii::$app->multiparser->getConfiguration($file_extension, 'basic_column'); |
| 51 | 53 | ``` |
| 52 | -<p>4.3. На третьем указываются настройки парсера в виде конфигурационного массива YII.</p> | |
| 53 | -Данный массив имеет один обязательный элемент с ключем – class, в котором указывается имя парсера, который будет обрабатывать данный тип файлов. Таким образом можно указать свой класс парсера, или использовать классы входящие в пакет, например для csv это класс - `yii\multiparser\CsvParser`. | |
| 54 | +<pre> | |
| 55 | + 4.3. На третьем указываются настройки парсера в виде конфигурационного массива YII.</p> | |
| 56 | +Данный массив имеет один обязательный элемент с ключем – class, в котором указывается имя парсера, который будет обрабатывать данный тип файлов. Таким образом можно указать свой класс парсера, или использовать классы входящие в пакет, например для csv это класс - </pre> | |
| 57 | +`yii\multiparser\CsvParser`. | |
| 54 | 58 | При использовании встроенного класса (или наследуемые от него) в данном массиве можно установить следующие атрибуты в качестве настроек: |
| 55 | 59 | <p>4.3.1. converter_conf – array. Настройки конвертера. Детально описано в п.5.</p> |
| 56 | 60 | <p>4.3.2. keys – array. В этом параметре можно назначить имена колонкам файла. Например:</p> | ... | ... |