restore_lesson_activity_task Class Reference

lesson restore task that provides all the settings and steps to perform one complete restore of the activity More...

Inheritance diagram for restore_lesson_activity_task:

Public Member Functions
	add_result ($result)
	Add the given info to the current plan's results. More...
	add_step ($step)
	after_restore ()
	Re-map the dependency and activitylink information If a depency or activitylink has no mapping in the backup data then it could either be a duplication of a lesson, or a backup/restore of a single lesson. More...
	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. More...
	destroy ()
	Destroy all circular references. More...
	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. More...
	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_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. More...
	get_restoreid ()
	get_results ()
	Return the current plan's results. More...
	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. More...
	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 lesson logs. More...
static	define_restore_log_rules_for_course ()
	Define the restore log rules that will be applied by the restore_logs_processor when restoring course logs. More...

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

Protected Attributes
	$activityid
	$built
	$contextid
	$executed
	$info
	$moduleid
	$modulename
	$name
	$oldactivityid
	$oldcontextid
	$oldmoduleid
	$oldmoduleversion
	$plan
	$settings
	$steps

Detailed Description

lesson restore task that provides all the settings and steps to perform one complete restore of the activity

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

after_restore()

restore_lesson_activity_task::after_restore

(

)

Re-map the dependency and activitylink information If a depency or activitylink has no mapping in the backup data then it could either be a duplication of a lesson, or a backup/restore of a single lesson.

We have no way to determine which and whether this is the same site and/or course. Therefore we try and retrieve a mapping, but fallback to the original value if one was not found. We then test to see whether the value found is valid for the course being restored into.

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

static restore_lesson_activity_task::define_restore_log_rules ( )

static

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

It must return one array of restore_log_rule objects

Reimplemented from restore_activity_task.

define_restore_log_rules_for_course()

static restore_lesson_activity_task::define_restore_log_rules_for_course ( )

static

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

It must return one array of restore_log_rule objects

Note this rules are applied when restoring course logs by the restore final task, but are defined here at activity level. All them are rules not linked to any module instance (cmid = 0)

destroy()

base_task::destroy ( )

inherited

Destroy all circular references.

It helps PHP 5.2 a lot!

get_comment_mapping_itemname()

restore_activity_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 module uses a different approach, this method can be overriden in its taks

Reimplemented in restore_data_activity_task, and restore_assign_activity_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

get_results()

base_task::get_results ( )

inherited

Return the current plan's results.

Return values

array|null

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.

---

The documentation for this class was generated from the following file:

• mod/lesson/backup/moodle2/restore_lesson_activity_task.class.php