backup_subplugin Class Reference

Inheritance diagram for backup_subplugin:

Public Member Functions
	__construct ($subplugintype, $subpluginname, $optigroup, $step)
	define_subplugin_structure ($connectionpoint)
Protected Member Functions
	get_setting_value ($name)
	get_subplugin_element ($final_elements=null, $conditionparam=null, $conditionvalue=null)
	get_recommended_name ()
Protected Attributes
	$subplugintype
	$subpluginname
	$connectionpoint
	$optigroup
	$step
	$task

---

Detailed Description

Class implementing the subplugins support for moodle2 backups

TODO: Finish phpdocs TODO: Make this subclass of backup_plugin

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

---

Constructor & Destructor Documentation

__construct	(	$	subplugintype,
		$	subpluginname,
		$	optigroup,
		$	step
	)

Definition at line 40 of file backup_subplugin.class.php.

---

Member Function Documentation

define_subplugin_structure

(

$

connectionpoint

)

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

get_recommended_name

(

)

[protected]

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

Definition at line 93 of file backup_subplugin.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 67 of file backup_subplugin.class.php.

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

Factory method that will return one backup_subplugin_element (backup_optigroup_element) with its name automatically calculated, based one the subplugin being handled (type, name)

Definition at line 80 of file backup_subplugin.class.php.

Here is the caller graph for this function:

---

Field Documentation

$connectionpoint [protected]

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

$optigroup [protected]

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

$step [protected]

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

$subpluginname [protected]

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

$subplugintype [protected]

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

$task [protected]

Definition at line 38 of file backup_subplugin.class.php.

---

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

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