PHPXRef 0.7.1 : Unnamed Project : Detail view of upgradelib.php

Class: upgrade_exception - X-Ref

Exception indicating unknown error during upgrade.

__construct($plugin, $version, $debuginfo=NULL) X-Ref

No description

Class: downgrade_exception - X-Ref

Exception indicating downgrade error during upgrade.

__construct($plugin, $oldversion, $newversion) X-Ref

No description

Class: upgrade_requires_exception - X-Ref

__construct($plugin, $pluginversion, $currentmoodle, $requiremoodle) X-Ref

No description

Class: plugin_defective_exception - X-Ref

__construct($plugin, $details) X-Ref

No description

Class: plugin_misplaced_exception - X-Ref

Misplaced plugin exception.

Note: this should be used only from the upgrade/admin code.

__construct($component, $expected, $current) X-Ref

Constructor.

param: string $component the component from version.php
param: string $expected expected directory, null means calculate
param: string $current plugin directory path

upgrade_set_timeout($max_execution_time=300) X-Ref

Sets maximum expected time needed for upgrade task.
Please always make sure that upgrade will not run longer!

The script may be automatically aborted if upgrade times out.

param: int $max_execution_time in seconds (can not be less than 60 s)

upgrade_main_savepoint($result, $version, $allowabort=true) X-Ref

Upgrade savepoint, marks end of each upgrade block.
It stores new main version, resets upgrade timeout
and abort upgrade if user cancels page loading.

Please do not make large upgrade blocks with lots of operations,
for example when adding tables keep only one table operation per block.

param: bool $result false if upgrade step failed, true if completed
param: string or float $version main version
param: bool $allowabort allow user to abort script execution here
return: void

upgrade_mod_savepoint($result, $version, $modname, $allowabort=true) X-Ref

Module upgrade savepoint, marks end of module upgrade blocks
It stores module version, resets upgrade timeout
and abort upgrade if user cancels page loading.

param: bool $result false if upgrade step failed, true if completed
param: string or float $version main version
param: string $modname name of module
param: bool $allowabort allow user to abort script execution here
return: void

upgrade_block_savepoint($result, $version, $blockname, $allowabort=true) X-Ref

Blocks upgrade savepoint, marks end of blocks upgrade blocks
It stores block version, resets upgrade timeout
and abort upgrade if user cancels page loading.

param: bool $result false if upgrade step failed, true if completed
param: string or float $version main version
param: string $blockname name of block
param: bool $allowabort allow user to abort script execution here
return: void

upgrade_plugin_savepoint($result, $version, $type, $plugin, $allowabort=true) X-Ref

Plugins upgrade savepoint, marks end of blocks upgrade blocks
It stores plugin version, resets upgrade timeout
and abort upgrade if user cancels page loading.

param: bool $result false if upgrade step failed, true if completed
param: string or float $version main version
param: string $type name of plugin
param: string $dir location of plugin
param: bool $allowabort allow user to abort script execution here
return: void

upgrade_stale_php_files_present() X-Ref

Detect if there are leftovers in PHP source files.

During main version upgrades administrators MUST move away
old PHP source files and start from scratch (or better
use git).

return: bool true means borked upgrade, false means previous PHP files were properly removed

upgrade_plugins($type, $startcallback, $endcallback, $verbose) X-Ref

Upgrade plugins

param: string $type The type of plugins that should be updated (e.g. 'enrol', 'qtype')

upgrade_plugins_modules($startcallback, $endcallback, $verbose) X-Ref

Find and check all modules and load them up or upgrade them if necessary

upgrade_plugins_blocks($startcallback, $endcallback, $verbose) X-Ref

This function finds all available blocks and install them
into blocks table or do all the upgrade process if newer.

log_update_descriptions($component) X-Ref

Log_display description function used during install and upgrade.

param: string $component name of component (moodle, mod_assignment, etc.)
return: void

external_update_descriptions($component) X-Ref

Web service discovery function used during install and upgrade.

param: string $component name of component (moodle, mod_assignment, etc.)
return: void

external_update_services() X-Ref

Allow plugins and subsystems to add external functions to other plugins or built-in services.
This function is executed just after all the plugins have been updated.

upgrade_handle_exception($ex, $plugin = null) X-Ref

upgrade logging functions

upgrade_log($type, $plugin, $info, $details=null, $backtrace=null) X-Ref

Adds log entry into upgrade_log table

param: int $type UPGRADE_LOG_NORMAL, UPGRADE_LOG_NOTICE or UPGRADE_LOG_ERROR
param: string $plugin frankenstyle component name
param: string $info short description text of log entry
param: string $details long problem description
param: string $backtrace string used for errors only
return: void

upgrade_started($preinstall=false) X-Ref

Marks start of upgrade, blocks any other access to site.
The upgrade is finished at the end of script or after timeout.

upgrade_finished_handler() X-Ref

Internal function - executed if upgrade interrupted.

upgrade_finished($continueurl=null) X-Ref

Indicates upgrade is finished.

This function may be called repeatedly.

upgrade_setup_debug($starting) X-Ref

print_upgrade_separator() X-Ref

No description

print_upgrade_part_start($plugin, $installation, $verbose) X-Ref

Default start upgrade callback

param: string $plugin
param: bool $installation true if installation, false means upgrade

print_upgrade_part_end($plugin, $installation, $verbose) X-Ref

Default end upgrade callback

param: string $plugin
param: bool $installation true if installation, false means upgrade

upgrade_init_javascript() X-Ref

Sets up JS code required for all upgrade scripts.

upgrade_language_pack($lang = null) X-Ref

Try to upgrade the given language pack (or current language)

param: string $lang the code of the language to update, defaults to the current language

install_core($version, $verbose) X-Ref

Install core moodle tables and initialize

param: float $version target version
param: bool $verbose
return: void, may throw exception

upgrade_core($version, $verbose) X-Ref

Upgrade moodle core

param: float $version target version
param: bool $verbose
return: void, may throw exception

upgrade_noncore($verbose) X-Ref

Upgrade/install other parts of moodle

param: bool $verbose
return: void, may throw exception

core_tables_exist() X-Ref

Checks if the main tables have been installed yet or not.

Note: we can not use caches here because they might be stale,
use with care!

return: bool

upgrade_plugin_mnet_functions($component) X-Ref

upgrades the mnet rpc definitions for the given component.
this method doesn't return status, an exception will be thrown in the case of an error

param: string $component the plugin to upgrade, eg auth_mnet

admin_mnet_method_profile(ReflectionFunctionAbstract $function) X-Ref

Given some sort of reflection function/method object, return a profile array, ready to be serialized and stored

param: ReflectionFunctionAbstract $function reflection function/method object from which to extract information
return: array associative array with function/method information

admin_mnet_method_get_docblock(ReflectionFunctionAbstract $function) X-Ref

Given some sort of reflection function/method object, return an array of docblock lines, where each line is an array of
keywords/descriptions

param: ReflectionFunctionAbstract $function reflection function/method object from which to extract information
return: array docblock converted in to an array

admin_mnet_method_get_help(ReflectionFunctionAbstract $function) X-Ref

Given some sort of reflection function/method object, return just the help text

param: ReflectionFunctionAbstract $function reflection function/method object from which to extract information
return: string docblock help text

upgrade_fix_missing_root_folders_draft() X-Ref

Detect draft file areas with missing root directory records and add them.

check_database_storage_engine(environment_results $result) X-Ref

This function verifies that the database is not using an unsupported storage engine.

param: environment_results $result object to update, if relevant
return: environment_results|null updated results object, or null if the storage engine is supported

check_slasharguments(environment_results $result) X-Ref

Method used to check the usage of slasharguments config and display a warning message.

param: environment_results $result object to update, if relevant.
return: environment_results|null updated results or null if slasharguments is disabled.

check_database_tables_row_format(environment_results $result) X-Ref

This function verifies if the database has tables using innoDB Antelope row format.

param: environment_results $result
return: environment_results|null updated results object, or null if no Antelope table has been found.

upgrade_minmaxgrade() X-Ref

Upgrade the minmaxgrade setting.

This step should only be run for sites running 2.8 or later. Sites using 2.7 will be fine
using the new default system setting $CFG->grade_minmaxtouse.

return: void

check_upgrade_key($upgradekeyhash) X-Ref

Assert the upgrade key is provided, if it is defined.

The upgrade key can be defined in the main config.php as $CFG->upgradekey. If
it is defined there, then its value must be provided every time the site is
being upgraded, regardless the administrator is logged in or not.

This is supposed to be used at certain places in /admin/index.php only.

param: string|null $upgradekeyhash the SHA-1 of the value provided by the user

upgrade_install_plugins(array $installable, $confirmed, $heading='', $continue=null, $return=null) X-Ref

Helper procedure/macro for installing remote plugins at admin/index.php

Does not return, always redirects or exits.

param: array $installable list of \core\update\remote_info
param: bool $confirmed false: display the validation screen, true: proceed installation
param: string $heading validation screen heading
param: moodle_url|string|null $continue URL to proceed with installation at the validation screen
param: moodle_url|string|null $return URL to go back on cancelling at the validation screen

check_unoconv_version(environment_results $result) X-Ref

Method used to check the installed unoconv version.

param: environment_results $result object to update, if relevant.
return: environment_results|null updated results or null if unoconv path is not executable.

Copyright:	1999 onwards Martin Dougiamas (http://dougiamas.com)
License:	http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size:	2319 lines (90 kb)
Included or required:	0 times
Referenced:	18 times
Includes or requires:	3 files version.php lib/db/install.php lib/db/upgrade.php

PHP Cross Reference of Unnamed Project

/lib/ -> upgradelib.php (summary)

Defines 5 classes