Inheritance diagram for restore_ui:

Collaboration diagram for restore_ui:

Public Member Functions
	process ()
	is_independent ()
	get_uniqueid ()
	get_restoreid ()
	execute ()
	cleanup ()
	enforce_changed_dependencies ()
	cancel_process ()
	get_progress_bar ()
	get_name ()
	get_first_stage_id ()
	requires_substage ()
	display ($renderer)
Static Public Member Functions
static	load_controller ($restoreid=false)
static	engage_independent_stage ($stage, $contextid)
Data Fields
const	STAGE_CONFIRM = 1
const	STAGE_DESTINATION = 2
const	STAGE_SETTINGS = 4
const	STAGE_SCHEMA = 8
const	STAGE_REVIEW = 16
const	STAGE_PROCESS = 32
const	STAGE_COMPLETE = 64
Static Public Attributes
static	$stages
Protected Member Functions
	initialise_stage ($stage=null, array $params=null)
	is_temporary_course_created ($courseid)
Protected Attributes
	$stage = null

Detailed Description

This is the restore user interface class

The restore user interface class manages the user interface and restore for Moodle.

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

Definition at line 35 of file restore_ui.class.php.

Member Function Documentation

cancel_process ( )

Cancels the current restore and redirects the user back to the relevant place

Reimplemented from base_ui.

Definition at line 230 of file restore_ui.class.php.

Here is the call graph for this function:

cleanup ( )

Delete course which is created by restore process

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

Here is the call graph for this function:

Here is the caller graph for this function:

display ( $ renderer )

Displays this stage

Parameters:

core_backup_renderer $renderer

Returns:: string HTML code to echo

Definition at line 292 of file restore_ui.class.php.

enforce_changed_dependencies ( )

Returns true if enforce_dependencies changed any settings

Returns:: bool

Reimplemented from base_ui.

Definition at line 189 of file restore_ui.class.php.

static engage_independent_stage	(	$	stage,
		$	contextid
	)		`[static, final]`

Initialised the requested independent stage

Parameters:

int	$stage	One of self::STAGE_*
int	$contextid

Returns:: restore_ui_stage_confirm|restore_ui_stage_destination

Definition at line 217 of file restore_ui.class.php.

execute ( )

Executes the restore plan

Returns:: bool

Reimplemented from base_ui.

Definition at line 134 of file restore_ui.class.php.

Here is the call graph for this function:

get_first_stage_id ( )

Gets the first stage for this UI

Returns:: int STAGE_CONFIRM

Reimplemented from base_ui.

Definition at line 276 of file restore_ui.class.php.

get_name ( )

Gets the name of this UI

Returns:: string

Reimplemented from base_ui.

Definition at line 269 of file restore_ui.class.php.

get_progress_bar ( )

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

Returns:: array Array of items for the progress bar

Reimplemented from base_ui.

Definition at line 241 of file restore_ui.class.php.

Here is the call graph for this function:

get_restoreid ( )

Gets the restore id from the controller

Returns:: string

Definition at line 127 of file restore_ui.class.php.

Here is the caller graph for this function:

get_uniqueid ( )

Gets the unique ID associated with this UI

Returns:: string

Reimplemented from base_ui.

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

Here is the call graph for this function:

initialise_stage	(	$	stage = `null`,
		array $	params = `null`
	)		`[protected]`

Intialises what ever stage is requested. If none are requested we check params for 'stage' and default to initial

Parameters:

int | null $stage The desired stage to intialise or null for the default

Returns:: restore_ui_stage_initial|restore_ui_stage_schema|restore_ui_stage_confirmation|restore_ui_stage_final

Reimplemented from base_ui.

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

Here is the call graph for this function:

Here is the caller graph for this function:

is_independent ( )

Returns true if the stage is independent (not requiring a restore controller)

Returns:: bool

Definition at line 113 of file restore_ui.class.php.

is_temporary_course_created ( $ courseid ) [protected]

Checks if the course is not restored fully and current controller has created it.

Parameters:

int $courseid id of the course which needs to be checked

Returns:: bool

Definition at line 168 of file restore_ui.class.php.

Here is the caller graph for this function:

static load_controller ( $ restoreid = false ) [static, final]

Loads the restore controller if we are tracking one

Returns:: restore_controller|false

Reimplemented from base_ui.

Definition at line 196 of file restore_ui.class.php.

process ( )

This processes the current stage of the restore

Returns:: bool

Reimplemented from base_ui.

Definition at line 88 of file restore_ui.class.php.

Here is the call graph for this function:

requires_substage ( )

Returns true if this stage has substages of which at least one needs to be displayed

Returns:: bool

Definition at line 283 of file restore_ui.class.php.

Field Documentation

$stage = null [protected]

Reimplemented from base_ui.

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

$stages [static]

Initial value:

 array(
        restore_ui::STAGE_CONFIRM       => 'confirm',
        restore_ui::STAGE_DESTINATION   => 'destination',
        restore_ui::STAGE_SETTINGS      => 'settings',
        restore_ui::STAGE_SCHEMA        => 'schema',
        restore_ui::STAGE_REVIEW        => 'review',
        restore_ui::STAGE_PROCESS       => 'process',
        restore_ui::STAGE_COMPLETE      => 'complete'
    )