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

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

Класс содержит API функции по обновлению системы

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

	canCheckUpdate ()

	getBeforeUpdateVersion ($module)

	prepareProductsForUpdate (&$count)

	getMyVersions ()

	prepareUpdateInfo ($product)

	isActualVersion ($ver1, $ver2)

	compareVersions ($skipped_modules=[])

	getPrepearedData ()

	setData ($key, $value=null)

	writeDataToFile ($bool)

	requester ($params, $json=true)

	prepareInstallUpdate (array $modules)

	updateDataStructure ()

	doUpdate ()

	startTimeCount ()

	isTimeExpire ()

	canRestore ()

	restoreSystem ()

	waitForCronFinished ()

	getChangelog ($module)

	getUpdateExpireDays ()

	isUpdateExpire ()

	getSaleUpdateExpire ()

	getSaleUpdateExpireDays ()

	getSaleUpdateUrl ()

	getCachedUpdateData ()

	checkUpdates ()

	makePrivateDir ($path)

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

	hasError ()

	getErrors ()

	cleanErrors ()

	getDisplayErrors ()

	getErrorsStr ()

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

	getNonFormErrors ($separator= ', ')

	exportErrors ()

	importErrors ($data)

Поля данных
const	REQUEST_TIMEOUT = 50

const	CHECK_FOR_UPDATES_INTERVAL = 14400

const	SKIPPED_MODULE_STORE_KEY = 'SKIPPED_MODULES'

const	UPDATE_IN_PROGRESS_STORE_KEY = 'UPDATE_IN_PROGRESS'

const	SECTION_PRODUCTS_FOR_UPDATE = 'products'

	$max_execution_time = 25

	$config

	$write_data_to_file = true

	$update_tmp_folder = '/siteupdate'

	$update_tmp_folder_zip

	$update_upacked_folder

	$backup_folder

	$data

	$data_file = 'data.srz'

	$copy_files

	$module_folders

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

	$errors_by_form = []

	$errors_non_form = []

	$errors = []

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

	incStep ()

	getNextStepInfo ()

	makeError ($module_title, $message)

Защищенные данные
	$time_marker = 0

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

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

__construct ( )

Методы

canCheckUpdate ( )

Возвращает true, если возможно провести проверку обновлений, иначе - false

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

canRestore ( )

Возвращает true, если возможно выполнить восстановление из резервной копии

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

checkUpdates ( )

Проверяет наличие доступных обновлений на сервере

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

compareVersions ( $skipped_modules = [] )

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

Аргументы

array $skipped_modules - список модулей которые нужно исключить из проверки обновлений

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

doUpdate ( )

Выполняет один этап обновления по карте обновлений.

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

getBeforeUpdateVersion ( $module )

Возвращает версию модуля до обновления или false, если такой модуль не найден

Аргументы

string $module - Имя модуля, или - для возвращения версии ядра, #default - для возвращения версии шаблона

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

getCachedUpdateData ( )

Возвращает массив с информацией об обновлении системы или false, что означает что сведения устарели и необходимо вызвать метод checkUpdates

Возвращает: array | bool(false)

getChangelog ( $module )

getMyVersions ( )

Возвращает массив со списком версий текущей системы

getNextStepInfo ( )

protected

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

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

getPrepearedData ( )

Возвращает все данные подготовленные для текущего обновления

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

getRequestVars ( )

protected

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

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

getSaleUpdateExpire ( )

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

Возвращает: timestamp | false

getSaleUpdateExpireDays ( )

Возвращает количество дней до истечения льготного периода обновлений

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

getSaleUpdateUrl ( )

Возвращает ссылку на льготное продление обновлений

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

getUpdateExpireDays ( )

Возвращает количество дней в течение которых доступно обновление скрипта

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

incStep ( )

protected

isActualVersion	(	$ver1,
		$ver2
	)

Возвращает true, если версия1 >= версии2

Аргументы

string	$ver1
string	$ver2

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

isTimeExpire ( )

Проверяет

isUpdateExpire ( )

Возвращает true, если подписка на обноления истекла

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

makeError	(	$module_title,
		$message
	)

protected

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

Аргументы

string	$module_title
array \| string	$message

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

makePrivateDir ( $path )

prepareInstallUpdate ( array $modules )

Проводит подготовку к обновленю системы, формирует список действий(карту) по обновлению системы

Аргументы

array $modules список устанавливаемых модулей

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

prepareProductsForUpdate ( & $count )

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

Возвращает: bool возвращает true в случае успеха, иначе - false

prepareUpdateInfo ( $product )

Подготавливает информацию о том, какие модули могут быть обновлены

Аргументы

$product

Возвращает: bool возвращает true в случае успеха, иначе - false

Исключения

DbException
RSException

requester	(	$params,
		$json = `true`
	)

Выполняет POST запрос к серверу обновления

Аргументы

mixed	$url
mixed	$params

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

restoreSystem ( )

Восстанавливает систему с помощью созданной перед обновлением резервной копии

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

setData	(	$key,
		$value = `null`
	)

Сохраняет подготовленную информацию $value под клчем $key

Аргументы

mixed	$key
mixed	$value

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

startTimeCount ( )

Устанавливает точку отсчета времени выполнения операции

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

updateDataStructure ( )

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

waitForCronFinished ( )

writeDataToFile ( $bool )

Устанавливает сохранять ли временные данные во внешний файл или нет.

Аргументы

bool $bool

Поля

$backup_folder

$config

$copy_files

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

= [
            '/package.inc.php'
    ]

$data

$data_file = 'data.srz'

$max_execution_time = 25

$module_folders

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

= [
            '@core' => [
                '/core/',
                '/resource/',
                '/templates/system/'
            ]
    ]

$time_marker = 0

protected

$update_tmp_folder = '/siteupdate'

$update_tmp_folder_zip

$update_upacked_folder

$write_data_to_file = true

const CHECK_FOR_UPDATES_INTERVAL = 14400

const REQUEST_TIMEOUT = 50

const SECTION_PRODUCTS_FOR_UPDATE = 'products'

const SKIPPED_MODULE_STORE_KEY = 'SKIPPED_MODULES'

const UPDATE_IN_PROGRESS_STORE_KEY = 'UPDATE_IN_PROGRESS'

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

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

Поля данных

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

Защищенные данные

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

Методы

Поля