Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
restore_ui_stage_complete Class Reference

This is the completed stage. More...

Inheritance diagram for restore_ui_stage_complete:
restore_ui_stage_process restore_ui_stage base_ui_stage

Public Member Functions

 __construct (restore_ui $ui, array $params=null, array $results=null)
 Constructs the complete backup stage.
 
 display (core_backup_renderer $renderer)
 Displays the completed backup stage.
 
 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_restoreid ()
 The restore id from the restore controller.
 
 get_stage ()
 The current stage.
 
 get_ui ()
 Returns the base UI class.
 
 get_uniqueid ()
 The backup id from the backup controller.
 
 has_sub_stages ()
 Returns true if this stage can have sub-stages.
 
 is_first_stage ()
 Returns true if this is the settings stage.
 
 is_independent ()
 This is an independent stage.
 
 process (base_moodleform $form=null)
 Processes the final stage.
 

Public Attributes

const SUBSTAGE_NONE = 0
 There is no substage required.
 
const SUBSTAGE_PRECHECKS = 2
 The prechecks substage is required/the current substage.
 

Protected Member Functions

 initialise_stage_form ()
 should NEVER be called... throws an exception
 

Protected Attributes

array $params = null
 Custom form params that will be added as hidden inputs.
 
array $results
 The results of the backup execution.
 
int $stage = 1
 The current stage.
 
base_moodleform $stageform = null
 The moodleform for this stage.
 
int $substage = 0
 The current substage.
 
base_ui $ui
 The backuck UI object.
 

Detailed Description

This is the completed stage.

Once this is displayed there is nothing more to do.

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructs the complete backup stage.

Parameters
restore_ui$ui
array$params
array$results

Member Function Documentation

◆ display()

restore_ui_stage_complete::display ( core_backup_renderer $renderer)

Displays the completed backup stage.

Currently this just envolves redirecting to the file browser with an appropriate message.

Parameters
core_backup_renderer$renderer
Return values
stringHTML code to echo

Reimplemented from restore_ui_stage_process.

◆ 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, 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_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_process::has_sub_stages ( )
inherited

Returns true if this stage can have sub-stages.

Return values
bool|false

Reimplemented from restore_ui_stage.

◆ initialise_stage_form()

restore_ui_stage_process::initialise_stage_form ( )
protectedinherited

should NEVER be called... throws an exception

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_process::process ( base_moodleform $form = null)
inherited

Processes the final stage.

In this case it checks to see if there is a sub stage that we need to display before execution, if there is we gear up to display the subpage, otherwise we return true which will lead to execution of the restore and the loading of the completed stage.

Parameters
base_moodleform$form

Reimplemented from base_ui_stage.


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