restore_ui_stage Class Reference

Inheritance diagram for restore_ui_stage:

Collaboration diagram for restore_ui_stage:

Public Member Functions
	__construct (restore_ui $ui, array $params=null)
	get_restoreid ()
	is_independent ()
	has_sub_stages ()
	get_name ()
	is_first_stage ()

---

Detailed Description

Abstract stage class

This class should be extended by all restore stages (a requirement of many restore ui functions). Each stage must then define two abstract methods

• process : To process the stage
• initialise_stage_form : To get a restore_moodleform instance for the stage

Copyright:

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

Definition at line 41 of file restore_ui_stage.class.php.

---

Constructor & Destructor Documentation

__construct	(	restore_ui $	ui,
		array $	params = null
	)

Constructor

Parameters:

restore_ui

$ui

Reimplemented in restore_ui_stage_schema, and restore_ui_stage_settings.

Definition at line 46 of file restore_ui_stage.class.php.

---

Member Function Documentation

get_name

(

)

[final]

The name of this stage

Returns:

string

Reimplemented from base_ui_stage.

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

get_restoreid

(

)

[final]

The restore id from the restore controller

Returns:

string

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

Here is the call graph for this function:

has_sub_stages

(

)

No sub stages for this stage

Returns:

false

Reimplemented in restore_ui_stage_process.

Definition at line 69 of file restore_ui_stage.class.php.

is_first_stage

(

)

[final]

Returns true if this is the settings stage

Returns:

bool

Reimplemented from base_ui_stage.

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

is_independent

(

)

[final]

This is an independent stage

Returns:

int

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

---

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

• C:/xampp/htdocs/moodle/backup/util/ui/restore_ui_stage.class.php