backup_ui Class Reference

Inheritance diagram for backup_ui:

Collaboration diagram for backup_ui:

Public Member Functions
	get_uniqueid ()
	get_backupid ()
	execute ()
	get_progress_bar ()
	get_name ()
	get_first_stage_id ()
Static Public Member Functions
static	load_controller ($backupid=false)
static	skip_current_stage ($setting=true)
Data Fields
const	STAGE_INITIAL = 1
const	STAGE_SCHEMA = 2
const	STAGE_CONFIRMATION = 4
const	STAGE_FINAL = 8
const	STAGE_COMPLETE = 16
Protected Member Functions
	initialise_stage ($stage=null, array $params=null)
Static Protected Attributes
static	$skipcurrentstage = false

---

Detailed Description

This is the backup user interface class

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

Copyright:

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

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

---

Member Function Documentation

execute

(

)

Executes the backup plan

Returns:

bool

Reimplemented from base_ui.

Definition at line 102 of file backup_ui.class.php.

get_backupid

(

)

Gets the backup id from the controller

Returns:

string

Definition at line 95 of file backup_ui.class.php.

Here is the caller graph for this function:

get_first_stage_id

(

)

Gets the id of the first stage this UI is reponsible for

Returns:

int

Reimplemented from base_ui.

Definition at line 178 of file backup_ui.class.php.

get_name

(

)

Gets the name related to the operation of this UI

Returns:

string

Reimplemented from base_ui.

Definition at line 171 of file backup_ui.class.php.

get_progress_bar

(

)

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

Returns:

array Array of items for the progress bar

Reimplemented from base_ui.

Reimplemented in import_ui.

Definition at line 138 of file backup_ui.class.php.

Here is the call graph for this function:

get_uniqueid

(

)

Returns the backup id

Returns:

string

Reimplemented from base_ui.

Definition at line 88 of file backup_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:

backup_ui_stage_initial|backup_ui_stage_schema|backup_ui_stage_confirmation|backup_ui_stage_final

Reimplemented from base_ui.

Reimplemented in import_ui.

Definition at line 58 of file backup_ui.class.php.

Here is the call graph for this function:

static load_controller

(

$

backupid = false

)

[static, final]

Loads the backup controller if we are tracking one

Returns:

backup_controller|false

Reimplemented from base_ui.

Definition at line 119 of file backup_ui.class.php.

static skip_current_stage

(

$

setting = true

)

[static]

If called with default arg the current stage gets skipped.

Definition at line 185 of file backup_ui.class.php.

---

Field Documentation

$skipcurrentstage = false [static, protected]

Definition at line 49 of file backup_ui.class.php.

const STAGE_COMPLETE = 16

Definition at line 43 of file backup_ui.class.php.

const STAGE_CONFIRMATION = 4

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

const STAGE_FINAL = 8

Definition at line 42 of file backup_ui.class.php.

const STAGE_INITIAL = 1

The stages of the backup user interface.

Definition at line 39 of file backup_ui.class.php.

const STAGE_SCHEMA = 2

Definition at line 40 of file backup_ui.class.php.

---

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

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