backup_block_task Class Reference

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

Inheritance diagram for backup_block_task:

Public Member Functions
	__construct ($name, $blockid, $moduleid=null, $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 ()
	Function responsible for executing the steps of any task (setting the $executed property to true)
	get_backupid ()
	get_basepath ()
	get_blockid ()
	get_blockname ()
	get_configdata_encoded_attributes ()
	Define one array() of configdata attributes that need to be processed by the contenttransformer.
	get_contextid ()
	get_courseid ()
	get_fileareas ()
	Define one array() of fileareas that each block controls.
	get_kept_roles ()
	Get the user roles that should be kept in the destination course for a course copy operation.
	get_logger ()
	get_moduleid ()
	get_modulename ()
	get_name ()
	get_parentcontextid ()
	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 ()
	Block 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)

Static Public Member Functions
static	encode_content_links ($content)
	Code the transformations to perform in the block in order to get transportable (encoded) links.

Protected Member Functions
	add_setting ($setting)
	define_my_settings ()
	Define (add) particular settings that each block can have.
	define_my_steps ()
	Define (add) particular steps that each block can have.
	define_settings ()
	Define the common setting that any backup block will have.

Protected Attributes
	$blockid
	$blockname
bool	$built
	$contextid
bool	$executed
	$moduleid
	$modulename
string	$name
	$parentcontextid
backup_plan restore_plan	$plan
base_setting[]	$settings
base_step[]	$steps

Detailed Description

abstract block task that provides all the properties and common steps to be performed when one block 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_block_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_my_settings()

backup_block_task::define_my_settings ( )

abstractprotected

Define (add) particular settings that each block can have.

Reimplemented in backup_default_block_task, backup_html_block_task, and backup_rss_client_block_task.

define_my_steps()

backup_block_task::define_my_steps ( )

abstractprotected

Define (add) particular steps that each block can have.

Reimplemented in backup_default_block_task, backup_html_block_task, and backup_rss_client_block_task.

define_settings()

backup_block_task::define_settings ( )

protected

Define the common setting that any backup block will have.

Reimplemented from base_task.

destroy()

base_task::destroy ( )

inherited

Destroy all circular references.

It helps PHP 5.2 a lot!

encode_content_links()

static backup_block_task::encode_content_links ( $content )

static

Code the transformations to perform in the block in order to get transportable (encoded) links.

Reimplemented in backup_default_block_task, backup_html_block_task, and backup_rss_client_block_task.

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

backup_block_task::get_configdata_encoded_attributes ( )

abstract

Define one array() of configdata attributes that need to be processed by the contenttransformer.

Reimplemented in backup_default_block_task, backup_html_block_task, and backup_rss_client_block_task.

get_fileareas()

backup_block_task::get_fileareas ( )

abstract

Define one array() of fileareas that each block controls.

Reimplemented in backup_default_block_task, backup_html_block_task, and backup_rss_client_block_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()

base_task::get_setting ( $name )

inherited

Reimplemented in backup_activity_task, backup_section_task, restore_activity_task, and restore_section_task.

get_taskbasepath()

backup_block_task::get_taskbasepath

(

)

Block 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_block_task.class.php