Class containing static utilities (such as various checks) required by the MoodleNet API. More...

Static Public Member Functions
static	can_user_share (\core\context\course $coursecontext, int $userid, string $type='activity')
	Check whether a user has the capabilities required to share activities or courses to MoodleNet.

static	does_user_have_capability_in_any_course (int $userid)
	Check the user has a valid capability in any course they are enrolled in.

static	get_support_url ()
	Get the support url.

static	is_valid_instance (issuer $issuer)
	Check whether the specified issuer is configured as a MoodleNet instance that can be shared to.

Detailed Description

Class containing static utilities (such as various checks) required by the MoodleNet API.

Copyright: 2023 Michael Hawkins micha.nosp@m.elh@.nosp@m.moodl.nosp@m.e.co.nosp@m.m

Member Function Documentation

static core\moodlenet\utilities::can_user_share	(	\core\context\course	$coursecontext,
		int	$userid,
		string	$type = 'activity' )

static

Check whether a user has the capabilities required to share activities or courses to MoodleNet.

Parameters

core\context\course	$coursecontext	Course context where the activity or course would be shared from.
int	$userid	The user ID being checked.
string	$type	The type of resource being checked (either 'activity' or 'course').

Return values

boolean

Exceptions

coding_exception If an invalid resource type is provided.

static core\moodlenet\utilities::does_user_have_capability_in_any_course ( int $userid )

static

Check the user has a valid capability in any course they are enrolled in.

Parameters

int $userid The user id to query

Return values

string Returns 'yes' if capability found, 'no' if not

static core\moodlenet\utilities::get_support_url ( )

static

Get the support url.

Return values

string

static core\moodlenet\utilities::is_valid_instance ( issuer $issuer )

static

Check whether the specified issuer is configured as a MoodleNet instance that can be shared to.

Parameters

issuer $issuer The OAuth 2 issuer being validated.

Return values

bool	true if the issuer is enabled and available to share to.

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