backup_ui_stage_schema Class Reference

Schema stage of backup process. More...

Inheritance diagram for backup_ui_stage_schema:

Public Member Functions
	__construct (backup_ui $ui, array $params=null)
	Schema stage constructor.
	display (core_backup_renderer $renderer)
	Displays the stage.
	get_backupid ()
	The backup id from the backup controller.
	get_name ()
	The name of this stage.
	get_next_stage ()
	The next stage.
	get_params ()
	Returns the custom params for this stage.
	get_prev_stage ()
	The previous stage.
	get_stage ()
	The current stage.
	get_ui ()
	Returns the base UI class.
	get_uniqueid ()
	The backup id from the backup controller.
	is_first_stage ()
	Returns true if this stage is the first stage.
	process (base_moodleform $form=null)
	Processes the schema stage.

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.

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()

backup_ui_stage_schema::__construct	(	backup_ui	$ui,
		array	$params = null
	)

Schema stage constructor.

Parameters

backup_ui	$ui
array	$params

Reimplemented from backup_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 backup_ui_stage_final, backup_ui_stage_complete, import_ui_stage_confirmation, restore_ui_stage_process, and restore_ui_stage_complete.

get_backupid()

backup_ui_stage::get_backupid ( )

finalinherited

The backup id from the backup controller.

Return values

string

get_name()

base_ui_stage::get_name ( )

inherited

The name of this stage.

Return values

string

Reimplemented in restore_ui_stage.

get_next_stage()

base_ui_stage::get_next_stage ( )

inherited

The next stage.

Return values

int

Reimplemented in backup_ui_stage_initial, and import_ui_stage_precheck.

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_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

initialise_stage_form()

backup_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()

base_ui_stage::is_first_stage ( )

inherited

Returns true if this stage is the first stage.

Return values

bool

Reimplemented in restore_ui_stage.

process()

backup_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.

Member Data Documentation

$params

array base_ui_stage::$params = null

protectedinherited

Custom form params that will be added as hidden inputs.

$stage

int base_ui_stage::$stage = 1

protectedinherited

The current stage.

$stageform

base_moodleform base_ui_stage::$stageform = null

protectedinherited

The moodleform for this stage.

$ui

base_ui base_ui_stage::$ui

protectedinherited

The backuck UI object.

---

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

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