Moodle APIs  3.8
Moodle 3.8.6 (Build: 20201109)
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
restore_root_task Class Reference

Start task that provides all the settings common to all restores and other initial steps. More...

Inheritance diagram for restore_root_task:
restore_task base_task checksumable executable loggable

Public Member Functions

 add_result ($result)
 Add the given info to the current plan's results. More...
 
 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. More...
 
 destroy ()
 Destroy all circular references. More...
 
 execute ()
 Function responsible for executing the steps of any task (setting the $executed property to true)
 
 execute_after_restore ()
 If the task has been executed, launch its after_restore() method if available.
 
 get_basepath ()
 
 get_courseid ()
 
 get_decoder ()
 
 get_info ()
 
 get_logger ()
 
 get_name ()
 
 get_old_contextid ()
 
 get_old_courseid ()
 
 get_old_system_contextid ()
 
 get_preloaded_information ()
 
 get_progress ()
 Gets the progress reporter, which can be used to report progress within the backup or restore process. More...
 
 get_restoreid ()
 
 get_results ()
 Return the current plan's results. More...
 
 get_setting ($name)
 
 get_setting_value ($name)
 
 get_settings ()
 
 get_steps ()
 
 get_target ()
 
 get_taskbasepath ()
 
 get_tempdir ()
 
 get_userid ()
 
 get_weight ()
 Returns the weight of this task, an approximation of the amount of time it will take. More...
 
 is_checksum_correct ($checksum)
 Given one checksum, returns if matches object's checksum (true) or no (false)
 
 is_excluding_activities ()
 
 is_missing_modules ()
 
 is_samesite ()
 
 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)
 
 set_preloaded_information ()
 
 setting_exists ($name)
 

Protected Member Functions

 add_setting ($setting)
 
 define_settings ()
 Define the common setting that any restore type will have.
 

Protected Attributes

 $built
 
 $executed
 
 $name
 
 $plan
 
 $settings
 
 $steps
 

Detailed Description

Start task that provides all the settings common to all restores and other initial steps.

TODO: Finish phpdocs

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

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

◆ destroy()

base_task::destroy ( )
inherited

Destroy all circular references.

It helps PHP 5.2 a lot!

◆ 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

◆ get_results()

base_task::get_results ( )
inherited

Return the current plan's results.

Return values
array|null

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


The documentation for this class was generated from the following file: