Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
base_task Class Reference

Abstract class defining the basis for one execution (backup/restore) task. More...

Inheritance diagram for base_task:
checksumable executable loggable backup_task restore_task 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 restore_section_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_basepath ()
 
 get_courseid ()
 
 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)
 
 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 basis for one execution (backup/restore) task.

TODO: Finish phpdocs

Constructor & Destructor Documentation

◆ __construct()

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

Constructor - instantiates one object of this class.

Reimplemented in backup_task, and restore_task.

Member Function Documentation

◆ add_result()

base_task::add_result ( $result)

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

◆ calculate_checksum()

base_task::calculate_checksum ( )

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

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

Destroy all circular references.

It helps PHP 5.2 a lot!

◆ execute()

base_task::execute ( )

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

base_task::get_progress ( )

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

Return the current plan's results.

Return values
array|null

◆ get_setting()

base_task::get_setting ( $name)

◆ get_taskbasepath()

◆ get_weight()

base_task::get_weight ( )

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)

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 )

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: