Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
|
Provides all the settings and steps to perform one complete backup of the activity. More...
Public Member Functions | |
__construct ($name, $moduleid, $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 () | |
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 Public Member Functions | |
static | encode_content_links ($content) |
Encodes URLs to the activity instance's scripts into a site-independent form. | |
Protected Member Functions | |
add_setting ($setting) | |
define_my_settings () | |
Defines activity specific settings to be added to the common ones. | |
define_my_steps () | |
Defines activity specific steps for this task. | |
define_settings () | |
Defines the common setting that any backup activity will have. | |
Protected Attributes | |
$activityid | |
bool | $built |
$contextid | |
bool | $executed |
$moduleid | |
$modulename | |
string | $name |
backup_plan restore_plan | $plan |
$sectionid | |
base_setting[] | $settings |
base_step[] | $steps |
Provides all the settings and steps to perform one complete backup of the activity.
Activities are supposed to provide the subclass of this class in their file mod/MODULENAME/backup/moodle2/backup_MODULENAME_activity_task.class.php The expected name of the subclass is backup_MODULENAME_activity_task
backup_activity_task::__construct | ( | $name, | |
$moduleid, | |||
$plan = null ) |
Constructor - instantiates one object of this class.
string | $name | the task identifier |
int | $moduleid | course module id (id in course_modules table) |
backup_plan | null | $plan | the backup plan instance this task is part of |
|
inherited |
Add the given info to the current plan's results.
array | $result | associative array describing a result of a task/step |
backup_activity_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.
|
abstractprotected |
Defines activity specific settings to be added to the common ones.
This method is called from self::define_settings(). The activity module author may use it to define additional settings that influence the execution of the backup.
Most activities just leave the method empty.
Reimplemented in backup_assign_activity_task, backup_bigbluebuttonbn_activity_task, backup_book_activity_task, backup_chat_activity_task, backup_choice_activity_task, backup_data_activity_task, backup_feedback_activity_task, backup_folder_activity_task, backup_forum_activity_task, backup_glossary_activity_task, backup_h5pactivity_activity_task, backup_imscp_activity_task, backup_label_activity_task, backup_lesson_activity_task, backup_lti_activity_task, backup_page_activity_task, backup_quiz_activity_task, backup_resource_activity_task, backup_scorm_activity_task, backup_survey_activity_task, backup_url_activity_task, backup_wiki_activity_task, and backup_workshop_activity_task.
|
abstractprotected |
Defines activity specific steps for this task.
This method is called from self::build(). Activities are supposed to call {self\add_step()} in it to include their specific steps in the backup plan.
Reimplemented in backup_assign_activity_task, backup_bigbluebuttonbn_activity_task, backup_book_activity_task, backup_chat_activity_task, backup_choice_activity_task, backup_data_activity_task, backup_feedback_activity_task, backup_folder_activity_task, backup_forum_activity_task, backup_glossary_activity_task, backup_h5pactivity_activity_task, backup_imscp_activity_task, backup_label_activity_task, backup_lesson_activity_task, backup_lti_activity_task, backup_page_activity_task, backup_quiz_activity_task, backup_resource_activity_task, backup_scorm_activity_task, backup_survey_activity_task, backup_url_activity_task, backup_wiki_activity_task, and backup_workshop_activity_task.
|
protected |
Defines the common setting that any backup activity will have.
Reimplemented from base_task.
|
inherited |
Destroy all circular references.
It helps PHP 5.2 a lot!
|
static |
Encodes URLs to the activity instance's scripts into a site-independent form.
The current instance of the activity may be referenced from other places in the course by URLs like http://my.moodle.site/mod/workshop/view.php?id=42 Obvisouly, such URLs are not valid any more once the course is restored elsewhere. For this reason the backup file does not store the original URLs but encodes them into a transportable form. During the restore, the reverse process is applied and the encoded URLs are replaced with the new ones valid for the target site.
Every plugin must override this method in its subclass.
string | $content | some HTML text that eventually contains URLs to the activity instance scripts |
string | the content with the URLs encoded |
Reimplemented in backup_assign_activity_task, backup_bigbluebuttonbn_activity_task, backup_book_activity_task, backup_chat_activity_task, backup_choice_activity_task, backup_data_activity_task, backup_feedback_activity_task, backup_folder_activity_task, backup_forum_activity_task, backup_glossary_activity_task, backup_h5pactivity_activity_task, backup_imscp_activity_task, backup_label_activity_task, backup_lesson_activity_task, backup_lti_activity_task, backup_page_activity_task, backup_quiz_activity_task, backup_resource_activity_task, backup_scorm_activity_task, backup_survey_activity_task, backup_url_activity_task, backup_wiki_activity_task, and backup_workshop_activity_task.
backup_activity_task::execute | ( | ) |
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.
backup_activity_task::get_activityid | ( | ) |
int | the id of the activity instance (id in the activity's instances table) |
backup_activity_task::get_contextid | ( | ) |
int | the id of the associated CONTEXT_MODULE instance |
|
inherited |
Get the user roles that should be kept in the destination course for a course copy operation.
array |
backup_activity_task::get_moduleid | ( | ) |
int | the course module id (id in the course_modules table) |
backup_activity_task::get_modulename | ( | ) |
string | the name of the module, eg 'workshop' (from the modules table) |
|
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 |
backup_activity_task::get_sectionid | ( | ) |
int | the course section id (id in the course_sections table) |
backup_activity_task::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.
string | $name | the name of the setting |
mixed|null | the value of the setting or null if not found |
Reimplemented from base_task.
backup_activity_task::get_taskbasepath | ( | ) |
string | full path to the directory where this task writes its files |
Reimplemented from base_task.
|
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.