restore_activity_task Class Reference

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

Inheritance diagram for restore_activity_task:

Public Member Functions
	__construct ($name, $info, $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 ()
	Exceptionally override the execute method, so, based in the activity_included setting, we are able to skip the execution of one task completely.
	execute_after_restore ()
	If the task has been executed, launch its after_restore() method if available.
	get_activityid ()
	get_basepath ()
	get_comment_mapping_itemname ($commentarea)
	Given a commment area, return the itemname that contains the itemid mappings.
	get_contextid ()
	get_courseid ()
	get_decoder ()
	get_info ()
	get_logger ()
	get_moduleid ()
	get_modulename ()
	get_name ()
	get_old_activityid ()
	get_old_contextid ()
	get_old_courseid ()
	get_old_moduleid ()
	Returns the old course module id (cmid of activity which will be restored)
	get_old_moduleversion ()
	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)
	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_target ()
	get_taskbasepath ()
	Activity tasks have their own directory to read 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_activityid ($activityid)
	set_contextid ($contextid)
	set_moduleid ($moduleid)
	set_old_activityid ($activityid)
	set_old_contextid ($contextid)
	set_old_moduleversion ($oldmoduleversion)
	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.
static	define_restore_log_rules ()
	Define the restore log rules that will be applied by the restore_logs_processor when restoring activity logs.

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

Protected Attributes
	$activityid
bool	$built
	$contextid
bool	$executed
	$info
	$moduleid
	$modulename
string	$name
	$oldactivityid
	$oldcontextid
	$oldmoduleid
	$oldmoduleversion
backup_plan restore_plan	$plan
base_setting[]	$settings
base_step[]	$steps

Detailed Description

abstract activity task that provides all the properties and common tasks to be performed when one activity 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_activity_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_decode_contents()

static restore_activity_task::define_decode_contents ( )

static

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

Reimplemented in restore_assign_activity_task, restore_bigbluebuttonbn_activity_task, restore_book_activity_task, restore_chat_activity_task, restore_choice_activity_task, restore_data_activity_task, restore_feedback_activity_task, restore_folder_activity_task, restore_forum_activity_task, restore_glossary_activity_task, restore_h5pactivity_activity_task, restore_imscp_activity_task, restore_label_activity_task, restore_lesson_activity_task, restore_lti_activity_task, restore_page_activity_task, restore_quiz_activity_task, restore_resource_activity_task, restore_scorm_activity_task, restore_survey_activity_task, restore_url_activity_task, restore_wiki_activity_task, and restore_workshop_activity_task.

define_decode_rules()

static restore_activity_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_assign_activity_task, restore_bigbluebuttonbn_activity_task, restore_book_activity_task, restore_chat_activity_task, restore_choice_activity_task, restore_data_activity_task, restore_feedback_activity_task, restore_folder_activity_task, restore_forum_activity_task, restore_glossary_activity_task, restore_h5pactivity_activity_task, restore_imscp_activity_task, restore_label_activity_task, restore_lesson_activity_task, restore_lti_activity_task, restore_page_activity_task, restore_quiz_activity_task, restore_resource_activity_task, restore_scorm_activity_task, restore_survey_activity_task, restore_url_activity_task, restore_wiki_activity_task, and restore_workshop_activity_task.

define_my_settings()

restore_activity_task::define_my_settings ( )

abstractprotected

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

Reimplemented in restore_assign_activity_task, restore_bigbluebuttonbn_activity_task, restore_book_activity_task, restore_chat_activity_task, restore_choice_activity_task, restore_data_activity_task, restore_feedback_activity_task, restore_folder_activity_task, restore_forum_activity_task, restore_glossary_activity_task, restore_h5pactivity_activity_task, restore_imscp_activity_task, restore_label_activity_task, restore_lesson_activity_task, restore_lti_activity_task, restore_page_activity_task, restore_quiz_activity_task, restore_resource_activity_task, restore_scorm_activity_task, restore_survey_activity_task, restore_url_activity_task, restore_wiki_activity_task, and restore_workshop_activity_task.

define_my_steps()

restore_activity_task::define_my_steps ( )

abstractprotected

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

Reimplemented in restore_assign_activity_task, restore_bigbluebuttonbn_activity_task, restore_book_activity_task, restore_chat_activity_task, restore_choice_activity_task, restore_data_activity_task, restore_feedback_activity_task, restore_folder_activity_task, restore_forum_activity_task, restore_glossary_activity_task, restore_h5pactivity_activity_task, restore_imscp_activity_task, restore_label_activity_task, restore_lesson_activity_task, restore_lti_activity_task, restore_page_activity_task, restore_quiz_activity_task, restore_resource_activity_task, restore_scorm_activity_task, restore_survey_activity_task, restore_url_activity_task, restore_wiki_activity_task, and restore_workshop_activity_task.

define_restore_log_rules()

static restore_activity_task::define_restore_log_rules ( )

static

Define the restore log rules that will be applied by the restore_logs_processor when restoring activity logs.

It must return one array of restore_log_rule objects

Reimplemented in restore_assign_activity_task, restore_bigbluebuttonbn_activity_task, restore_book_activity_task, restore_chat_activity_task, restore_choice_activity_task, restore_data_activity_task, restore_feedback_activity_task, restore_folder_activity_task, restore_forum_activity_task, restore_glossary_activity_task, restore_h5pactivity_activity_task, restore_imscp_activity_task, restore_label_activity_task, restore_lesson_activity_task, restore_lti_activity_task, restore_page_activity_task, restore_quiz_activity_task, restore_resource_activity_task, restore_scorm_activity_task, restore_survey_activity_task, restore_url_activity_task, restore_wiki_activity_task, and restore_workshop_activity_task.

define_settings()

restore_activity_task::define_settings ( )

protected

Define the common setting that any restore activity will have.

Reimplemented from base_task.

destroy()

base_task::destroy ( )

inherited

Destroy all circular references.

It helps PHP 5.2 a lot!

execute()

restore_activity_task::execute

(

)

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

Reimplemented from base_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_old_contextid()

restore_activity_task::get_old_contextid

(

)

Reimplemented from restore_task.

get_old_moduleid()

restore_activity_task::get_old_moduleid

(

)

Returns the old course module id (cmid of activity which will be restored)

Return values

int

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

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

restore_activity_task::get_taskbasepath

(

)

Activity tasks have their own directory to read 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_activity_task.class.php