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/ -> restore_plan.class.php (source)

[Source view]

Differences Between: [Versions 310 and 401] [Versions 311 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: 249 lines (9 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 2 classes

restore_plan:: (26 methods):
  __construct()
  destroy()
  build()
  get_restoreid()
  get_courseid()
  get_mode()
  get_basepath()
  get_logger()
  get_progress()
  get_info()
  get_target()
  get_userid()
  get_decoder()
  is_samesite()
  is_missing_modules()
  is_excluding_activities()
  set_preloaded_information()
  get_preloaded_information()
  get_tempdir()
  set_missing_modules()
  set_excluding_activities()
  log()
  execute()
  execute_after_restore()
  backup_version_compare()
  backup_release_compare()

restore_plan_exception:: (1 method):
  __construct()


Class: restore_plan  - X-Ref

Implementable class defining the needed stuf for one restore 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_restoreid()   X-Ref
No description

get_courseid()   X-Ref
No description

get_mode()   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

get_info()   X-Ref
No description

get_target()   X-Ref
No description

get_userid()   X-Ref
No description

get_decoder()   X-Ref
No description

is_samesite()   X-Ref
No description

is_missing_modules()   X-Ref
No description

is_excluding_activities()   X-Ref
No description

set_preloaded_information()   X-Ref
No description

get_preloaded_information()   X-Ref
No description

get_tempdir()   X-Ref
No description

set_missing_modules()   X-Ref
No description

set_excluding_activities()   X-Ref
No description

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


execute_after_restore()   X-Ref
Execute the after_restore methods of all the executed tasks in the plan


backup_version_compare(int $version, string $operator)   X-Ref
Compares the provided moodle version with the one the backup was taken from.

param: int $version Moodle version number (YYYYMMDD or YYYYMMDDXX)
param: string $operator Operator to compare the provided version to the backup version. {@see version_compare()}
return: bool True if the comparison passes.

backup_release_compare(string $release, string $operator)   X-Ref
Compares the provided moodle release with the one the backup was taken from.

param: string $release Moodle release (X.Y or X.Y.Z)
param: string $operator Operator to compare the provided release to the backup release. {@see version_compare()}
return: bool True if the comparison passes.

Class: restore_plan_exception  - X-Ref

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