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

Public Member Functions

 get_task ()

Protected Member Functions

 add_subplugin_structure ($subplugintype, $element, $multiple)
 prepare_activity_structure ($activitystructure)

Detailed Description

Abstract structure step, parent of all the activity structure steps. Used to wrap the activity structure definition within the main <activity ...> tag. Also provides subplugin support for activities (that must be properly declared)

Definition at line 91 of file backup_stepslib.php.


Member Function Documentation

add_subplugin_structure ( subplugintype,
element,
multiple 
) [protected]

Add subplugin structure to any element in the activity backup tree

Parameters:
string$subplugintypetype of subplugin as defined in activity db/subplugins.php
backup_nested_element$elementelement in the activity backup tree that we are going to add subplugin information to
bool$multipleto define if multiple subplugins can produce information for each instance of $element (true) or no (false)

Definition at line 102 of file backup_stepslib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

get_task ( )

As far as activity backup steps are implementing backup_subplugin stuff, they need to have the parent task available for wrapping purposes (get course/context....)

Reimplemented from backup_structure_step.

Definition at line 139 of file backup_stepslib.php.

prepare_activity_structure ( activitystructure) [protected]

Wraps any activity backup structure within the common 'activity' element that will include common to all activities information like id, context...

Definition at line 147 of file backup_stepslib.php.

Here is the caller graph for this function:


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