base_step Class Reference

Inheritance diagram for base_step:

Collaboration diagram for base_step:

Public Member Functions
	__construct ($name, $task=null)
	get_name ()
	set_task ($task)
	destroy ()
	log ($message, $level, $a=null, $depth=null, $display=false)
Protected Member Functions
	get_settings ()
	Protected API starts here.
	get_setting ($name)
	setting_exists ($name)
	get_setting_value ($name)
	get_courseid ()
	get_basepath ()
	get_logger ()
Protected Attributes
	$name
	$task

---

Detailed Description

Abstract class defining the basis for one execution (backup/restore) step

TODO: Finish phpdocs

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

---

Constructor & Destructor Documentation

__construct	(	$	name,
		$	task = null
	)

Constructor - instantiates one object of this class

Reimplemented in backup_step, and restore_step.

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

---

Member Function Documentation

destroy

(

)

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

Definition at line 63 of file base_step.class.php.

get_basepath

(

)

[protected]

Definition at line 112 of file base_step.class.php.

Here is the caller graph for this function:

get_courseid

(

)

[protected]

Definition at line 105 of file base_step.class.php.

get_logger

(

)

[protected]

Definition at line 116 of file base_step.class.php.

Here is the caller graph for this function:

get_name

(

)

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

Here is the caller graph for this function:

get_setting

(

$

name

)

[protected]

Definition at line 84 of file base_step.class.php.

get_setting_value

(

$

name

)

[protected]

Definition at line 98 of file base_step.class.php.

get_settings

(

)

[protected]

Protected API starts here.

Definition at line 77 of file base_step.class.php.

Here is the caller graph for this function:

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 68 of file base_step.class.php.

Here is the call graph for this function:

set_task

(

$

task

)

Definition at line 53 of file base_step.class.php.

setting_exists

(

$

name

)

[protected]

Definition at line 91 of file base_step.class.php.

Here is the caller graph for this function:

---

Field Documentation

$name [protected]

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

$task [protected]

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

---

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

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