Class implementing the controller of any backup process. More...

Inheritance diagram for backup_controller:

Public Member Functions
	__construct ($type, $id, $format, $interactive, $mode, $userid, $releasesession=backup::RELEASESESSION_NO)
	Constructor for the backup controller class. More...

	add_logger (base_logger $logger)
	Inserts a new logger at end of logging chain. More...

	calculate_checksum ()
	This function will return one unique and stable checksum for one instance of the class implementing it. More...

	debug_display_all_settings_values ()
	For debug only. More...

	destroy ()
	Clean structures used by the backup_controller. More...

	execute_plan ()
	Executes the backup. More...

	finish_ui ()

	get_backupid ()

	get_copy ()
	Get the course copy data. More...

	get_courseid ()

	get_execution ()

	get_executiontime ()

	get_format ()

	get_id ()

	get_include_files ()
	Returns the current value of the include_files setting. More...

	get_interactive ()

	get_logger ()
	Gets first logger in logging chain. More...

	get_mode ()

	get_operation ()

	get_plan ()

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

	get_releasesession ()
	Returns the set value of releasesession. More...

	get_results ()

	get_status ()

	get_type ()

	get_userid ()

	is_checksum_correct ($checksum)
	Given one checksum, returns if matches object's checksum (true) or no (false) More...

	log ($message, $level, $a=null, $depth=null, $display=false)
	Logs data to the logger chain. More...

	process_ui_event ()

	save_controller ($includeobj=true, $cleanobj=false)
	Save controller information. More...

	set_copy (\stdClass $data)
	Store extra data for course copy operations. More...

	set_execution ($execution, $executiontime=0)

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

	set_progress (\core\progress\base $progress)
	Sets the progress reporter. More...

	set_status ($status)

Static Public Member Functions
static	load_controller ($backupid)

Public Attributes
const	CIPHER = 'aes-256-cbc'
	Cipher to be used in backup and restore operations.

const	CIPHERKEYLEN = 32
	Bytes enforced for key, using the cypher above. More...

const	ENROL_ALWAYS = 2

const	ENROL_NEVER = 0

const	ENROL_WITHUSERS = 1

const	EXECUTION_DELAYED = 2

const	EXECUTION_INMEDIATE = 1

const	FORMAT_IMSCC1 = 'imscc1'

const	FORMAT_IMSCC11 = 'imscc11'

const	FORMAT_MOODLE = 'moodle2'

const	FORMAT_MOODLE1 = 'moodle1'

const	FORMAT_UNKNOWN = 'unknown'

const	INTERACTIVE_NO = false

const	INTERACTIVE_YES = true

const	LOG_DEBUG = 50

const	LOG_ERROR = 20

const	LOG_INFO = 40

const	LOG_NONE = 10

const	LOG_WARNING = 30

const	MODE_ASYNC = 70
	This mode is for asynchronous backups. More...

const	MODE_AUTOMATED = 50

const	MODE_CONVERTED = 60

const	MODE_COPY = 80
	This mode is for course copies. More...

const	MODE_GENERAL = 10

const	MODE_HUB = 30

const	MODE_IMPORT = 20
	This is used for importing courses, and for duplicating activities. More...

const	MODE_SAMESITE = 40
	This mode is intended for duplicating courses and cases where the backup target is within the same site. More...

const	OPERATION_BACKUP ='backup'

const	OPERATION_RESTORE ='restore'

const	RELEASE = '3.9'
	Usually same than major release zero version, mainly for informative/historic purposes.

const	RELEASESESSION_NO = false
	Don't release the session during backup/restore.

const	RELEASESESSION_YES = true
	Release the session during backup/restore.

const	STATUS_AWAITING = 700

const	STATUS_CONFIGURED = 400

const	STATUS_CREATED = 100

const	STATUS_EXECUTING = 800

const	STATUS_FINISHED_ERR = 900

const	STATUS_FINISHED_OK =1000

const	STATUS_NEED_PRECHECK =600

const	STATUS_PLANNED = 300

const	STATUS_REQUIRE_CONV = 200

const	STATUS_SETTING_UI = 500

const	TARGET_CURRENT_ADDING = 1

const	TARGET_CURRENT_DELETING = 0

const	TARGET_EXISTING_ADDING = 4

const	TARGET_EXISTING_DELETING = 3

const	TARGET_NEW_COURSE = 2

const	TYPE_1ACTIVITY = 'activity'

const	TYPE_1COURSE = 'course'

const	TYPE_1SECTION = 'section'

const	VAR_ACTIVITYID = -21

const	VAR_BACKUPID = -1001

const	VAR_BASEPATH = -1011

const	VAR_BLOCKID = -51

const	VAR_BLOCKNAME = -61

const	VAR_CONTEXTID = -71

const	VAR_COURSEID = -1

const	VAR_MODID = -31

const	VAR_MODNAME = -41

const	VAR_PARENTID = -81

const	VAR_SECTIONID = -11

const	VERSION = 2020061500
	Usually same than major release version, this is used to mark important point is backup when some behavior/approach channged, in order to allow conditional coding based on it.

Protected Member Functions
	apply_defaults ()

	calculate_backupid ()

	get_include_files_default ()
	Returns the default value for $this->includefiles before we consider any settings. More...

	load_plan ()

	set_include_files (bool $includefiles)
	Set the initial value for the include_files setting. More...

Protected Attributes
	$backupid

	$checksum

stdClass	$copy
	Holds the relevant destination information for course copy operations.

	$courseid

	$destination

integer	$execution
	Immediate/delayed execution type.

	$executiontime

	$format

	$id

	$includefiles

	$interactive

array	$keptroles = array()
	The role ids to keep in a copy operation.

base_logger	$logger
	Logging chain object (moodle, inline, fs, db, syslog)

	$mode

	$operation

backup_plan	$plan

core progress base	$progress
	Progress reporting object.

bool	$releasesession = backup::RELEASESESSION_NO
	Whether this backup should release the session.

	$status

	$type

	$userid

Detailed Description

Class implementing the controller of any backup process.

This final class is in charge of controlling all the backup architecture, for any type of backup. Based in type, format, interactivity and target, it stores the whole execution plan and settings that will be used later by the @backup_worker, applies all the defaults, performs all the security contraints and is in charge of handling the ui if necessary. Also logging strategy is defined here.

Note the class is 100% neutral and usable for any backup. It just stores/requests all the needed information from other backup classes in order to have everything well structured in order to allow the @backup_worker classes to do their job.

In other words, a mammoth class, but don't worry, practically everything is delegated/ aggregated!)

TODO: Finish phpdocs

Constructor & Destructor Documentation

◆ __construct()

backup_controller::__construct	(	$type,
		$id,
		$format,
		$interactive,
		$mode,
		$userid,
		$releasesession = `backup::RELEASESESSION_NO`
	)

Constructor for the backup controller class.

Parameters

int	$type	Type of the backup; One of backup::TYPE_1COURSE, TYPE_1SECTION, TYPE_1ACTIVITY
int	$id	The ID of the item to backup; e.g the course id
int	$format	The backup format to use; Most likely backup::FORMAT_MOODLE
bool	$interactive	Whether this backup will require user interaction; backup::INTERACTIVE_YES or INTERACTIVE_NO
int	$mode	One of backup::MODE_GENERAL, MODE_IMPORT, MODE_SAMESITE, MODE_HUB, MODE_AUTOMATED
int	$userid	The id of the user making the backup
bool	$releasesession	Should release the session? backup::RELEASESESSION_YES or backup::RELEASESESSION_NO

Member Function Documentation

◆ add_logger()

base_controller::add_logger ( base_logger $logger )

inherited

Inserts a new logger at end of logging chain.

Parameters

base_logger $logger New logger to add

◆ calculate_checksum()

backup_controller::calculate_checksum ( )

This function will return one unique and stable checksum for one instance of the class implementing it.

It's each implementation responsibility to do it recursively if needed and use optional store (caching) of the checksum if necessary/possible

Implements checksumable.

◆ debug_display_all_settings_values()

backup_controller::debug_display_all_settings_values ( )

For debug only.

Get a simple test display of all the settings.

Return values

string

◆ destroy()

backup_controller::destroy ( )

Clean structures used by the backup_controller.

This method clean various structures used by the backup_controller, destroying them in an ordered way, so their memory will be gc properly by PHP (mainly circular references).

Note that, while it's not mandatory to execute this method, it's highly recommended to do so, specially in scripts performing multiple operations (like the automated backups) or the system will run out of memory after a few dozens of backups)

◆ execute_plan()

backup_controller::execute_plan ( )

Executes the backup.

Return values

void	Throws and exception of completes

◆ get_copy()

base_controller::get_copy ( )

inherited

Get the course copy data.

Return values

stdClass

◆ get_include_files()

backup_controller::get_include_files ( )

Returns the current value of the include_files setting.

This setting is intended to ensure that files are not included in generated backups.

Return values

int	Indicates whether files should be included in backups.

◆ get_include_files_default()

backup_controller::get_include_files_default ( )

protected

Returns the default value for $this->includefiles before we consider any settings.

Return values

bool

Exceptions

dml_exception

◆ get_logger()

base_controller::get_logger ( )

inherited

Gets first logger in logging chain.

Return values

base_logger Logger

◆ get_plan()

backup_controller::get_plan ( )

Return values

backup_plan

◆ get_progress()

base_controller::get_progress ( )

inherited

Gets the progress reporter, which can be used to report progress within the backup or restore process.

Return values

core::progress::base Progress reporting object

◆ get_releasesession()

base_controller::get_releasesession ( )

inherited

Returns the set value of releasesession.

This is used to indicate if the session should be closed during the backup/restore.

Return values

bool	Indicates whether the session should be released.

◆ is_checksum_correct()

backup_controller::is_checksum_correct ( $checksum )

Given one checksum, returns if matches object's checksum (true) or no (false)

Implements checksumable.

◆ log()

base_controller::log	(	$message,
		$level,
		$a = `null`,
		$depth = `null`,
		$display = `false`
	)

inherited

Logs data to the logger chain.

See also: loggable::log()

Implements loggable.

◆ save_controller()

backup_controller::save_controller	(	$includeobj = `true`,
		$cleanobj = `false`
	)

Save controller information.

Parameters

bool	$includeobj	to decide if the object itself must be updated (true) or no (false)
bool	$cleanobj	to decide if the object itself must be cleaned (true) or no (false)

◆ set_copy()

base_controller::set_copy ( \stdClass $data )

inherited

Store extra data for course copy operations.

For a course copying these is data required to be passed to the restore step. We store this data in its own section of the backup controller

Parameters

stdClass $data The course copy data.

Exceptions

backup_controller_exception

◆ set_include_files()

backup_controller::set_include_files ( bool $includefiles )

protected

Set the initial value for the include_files setting.

Parameters

bool $includefiles

See also: backup_controller::get_include_files for further information on the purpose of this setting.

◆ set_kept_roles()

backup_controller::set_kept_roles ( array $roleids )

Sets the user roles that should be kept in the destination course for a course copy operation.

Parameters

array $roleids

Exceptions

backup_controller_exception

◆ set_progress()

base_controller::set_progress ( \core\progress\base $progress )

inherited

Sets the progress reporter.

Parameters

core::progress::base $progress Progress reporting object

Member Data Documentation

◆ CIPHERKEYLEN

const backup::CIPHERKEYLEN = 32

inherited

Bytes enforced for key, using the cypher above.

Restrictive? Yes, but better than unsafe lengths

◆ MODE_ASYNC

const backup::MODE_ASYNC = 70

inherited

This mode is for asynchronous backups.

These backups will run via adhoc scheduled tasks.

◆ MODE_COPY

const backup::MODE_COPY = 80

inherited

This mode is for course copies.

It is similar to async, but identifies back up and restore tasks as course copies.

These copies will run via adhoc scheduled tasks.

◆ MODE_IMPORT

const backup::MODE_IMPORT = 20

inherited

This is used for importing courses, and for duplicating activities.

This mode will ensure that files are not included in the backup generation, and during a restore they are copied from the existing file record.

◆ MODE_SAMESITE

const backup::MODE_SAMESITE = 40

inherited

This mode is intended for duplicating courses and cases where the backup target is within the same site.

This mode will ensure that files are not included in the backup generation, and during a restore they are copied from the existing file record.

For creating a backup for archival purposes or greater longevity, use MODE_GENERAL.

The documentation for this class was generated from the following file:

backup/controller/backup_controller.class.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ add_logger()

◆ calculate_checksum()

◆ debug_display_all_settings_values()

◆ destroy()

◆ execute_plan()

◆ get_copy()

◆ get_include_files()

◆ get_include_files_default()

◆ get_logger()

◆ get_plan()

◆ get_progress()

◆ get_releasesession()

◆ is_checksum_correct()

◆ log()

◆ save_controller()

◆ set_copy()

◆ set_include_files()

◆ set_kept_roles()

◆ set_progress()

Member Data Documentation

◆ CIPHERKEYLEN

◆ MODE_ASYNC

◆ MODE_COPY

◆ MODE_IMPORT

◆ MODE_SAMESITE