See Release Notes
Long Term Support Release
Differences Between: [Versions 310 and 401]
Backup user interface stages This file contains the classes required to manage the stages that make up the backup user interface. These will be primarily operated a {@link backup_ui} instance.
Copyright: | 2010 Sam Hemelryk |
License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
File Size: | 651 lines (24 kb) |
Included or required: | 0 times |
Referenced: | 0 times |
Includes or requires: | 0 files |
backup_ui_stage:: (2 methods):
__construct()
get_backupid()
backup_ui_stage_initial:: (4 methods):
__construct()
process()
get_next_stage()
initialise_stage_form()
backup_ui_stage_schema:: (3 methods):
__construct()
process()
initialise_stage_form()
backup_ui_stage_confirmation:: (3 methods):
__construct()
process()
initialise_stage_form()
backup_ui_stage_final:: (4 methods):
__construct()
process()
initialise_stage_form()
display()
backup_ui_stage_complete:: (2 methods):
__construct()
display()
Class: backup_ui_stage - X-Ref
Abstract stage class__construct(backup_ui $ui, array $params = null) X-Ref |
Constructor. param: backup_ui $ui param: array $params |
get_backupid() X-Ref |
The backup id from the backup controller return: string |
Class: backup_ui_stage_initial - X-Ref
Class representing the initial stage of a backup.__construct(backup_ui $ui, array $params = null) X-Ref |
Initial backup stage constructor param: backup_ui $ui param: array $params |
process(base_moodleform $m = null) X-Ref |
Processes the initial backup stage param: base_moodleform $m return: int The number of changes |
get_next_stage() X-Ref |
Gets the next stage for the backup. We override this function to implement the one click backup. When the user performs a one click backup we jump straight to the final stage. return: int |
initialise_stage_form() X-Ref |
Initialises the backup_moodleform instance for this stage return: backup_initial_form |
Class: backup_ui_stage_schema - X-Ref
Schema stage of backup process__construct(backup_ui $ui, array $params = null) X-Ref |
Schema stage constructor param: backup_ui $ui param: array $params |
process(base_moodleform $form = null) X-Ref |
Processes the schema stage param: base_moodleform $form return: int The number of changes the user made |
initialise_stage_form() X-Ref |
Creates the backup_schema_form instance for this stage return: backup_schema_form |
Class: backup_ui_stage_confirmation - X-Ref
Confirmation stage__construct($ui, array $params = null) X-Ref |
Constructs the stage param: backup_ui $ui param: array $params |
process(base_moodleform $form = null) X-Ref |
Processes the confirmation stage param: base_moodleform $form return: int The number of changes the user made |
initialise_stage_form() X-Ref |
Creates the backup_confirmation_form instance this stage requires return: backup_confirmation_form |
Class: backup_ui_stage_final - X-Ref
Final stage of backup__construct(backup_ui $ui, array $params = null) X-Ref |
Constructs the final stage param: backup_ui $ui param: array $params |
process(base_moodleform $form = null) X-Ref |
Processes the final stage. In this case it ALWAYS passes processing to the previous stage (confirmation) param: base_moodleform $form return: bool |
initialise_stage_form() X-Ref |
should NEVER be called... throws an exception |
display(core_backup_renderer $renderer) X-Ref |
should NEVER be called... throws an exception param: core_backup_renderer $renderer return: void |
Class: backup_ui_stage_complete - X-Ref
The completed backup stage__construct(backup_ui $ui, array $params = null, array $results = null) X-Ref |
Constructs the complete backup stage param: backup_ui $ui param: array $params param: array $results |
display(core_backup_renderer $renderer) X-Ref |
Displays the completed backup stage. Currently this just involves redirecting to the file browser with an appropriate message. param: core_backup_renderer $renderer return: string HTML code to echo |