Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.

This file contains the backup user interface class

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

Defines 2 classes

base_ui:: (18 methods):
  __construct()
  destroy()
  process()
  save_controller()
  display()
  get_tasks()
  get_stage()
  get_stage_name()
  enforce_dependencies()
  enforce_changed_dependencies()
  load_controller()
  cancel_process()
  get_format()
  get_type()
  get_controller()
  get_controller_id()
  get_setting()
  get_setting_value()

base_ui_exception:: (0 methods):


Class: base_ui  - X-Ref

This is the backup user interface class

The backup user interface class manages the user interface and backup for
Moodle.

__construct($controller, array $params = null)   X-Ref
Yay for constructors

param: backup_controller $controller
param: array $params

destroy()   X-Ref
Destorys the backup controller and the loaded stage.


process()   X-Ref
This processes the current stage of the backup

return: bool

save_controller()   X-Ref
Saves the backup controller.

Once this has been called nothing else can be changed in the controller.

return: bool

display(core_backup_renderer $renderer)   X-Ref
Displays the UI for the backup!

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

get_tasks()   X-Ref
Gets all backup tasks from the controller

return: array Array of backup_task

get_stage()   X-Ref
Gets the stage we are on

return: int

get_stage_name()   X-Ref
Gets the name of the stage we are on

return: string

enforce_dependencies()   X-Ref
Enforces dependencies on all settings. Call before save

return: bool True if dependencies were enforced and changes were made

enforce_changed_dependencies()   X-Ref
Returns true if enforce_dependencies changed any settings

return: bool

load_controller($uniqueid = false)   X-Ref
Loads the backup controller if we are tracking one

param: string|bool $uniqueid
return: backup_controller|false

cancel_process()   X-Ref
Cancels the current backup/restore and redirects the user back to the relevant place


get_format()   X-Ref
Gets the format for the backup

return: int

get_type()   X-Ref
Gets the type of the backup

return: int

get_controller()   X-Ref
Returns the controller object.

return: backup_controller|restore_controller

get_controller_id()   X-Ref
Gets the ID used in creating the controller. Relates to course/section/cm

return: int

get_setting($name, $default = false)   X-Ref
Gets the requested setting

param: string $name
param: bool $default
return: base_setting

get_setting_value($name, $default = false)   X-Ref
Gets the value for the requested setting

param: string $name
param: bool $default
return: mixed

Class: base_ui_exception  - X-Ref

Backup user interface exception. Modelled off the backup_exception class