backup_plugin Class Reference

Inheritance diagram for backup_plugin:

Public Member Functions
	__construct ($plugintype, $pluginname, $optigroup, $step)
	define_plugin_structure ($connectionpoint)
Protected Member Functions
	get_setting_value ($name)
	get_plugin_element ($final_elements=null, $conditionparam=null, $conditionvalue=null)
	get_recommended_name ()
Protected Attributes
	$plugintype
	$pluginname
	$connectionpoint
	$optigroup
	$step
	$task

---

Detailed Description

Class implementing the plugins support for moodle2 backups

TODO: Finish phpdocs

Definition at line 30 of file backup_plugin.class.php.

---

Constructor & Destructor Documentation

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

Reimplemented in backup_theme_plugin, and backup_format_plugin.

Definition at line 39 of file backup_plugin.class.php.

---

Member Function Documentation

define_plugin_structure

(

$

connectionpoint

)

Reimplemented in backup_plagiarism_plugin.

Definition at line 48 of file backup_plugin.class.php.

get_plugin_element	(	$	final_elements = null,
		$	conditionparam = null,
		$	conditionvalue = null
	)		[protected]

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)

Definition at line 79 of file backup_plugin.class.php.

Here is the caller graph for this function:

get_recommended_name

(

)

[protected]

Simple helper function that suggests one name for the main nested element in plugins It's not mandatory to use it but recommended ;-)

Definition at line 92 of file backup_plugin.class.php.

Here is the caller graph for this function:

get_setting_value

(

$

name

)

[protected]

Returns the value of one (task/plan) setting

Definition at line 66 of file backup_plugin.class.php.

---

Field Documentation

$connectionpoint [protected]

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

$optigroup [protected]

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

$pluginname [protected]

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

$plugintype [protected]

Definition at line 32 of file backup_plugin.class.php.

$step [protected]

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

$task [protected]

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

---

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

• C:/xampp/htdocs/moodle/backup/moodle2/backup_plugin.class.php