Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
|
Abstract stage class. More...
Public Member Functions | |
__construct (backup_ui $ui, array $params=null) | |
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 () | |
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 stage. | |
Protected Member Functions | |
initialise_stage_form () | |
Creates an instance of the correct moodleform properly populated and all dependencies instantiated. | |
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. | |
Abstract stage class.
This class should be extended by all backup stages (a requirement of many backup ui functions). Each stage must then define two abstract methods
backup_ui_stage::__construct | ( | backup_ui | $ui, |
array | $params = null ) |
Constructor.
backup_ui | $ui | |
array | $params |
Reimplemented in backup_ui_stage_final, backup_ui_stage_initial, backup_ui_stage_schema, and import_ui_stage_precheck.
|
inherited |
Displays the stage.
By default this involves instantiating the form for the stage and the calling it to display.
core_backup_renderer | $renderer |
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.
|
final |
The backup id from the backup controller.
string |
|
inherited |
|
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 current stage.
int |
|
finalinherited |
Returns the base UI class.
base_ui |
|
finalinherited |
The backup id from the backup controller.
string |
|
abstractprotectedinherited |
Creates an instance of the correct moodleform properly populated and all dependencies instantiated.
@abstract
backup_moodleform |
Reimplemented in backup_ui_stage_confirmation, backup_ui_stage_final, backup_ui_stage_initial, backup_ui_stage_schema, import_ui_stage_confirmation, import_ui_stage_precheck, restore_ui_stage_process, restore_ui_stage_review, restore_ui_stage_schema, and restore_ui_stage_settings.
|
inherited |
Returns true if this stage is the first stage.
bool |
Reimplemented in restore_ui_stage.
|
abstractinherited |
Processes the stage.
This must be overridden by every stage as it will be different for every stage
@abstract
base_moodleform | $form |
Reimplemented in backup_ui_stage_confirmation, backup_ui_stage_final, backup_ui_stage_initial, backup_ui_stage_schema, import_ui_stage_precheck, restore_ui_stage_process, restore_ui_stage_review, restore_ui_stage_schema, and restore_ui_stage_settings.