externallib.php File Reference

Course participations External functions. More...

Classes
class	core_enrol_external
class	core_role_external

Functions
static	get_course_enrolment_methods ($courseid)
	Get list of active course enrolment methods for current user.
static	get_course_enrolment_methods_parameters ()
	Returns description of get_course_enrolment_methods() parameters.
static	get_course_enrolment_methods_returns ()
	Returns description of get_course_enrolment_methods() result value.
static	get_enrolled_users ($courseid, $options=[])
	Get course participants details.
static	get_enrolled_users_parameters ()
	Returns description of method parameters.
static	get_enrolled_users_returns ()
	Returns description of method result value.
static	get_potential_users_returns ()
	Returns description of method result value.
static	search_users (int $courseid, string $search, bool $searchanywhere, int $page, int $perpage, ?int $contextid=null)
	Search course participants.
static	search_users_parameters ()
	Returns description of method parameters.
static	search_users_returns ()
	Returns description of method result value.
static	submit_user_enrolment_form ($formdata)
	External function that handles the user enrolment form submission.
static	submit_user_enrolment_form_parameters ()
	Returns description of submit_user_enrolment_form parameters.
static	submit_user_enrolment_form_returns ()
	Returns description of submit_user_enrolment_form() result value.
static	unenrol_user_enrolment ($ueid)
	External function that unenrols a given user enrolment.
static	unenrol_user_enrolment_parameters ()
	Returns description of unenrol_user_enrolment() parameters.
static	unenrol_user_enrolment_returns ()
	Returns description of unenrol_user_enrolment() result value.

Detailed Description

Course participations External functions.