This is the backup user interface class.
More...
|
static | load_controller ($uniqueid=false) |
| Loads the backup controller if we are tracking one.
|
|
|
const | PROGRESS_EXECUTED = 3 |
| The progress of this instance of the backup ui class It has been executed.
|
|
const | PROGRESS_INTIAL = 0 |
| The progress of this instance of the backup ui class It is in the initial stage.
|
|
const | PROGRESS_PROCESSED = 1 |
| The progress of this instance of the backup ui class It is processed.
|
|
const | PROGRESS_SAVED = 2 |
| The progress of this instance of the backup ui class It is saved.
|
|
|
backup_controller restore_controller | $controller |
| The controller.
|
|
int | $dependencychanges = 0 |
| The number of changes made by dependency enforcement.
|
|
int | $progress |
| The current progress of the UI One of self\PROGRESS_*.
|
|
base_ui_stage | $stage |
| The current stage.
|
|
This is the backup user interface class.
The backup user interface class manages the user interface and backup for Moodle.
- Copyright
- 2010 Sam Hemelryk
- License
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
◆ __construct()
base_ui::__construct |
( |
| $controller, |
|
|
array | $params = null ) |
Yay for constructors.
- Parameters
-
◆ cancel_process()
base_ui::cancel_process |
( |
| ) |
|
Cancels the current backup/restore and redirects the user back to the relevant place.
Reimplemented in restore_ui.
◆ display()
Displays the UI for the backup!
- Exceptions
-
- Parameters
-
- Return values
-
Reimplemented in restore_ui.
◆ enforce_changed_dependencies()
base_ui::enforce_changed_dependencies |
( |
| ) |
|
Returns true if enforce_dependencies changed any settings.
- Return values
-
Reimplemented in restore_ui.
◆ enforce_dependencies()
base_ui::enforce_dependencies |
( |
| ) |
|
|
protected |
Enforces dependencies on all settings.
Call before save
- Return values
-
bool | True if dependencies were enforced and changes were made |
◆ execute()
◆ get_controller()
base_ui::get_controller |
( |
| ) |
|
Returns the controller object.
- Return values
-
backup_controller|restore_controller | |
◆ get_controller_id()
base_ui::get_controller_id |
( |
| ) |
|
Gets the ID used in creating the controller.
Relates to course/section/cm
- Return values
-
◆ get_first_stage_id()
base_ui::get_first_stage_id |
( |
| ) |
|
|
abstract |
◆ get_format()
Gets the format for the backup.
- Return values
-
◆ get_name()
◆ get_progress_bar()
base_ui::get_progress_bar |
( |
| ) |
|
|
abstract |
Gets an array of progress bar items that can be displayed through the backup renderer.
- Return values
-
array | Array of items for the progress bar |
Reimplemented in backup_ui, import_ui, and restore_ui.
◆ get_setting()
base_ui::get_setting |
( |
| $name, |
|
|
| $default = false ) |
Gets the requested setting.
- Parameters
-
- Return values
-
◆ get_setting_value()
base_ui::get_setting_value |
( |
| $name, |
|
|
| $default = false ) |
Gets the value for the requested setting.
- Parameters
-
- Return values
-
◆ get_stage()
Gets the stage we are on.
- Return values
-
◆ get_stage_name()
base_ui::get_stage_name |
( |
| ) |
|
Gets the name of the stage we are on.
- Return values
-
◆ get_tasks()
Gets all backup tasks from the controller.
- Return values
-
◆ get_type()
Gets the type of the backup.
- Return values
-
◆ get_uniqueid()
base_ui::get_uniqueid |
( |
| ) |
|
|
abstract |
Gets the backup id from the controller.
- Return values
-
Reimplemented in backup_ui, and restore_ui.
◆ initialise_stage()
base_ui::initialise_stage |
( |
| $stage = null, |
|
|
array | $params = null ) |
|
abstractprotected |
Intialises what ever stage is requested.
If none are requested we check params for 'stage' and default to initial
- Parameters
-
int | null | $stage | The desired stage to intialise or null for the default |
array | $params | |
- Return values
-
Reimplemented in backup_ui, import_ui, and restore_ui.
◆ load_controller()
static base_ui::load_controller |
( |
| $uniqueid = false | ) |
|
|
static |
Loads the backup controller if we are tracking one.
- Exceptions
-
- Parameters
-
- Return values
-
Reimplemented in backup_ui, and restore_ui.
◆ process()
This processes the current stage of the backup.
- Exceptions
-
- Return values
-
Reimplemented in restore_ui.
◆ save_controller()
base_ui::save_controller |
( |
| ) |
|
Saves the backup controller.
Once this has been called nothing else can be changed in the controller.
- Exceptions
-
- Return values
-
The documentation for this class was generated from the following file:
- backup/util/ui/base_ui.class.php