base_step Class Reference

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

Inheritance diagram for base_step:

Public Member Functions
	__construct ($name, $task=null)
	Constructor - instantiates one object of this class.
	destroy ()
	Destroy all circular references. More...
	execute ()
	This function will perform all the actions necessary to achieve the execution of the plan/part/task.
	get_name ()
	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.
	set_task ($task)

Protected Member Functions
	get_basepath ()
	get_courseid ()
	get_logger ()
	get_setting ($name)
	get_setting_value ($name)
	get_settings ()
	Protected API starts here.
	setting_exists ($name)

Protected Attributes
	$name
	$task

Detailed Description

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

TODO: Finish phpdocs

Member Function Documentation

destroy()

base_step::destroy

(

)

Destroy all circular references.

It helps PHP 5.2 a lot!

---

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

• backup/util/plan/base_step.class.php