Class AdminUpdate

Description

Класс администрирования модуля "Обновления"

Located in /itweb/modules/Update/admin/class.Admin.Update.php (line 17)

MyModule
   |
   --Update
      |
      --AdminUpdate
Variable Summary
Method Summary
 AdminUpdate AdminUpdate ()
 void AddErrorMsg (mixed $text)
 void AddStatusMsg (string $text, bool $isWarning)
 void CancelUpdate ()
 void ChangeUpdatesStatus (integer $curStatus, integer $newStatus, integer $iID)
 string ConvertCriticalness (mixed $latName)
 void ConvertStatus (mixed $latName)
 string CopyFile (string $dir, string $params, boolean $checkOnly, [string $errPrefix = ''], mixed $updVer)
 string DeleteFile (string $dir, string $params, boolean $checkOnly, [string $errPrefix = ''])
 void DeleteUpdatesFiles (array $updsVers)
 integer GetBackupIDForUpdate (string $updVer)
 array GetContextMenu (mixed $bAdmin)
 array GetItemEx (mixed $bAssociative)
 void GetLastErrorMsg ()
 array GetLastInstalledUpdate (boolean $hasBackup)
 string GetLastUpdateVer ()
 void GetPIN ()
 void GetRestorePageContent (mixed $fullPage)
 void GetStepResult (mixed $stepInd, [mixed $isSuccess = 1])
 void GetUpdatesIDsByStatus (mixed $status)
 void GetUpdateStep ()
 void Install ()
 string InstallUpdates (boolean $installFirstLoaded, boolean $checkOnly)
 string MakeDir (string $dir, string $params, boolean $checkOnly, [string $errPrefix = ''])
 string MakeSystemBackup ()
 void NextUpdateStep ()
 string RemoveDir (string $dir, string $params, boolean $checkOnly, [string $errPrefix = ''])
 string RestoreSystemBackup ([booean $clearUpdatesList = 1])
 string RunScript (string $dir)
 void SetUpdateStep (mixed $step)
Variables
bool $autoCheckUpdates = false (line 110)

Флаг автоматической проверки по умолчанию

string $bakOriginal = 'original' (line 69)

Постфикс в комментарии оригинального(изначального) обновления

string $bakPrefix = '__backup_update_' (line 63)

Значения для комментариев резервных копий

bool $delUpdatesFiles = true (line 75)

Удалять файлы обновлений после их установки

array $errors = array() (line 99)

Временные переменные. Массив ошибок в процессе обновления

array $installedUpds = array() (line 87)

Временные переменные. Массив установленных обновлений

array $msgs = array() (line 93)

Временные переменные. Массив сообщений процесса обновления

mixed $pagesPrps = array('ItemsList' => array('title' => 'Список обновлений',
'btns' => array('btnUpdate'),'sel_type'=>''))
(line 20)
string $prpAutoCheck = 'Автоматическая проверка обновлений' (line 105)

Наименование свойства автоматической проверки

string $scriptFilename = 'script.php' (line 51)

Имя файла скрипта в обновлении

string $scriptFuncName = '__UpdateSystem' (line 57)

Имя функции в файле скрипта в обновлении

string $tmpFile = 'inprocess.tmp' (line 45)

Имя файла статуса обновления

string $updatesDir = '/_updates' (line 39)

Имя папки для загруженных файлов обновлений

mixed $URL_UPDATES_CHECK = 'http://control-center.prosto-r.ru/check.php' (line 26)
mixed $URL_UPDATES_DOWNLOAD = 'http://control-center.prosto-r.ru/get.php' (line 27)
bool $useBackups = true (line 81)

Создавать/восстанавливать резервнвые копии перед/после обновления системы

Inherited Variables

Inherited from Update

Update::$desc
Update::$hidden
Update::$icon
Update::$name

Inherited from MyModule

MyModule::$connectionID
MyModule::$oITWEB
MyModule::$oMyCatalog
MyModule::$prps
MyModule::$view_php_funcPrefix
Methods
Constructor AdminUpdate (line 117)

Класс администрирования модуля "Обновления"

AdminUpdate AdminUpdate ()
AddErrorMsg (line 910)
void AddErrorMsg (mixed $text)
AddStatusMsg (line 905)

Сформировать сообщения и ошибки

void AddStatusMsg (string $text, bool $isWarning)
  • string $text: текст сообщения
  • bool $isWarning: флаг: предупреждение, при котором процесс обновления
CancelUpdate (line 588)

Отменить процесс обновления.

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

void CancelUpdate ()
ChangeUpdatesStatus (line 433)

Меняет статусы обновлений в базе

void ChangeUpdatesStatus (integer $curStatus, integer $newStatus, integer $iID)
  • integer $curStatus: текущий статус
  • integer $newStatus: новый статус
  • integer $iID: ID обновления (0 - все)
ConvertCriticalness (line 557)

Конвертируют значения критичности и статуса обновлений на русский

string ConvertCriticalness (mixed $latName)
ConvertStatus (line 563)
void ConvertStatus (mixed $latName)
CopyFile (line 1304)

Копирует файл, указанный в массиве $actions

  • return: в случае неудачи текст ошибки
string CopyFile (string $dir, string $params, boolean $checkOnly, [string $errPrefix = ''], mixed $updVer)
  • string $dir: папка в которую будет производится копирование
  • string $params: дополнительные параметры
  • boolean $checkOnly: проверка на ошибки только, без копирования
  • string $errPrefix: префикс ошибки
DeleteFile (line 1387)

Удаляет файл, указанный в массиве $actions

  • return: в случае неудачи текст ошибки
string DeleteFile (string $dir, string $params, boolean $checkOnly, [string $errPrefix = ''])
  • string $dir: папка расположения файла
  • string $params: дополнительные параметры
  • boolean $checkOnly: ???
  • string $errPrefix: префикс ошибки
DeleteUpdatesFiles (line 937)

Удаляет файлы и папки установленных обновлений

void DeleteUpdatesFiles (array $updsVers)
  • array $updsVers: массив версий
GetAvailableUpdatesData (line 463)

Возвращает информацию о доступных обновлениях, информация о которых уже занесена в базу

array GetAvailableUpdatesData ()
GetBackupIDForUpdate (line 955)

Получить ID бэкапа, если таковой сделан для указанного обновления.

ID=0 - для оригинальной копии системы.

  • return: ID бэкапа, 0 если бэкап не сделан
integer GetBackupIDForUpdate (string $updVer)
  • string $updVer: версия обновления
GetContextMenu (line 178)

Вернуть массив содержащий контекстное меню

  • return: массив контекстного меню
array GetContextMenu (mixed $bAdmin)
GetFirstAvailableUpdateID (line 528)

Возвращает версию последнего (самого нового) загруженного или установленного обновления

string GetFirstAvailableUpdateID ()
GetItemEx (line 616)

Уточнение функции GetItem. Получить свойства текущего элемента

  • return: массив значений текущего элемента
array GetItemEx (mixed $bAssociative)
GetLastErrorMsg (line 923)

Возвращает текст последней ошибки

void GetLastErrorMsg ()
GetLastInstalledUpdate (line 998)

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

  • return: массив со свойствами обновления, включая ID бэкапа eсли бэкапа для обновления нет, backupID = 0. eсли нет установленного обновления, Версия = 0.
array GetLastInstalledUpdate (boolean $hasBackup)
  • boolean $hasBackup: флаг того, что установленное обновление должно иметь бэкап
GetLastUpdateVer (line 495)

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

string GetLastUpdateVer ()
GetPIN (line 256)
void GetPIN ()
GetRestorePageContent (line 573)
void GetRestorePageContent (mixed $fullPage)
GetStepResult (line 678)
void GetStepResult (mixed $stepInd, [mixed $isSuccess = 1])
GetUpdatesIDsByStatus (line 412)
void GetUpdatesIDsByStatus (mixed $status)
GetUpdateStep (line 196)
void GetUpdateStep ()
Install (line 128)

Функция вызываемая в процессе установки.

void Install ()
InstallUpdates (line 1172)

Устанавливает/проверяет обновления системы.

  • return: в случае неудачи текст ошибки
string InstallUpdates (boolean $installFirstLoaded, boolean $checkOnly)
  • boolean $installFirstLoaded: установить только первое загруженное обновление
  • boolean $checkOnly: только проверить обновления (без установки)
isLastUpdateWasCorrect (line 220)

Проверяет, завершился ли последний процесс обновления успешно или прервался

bool isLastUpdateWasCorrect ()
LoadAvailableUpdatesFiles (line 326)

Загружает файлы обновлений с сервера

  • return: в случае неудачи текст ошибки
string LoadAvailableUpdatesFiles ()
LoadAvailableUpdatesList (line 270)

Загружает список доступных на сервере обновлений

  • return: в случае неудачи текст ошибки
string LoadAvailableUpdatesList ()
MakeDir (line 1417)

Создает папку по указанному пути в массиве $actions

  • return: в случае неудачи текст ошибки
string MakeDir (string $dir, string $params, boolean $checkOnly, [string $errPrefix = ''])
  • string $dir: папка расположения файла
  • string $params: дополнительные параметры
  • boolean $checkOnly: ???
  • string $errPrefix: префикс ошибки
MakeSystemBackup (line 1047)

Создает резервную копию системы и базы через модуль "Резервные копии".

Пометить резервную копию как бэкап обновления через комментарий бэкапа.

  • return: в случае неудачи текст ошибки
string MakeSystemBackup ()
NextUpdateStep (line 712)
void NextUpdateStep ()
RemoveDir (line 1479)

Удаляет папку по указанному пути в массиве $actions

  • return: в случае неудачи текст ошибки
string RemoveDir (string $dir, string $params, boolean $checkOnly, [string $errPrefix = ''])
  • string $dir: путь к папке папка
  • string $params: дополнительные параметры
  • boolean $checkOnly: ???
  • string $errPrefix: префикс ошибки
ResetUpdateStatus (line 245)
void ResetUpdateStatus ()
RestoreSystemBackup (line 1099)

Восстанавливает резервную копию системы и базы через модуль "Резервные копии"

  • return: в случае неудачи текст ошибки
string RestoreSystemBackup ([booean $clearUpdatesList = 1])
  • booean $clearUpdatesList: удалить обнолвения из списка обновлений, пришедшие после восстановленного бэкапа
RunScript (line 1515)

Подключает из обновления файл скрипта script.php и вызывает его метод

  • return: в случае неудачи текст ошибки
string RunScript (string $dir)
  • string $dir: путь к папке скрипта
SetUpdateStep (line 205)
void SetUpdateStep (mixed $step)

Inherited Methods

Inherited From Update

 Update::Update()
 Update::OnLoad()

Inherited From MyModule

 MyModule::MyModule()
 MyModule::AddCategoriesPropertiesTables()
 MyModule::AddCategory()
 MyModule::AddDataType()
 MyModule::AddItem()
 MyModule::AddItemsPropertiesTables()
 MyModule::AddPropertiesTables()
 MyModule::AddPropertyType()
 MyModule::BuildPropertyTypesMap()
 MyModule::CheckDelResourceProperty()
 MyModule::CheckElementResources()
 MyModule::CheckModifyResourceProperty()
 MyModule::ClearCategoriesPropertiesCache()
 MyModule::CopyCategory()
 MyModule::CopyFileProperties()
 MyModule::CopyItem()
 MyModule::CountItems()
 MyModule::CurrentCategory()
 MyModule::CurrentItem()
 MyModule::CurrentModule()
 MyModule::DelCategoriesPropertiesTables()
 MyModule::DelCategory()
 MyModule::DelDataType()
 MyModule::DelElementResources()
 MyModule::DelItem()
 MyModule::DelItemsPropertiesTables()
 MyModule::DelPropertiesTables()
 MyModule::DelPropertyType()
 MyModule::GetCachedCategories()
 MyModule::GetCacheDir()
 MyModule::GetCachedItems()
 MyModule::GetCategories()
 MyModule::GetCategoriesFilter()
 MyModule::GetCategory()
 MyModule::GetCategoryID()
 MyModule::GetCategoryLight()
 MyModule::GetCategoryProperties()
 MyModule::GetCategoryPropertiesLight()
 MyModule::GetCategoryProperty()
 MyModule::GetCategoryPropertyTypes()
 MyModule::GetCategoryPropertyTypesLight()
 MyModule::GetCurrentLevel()
 MyModule::GetCurrentModule()
 MyModule::GetDataType()
 MyModule::GetDataTypes()
 MyModule::GetFileDir()
 MyModule::GetFilter()
 MyModule::GetFirstChild()
 MyModule::GetImgDir()
 MyModule::GetItem()
 MyModule::GetItemLight()
 MyModule::GetItemPosition()
 MyModule::GetItemProperties()
 MyModule::GetItemPropertiesLight()
 MyModule::GetItemProperty()
 MyModule::GetItemPropertyEx()
 MyModule::GetItemPropertyTypes()
 MyModule::GetItemPropertyTypesLight()
 MyModule::GetItems()
 MyModule::GetItemsFilter()
 MyModule::GetItemsLimit()
 MyModule::GetItemsOffset()
 MyModule::GetItemsRange()
 MyModule::GetItemsSorting()
 MyModule::GetMaxCategory()
 MyModule::GetMaxCategoryID()
 MyModule::GetMaxItem()
 MyModule::GetMaxLevel()
 MyModule::GetMinItem()
 MyModule::GetModuleProperties()
 MyModule::GetParentCategory()
 MyModule::GetProperties()
 MyModule::GetPropertyByName()
 MyModule::GetPropertyMultipleValue()
 MyModule::GetPropertyType()
 MyModule::GetPropertyTypeGroups()
 MyModule::GetPropertyTypes()
 MyModule::GetRootCategory()
 MyModule::Init()
 MyModule::isCategoryContainsCategory()
 MyModule::isCategoryExist()
 MyModule::isCategoryLeaf()
 MyModule::isCategoryPropertyTypeExist()
 MyModule::isCategorySearch()
 MyModule::isCategorySystem()
 MyModule::isDataTypeExist()
 MyModule::isItemExist()
 MyModule::isItemPropertyTypeExist()
 MyModule::isPropertyTypeExist()
 MyModule::LoadModule()
 MyModule::LoadStatus()
 MyModule::ModifyCategory()
 MyModule::ModifyItem()
 MyModule::ModifyPropertyType()
 MyModule::MoveCategory()
 MyModule::MoveItem()
 MyModule::PopUp()
 MyModule::ResetCachedItems()
 MyModule::ResetCategoriesFilter()
 MyModule::ResetFilter()
 MyModule::ResetItemsFilter()
 MyModule::ResetItemsSorting()
 MyModule::RootCategory()
 MyModule::SaveStatus()
 MyModule::SetCachedCategories()
 MyModule::SetCachedItems()
 MyModule::SetCategoriesFilter()
 MyModule::SetFilter()
 MyModule::SetItemsFilter()
 MyModule::SetItemsLimit()
 MyModule::SetItemsOffset()
 MyModule::SetItemsRandomSorting()
 MyModule::SetItemsRange()
 MyModule::SetItemsSearchFilter()
 MyModule::SetItemsSorting()
 MyModule::SetPropertyMultipleValue()
 MyModule::ShiftCategory()
 MyModule::ShiftItem()
 MyModule::ShiftPropertyType()
 MyModule::ShowHiddenCategories()
 MyModule::ShowSystemProperties()

Documentation generated on Wed, 21 Mar 2007 17:34:22 +0300 by phpDocumentor 1.3.0RC3