Class: I2CE Updater (4.0.14)

For other versions, see Class: I2CE_Updater (versions) .

This article describes the class I2CE_Updater .

• Location: Part of the module I2CE in the package I2CE 4.0.14-release
• Source: Defined in the file lib/I2CE_Updater.php on line 38

Variables

$timeout

int $timeout. update authentication time (in minutes) is to remain valid

• Defined in i2ce/lib/I2CE_Updater.php on line 43
• Type: static public static $timeout

Methods

_updateModules()

• Defined in i2ce/lib/I2CE_Updater.php on line 442
• Signature: static protected function _updateModules($updates,$removals,$optional_excludes,$disables)
• Parameters:
  • $updates
  • $removals
    • Default Value: array()
  • $optional_excludes
    • Default Value: array()
  • $disables
    • Default Value: array()

_updateSite()

• Defined in i2ce/lib/I2CE_Updater.php on line 132
• Signature: static protected function _updateSite($site_module_file,$verbose_errors)
• Parameters:
  • $site_module_file
  • $verbose_errors
    • Default Value: true

failedRequiredUpdate()

• Defined in i2ce/lib/I2CE_Updater.php on line 773
• Signature: static protected function failedRequiredUpdate($shortname,$data,$msg,$configurator)
• Parameters:
  • $shortname
  • &$data
  • $msg
  • $configurator

install()

Worker function for the first time installation. Absolutely nothing has been done yet.

• Defined in i2ce/lib/I2CE_Updater.php on line 242
• Signature: static protected function install($site_module_file,$restart,$verbose_errors)
• Parameters:
  • string $site_module_file
    The site module file
  • $restart
  • boolean $verbose_errors
    defaults to true.
    • Default Value: true

isAuthorizedToUpdate()

method to check if authorized to update

• Defined in i2ce/lib/I2CE_Updater.php on line 49
• Signature: static public function isAuthorizedToUpdate()
• Returns: boolean

loadModuleMagicData()

• Defined in i2ce/lib/I2CE_Updater.php on line 875
• Signature: static protected function loadModuleMagicData($shortname,$file,$old_vers,$new_vers,$mod_configurator)
• Parameters:
  • $shortname
  • $file
  • $old_vers
  • $new_vers
  • $mod_configurator

postUpdateModule()

• Defined in i2ce/lib/I2CE_Updater.php on line 963
• Signature: static protected function postUpdateModule($shortname,$old_vers,$new_vers)
• Parameters:
  • $shortname
  • $old_vers
  • $new_vers

preUpgradeModule()

• Defined in i2ce/lib/I2CE_Updater.php on line 929
• Signature: static protected function preUpgradeModule($shortname,$old_vers,$new_vers,$new_storage)
• Parameters:
  • $shortname
  • $old_vers
  • $new_vers
  • $new_storage

reinstall()

• Defined in i2ce/lib/I2CE_Updater.php on line 306
• Signature: static protected function reinstall($site_module_file,$restart)
• Parameters:
  • $site_module_file
  • $restart

storeModuleMagicData()

• Defined in i2ce/lib/I2CE_Updater.php on line 798
• Signature: static protected function storeModuleMagicData($shortname,$old_vers,$new_vers,$mod_configurator,$imported)
• Parameters:
  • $shortname
  • $old_vers
  • $new_vers
  • $mod_configurator
  • $imported

updateModules()

• Defined in i2ce/lib/I2CE_Updater.php on line 407
• Signature: static public function updateModules($updates,$removals,$optional_excludes,$disables)
• Parameters:
  • $updates
  • $removals
    • Default Value: array()
  • $optional_excludes
    • Default Value: array()
  • $disables
    • Default Value: array()

updateOutOfDateConfigFiles()

Checks the registered config files {@see addConfigFile() } to make sure that they have been initialized. If the modified time is more recent than the last access time, then it will re-initialize the files. It also checks all loaded config files for enabled modules/components to make sure that they are up-to-date in a simmiar way.

• Defined in i2ce/lib/I2CE_Updater.php on line 375
• Signature: static protected function updateOutOfDateConfigFiles($shortnames)
• Parameters:
  • $shortnames
    • Default Value: null
• Returns: boolean
  true on success. Future desired behavior: redirect to an error/admin page on failure or if the site module is removed.

updateSite()

Controls the site update

• Defined in i2ce/lib/I2CE_Updater.php on line 93
• Signature: static public function updateSite($site_module_file,$verbose_errors)
• Parameters:
  • string $site_module_file
  • boolean $verbose_errors
    Defaults to true
    • Default Value: true

upgradeModule()

• Defined in i2ce/lib/I2CE_Updater.php on line 948
• Signature: static protected function upgradeModule($shortname,$old_vers,$new_vers)
• Parameters:
  • $shortname
  • $old_vers
  • $new_vers