Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
restore_ui_stage_review Class Reference

Confirmation stage. More...

Inheritance diagram for restore_ui_stage_review:
restore_ui_stage base_ui_stage

Public Member Functions

 __construct ($ui, array $params=null)
 Constructs the stage.
 
 display (core_backup_renderer $renderer)
 Displays the 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 ()
 No sub stages for this stage.
 
 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 confirmation stage.
 

Protected Member Functions

 initialise_stage_form ()
 Creates the backup_confirmation_form instance this stage requires.
 

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

Confirmation stage.

On this stage the user reviews the setting for the backup and can change the filename of the file that will be generated.

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

Constructor & Destructor Documentation

◆ __construct()

restore_ui_stage_review::__construct ( $ui,
array $params = null )

Constructs the stage.

Parameters
restore_ui$ui
array$params

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
stringHTML 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_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::has_sub_stages ( )
inherited

No sub stages for this stage.

Return values
false

Reimplemented in restore_ui_stage_process.

◆ initialise_stage_form()

restore_ui_stage_review::initialise_stage_form ( )
protected

Creates the backup_confirmation_form instance this stage requires.

Return values
backup_confirmation_form

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

Processes the confirmation stage.

Parameters
base_moodleform$form
Return values
intThe number of changes the user made

Reimplemented from base_ui_stage.


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