course task that provides all the properties and common steps to be performed when one course is being backup
More...
|
| __construct ($name, $courseid, $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) |
|
| 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_contextid () |
|
| 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 () |
| Course tasks have their own directory to write files.
|
|
| 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) |
|
|
static | encode_content_links ($content) |
| Code the transformations to perform in the course in order to get transportable (encoded) links.
|
|
|
| add_setting ($setting) |
|
| define_settings () |
| Define the common setting that any backup section will have.
|
|
course task that provides all the properties and common steps to be performed when one course is being backup
- Copyright
- 2010 onwards Eloy Lafuente (stronk7)
- License
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
TODO: Finish phpdocs
◆ add_result()
base_task::add_result |
( |
| $result | ) |
|
|
inherited |
Add the given info to the current plan's results.
- See also
- base_plan\add_result()
- Parameters
-
array | $result | associative array describing a result of a task/step |
◆ build()
backup_course_task::build |
( |
| ) |
|
Create all the steps that will be part of this task.
Reimplemented from base_task.
◆ calculate_checksum()
base_task::calculate_checksum |
( |
| ) |
|
|
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.
◆ define_settings()
backup_course_task::define_settings |
( |
| ) |
|
|
protected |
Define the common setting that any backup section will have.
Reimplemented from base_task.
◆ destroy()
Destroy all circular references.
It helps PHP 5.2 a lot!
◆ encode_content_links()
static backup_course_task::encode_content_links |
( |
| $content | ) |
|
|
static |
Code the transformations to perform in the course in order to get transportable (encoded) links.
- Parameters
-
string | $content | content in which to encode links. |
- Return values
-
string | content with links encoded. |
◆ execute()
◆ get_kept_roles()
backup_task::get_kept_roles |
( |
| ) |
|
|
inherited |
Get the user roles that should be kept in the destination course for a course copy operation.
- Return values
-
◆ get_progress()
base_task::get_progress |
( |
| ) |
|
|
inherited |
Gets the progress reporter, which can be used to report progress within the backup or restore process.
- Return values
-
◆ get_results()
base_task::get_results |
( |
| ) |
|
|
inherited |
Return the current plan's results.
- Return values
-
◆ get_setting()
base_task::get_setting |
( |
| $name | ) |
|
|
inherited |
◆ get_taskbasepath()
backup_course_task::get_taskbasepath |
( |
| ) |
|
Course tasks have their own directory to write files.
Reimplemented from base_task.
◆ get_weight()
base_task::get_weight |
( |
| ) |
|
|
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.
- Return values
-
Reimplemented in backup_final_task.
◆ is_checksum_correct()
base_task::is_checksum_correct |
( |
| $checksum | ) |
|
|
inherited |
Given one checksum, returns if matches object's checksum (true) or no (false)
Implements checksumable.
◆ log()
base_task::log |
( |
| $message, |
|
|
| $level, |
|
|
| $a = null, |
|
|
| $depth = null, |
|
|
| $display = false ) |
|
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.
The documentation for this class was generated from the following file:
- backup/moodle2/backup_course_task.class.php