Inheritance diagram for restore_activity_task:

Collaboration diagram for restore_activity_task:

Public Member Functions
	__construct ($name, $info, $plan=null)
	get_taskbasepath ()
	set_moduleid ($moduleid)
	set_old_moduleversion ($oldmoduleversion)
	set_activityid ($activityid)
	set_old_activityid ($activityid)
	set_contextid ($contextid)
	set_old_contextid ($contextid)
	get_modulename ()
	get_moduleid ()
	get_old_moduleversion ()
	get_activityid ()
	get_old_activityid ()
	get_contextid ()
	get_old_contextid ()
	build ()
	execute ()
	get_setting ($name)
	get_comment_mapping_itemname ($commentarea)
Static Public Member Functions
static	define_decode_contents ()
static	define_decode_rules ()
static	define_restore_log_rules ()
Protected Member Functions
	define_my_steps ()
	define_settings ()
	define_my_settings ()
Protected Attributes
	$info
	$modulename
	$moduleid
	$oldmoduleid
	$oldmoduleversion
	$contextid
	$oldcontextid
	$activityid
	$oldactivityid

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

Definition at line 31 of file restore_activity_task.class.php.

Constructor & Destructor Documentation

__construct	(	$	name,
		$	info,
		$	plan = `null`
	)

Constructor - instantiates one object of this class

Definition at line 46 of file restore_activity_task.class.php.

Here is the call graph for this function:

Member Function Documentation

build ( )

Create all the steps that will be part of this task

Reimplemented from base_task.

Definition at line 121 of file restore_activity_task.class.php.

Here is the call graph for this function:

static define_decode_contents ( ) [static]

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

Definition at line 231 of file restore_activity_task.class.php.

static define_decode_rules ( ) [static]

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

Definition at line 239 of file restore_activity_task.class.php.

define_my_settings ( ) [abstract, protected]

Define (add) particular settings that each activity can have

Here is the caller graph for this function:

define_my_steps ( ) [abstract, protected]

Define (add) particular steps that each activity can have

Here is the caller graph for this function:

static 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

Definition at line 249 of file restore_activity_task.class.php.

define_settings ( ) [protected]

Define the common setting that any restore activity will have

Reimplemented from base_task.

Definition at line 258 of file restore_activity_task.class.php.

Here is the call graph for this function:

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.

Definition at line 174 of file restore_activity_task.class.php.

Here is the call graph for this function:

get_activityid ( )

Definition at line 102 of file restore_activity_task.class.php.

get_comment_mapping_itemname ( $ commentarea )

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

Definition at line 218 of file restore_activity_task.class.php.

get_contextid ( )

Definition at line 110 of file restore_activity_task.class.php.

get_moduleid ( )

Definition at line 94 of file restore_activity_task.class.php.

get_modulename ( )

Definition at line 90 of file restore_activity_task.class.php.

get_old_activityid ( )

Definition at line 106 of file restore_activity_task.class.php.

get_old_contextid ( )

Reimplemented from restore_task.

Definition at line 114 of file restore_activity_task.class.php.

get_old_moduleversion ( )

Definition at line 98 of file restore_activity_task.class.php.

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.

Definition at line 192 of file restore_activity_task.class.php.

Here is the call graph for this function: