backup_plugin Class Reference

Class implementing the plugins support for moodle2 backups. More...

Inheritance diagram for backup_plugin:

Public Member Functions
	__construct ($plugintype, $pluginname, $optigroup, $step)
	backup_plugin constructor. More...
	define_plugin_structure ($connectionpoint)

Protected Member Functions
	get_plugin_element ($final_elements=null, $conditionparam=null, $conditionvalue=null)
	Factory method that will return one backup_plugin_element (backup_optigroup_element) with its name automatically calculated, based one the plugin being handled (type, name)
	get_recommended_name ()
	Simple helper function that suggests one name for the main nested element in plugins It's not mandatory to use it but recommended ;-)
	get_setting_value ($name)
	Returns the value of one (task/plan) setting.

Protected Attributes
string	$connectionpoint
backup_optigroup_element	$optigroup
string	$pluginname
string	$plugintype
backup_structure_step	$step
backup_course_task backup_activity_task	$task

Detailed Description

Class implementing the plugins support for moodle2 backups.

TODO: Finish phpdocs

Constructor & Destructor Documentation

__construct()

backup_plugin::__construct	(		$plugintype,
			$pluginname,
			$optigroup,
			$step
	)

backup_plugin constructor.

Parameters

string	$plugintype
string	$pluginname
backup_optigroup_element	$optigroup
backup_structure_step	$step

Reimplemented in backup_theme_plugin, and backup_format_plugin.

---

The documentation for this class was generated from the following file:

• backup/moodle2/backup_plugin.class.php