core\moodlenet\course_sender Class Reference

API for sharing Moodle LMS courses to MoodleNet instances. More...

Inheritance diagram for core\moodlenet\course_sender:

Public Member Functions
	__construct (int $courseid, protected int $userid, protected moodlenet_client $moodlenetclient, protected client $oauthclient, protected int $shareformat=self::SHARE_FORMAT_BACKUP,)
	Constructor for course sender.
	share_resource ()
	Share a course to MoodleNet.

Public Attributes
int const	MAX_FILESIZE = 1070000000
	Maximum upload file size (1.07 GB).
int const	SHARE_FORMAT_BACKUP = 0
	Backup share format - the content is being shared as a Moodle backup file.

Protected Member Functions
	get_resource_description ()
	Fetch the description for the resource being created, in a supported text format.
	log_event (string $resourceurl, int $responsecode,)
	Log an event to the admin logs for an outbound share attempt.
	prepare_share_contents ()
	Prepare the data for sharing, in the format specified.

Static Protected Member Functions
static	get_allowed_share_formats ()
	Return the list of supported share formats.

Protected Attributes
stdClass stdClass	$course
	The course where the activity is located.
core context course false core context course false	$coursecontext
	The course context.
resource_packager resource_packager	$packager
	Resource packager.

Detailed Description

API for sharing Moodle LMS courses to MoodleNet instances.

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_sender::__construct	(	int	$courseid,
		protected int	$userid,
		protected moodlenet_client	$moodlenetclient,
		protected client	$oauthclient,
		protected int	$shareformat = self::SHARE_FORMAT_BACKUP )

Constructor for course sender.

Parameters

int	$courseid	The course ID of the course being shared
int	$userid	The user ID who is sharing the activity
moodlenet_client	$moodlenetclient	The moodlenet_client object used to perform the share
client	$oauthclient	The OAuth 2 client for the MoodleNet instance
int	$shareformat	The data format to share in. Defaults to a Moodle backup (SHARE_FORMAT_BACKUP)

Reimplemented from core\moodlenet\resource_sender.

Member Function Documentation

get_allowed_share_formats()

static core\moodlenet\course_sender::get_allowed_share_formats ( )

staticprotected

Return the list of supported share formats.

Return values

array

Array of supported share format values.

Reimplemented from core\moodlenet\resource_sender.

get_resource_description()

core\moodlenet\course_sender::get_resource_description ( )

protected

Fetch the description for the resource being created, in a supported text format.

Return values

string

Converted course description.

log_event()

core\moodlenet\course_sender::log_event ( string $resourceurl, int $responsecode )

protected

Log an event to the admin logs for an outbound share attempt.

Parameters

string	$resourceurl	The URL of the draft resource if it was created
int	$responsecode	The HTTP response code describing the outcome of the attempt

Return values

void

Reimplemented in core\moodlenet\course_partial_sender.

prepare_share_contents()

core\moodlenet\resource_sender::prepare_share_contents ( )

protectedinherited

Prepare the data for sharing, in the format specified.

Return values

stored_file

share_resource()

core\moodlenet\course_sender::share_resource

(

)

Share a course to MoodleNet.

Return values

array

The HTTP response code from MoodleNet and the MoodleNet draft resource URL (URL empty string on fail). Format: ['responsecode' => 201, 'drafturl' => 'https://draft.mnurl/here']

Reimplemented from core\moodlenet\resource_sender.

---

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

• lib/classes/moodlenet/course_sender.php