Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
|
Abstract class used to represent a restore stage that is indenependent. More...
Public Member Functions | |
__construct ($contextid) | |
Constructs the restore stage. More... | |
destroy () | |
Handles the destruction of this object. | |
display (core_backup_renderer $renderer) | |
Displays this restore stage. More... | |
get_progress_bar () | |
Gets an array of progress bar items that can be displayed through the restore renderer. More... | |
get_progress_reporter () | |
Gets the progress reporter object in use for this restore UI stage. More... | |
get_stage () | |
Returns the current restore stage. More... | |
get_stage_name () | |
Returns the restore stage name. More... | |
is_independent () | |
Obviously true. More... | |
process () | |
Processes the current restore stage. More... | |
set_progress_reporter (\core\progress\base $progressreporter) | |
Sets the progress reporter that will be returned by get_progress_reporter. More... | |
Abstract class used to represent a restore stage that is indenependent.
An independent stage is a judged to be so because it doesn't require, and has no use for the restore controller.
|
abstract |
Constructs the restore stage.
int | $contextid |
Reimplemented in restore_ui_stage_confirm, and restore_ui_stage_destination.
|
abstract |
Displays this restore stage.
core_backup_renderer | $renderer |
mixed |
Reimplemented in restore_ui_stage_confirm, and restore_ui_stage_destination.
restore_ui_independent_stage::get_progress_bar | ( | ) |
Gets an array of progress bar items that can be displayed through the restore renderer.
array | Array of items for the progress bar |
restore_ui_independent_stage::get_progress_reporter | ( | ) |
Gets the progress reporter object in use for this restore UI stage.
IMPORTANT: This progress reporter is used only for UI progress that is outside the restore controller. The restore controller has its own progress reporter which is used for progress during the main restore. Use the restore controller's progress reporter to report progress during a restore operation, not this one.
This extra reporter is necessary because on some restore UI screens, there are long-running tasks even though there is no restore controller in use. There is a similar function in restore_ui. but that class is not used on some stages.
core::progress::none |
|
abstract |
Returns the current restore stage.
int |
Reimplemented in restore_ui_stage_confirm, and restore_ui_stage_destination.
|
abstract |
Returns the restore stage name.
string |
Reimplemented in restore_ui_stage_confirm, and restore_ui_stage_destination.
|
final |
Obviously true.
true |
|
abstract |
Processes the current restore stage.
mixed |
Reimplemented in restore_ui_stage_confirm, and restore_ui_stage_destination.
restore_ui_independent_stage::set_progress_reporter | ( | \core\progress\base | $progressreporter | ) |
Sets the progress reporter that will be returned by get_progress_reporter.
core::progress::base | $progressreporter | Progress reporter |