Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
|
Final task that provides all the final steps necessary in order to finish one backup (mainly gathering references and creating the main xml) apart from some final cleaning. More...
Public Member Functions | |
add_result ($result) | |
Add the given info to the current plan's results. | |
add_step ($step) | |
build () | |
Create all the steps that will be part of this task. | |
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) | |
get_backupid () | |
get_basepath () | |
get_courseid () | |
get_kept_roles () | |
Get the user roles that should be kept in the destination course for a course copy operation. | |
get_logger () | |
get_name () | |
get_progress () | |
Gets the progress reporter, which can be used to report progress within the backup or restore process. | |
get_results () | |
Return the current plan's results. | |
get_setting ($name) | |
get_setting_value ($name) | |
get_settings () | |
get_steps () | |
get_taskbasepath () | |
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 () | |
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) | |
setting_exists ($name) | |
Protected Member Functions | |
add_setting ($setting) | |
define_settings () | |
Define the common setting that any backup type will have. | |
Protected Attributes | |
bool | $built |
bool | $executed |
string | $name |
backup_plan restore_plan | $plan |
base_setting[] | $settings |
base_step[] | $steps |
Final task that provides all the final steps necessary in order to finish one backup (mainly gathering references and creating the main xml) apart from some final cleaning.
TODO: Finish phpdocs
|
inherited |
Add the given info to the current plan's results.
array | $result | associative array describing a result of a task/step |
backup_final_task::build | ( | ) |
Create all the steps that will be part of this task.
Reimplemented from base_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.
|
protected |
Define the common setting that any backup type will have.
Reimplemented from base_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.
|
inherited |
Get the user roles that should be kept in the destination course for a course copy operation.
array |
|
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 |
backup_final_task::get_weight | ( | ) |
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 from base_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.