Граф наследования:Api:

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

API функции, необходимые для инсталяции системы

Открытые члены
	__construct ()

	getLicenseText ($lang)

	checkDbConnect ()

	resetInstall ($config)

	getInstallSteps ($modules, $config)

	doAfterInstall ()

	doAllowDbWrite ()

	progress ()

	doInsertDemoData ($module, $params=[])

	doInstall ($module)

	installComplete ()

	getInstallStack ()

	removeLocalStorage ()

	setKey ($key, $value)

	setMaxAllowStep ($step)

	getKey ($key=null, $default=null)

	checkServerParams ()

	checkGDSupport ()

	checkZipSupport ()

	checkmbSupport ()

	checkCrypt ()

	checkPhpVersion ()

	checkMysqlSupport ()

	checkSafeMode ()

	checkUploadFiles ()

	checkCurl ()

	checkWriteRights ()

Открытые члены унаследованные от BaseModel
	addError ($message, $fieldname=null, $form=null)

	hasError ()

	getErrors ()

	cleanErrors ()

	getDisplayErrors ()

	getErrorsStr ()

	getFormErrors ($form, $separator= ', ')

	getNonFormErrors ($separator= ', ')

	exportErrors ()

	importErrors ($data)

Поля данных
const	NEED_PHP_VERSION = '8.1.0'

const	NEED_MYSQL_VERSION = '5.7+'

	$local_storage_file

	$check_write_rights

Поля данных унаследованные от BaseModel
	$form_fieldname = []

	$errors_by_form = []

	$errors_non_form = []

	$errors = []

Защищенные члены
	finishInstall ()

	getNextStepInfo ()

	makeError ($module_title, $message)

	compareVersion ($need, $version)

	getLoadedExtensions ()

Дополнительные унаследованные члены
Защищенные данные унаследованные от BaseModel
	$default_error_fieldname = 'Информация'

Конструктор(ы)

__construct ( )

Методы

checkCrypt ( )

Проверяет наличие модуля mcrypt с шифрованием twofish или openSSL

checkCurl ( )

Проверяет, включен ли модуль CUrl

Возвращает: array

checkDbConnect ( )

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

Возвращает: bool(true) | string Возвращает true, в случае успеха, иначе текст ошибки

checkGDSupport ( )

Проверяет наличие графических функций(модуля GD) в PHP

Возвращает: array

checkmbSupport ( )

Проверяет наличие Multibyte функций для работы с кодировкой UTF-8

Возвращает: array

checkMysqlSupport ( )

Проверяет наличие функций mysql в системе

Возвращает: array

checkPhpVersion ( )

Проверяет соответствие установленной версии PHP требуемой

Возвращает: array

checkSafeMode ( )

Проверяет, выключен ли безопасный режим

Возвращает: array

checkServerParams ( )

Проверяет соответствует ли сервер требуемым параметрам системы

Возвращает: array Возвращает массив с результатом проверки всех параметров

checkUploadFiles ( )

Проверяет, возможна ли загрузка файлов в системе

Возвращает: array

checkWriteRights ( )

Проверяет права на запись в директориях

Возвращает: array

checkZipSupport ( )

Проверяет наличие функций для распаковки zip архивов в PHP

Возвращает: array

compareVersion	(	$need,
		$version
	)

protected

Проверяет, соответствует ли версия $version требуемой $need

Аргументы

string	$need	- требуемая версия, например 7.1 или 7.01.2525
string	$version	- имеющаяся версия, например 5.2.10

Возвращает: bool Возвращает true, если версия $version больше или равно $need

doAfterInstall ( )

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

Возвращает: bool | string

doAllowDbWrite ( )

Меняет флаг DB_INSTALL_MODE в false, включая отображение ошибок "Таблица в БД не создана"

Возвращает: bool

doInsertDemoData	(	$module,
		$params = `[]`
	)

Устанавливает демонстрационные данные для модулей

Аргументы

string	$module	- имя модуля
string	$schema	- имя текущей схемы для продолжения обработки
string	$file	- файл импорта с которого продолжать
integer	$start_pos	- позиция с которой продолжать импорт

doInstall ( $module )

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

Аргументы

string $module имя модуля

Возвращает: array - возвращает инсформацию о следующем этапе установки или массив с ошибками

finishInstall ( )

protected

Завершает установку

getInstallStack ( )

Возвращает массив модулей, которые необходимо установить или строку с ошибкой

Возвращает: array | string

getInstallSteps	(	$modules,
		$config
	)

Возврщает массив шагов инсталяции

Аргументы

array	$modules	- список модулей
array	$config	- настройки

getKey	(	$key = `null`,
		$default = `null`
	)

Возвращает значение по ключу из локального хранилища

Аргументы

mixed	$key	- ключ
mixed	$default	- значение по-умолчанию

Возвращает: mixed

getLicenseText ( $lang )

Возвращает текст лицензии на языке $lang (если таковой не существует, то на базовом языке системы)

Аргументы

string $lang - язык (ru или en....)

Возвращает: string

getLoadedExtensions ( )

protected

Возвращает массив с установленными в модулями PHP

Возвращает: array

getNextStepInfo ( )

protected

Возвращает информацию о следующем шаге установки

Возвращает: array

installComplete ( )

Вызывается после полного завершения установки. Удаляет временные файлы

makeError	(	$module_title,
		$message
	)

protected

Подготавливает массив с информацией об ошибках для вывода в браузер

Аргументы

string	$module_title
array \| string	$message

Возвращает: array

progress ( )

Выполняет один шаг установки

Возвращает: array - возвращает инсформацию о следующем этапе установки или массив с ошибками

removeLocalStorage ( )

resetInstall ( $config )

Устанавливает начальные параметры

Аргументы

mixed $config

setKey	(	$key,
		$value
	)

Записывает пару ключ => значение в локальное хранилище, которое удаляетс после установки

Аргументы

string	$key	- ключ
mixed	$value	- значение

setMaxAllowStep ( $step )

Аргументы

type $step

Поля

$check_write_rights

Инициализатор

= [
            '/storage' => [
                    'description' => 'Папка для хранения пользовательских файлов'
            ],
            '/cache' => [
                    'description' => 'Папка для хранения кэш-данных'
            ],
            '/templates' => [
                'description' => 'Папка для шаблонов. Доступ необходим для корректной работы функции установки новых тем оформления'
            ],
            '/modules' => [
                'description' => 'Папка для модулей. Доступ необходим для корректной работы функции установки и обновления модулей'
            ],
            '/' => [
                'description' => 'В процессе установки в корне будет создан файл конфигурации'
            ],
    ],
        $exts

$local_storage_file

const NEED_MYSQL_VERSION = '5.7+'

const NEED_PHP_VERSION = '8.1.0'

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

Открытые члены

Поля данных

Защищенные члены

Дополнительные унаследованные члены

Конструктор(ы)

Методы

Поля