core_enrol_external Class Reference

Inheritance diagram for core_enrol_external:

Collaboration diagram for core_enrol_external:

Static Public Member Functions
static	get_users_courses_parameters ()
static	get_users_courses ($userid)
static	get_users_courses_returns ()
static	get_enrolled_users_parameters ()
static	get_enrolled_users ($courseid, $options)
static	get_enrolled_users_returns ()

---

Detailed Description

Enrol functions

Definition at line 37 of file externallib.php.

---

Member Function Documentation

static get_enrolled_users	(	$	courseid,
		$	options
	)		[static]

Get course participants details

Parameters:

int	$courseid	course id
array	$options	options { 'name' => option name 'value' => option value }

Returns:

array An array of users

Definition at line 140 of file externallib.php.

Here is the call graph for this function:

static get_enrolled_users_parameters

(

)

[static]

Returns description of method parameters

Returns:

external_function_parameters

Definition at line 116 of file externallib.php.

Here is the caller graph for this function:

static get_enrolled_users_returns

(

)

[static]

Returns description of method result value

Returns:

external_description

Definition at line 233 of file externallib.php.

Here is the caller graph for this function:

static get_users_courses

(

$

userid

)

[static]

Get list of courses user is enrolled in (only active enrolments are returned).

Please note the current user must be able to access the course, otherwise the course is not included.

Parameters:

int

$userid

Returns:

array of courses

Definition at line 59 of file externallib.php.

Here is the call graph for this function:

static get_users_courses_parameters

(

)

[static]

Returns description of method parameters

Returns:

external_function_parameters

Definition at line 43 of file externallib.php.

static get_users_courses_returns

(

)

[static]

Returns description of method result value

Returns:

external_description

Definition at line 97 of file externallib.php.

---

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

• C:/xampp/htdocs/moodle/enrol/externallib.php