backup_section_task Class Reference

section task that provides all the properties and common steps to be performed when one section is being backup More...

Inheritance diagram for backup_section_task:

Public Member Functions
	__construct ($name, $sectionid, $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 section_included setting, we are able to skip the execution of one task completely.
	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_sectionid ()
	get_setting ($name)
	Specialisation that, first of all, looks for the setting within the task with the the prefix added and later, delegates to parent without adding anything.
	get_setting_value ($name)
	get_settings ()
	get_steps ()
	get_taskbasepath ()
	Section tasks have their own directory to write files.
	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 ()
	Define the common setting that any backup section will have.

Protected Attributes
bool	$built
bool	$executed
string	$name
backup_plan restore_plan	$plan
	$sectionid
base_setting[]	$settings
base_step[]	$steps

Detailed Description

section task that provides all the properties and common steps to be performed when one section is being backup

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

$result

associative array describing a result of a task/step

build()

backup_section_task::build

(

)

Create all the steps that will be part of this task.

Reimplemented from base_task.

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

backup_section_task::define_settings ( )

protected

Define the common setting that any backup section will have.

Reimplemented from base_task.

destroy()

base_task::destroy ( )

inherited

Destroy all circular references.

It helps PHP 5.2 a lot!

execute()

backup_section_task::execute

(

)

Exceptionally override the execute method, so, based in the section_included setting, we are able to skip the execution of one task completely.

Reimplemented from base_task.

get_kept_roles()

backup_task::get_kept_roles ( )

inherited

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

Progress reporting object

get_results()

base_task::get_results ( )

inherited

Return the current plan's results.

Return values

array|null

get_setting()

backup_section_task::get_setting

(

$name

)

Specialisation that, first of all, looks for the setting within the task with the the prefix added and later, delegates to parent without adding anything.

Reimplemented from base_task.

get_taskbasepath()

backup_section_task::get_taskbasepath

(

)

Section tasks have their own directory to write files.

Reimplemented from base_task.

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

int

Weight

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:

• backup/moodle2/backup_section_task.class.php