base_ui_stage Class Reference

Inheritance diagram for base_ui_stage:

Public Member Functions
	__construct (base_ui $ui, array $params=null)
	get_params ()
	get_stage ()
	get_next_stage ()
	get_prev_stage ()
	get_name ()
	get_uniqueid ()
	display ()
	process (base_moodleform $form=null)
	get_ui ()
	is_first_stage ()
Protected Member Functions
	initialise_stage_form ()
Protected Attributes
	$stage = 1
	$ui
	$stageform = null
	$params = null

---

Detailed Description

Abstract stage class

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

• process : To process the stage
• initialise_stage_form : To get a backup_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 base_ui_stage.class.php.

---

Constructor & Destructor Documentation

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

Parameters:

base_ui

$ui

Reimplemented in restore_ui_stage_process.

Definition at line 65 of file base_ui_stage.class.php.

---

Member Function Documentation

display

(

)

Displays the stage.

By default this involves instantiating the form for the stage and the calling it to display.

Returns:

string HTML code to display

Reimplemented in backup_ui_stage_complete, backup_ui_stage_final, and import_ui_stage_confirmation.

Definition at line 120 of file base_ui_stage.class.php.

Here is the call graph for this function:

get_name

(

)

The name of this stage

Returns:

string

Reimplemented in restore_ui_stage.

Definition at line 101 of file base_ui_stage.class.php.

Here is the caller graph for this function:

get_next_stage

(

)

[final]

The next stage

Returns:

int

Definition at line 87 of file base_ui_stage.class.php.

get_params

(

)

[final]

Returns the custom params for this stage

Returns:

array|null

Definition at line 73 of file base_ui_stage.class.php.

get_prev_stage

(

)

[final]

The previous stage

Returns:

int

Definition at line 94 of file base_ui_stage.class.php.

get_stage

(

)

[final]

The current stage

Returns:

int

Definition at line 80 of file base_ui_stage.class.php.

Here is the caller graph for this function:

get_ui

(

)

[final]

Definition at line 152 of file base_ui_stage.class.php.

Here is the caller graph for this function:

get_uniqueid

(

)

[final]

The backup id from the backup controller

Returns:

string

Definition at line 108 of file base_ui_stage.class.php.

Here is the caller graph for this function:

initialise_stage_form

(

)

[abstract, protected]

Creates an instance of the correct moodleform properly populated and all dependencies instantiated

Returns:

backup_moodleform

Reimplemented in restore_ui_stage_process, restore_ui_stage_review, restore_ui_stage_schema, backup_ui_stage_final, restore_ui_stage_settings, backup_ui_stage_confirmation, backup_ui_stage_schema, import_ui_stage_confirmation, and backup_ui_stage_initial.

Here is the caller graph for this function:

is_first_stage

(

)

Reimplemented in restore_ui_stage.

Definition at line 156 of file base_ui_stage.class.php.

process

(

base_moodleform $

form = null

)

[abstract]

Processes the stage.

This must be overridden by every stage as it will be different for every stage

Parameters:

backup_moodleform | null

$form

Reimplemented in restore_ui_stage_process, restore_ui_stage_review, restore_ui_stage_schema, backup_ui_stage_final, restore_ui_stage_settings, backup_ui_stage_confirmation, backup_ui_stage_schema, and backup_ui_stage_initial.

---

Field Documentation

$params = null [protected]

Custom form params that will be added as hidden inputs

Definition at line 60 of file base_ui_stage.class.php.

$stage = 1 [protected]

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

$stageform = null [protected]

Definition at line 56 of file base_ui_stage.class.php.

$ui [protected]

Definition at line 51 of file base_ui_stage.class.php.

---

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

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