Moodle  2.2.1
http://www.collinsharper.com
backup_activity_task Class Reference
Inheritance diagram for backup_activity_task:
Collaboration diagram for backup_activity_task:

Public Member Functions

 __construct ($name, $moduleid, $plan=null)
 get_moduleid ()
 get_sectionid ()
 get_modulename ()
 get_activityid ()
 get_contextid ()
 get_taskbasepath ()
 build ()
 execute ()
 get_setting ($name)

Static Public Member Functions

static encode_content_links ($content)

Protected Member Functions

 define_settings ()
 define_my_settings ()
 define_my_steps ()

Protected Attributes

 $moduleid
 $sectionid
 $modulename
 $activityid
 $contextid

Detailed Description

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

TODO: Finish phpdocs

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


Constructor & Destructor Documentation

__construct ( name,
moduleid,
plan = null 
)

Constructor - instantiates one object of this class

Definition at line 42 of file backup_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 92 of file backup_activity_task.class.php.

Here is the call graph for this function:

define_settings ( ) [protected]

Define the common setting that any backup activity will have

Reimplemented from base_task.

Definition at line 216 of file backup_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 backup_activity_task.class.php.

Here is the call graph for this function:

Definition at line 74 of file backup_activity_task.class.php.

Definition at line 78 of file backup_activity_task.class.php.

Definition at line 62 of file backup_activity_task.class.php.

Definition at line 70 of file backup_activity_task.class.php.

Definition at line 66 of file backup_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 191 of file backup_activity_task.class.php.

Activity tasks have their own directory to write files

Reimplemented from base_task.

Definition at line 85 of file backup_activity_task.class.php.

Here is the call graph for this function:


Field Documentation

$activityid [protected]

Definition at line 36 of file backup_activity_task.class.php.

$contextid [protected]

Definition at line 37 of file backup_activity_task.class.php.

$moduleid [protected]

Definition at line 33 of file backup_activity_task.class.php.

$modulename [protected]

Definition at line 35 of file backup_activity_task.class.php.

$sectionid [protected]

Definition at line 34 of file backup_activity_task.class.php.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations