moodle_enrol_external Class Reference

Inheritance diagram for moodle_enrol_external:

Collaboration diagram for moodle_enrol_external:

Static Public Member Functions
static	get_enrolled_users_parameters ()
static	get_enrolled_users ($courseid, $withcapability=null, $groupid=null, $onlyactive=false)
static	get_enrolled_users_returns ()
static	get_users_courses_parameters ()
static	get_users_courses ($userid)
static	get_users_courses_returns ()
static	role_assign_parameters ()
static	role_assign ($assignments)
static	role_assign_returns ()
static	role_unassign_parameters ()
static	role_unassign ($unassignments)
static	role_unassign_returns ()

---

Detailed Description

Deprecated enroll and role functions

Deprecated:

since Moodle 2.2 please use core_enrol_external or core_role_external instead

Definition at line 446 of file externallib.php.

---

Member Function Documentation

static get_enrolled_users	(	$	courseid,
		$	withcapability = null,
		$	groupid = null,
		$	onlyactive = false
	)		[static]

Get list of course participants.

Deprecated:

since Moodle 2.2 please use core_enrol_external::get_enrolled_users() instead

Parameters:

int	$courseid
text	$withcapability
int	$groupid
bool	$onlyactive

Returns:

array of course participants

Definition at line 474 of file externallib.php.

Here is the call graph for this function:

static get_enrolled_users_parameters

(

)

[static]

Returns description of method parameters

Deprecated:

since Moodle 2.2 please use core_enrol_external::get_enrolled_users_parameters() instead

Returns:

external_function_parameters

Definition at line 454 of file externallib.php.

static get_enrolled_users_returns

(

)

[static]

Returns description of method result value

Deprecated:

since Moodle 2.2 please use core_enrol_external::get_enrolled_users_returns() instead

Returns:

external_description

Definition at line 561 of file externallib.php.

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.

Deprecated:

since Moodle 2.2 please use core_enrol_external::get_users_courses() instead

Parameters:

int

$userid

Returns:

array of courses

Definition at line 595 of file externallib.php.

static get_users_courses_parameters

(

)

[static]

Returns description of method parameters

Deprecated:

since Moodle 2.2 please use core_enrol_external::get_users_courses_parameters() instead

Returns:

external_function_parameters

Definition at line 583 of file externallib.php.

static get_users_courses_returns

(

)

[static]

Returns description of method result value

Deprecated:

since Moodle 2.2 please use core_enrol_external::get_users_courses_returns() instead

Returns:

external_description

Definition at line 604 of file externallib.php.

static role_assign

(

$

assignments

)

[static]

Manual role assignments to users

Deprecated:

since Moodle 2.2 please use core_role_external::assign_roles() instead

Parameters:

array

$assignment

An array of manual role assignment

Returns:

null

Definition at line 624 of file externallib.php.

Here is the call graph for this function:

static role_assign_parameters

(

)

[static]

Returns description of method parameters

Deprecated:

since Moodle 2.2 please use core_role_external::assign_roles_parameters() instead

Returns:

external_function_parameters

Definition at line 614 of file externallib.php.

Here is the call graph for this function:

static role_assign_returns

(

)

[static]

Returns description of method result value

Deprecated:

since Moodle 2.2 please use core_role_external::assign_roles_returns() instead

Returns:

external_description

Definition at line 633 of file externallib.php.

Here is the call graph for this function:

static role_unassign

(

$

unassignments

)

[static]

Unassign roles from users

Deprecated:

since Moodle 2.2 please use core_role_external::unassign_roles() instead

Parameters:

array

$unassignment

An array of unassignment

Returns:

null

Definition at line 653 of file externallib.php.

Here is the call graph for this function:

static role_unassign_parameters

(

)

[static]

Returns description of method parameters

Deprecated:

since Moodle 2.2 please use core_role_external::unassign_roles_parameters() instead

Returns:

external_function_parameters

Definition at line 643 of file externallib.php.

Here is the call graph for this function:

static role_unassign_returns

(

)

[static]

Returns description of method result value

Deprecated:

since Moodle 2.2 please use core_role_external::unassign_roles_returns() instead

Returns:

external_description

Definition at line 662 of file externallib.php.

Here is the call graph for this function:

---

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

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