Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
|
Abstract class defining the needed stuf for one restore task (a collection of steps) More...
Public Member Functions | |
__construct ($name, $plan=null) | |
Constructor - instantiates one object of this class. | |
add_result ($result) | |
Add the given info to the current plan's results. | |
add_step ($step) | |
backup_release_compare (string $release, string $operator) | |
Compares the provided moodle release with the one the backup was taken from. | |
backup_version_compare (int $version, string $operator) | |
Compares the provided moodle version with the one the backup was taken from. | |
build () | |
Function responsible for building the steps of any task (must set the $built property to true) | |
calculate_checksum () | |
This function will return one unique and stable checksum for one instance of the class implementing it. | |
destroy () | |
Destroy all circular references. | |
execute () | |
Function responsible for executing the steps of any task (setting the $executed property to true) | |
execute_after_restore () | |
If the task has been executed, launch its after_restore() method if available. | |
get_basepath () | |
get_comment_mapping_itemname ($commentarea) | |
Given a commment area, return the itemname that contains the itemid mappings. | |
get_courseid () | |
get_decoder () | |
get_info () | |
get_logger () | |
get_name () | |
get_old_contextid () | |
get_old_courseid () | |
get_old_system_contextid () | |
get_preloaded_information () | |
get_progress () | |
Gets the progress reporter, which can be used to report progress within the backup or restore process. | |
get_restoreid () | |
get_results () | |
Return the current plan's results. | |
get_setting ($name) | |
get_setting_value ($name) | |
get_settings () | |
get_steps () | |
get_target () | |
get_taskbasepath () | |
get_tempdir () | |
get_userid () | |
get_weight () | |
Returns the weight of this task, an approximation of the amount of time it will take. | |
is_checksum_correct ($checksum) | |
Given one checksum, returns if matches object's checksum (true) or no (false) | |
is_excluding_activities () | |
is_missing_modules () | |
is_samesite () | |
log ($message, $level, $a=null, $depth=null, $display=false) | |
This function will be responsible for handling the params, and to call to the corresponding logger->process() once all modifications in params have been performed. | |
set_plan ($plan) | |
set_preloaded_information () | |
setting_exists ($name) | |
Protected Member Functions | |
add_setting ($setting) | |
define_settings () | |
This function is invoked on activity creation in order to add all the settings that are associated with one task. | |
Protected Attributes | |
bool | $built |
bool | $executed |
string | $name |
backup_plan restore_plan | $plan |
base_setting[] | $settings |
base_step[] | $steps |
Abstract class defining the needed stuf for one restore task (a collection of steps)
TODO: Finish phpdocs
restore_task::__construct | ( | $name, | |
$plan = null ) |
Constructor - instantiates one object of this class.
Reimplemented from base_task.
|
inherited |
Add the given info to the current plan's results.
array | $result | associative array describing a result of a task/step |
restore_task::backup_release_compare | ( | string | $release, |
string | $operator ) |
Compares the provided moodle release with the one the backup was taken from.
string | $release | Moodle release (X.Y or X.Y.Z) |
string | $operator | Operator to compare the provided release to the backup release. { |
bool | True if the comparison passes. |
restore_task::backup_version_compare | ( | int | $version, |
string | $operator ) |
Compares the provided moodle version with the one the backup was taken from.
int | $version | Moodle version number (YYYYMMDD or YYYYMMDDXX) |
string | $operator | Operator to compare the provided version to the backup version. { |
bool | True if the comparison passes. |
|
abstractinherited |
Function responsible for building the steps of any task (must set the $built property to true)
Reimplemented in backup_activity_task, backup_block_task, backup_course_task, backup_final_task, backup_root_task, backup_section_task, restore_activity_task, restore_block_task, restore_course_task, restore_final_task, restore_root_task, and restore_section_task.
|
inherited |
This function will return one unique and stable checksum for one instance of the class implementing it.
It's each implementation responsibility to do it recursively if needed and use optional store (caching) of the checksum if necessary/possible
Implements checksumable.
|
abstractprotectedinherited |
This function is invoked on activity creation in order to add all the settings that are associated with one task.
The function will, directly, inject the settings in the task.
Reimplemented in backup_activity_task, backup_block_task, backup_course_task, backup_final_task, backup_root_task, backup_section_task, restore_activity_task, restore_block_task, restore_course_task, restore_final_task, restore_root_task, and restore_section_task.
|
inherited |
Destroy all circular references.
It helps PHP 5.2 a lot!
|
inherited |
Function responsible for executing the steps of any task (setting the $executed property to true)
Implements executable.
Reimplemented in backup_activity_task, backup_section_task, restore_activity_task, and restore_section_task.
restore_task::get_comment_mapping_itemname | ( | $commentarea | ) |
Given a commment area, return the itemname that contains the itemid mappings.
By default, both are the same (commentarea = itemname), so return it. If some plugins use a different approach, this method can be overriden in its task.
string | $commentarea | area defined for this comment |
string | itemname that contains the related itemid mapping |
Reimplemented in restore_assign_activity_task, and restore_data_activity_task.
|
inherited |
Gets the progress reporter, which can be used to report progress within the backup or restore process.
core\progress\base | Progress reporting object |
|
inherited |
Return the current plan's results.
array|null |
|
inherited |
Reimplemented in backup_activity_task, backup_section_task, restore_activity_task, and restore_section_task.
|
inherited |
|
inherited |
Returns the weight of this task, an approximation of the amount of time it will take.
By default this value is 1. It can be increased for longer tasks.
int | Weight |
Reimplemented in backup_final_task.
|
inherited |
Given one checksum, returns if matches object's checksum (true) or no (false)
Implements checksumable.
|
inherited |
This function will be responsible for handling the params, and to call to the corresponding logger->process() once all modifications in params have been performed.
Implements loggable.