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

The completed backup stage. More...

Inheritance diagram for backup_ui_stage_complete:
backup_ui_stage_final backup_ui_stage base_ui_stage

Public Member Functions

 __construct (backup_ui $ui, array $params=null, array $results=null)
 Constructs the complete backup stage.
 
 display (core_backup_renderer $renderer)
 Displays the completed backup 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 final stage.
 

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.
 
base_ui $ui
 The backuck UI object.
 

Detailed Description

The completed backup stage.

At this stage everything is done and the user will be redirected to view the backup file in the file browser.

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructs the complete backup stage.

Parameters
backup_ui$ui
array$params
array$results

Member Function Documentation

◆ display()

backup_ui_stage_complete::display ( core_backup_renderer $renderer)

Displays the completed backup stage.

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

Parameters
core_backup_renderer$renderer
Return values
stringHTML code to echo

Reimplemented from backup_ui_stage_final.

◆ 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_final::initialise_stage_form ( )
protectedinherited

should NEVER be called... throws an exception

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

Processes the final stage.

In this case it ALWAYS passes processing to the previous stage (confirmation)

Parameters
base_moodleform$form
Return values
bool

Reimplemented from base_ui_stage.


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