restore_ui_independent_stage Class Reference

Abstract class used to represent a restore stage that is indenependent. More...

Inheritance diagram for restore_ui_independent_stage:

Public Member Functions
	__construct ($contextid)
	Constructs the restore stage. More...
	destroy ()
	Handles the destruction of this object.
	display (core_backup_renderer $renderer)
	Displays this restore stage. More...
	get_progress_bar ()
	Gets an array of progress bar items that can be displayed through the restore renderer. More...
	get_progress_reporter ()
	Gets the progress reporter object in use for this restore UI stage. More...
	get_stage ()
	Returns the current restore stage. More...
	get_stage_name ()
	Returns the restore stage name. More...
	is_independent ()
	Obviously true. More...
	process ()
	Processes the current restore stage. More...
	set_progress_reporter (\core\progress\base $progressreporter)
	Sets the progress reporter that will be returned by get_progress_reporter. More...

Detailed Description

Abstract class used to represent a restore stage that is indenependent.

An independent stage is a judged to be so because it doesn't require, and has no use for the restore controller.

Copyright

2010 Sam Hemelryk

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Constructor & Destructor Documentation

__construct()

restore_ui_independent_stage::__construct (   $contextid )

abstract

Constructs the restore stage.

Parameters

int

$contextid

Reimplemented in restore_ui_stage_destination, and restore_ui_stage_confirm.

Member Function Documentation

display()

restore_ui_independent_stage::display ( core_backup_renderer  $renderer )

abstract

Displays this restore stage.

Parameters

core_backup_renderer

$renderer

Return values

mixed

Reimplemented in restore_ui_stage_destination, and restore_ui_stage_confirm.

get_progress_bar()

restore_ui_independent_stage::get_progress_bar

(

)

Gets an array of progress bar items that can be displayed through the restore renderer.

Return values

array

Array of items for the progress bar

get_progress_reporter()

restore_ui_independent_stage::get_progress_reporter

(

)

Gets the progress reporter object in use for this restore UI stage.

IMPORTANT: This progress reporter is used only for UI progress that is outside the restore controller. The restore controller has its own progress reporter which is used for progress during the main restore. Use the restore controller's progress reporter to report progress during a restore operation, not this one.

This extra reporter is necessary because on some restore UI screens, there are long-running tasks even though there is no restore controller in use. There is a similar function in restore_ui. but that class is not used on some stages.

Return values

core

get_stage()

restore_ui_independent_stage::get_stage ( )

abstract

Returns the current restore stage.

Return values

int

Reimplemented in restore_ui_stage_destination, and restore_ui_stage_confirm.

get_stage_name()

restore_ui_independent_stage::get_stage_name ( )

abstract

Returns the restore stage name.

Return values

string

Reimplemented in restore_ui_stage_destination, and restore_ui_stage_confirm.

is_independent()

restore_ui_independent_stage::is_independent ( )

final

Obviously true.

Return values

true

process()

restore_ui_independent_stage::process ( )

abstract

Processes the current restore stage.

Return values

mixed

Reimplemented in restore_ui_stage_destination, and restore_ui_stage_confirm.

set_progress_reporter()

restore_ui_independent_stage::set_progress_reporter

(

\core\progress\base

$progressreporter

)

Sets the progress reporter that will be returned by get_progress_reporter.

Parameters

core\progress\base

$progressreporter

Progress reporter

---

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

• backup/util/ui/restore_ui_stage.class.php