Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 3.9.x will end* 10 May 2021 (12 months).
  • Bug fixes for security issues in 3.9.x will end* 8 May 2023 (36 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
/backup/util/ui/ -> base_ui_stage.class.php (source)

[Source view]

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 base_ui} instance.

Copyright: 2010 Sam Hemelryk
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 183 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

base_ui_stage:: (10 methods):
  __construct()
  get_params()
  get_stage()
  get_next_stage()
  get_prev_stage()
  get_name()
  get_uniqueid()
  display()
  get_ui()
  is_first_stage()


Class: base_ui_stage  - X-Ref

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
- process : To process the stage
- initialise_stage_form : To get a backup_moodleform instance for the stage

__construct(base_ui $ui, array $params = null)   X-Ref
Constructor

param: base_ui $ui
param: array $params

get_params()   X-Ref
Returns the custom params for this stage

return: array|null

get_stage()   X-Ref
The current stage

return: int

get_next_stage()   X-Ref
The next stage

return: int

get_prev_stage()   X-Ref
The previous stage

return: int

get_name()   X-Ref
The name of this stage

return: string

get_uniqueid()   X-Ref
The backup id from the backup controller

return: string

display(core_backup_renderer $renderer)   X-Ref
Displays the stage.

By default this involves instantiating the form for the stage and the calling
it to display.

param: core_backup_renderer $renderer
return: string HTML code to echo

get_ui()   X-Ref
Returns the base UI class

return: base_ui

is_first_stage()   X-Ref
Returns true if this stage is the first stage.

return: bool