Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/backup/util/plan/ -> backup_plan.class.php (source)

[Source view]

Differences Between: [Versions 310 and 401] [Versions 39 and 401]

(no description)

Copyright: 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 174 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 2 classes

backup_plan:: (16 methods):
  __construct()
  destroy()
  build()
  get_backupid()
  get_type()
  get_mode()
  get_courseid()
  get_basepath()
  get_logger()
  get_progress()
  is_excluding_activities()
  set_excluding_activities()
  set_kept_roles()
  get_kept_roles()
  log()
  execute()

backup_plan_exception:: (1 method):
  __construct()


Class: backup_plan  - X-Ref

Implementable class defining the needed stuf for one backup plan

TODO: Finish phpdocs
__construct($controller)   X-Ref
Constructor - instantiates one object of this class


destroy()   X-Ref
Destroy all circular references. It helps PHP 5.2 a lot!


build()   X-Ref
No description

get_backupid()   X-Ref
No description

get_type()   X-Ref
No description

get_mode()   X-Ref
No description

get_courseid()   X-Ref
No description

get_basepath()   X-Ref
No description

get_logger()   X-Ref
No description

get_progress()   X-Ref
Gets the progress reporter, which can be used to report progress within
the backup or restore process.

return: \core\progress\base Progress reporting object

is_excluding_activities()   X-Ref
No description

set_excluding_activities()   X-Ref
No description

set_kept_roles(array $roleids)   X-Ref
Sets the user roles that should be kept in the destination course
for a course copy operation.

param: array $roleids

get_kept_roles()   X-Ref
Get the user roles that should be kept in the destination course
for a course copy operation.

return: array

log($message, $level, $a = null, $depth = null, $display = false)   X-Ref
No description

execute()   X-Ref
Function responsible for executing the tasks of any plan


Class: backup_plan_exception  - X-Ref

__construct($errorcode, $a=NULL, $debuginfo=null)   X-Ref
No description