backup_plan Class Reference

Inheritance diagram for backup_plan:

Collaboration diagram for backup_plan:

Public Member Functions
	__construct ($controller)
	destroy ()
	build ()
	get_backupid ()
	get_mode ()
	get_courseid ()
	get_basepath ()
	get_logger ()
	is_excluding_activities ()
	set_excluding_activities ()
	log ($message, $level, $a=null, $depth=null, $display=false)
	execute ()
Protected Attributes
	$controller
	$basepath
	$excludingdactivities

---

Detailed Description

Implementable class defining the needed stuf for one backup plan

TODO: Finish phpdocs

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

---

Constructor & Destructor Documentation

__construct

(

$

controller

)

Constructor - instantiates one object of this class

Reimplemented from base_plan.

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

---

Member Function Documentation

build

(

)

Function responsible for building the tasks of any plan with their corresponding settings (must set the $built property to true)

Reimplemented from base_plan.

Definition at line 61 of file backup_plan.class.php.

Here is the call graph for this function:

destroy

(

)

Destroy all circular references. It helps PHP 5.2 a lot!

Reimplemented from base_plan.

Definition at line 54 of file backup_plan.class.php.

execute

(

)

Function responsible for executing the tasks of any plan

Reimplemented from base_plan.

Definition at line 101 of file backup_plan.class.php.

get_backupid

(

)

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

get_basepath

(

)

Definition at line 78 of file backup_plan.class.php.

get_courseid

(

)

Definition at line 74 of file backup_plan.class.php.

get_logger

(

)

Definition at line 82 of file backup_plan.class.php.

Here is the caller graph for this function:

get_mode

(

)

Definition at line 70 of file backup_plan.class.php.

is_excluding_activities

(

)

Definition at line 86 of file backup_plan.class.php.

log	(	$	message,
		$	level,
		$	a = null,
		$	depth = null,
		$	display = false
	)

This function will be responsible for handling the params, and to call to the corresponding logger->process() once all modifications in params have been performed

Implements loggable.

Definition at line 94 of file backup_plan.class.php.

Here is the call graph for this function:

set_excluding_activities

(

)

Definition at line 90 of file backup_plan.class.php.

---

Field Documentation

$basepath [protected]

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

$controller [protected]

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

$excludingdactivities [protected]

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

---

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

• C:/xampp/htdocs/moodle/backup/util/plan/backup_plan.class.php