restore_ui_stage_schema Class Reference

Schema stage of backup process. More...

Inheritance diagram for restore_ui_stage_schema:

Public Member Functions
	__construct (restore_ui $ui, array $params=null)
	Schema stage constructor. More...
	display (core_backup_renderer $renderer)
	Displays the stage. More...
	get_name ()
	The name of this stage. More...
	get_next_stage ()
	The next stage. More...
	get_params ()
	Returns the custom params for this stage. More...
	get_prev_stage ()
	The previous stage. More...
	get_restoreid ()
	The restore id from the restore controller. More...
	get_stage ()
	The current stage. More...
	get_ui ()
	Returns the base UI class. More...
	get_uniqueid ()
	The backup id from the backup controller. More...
	has_sub_stages ()
	No sub stages for this stage. More...
	is_first_stage ()
	Returns true if this is the settings stage. More...
	is_independent ()
	This is an independent stage. More...
	process (base_moodleform $form=null)
	Processes the schema stage. More...

Public Attributes
int const	MAX_SETTINGS_BATCH = 1000
	Maximum number of settings to add to form at once.

Protected Member Functions
	initialise_stage_form ()
	Creates the backup_schema_form instance for this stage. More...

Protected Attributes
array	$params = null
	Custom form params that will be added as hidden inputs.
int	$stage = 1
	The current stage.
base_moodleform	$stageform = null
	The moodleform for this stage.
base_ui	$ui
	The backuck UI object.

Detailed Description

Schema stage of backup process.

During the schema stage the user is required to set the settings that relate to the area that they are backing up as well as its children.

Copyright

2010 Sam Hemelryk

License

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

Constructor & Destructor Documentation

__construct()

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

Schema stage constructor.

Parameters

restore_ui	$ui
array	$params

Reimplemented from restore_ui_stage.

Member Function Documentation

display()

base_ui_stage::display ( core_backup_renderer  $renderer )

inherited

Displays the stage.

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

Parameters

core_backup_renderer

$renderer

Return values

string

HTML code to echo

Reimplemented in restore_ui_stage_complete, restore_ui_stage_process, import_ui_stage_confirmation, backup_ui_stage_complete, and backup_ui_stage_final.

get_name()

restore_ui_stage::get_name ( )

finalinherited

The name of this stage.

Return values

string

Reimplemented from base_ui_stage.

get_next_stage()

base_ui_stage::get_next_stage ( )

inherited

The next stage.

Return values

int

Reimplemented in backup_ui_stage_initial.

get_params()

base_ui_stage::get_params ( )

finalinherited

Returns the custom params for this stage.

Return values

array|null

get_prev_stage()

base_ui_stage::get_prev_stage ( )

finalinherited

The previous stage.

Return values

int

get_restoreid()

restore_ui_stage::get_restoreid ( )

finalinherited

The restore id from the restore controller.

Return values

string

get_stage()

base_ui_stage::get_stage ( )

finalinherited

The current stage.

Return values

int

get_ui()

base_ui_stage::get_ui ( )

finalinherited

Returns the base UI class.

Return values

base_ui

get_uniqueid()

base_ui_stage::get_uniqueid ( )

finalinherited

The backup id from the backup controller.

Return values

string

has_sub_stages()

restore_ui_stage::has_sub_stages ( )

inherited

No sub stages for this stage.

Return values

false

Reimplemented in restore_ui_stage_process.

initialise_stage_form()

restore_ui_stage_schema::initialise_stage_form ( )

protected

Creates the backup_schema_form instance for this stage.

Return values

backup_schema_form

Reimplemented from base_ui_stage.

is_first_stage()

restore_ui_stage::is_first_stage ( )

finalinherited

Returns true if this is the settings stage.

Return values

bool

Reimplemented from base_ui_stage.

is_independent()

restore_ui_stage::is_independent ( )

finalinherited

This is an independent stage.

Return values

int

process()

restore_ui_stage_schema::process

(

base_moodleform

$form = null

)

Processes the schema stage.

Parameters

base_moodleform

$form

Return values

int	The number of changes the user made

Reimplemented from base_ui_stage.

---

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

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