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

Inheritance diagram for restore_block_task:

Public Member Functions
	__construct ($name, $taskbasepath, $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)

	backup_release_compare (string $release, string $operator)
	Compares the provided moodle release with the one the backup was taken from.

	backup_version_compare (int $version, string $operator)
	Compares the provided moodle version with the one the backup was taken from.

	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)

	execute_after_restore ()
	If the task has been executed, launch its after_restore() method if available.

	get_basepath ()

	get_blockid ()

	get_blockname ()

	get_comment_mapping_itemname ($commentarea)
	Given a commment area, return the itemname that contains the itemid mappings.

	get_configdata_encoded_attributes ()
	Define one array() of configdata attributes that need to be decoded.

	get_contextid ()

	get_courseid ()

	get_decoder ()

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

	get_info ()

	get_logger ()

	get_name ()

	get_old_blockid ()

	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.

	get_restoreid ()

	get_results ()
	Return the current plan's results.

	get_setting ($name)

	get_setting_value ($name)

	get_settings ()

	get_steps ()

	get_target ()

	get_taskbasepath ()
	Block tasks have their own directory to write files.

	get_tempdir ()

	get_userid ()

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

	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_blockid ($blockid)

	set_blockname ($blockname)

	set_contextid ($contextid)

	set_old_blockid ($blockid)

	set_old_contextid ($contextid)

	set_plan ($plan)

	set_preloaded_information ()

	setting_exists ($name)

Static Public Member Functions
static	define_decode_contents ()
	Define the contents in the activity that must be processed by the link decoder.

static	define_decode_rules ()
	Define the decoding rules for links belonging to the activity to be executed by the link decoder.

Protected Member Functions
	add_setting ($setting)

	decode_configdata (string $configdata)
	Helper method to safely unserialize block configuration during restore.

	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

string	$name

	$oldblockid

	$oldcontextid

backup_plan restore_plan	$plan

base_setting[]	$settings

base_step[]	$steps

	$taskbasepath

Detailed Description

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

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

◆ backup_release_compare()

restore_task::backup_release_compare	(	string	$release,
		string	$operator )

inherited

Compares the provided moodle release with the one the backup was taken from.

Parameters

string	$release	Moodle release (X.Y or X.Y.Z)
string	$operator	Operator to compare the provided release to the backup release. {

See also: version_compare()}

Return values

bool	True if the comparison passes.

◆ backup_version_compare()

restore_task::backup_version_compare	(	int	$version,
		string	$operator )

inherited

Compares the provided moodle version with the one the backup was taken from.

Parameters

int	$version	Moodle version number (YYYYMMDD or YYYYMMDDXX)
string	$operator	Operator to compare the provided version to the backup version. {

See also: version_compare()}

Return values

bool	True if the comparison passes.

◆ build()

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

◆ decode_configdata()

restore_block_task::decode_configdata ( string $configdata )

protected

Helper method to safely unserialize block configuration during restore.

Parameters

string $configdata The original base64 encoded block config, as retrieved from the block_instances table

Return values

stdClass

◆ define_decode_contents()

static restore_block_task::define_decode_contents ( )

static

Define the contents in the activity that must be processed by the link decoder.

Reimplemented in restore_activity_results_block_task, restore_default_block_task, restore_glossary_random_block_task, restore_html_block_task, restore_rss_client_block_task, and restore_tags_block_task.

◆ define_decode_rules()

static restore_block_task::define_decode_rules ( )

static

Define the decoding rules for links belonging to the activity to be executed by the link decoder.

Reimplemented in restore_activity_results_block_task, restore_default_block_task, restore_glossary_random_block_task, restore_html_block_task, restore_rss_client_block_task, and restore_tags_block_task.

◆ define_my_settings()

restore_block_task::define_my_settings ( )

abstractprotected

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

Reimplemented in restore_activity_results_block_task, restore_default_block_task, restore_glossary_random_block_task, restore_html_block_task, restore_rss_client_block_task, and restore_tags_block_task.

◆ define_my_steps()

restore_block_task::define_my_steps ( )

abstractprotected

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

Reimplemented in restore_activity_results_block_task, restore_default_block_task, restore_glossary_random_block_task, restore_html_block_task, restore_rss_client_block_task, and restore_tags_block_task.

◆ define_settings()

restore_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!

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

restore_task::get_comment_mapping_itemname ( $commentarea )

inherited

Given a commment area, return the itemname that contains the itemid mappings.

By default, both are the same (commentarea = itemname), so return it. If some plugins use a different approach, this method can be overriden in its task.

Parameters

string $commentarea area defined for this comment

Return values

string itemname that contains the related itemid mapping

Reimplemented in restore_assign_activity_task, and restore_data_activity_task.

◆ get_configdata_encoded_attributes()

restore_block_task::get_configdata_encoded_attributes ( )

abstract

Define one array() of configdata attributes that need to be decoded.

Reimplemented in restore_activity_results_block_task, restore_default_block_task, restore_glossary_random_block_task, restore_html_block_task, restore_rss_client_block_task, and restore_tags_block_task.

◆ get_fileareas()

restore_block_task::get_fileareas ( )

abstract

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

Reimplemented in restore_activity_results_block_task, restore_default_block_task, restore_glossary_random_block_task, restore_html_block_task, restore_rss_client_block_task, and restore_tags_block_task.

◆ get_old_contextid()

restore_block_task::get_old_contextid ( )

Reimplemented from restore_task.

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

restore_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/restore_block_task.class.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ add_result()

◆ backup_release_compare()

◆ backup_version_compare()

◆ build()

◆ calculate_checksum()

◆ decode_configdata()

◆ define_decode_contents()

◆ define_decode_rules()

◆ define_my_settings()

◆ define_my_steps()

◆ define_settings()

◆ destroy()

◆ execute()

◆ get_comment_mapping_itemname()

◆ get_configdata_encoded_attributes()

◆ get_fileareas()

◆ get_old_contextid()

◆ get_progress()

◆ get_results()

◆ get_setting()

◆ get_taskbasepath()

◆ get_weight()

◆ is_checksum_correct()

◆ log()