backup_execution_step Class Reference

Abstract class defining the needed stuff to execute code on backup. More...

Inheritance diagram for backup_execution_step:

Public Member Functions
	destroy ()
	Destroy all circular references.
	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
	define_execution ()
	Function that will contain all the code to be executed.
	get_backupid ()
	get_basepath ()
	get_courseid ()
	get_logger ()
	get_setting ($name)
	get_setting_value ($name)
	get_settings ()
	Protected API starts here.
	setting_exists ($name)

Protected Attributes
string	$name
	One simple name for identification purposes.
base_task null	$task
	Task this is part of.

Detailed Description

Abstract class defining the needed stuff to execute code on backup.

TODO: Finish phpdocs

Member Function Documentation

define_execution()

backup_execution_step::define_execution ( )

abstractprotected

Function that will contain all the code to be executed.

Reimplemented in create_and_clean_temp_stuff, create_taskbasepath_directory, drop_and_clean_temp_stuff, imscc11_backup_convert, imscc11_store_backup_file, and imscc11_zip_contents.

destroy()

base_step::destroy ( )

inherited

Destroy all circular references.

It helps PHP 5.2 a lot!

execute()

backup_execution_step::execute

(

)

This function will perform all the actions necessary to achieve the execution of the plan/part/task.

Implements executable.

log()

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

inherited

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.

---

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

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