core\moodlenet\resource_packager Class Reference

Inheritance diagram for core\moodlenet\resource_packager:

Public Member Functions
	__construct (stdClass|cm_info $resource, int $userid, string $resourcefilename,)
	Constructor for the base 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.

Constructor & Destructor Documentation

__construct()

core\moodlenet\resource_packager::__construct	(	stdClass|cm_info	$resource,
		int	$userid,
		string	$resourcefilename )

Constructor for the base packager.

Parameters

stdClass | cm_info	$resource	The resource object
int	$userid	The user id

Member Function Documentation

get_all_task_settings()

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

protected

Get all backup settings available for override.

Return values

array

the associative array of taskclass => settings instances.

get_backup_controller()

core\moodlenet\resource_packager::get_backup_controller ( )

abstractprotected

Get the backup controller for the course.

Return values

backup_controller

The backup controller instance that will be used to package the resource.

Reimplemented in core\moodlenet\activity_packager, and core\moodlenet\course_packager.

get_package()

core\moodlenet\resource_packager::get_package

(

)

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 )

protected

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 )

protected

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/resource_packager.php