Backup task that provides all the settings and steps to perform one complete backup of the activity.
More...
|
| 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 () |
| Exceptionally override the execute method, so, based in the activity_included setting, we are able to skip the execution of one task completely.
|
|
| get_activityid () |
|
| 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_moduleid () |
|
| get_modulename () |
|
| 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_sectionid () |
|
| get_setting ($name) |
| Tries to look for the instance specific setting value, task specific setting value or the common plan setting value - in that order.
|
|
| 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) |
|
|
static | encode_content_links ($content) |
| Code the transformations to perform in the activity in order to get transportable (encoded) links.
|
|
|
| add_setting ($setting) |
|
| define_my_settings () |
| Define (add) particular settings this activity can have.
|
|
| define_my_steps () |
| Define (add) particular steps this activity can have.
|
|
| define_settings () |
| Defines the common setting that any backup activity will have.
|
|
Backup task that provides all the settings and steps to perform one complete backup of the activity.
- Copyright
- 2010 onwards, Blindside Networks Inc
- License
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
◆ 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_activity_task::build |
( |
| ) |
|
|
inherited |
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_my_settings()
backup_bigbluebuttonbn_activity_task::define_my_settings |
( |
| ) |
|
|
protected |
Define (add) particular settings this activity can have.
- Return values
-
Reimplemented from backup_activity_task.
◆ define_my_steps()
backup_bigbluebuttonbn_activity_task::define_my_steps |
( |
| ) |
|
|
protected |
Define (add) particular steps this activity can have.
- Return values
-
Reimplemented from backup_activity_task.
◆ define_settings()
backup_activity_task::define_settings |
( |
| ) |
|
|
protectedinherited |
Defines the common setting that any backup activity will have.
Reimplemented from base_task.
◆ destroy()
Destroy all circular references.
It helps PHP 5.2 a lot!
◆ encode_content_links()
static backup_bigbluebuttonbn_activity_task::encode_content_links |
( |
| $content | ) |
|
|
static |
Code the transformations to perform in the activity in order to get transportable (encoded) links.
- Parameters
-
- Return values
-
Reimplemented from backup_activity_task.
◆ execute()
backup_activity_task::execute |
( |
| ) |
|
|
inherited |
Exceptionally override the execute method, so, based in the activity_included setting, we are able to skip the execution of one task completely.
Reimplemented from base_task.
◆ get_activityid()
backup_activity_task::get_activityid |
( |
| ) |
|
|
inherited |
- Return values
-
int | the id of the activity instance (id in the activity's instances table) |
◆ get_contextid()
backup_activity_task::get_contextid |
( |
| ) |
|
|
inherited |
- Return values
-
int | the id of the associated CONTEXT_MODULE instance |
◆ 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_moduleid()
backup_activity_task::get_moduleid |
( |
| ) |
|
|
inherited |
- Return values
-
int | the course module id (id in the course_modules table) |
◆ get_modulename()
backup_activity_task::get_modulename |
( |
| ) |
|
|
inherited |
- Return values
-
string | the name of the module, eg 'workshop' (from the modules table) |
◆ 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_sectionid()
backup_activity_task::get_sectionid |
( |
| ) |
|
|
inherited |
- Return values
-
int | the course section id (id in the course_sections table) |
◆ get_setting()
backup_activity_task::get_setting |
( |
| $name | ) |
|
|
inherited |
Tries to look for the instance specific setting value, task specific setting value or the common plan setting value - in that order.
- Parameters
-
string | $name | the name of the setting |
- Return values
-
mixed|null | the value of the setting or null if not found |
Reimplemented from base_task.
◆ get_taskbasepath()
backup_activity_task::get_taskbasepath |
( |
| ) |
|
|
inherited |
- Return values
-
string | full path to the directory where this task writes its 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:
- mod/bigbluebuttonbn/backup/moodle2/backup_bigbluebuttonbn_activity_task.class.php