[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/backup/util/plan/ -> backup_structure_step.class.php (summary)

(no description)

Copyright: 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 182 lines (7 kb)
Included or required:0 times
Referenced: 1 time
Includes or requires: 0 files

Defines 5 functions

  __construct()
  execute()
  get_task()
  add_plugin_structure()
  execute_condition()

Functions
Functions that are not part of a class:

__construct($name, $filename, $task = null)   X-Ref
Constructor - instantiates one object of this class


execute()   X-Ref
No description

get_task()   X-Ref
As far as backup structure steps are implementing backup_plugin stuff, they need to
have the parent task available for wrapping purposes (get course/context....)


add_plugin_structure($plugintype, $element, $multiple)   X-Ref
Add plugin structure to any element in the structure backup tree

param: string $plugintype type of plugin as defined by core_component::get_plugin_types()
param: backup_nested_element $element element in the structure backup tree that
param: bool $multiple to define if multiple plugins can produce information

execute_condition()   X-Ref
To conditionally decide if one step will be executed or no

For steps needing to be executed conditionally, based in dynamic
conditions (at execution time vs at declaration time) you must
override this function. It will return true if the step must be
executed and false if not



Generated: Fri Nov 28 20:29:05 2014 Cross-referenced by PHPXref 0.7.1