base_task Class Reference

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

Inheritance diagram for base_task:

Public Member Functions
	__construct ($name, $plan=null)
	Constructor - instantiates one object of this class. More...
	add_result ($result)
	Add the given info to the current plan's results. More...
	add_step ($step)
	build ()
	Function responsible for building the steps of any task (must set the $built property to true) More...
	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) More...
	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. More...
	get_results ()
	Return the current plan's results. More...
	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. More...
	is_checksum_correct ($checksum)
	Given one checksum, returns if matches object's checksum (true) or no (false) More...
	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. More...
	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. More...

Protected Attributes
	$built
	$executed
	$name
	$plan
	$settings
	$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

$result

associative array describing a result of a task/step

build()

base_task::build ( )

abstract

Function responsible for building the steps of any task (must set the $built property to true)

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.

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::base

Progress 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

)

Reimplemented in backup_activity_task, backup_section_task, restore_activity_task, and restore_section_task.

get_taskbasepath()

base_task::get_taskbasepath

(

)

Reimplemented in backup_activity_task, backup_block_task, backup_course_task, backup_section_task, restore_activity_task, restore_block_task, restore_course_task, and restore_section_task.

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

int

Weight

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:

• backup/util/plan/base_task.class.php