core\moodlenet\course_packager Class Reference

Packager to prepare appropriate backup of a course to share to MoodleNet. More...

Inheritance diagram for core\moodlenet\course_packager:

Public Member Functions
	__construct (stdClass $course, int $userid,)
	Constructor for course packager.
	get_package ()
	Prepare the backup file using appropriate setting overrides and return relevant information.

Protected Member Functions
	get_all_task_settings (backup_controller $controller)
	Get all backup settings available for override.
	get_backup_controller ()
	Get the backup controller for the course.
	override_task_setting (array $alltasksettings, string $settingname, int $settingvalue)
	Override a backup task setting with a given value.
	package (backup_controller $controller)
	Package the resource identified by resource id into a new stored_file.

Protected Attributes
cm_info cm_info	$cminfo
	$cminfo The course module which the resource belongs to.
stdClass stdClass	$course
	$course The course which the resource belongs to.
string string	$resourcefilename = 'resource'
	$resourcefilename The filename for the resource.
int int	$userid
	$userid The ID of the user performing the packaging.

Detailed Description

Packager to prepare appropriate backup of a course to share to MoodleNet.

Copyright

2023 Safat Shahin safat.nosp@m..sha.nosp@m.hin@m.nosp@m.oodl.nosp@m.e.com

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Constructor & Destructor Documentation

__construct()

core\moodlenet\course_packager::__construct	(	stdClass	$course,
		int	$userid )

Constructor for course packager.

Parameters

stdClass	$course	The course to package
int	$userid	The ID of the user performing the packaging

Member Function Documentation

get_all_task_settings()

core\moodlenet\resource_packager::get_all_task_settings ( backup_controller $controller )

protectedinherited

Get all backup settings available for override.

Return values

array

the associative array of taskclass => settings instances.

get_backup_controller()

core\moodlenet\course_packager::get_backup_controller ( )

protected

Get the backup controller for the course.

Return values

backup_controller

the backup controller for the course.

Reimplemented from core\moodlenet\resource_packager.

get_package()

core\moodlenet\resource_packager::get_package ( )

inherited

Prepare the backup file using appropriate setting overrides and return relevant information.

Return values

stored_file

override_task_setting()

core\moodlenet\resource_packager::override_task_setting ( array $alltasksettings, string $settingname, int $settingvalue )

protectedinherited

Override a backup task setting with a given value.

Parameters

array	$alltasksettings	All task settings.
string	$settingname	The name of the setting to be overridden (task class name format).
int	$settingvalue	Value to be given to the setting.

package()

core\moodlenet\resource_packager::package ( backup_controller $controller )

protectedinherited

Package the resource identified by resource id into a new stored_file.

Parameters

backup_controller

$controller

The backup controller.

Return values

stored_file

Reimplemented in core\moodlenet\course_partial_packager.

---

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

• lib/classes/moodlenet/course_packager.php