Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
|
Final stage of backup. More...
Public Member Functions | |
__construct (base_ui $ui, array $params=null) | |
Constructs the final stage. | |
display (core_backup_renderer $renderer) | |
Renders the process stage screen. | |
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. | |
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. | |
Final stage of backup.
This stage is special in that it is does not make use of a form. The reason for this is the order of procession of backup at this stage. The processesion is:
This highlights that we neither need a form nor a display method for this stage we simply need to process.
restore_ui_stage_process::__construct | ( | base_ui | $ui, |
array | $params = null ) |
restore_ui_stage_process::display | ( | core_backup_renderer | $renderer | ) |
Renders the process stage screen.
restore_ui_exception |
core_backup_renderer | $renderer | renderer instance to use |
string | HTML code |
Reimplemented from base_ui_stage.
Reimplemented in restore_ui_stage_complete.
|
finalinherited |
|
inherited |
The next stage.
int |
Reimplemented in backup_ui_stage_initial, and import_ui_stage_precheck.
|
finalinherited |
Returns the custom params for this stage.
array|null |
|
finalinherited |
The previous stage.
int |
|
finalinherited |
The restore id from the restore controller.
string |
|
finalinherited |
The current stage.
int |
|
finalinherited |
Returns the base UI class.
base_ui |
|
finalinherited |
The backup id from the backup controller.
string |
restore_ui_stage_process::has_sub_stages | ( | ) |
Returns true if this stage can have sub-stages.
bool|false |
Reimplemented from restore_ui_stage.
|
protected |
should NEVER be called... throws an exception
Reimplemented from base_ui_stage.
|
finalinherited |
|
finalinherited |
This is an independent stage.
int |
restore_ui_stage_process::process | ( | base_moodleform | $form = null | ) |
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.
base_moodleform | $form |
Reimplemented from base_ui_stage.