Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
backup_task Class Reference

Abstract class defining the needed stuf for one backup task (a collection of steps) More...

Inheritance diagram for backup_task:
base_task checksumable executable loggable backup_activity_task backup_block_task backup_course_task backup_final_task backup_root_task backup_section_task 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 backup_workshop_activity_task backup_default_block_task backup_html_block_task backup_rss_client_block_task

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)
 
 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)
 
 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 ()
 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
 

Detailed Description

Abstract class defining the needed stuf for one backup task (a collection of steps)

TODO: Finish phpdocs

Constructor & Destructor Documentation

◆ __construct()

backup_task::__construct ( $name,
$plan = null )

Constructor - instantiates one object of this class.

Reimplemented from base_task.

Member Function Documentation

◆ 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$resultassociative array describing a result of a task/step

◆ build()

base_task::build ( )
abstractinherited

◆ 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()

base_task::define_settings ( )
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.

◆ destroy()

base_task::destroy ( )
inherited

Destroy all circular references.

It helps PHP 5.2 a lot!

◆ execute()

base_task::execute ( )
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.

◆ get_kept_roles()

backup_task::get_kept_roles ( )

Get the user roles that should be kept in the destination course for a course copy operation.

Return values
array

◆ 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
core\progress\baseProgress reporting object

◆ get_results()

base_task::get_results ( )
inherited

Return the current plan's results.

Return values
array|null

◆ get_setting()

base_task::get_setting ( $name)
inherited

◆ get_taskbasepath()

◆ 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
intWeight

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: