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

Public Member Functions

 __construct ($name, $info, $plan=null)
 get_taskbasepath ()
 set_sectionid ($sectionid)
 get_contextid ()
 get_sectionid ()
 build ()
 execute ()
 get_setting ($name)

Static Public Member Functions

static define_decode_contents ()
static define_decode_rules ()

Protected Member Functions

 define_settings ()

Protected Attributes

 $info
 $contextid
 $sectionid

Detailed Description

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

TODO: Finish phpdocs

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


Constructor & Destructor Documentation

__construct ( name,
info,
plan = null 
)

Constructor - instantiates one object of this class

Definition at line 40 of file restore_section_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 69 of file restore_section_task.class.php.

Here is the call graph for this function:

static define_decode_contents ( ) [static]

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

Definition at line 128 of file restore_section_task.class.php.

static define_decode_rules ( ) [static]

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

Definition at line 140 of file restore_section_task.class.php.

define_settings ( ) [protected]

Define the common setting that any restore section will have

Reimplemented from base_task.

Definition at line 149 of file restore_section_task.class.php.

Here is the call graph for this function:

execute ( )

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

Reimplemented from base_task.

Definition at line 88 of file restore_section_task.class.php.

Here is the call graph for this function:

Definition at line 58 of file restore_section_task.class.php.

Definition at line 62 of file restore_section_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 104 of file restore_section_task.class.php.

Here is the call graph for this function:

Section tasks have their own directory to read files

Reimplemented from base_task.

Definition at line 49 of file restore_section_task.class.php.

Here is the call graph for this function:

set_sectionid ( sectionid)

Definition at line 54 of file restore_section_task.class.php.


Field Documentation

$contextid [protected]

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

$info [protected]

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

$sectionid [protected]

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


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