Inheritance diagram for base_controller:

Public Member Functions
	add_logger (base_logger $logger)
	Inserts a new logger at end of logging chain.

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

	get_copy ()
	Get the course copy data.

	get_logger ()
	Gets first logger in logging chain.

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

	get_releasesession ()
	Returns the set value of releasesession.

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

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

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

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

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.

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.

const	MODE_AUTOMATED = 50

const	MODE_CONVERTED = 60

const	MODE_COPY = 80
	This mode is for course copies.

const	MODE_GENERAL = 10

const	MODE_HUB = 30

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

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

const	OPERATION_BACKUP ='backup'

const	OPERATION_RESTORE ='restore'

const	RELEASE = '4.4'
	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 = 2024042200
	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 Attributes
stdClass	$copy
	Holds the relevant destination information for course copy operations.

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

int	$mode
	Backup mode.

core progress base	$progress
	Progress reporting object.

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

Member Function Documentation

◆ add_logger()

base_controller::add_logger ( base_logger $logger )

Inserts a new logger at end of logging chain.

Parameters

base_logger $logger New logger to add

◆ calculate_checksum()

checksumable::calculate_checksum ( )

inherited

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

Implemented in backup_controller, backup_setting, base_logger, base_plan, base_task, and restore_controller.

◆ get_copy()

base_controller::get_copy ( )

Get the course copy data.

Return values

stdClass

Deprecated: since Moodle 4.1 MDL-74548 - please do not use this method anymore.

Todo: MDL-75026 This method will be deleted in Moodle 4.5

See also: restore_controller\get_copy()

Reimplemented in restore_controller.

◆ get_logger()

base_controller::get_logger ( )

Gets first logger in logging chain.

Return values

base_logger Logger

◆ get_progress()

base_controller::get_progress ( )

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

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

checksumable::is_checksum_correct ( $checksum )

inherited

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

Implemented in backup_controller, backup_setting, base_logger, base_plan, base_task, and restore_controller.

◆ log()

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

Logs data to the logger chain.

See also: loggable\log()

Implements loggable.

◆ set_copy()

base_controller::set_copy ( \stdClass $data )

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

Deprecated: since Moodle 4.1 MDL-74548 - please do not use this method anymore.

Todo: MDL-75025 This method will be deleted in Moodle 4.5

See also: restore_controller\__construct()

◆ set_progress()

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

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/base_controller.class.php

Public Member Functions

Public Attributes

Protected Attributes

Member Function Documentation

◆ add_logger()

◆ calculate_checksum()

◆ get_copy()

◆ get_logger()

◆ get_progress()

◆ get_releasesession()

◆ is_checksum_correct()

◆ log()

◆ set_copy()

◆ set_progress()

Member Data Documentation

◆ CIPHERKEYLEN

◆ MODE_ASYNC

◆ MODE_COPY

◆ MODE_IMPORT

◆ MODE_SAMESITE