Версия: 6.x
Базовый класс установщика модуля. Выполняет роль установщика "по-умолчанию" для модуля. Вызывается с параметром $module_name в конструкторе, если у модуля не определн собственный класс МОДУЛЬ/Config/Install
Открытые члены | |
| __construct ($module_name=null) | |
| install () | |
| update () | |
| installAdminMenu () | |
| addError ($message) | |
| getErrors () | |
| insertDemoData ($params=[]) | |
| canInsertDemoData () | |
| importCsv (\RS\Csv\AbstractSchema $schema, $csv_file, $site_id=null, $charset= 'utf-8', $start_pos=false) | |
| deferredAfterInstall ($options) | |
 Открытые члены унаследованные от InstallInterface | |
| insertDemoData () | |
Защищенные члены | |
| findOrmObjects ($base=null, $subfolder= '', $prefix=null) | |
| importCsvFiles ($demo_schemas_array=[], $charset='utf-8', $params=[]) | |
Защищенные данные | |
| $module | |
| $mod_folder | |
| $demo_data_folder = '/config/demo' | |
| $patches | |
| $errors = [] | |
| __construct | ( | $module_name = null | ) |
Конструктор.
| string | $module_name | имя модуля, если не задано, то будет получено из имени класса наследника. |
| addError | ( | $message | ) |
Добавляет ошибку в список
| string | $message |
| canInsertDemoData | ( | ) |
Возвращает true, если модуль может вставить демонстрационные данные
Замещает InstallInterface.
| deferredAfterInstall | ( | $options | ) |
Выполняется, после того, как были установлены все модули. Здесь можно устанавливать настройки, которые связаны с другими модулями.
| array | $options | параметры установки |
Замещает InstallInterface.
|
protected |
Возвращает список ORM объектов, находящихся в указанной папке
| mixed | $base | - путь к корневой папке orm объектов |
| mixed | $subfolder | - путь к объектам, отностельно корневой папки |
| mixed | $prefix | - текст, приписываемый вначале к имени класса |
| \ReflectionException |
| getErrors | ( | ) |
| importCsv | ( | \RS\Csv\AbstractSchema | $schema, |
| $csv_file, | |||
$site_id = null, |
|||
$charset = 'utf-8', |
|||
$start_pos = false |
|||
| ) |
Испортирует CSV с учетом текущего языка. Например, если установлен английский язык то к имени файла будет подставлен постфикс _en. Если такого файла не существует, то импортируется файл $csv_file без постфикса.
| \RS\Csv\AbstractSchema | $schema | - схема импорта |
| string | $csv_file | - путь к файлу без расширения |
| integer | $site_id | - ID сайта на который необходимо загрузить данные. Если null, то текущий сайт. |
| string | $charset | - кодировка в которой будет обрабатыватся файл |
| bool(false) | | integer $start_pos - позиция с которой начинать чтение файла. Если false, то проверка на таймаут будет отключена |
|
protected |
Добавляет демонстрационные данные
| array | $demo_schemas_array | - массив с данными по схеме и файлу импорта, которые необходимо вызвать для установки модуля: первый элемент массива это класс схемы для импорта, а второй имя файла импорта массив[0][0] - Схема импорта массив[0][1] - Имя файла импорта |
| string | $charset | - кодировка в которой будут файлы импорта демо данных |
| null | string | $start_class_name | - класс схемы с которого начинать свой импорт. Если false, то идти по порядку. |
| null | string | $start_file_name | - файл импорта с которого начинать свой импорт. Если false, то идти по порядку. |
| integer | $start_pos | - позиция с которой начинать чтение файла |
| insertDemoData | ( | $params = [] | ) |
Добавляет демонстрационные данные
| array | $params | - произвольные параметры. |
| install | ( | ) |
Выполняет установку модуля
| \ReflectionException |
Замещает InstallInterface.
| installAdminMenu | ( | ) |
Добавляет в меню административной панели
| update | ( | ) |
Обновляет модуль, приводит в соответствие базу данных.
| \ReflectionException |
Замещает InstallInterface.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |