import_ui_stage_precheck Class Reference

Class representing the precheck/selection stage of a import. More...

Inheritance diagram for import_ui_stage_precheck:

Public Member Functions
	__construct (backup_ui $ui, array $params=null)
	Precheck/selection import 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 ()
	Gets the next stage for the import.
	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.
	initialise_stage_form ()
	Initialises the backup_moodleform instance for this stage.
	is_first_stage ()
	Returns true if this stage is the first stage.
	process (base_moodleform $form=null)
	Processes the precheck/selection import 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

Class representing the precheck/selection stage of a import.

In this stage the user is required to perform initial selections. That is a choice of which course to import from.

Copyright

2019 Peter Dias

License

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

Constructor & Destructor Documentation

__construct()

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

Precheck/selection import 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_complete, backup_ui_stage_final, import_ui_stage_confirmation, restore_ui_stage_complete, and restore_ui_stage_process.

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

import_ui_stage_precheck::get_next_stage

(

)

Gets the next stage for the import.

Return values

int

Reimplemented from base_ui_stage.

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

import_ui_stage_precheck::initialise_stage_form

(

)

Initialises the backup_moodleform instance for this stage.

Return values

backup_moodleform|void

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

import_ui_stage_precheck::process

(

base_moodleform

$form = null

)

Processes the precheck/selection import stage.

Parameters

base_moodleform | null

$form

Reimplemented from base_ui_stage.

---

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

• backup/util/ui/import_extensions.php