Версия: 6.x
burger close
Класс AbstractInstall
Граф наследования:AbstractInstall:
InstallInterface Install Install Install Install Install Install Install Install Install Install Install Install Install Install Install Install Install Install Install Install

Подробное описание

Базовый класс установщика модуля. Выполняет роль установщика "по-умолчанию" для модуля. Вызывается с параметром $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
Возвращает
bool(false)
canInsertDemoData ( )

Возвращает true, если модуль может вставить демонстрационные данные

Возвращает
bool

Замещает InstallInterface.

deferredAfterInstall (   $options)

Выполняется, после того, как были установлены все модули. Здесь можно устанавливать настройки, которые связаны с другими модулями.

Аргументы
array$optionsпараметры установки
Возвращает
bool

Замещает InstallInterface.

findOrmObjects (   $base = null,
  $subfolder = '',
  $prefix = null 
)
protected

Возвращает список ORM объектов, находящихся в указанной папке

Аргументы
mixed$base- путь к корневой папке orm объектов
mixed$subfolder- путь к объектам, отностельно корневой папки
mixed$prefix- текст, приписываемый вначале к имени класса
Возвращает
array
Исключения
\ReflectionException
getErrors ( )

Возвращает список ошибок

Возвращает
array

Замещает InstallInterface.

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, то проверка на таймаут будет отключена
importCsvFiles (   $demo_schemas_array = [],
  $charset = 'utf-8',
  $params = [] 
)
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- позиция с которой начинать чтение файла
Возвращает
bool|array
insertDemoData (   $params = [])

Добавляет демонстрационные данные

Аргументы
array$params- произвольные параметры.
Возвращает
bool(true) | array Если возвращается array, то
install ( )

Выполняет установку модуля

Возвращает
bool
Исключения
\ReflectionException

Замещает InstallInterface.

installAdminMenu ( )

Добавляет в меню административной панели

Возвращает
void
update ( )

Обновляет модуль, приводит в соответствие базу данных.

Возвращает
bool
Исключения
\ReflectionException

Замещает InstallInterface.

Поля

$demo_data_folder = '/config/demo'
protected
$errors = []
protected
$mod_folder
protected
$module
protected
$patches
protected