enrol_manual_external Class Reference

External course participation api. More...

Inheritance diagram for enrol_manual_external:

Static Public Member Functions
static	enrol_users ($enrolments)
	Enrolment of users.
static	enrol_users_parameters ()
	Returns description of method parameters.
static	enrol_users_returns ()
	Returns description of method result value.
static	unenrol_users ($enrolments)
	Unenrolment of users.
static	unenrol_users_parameters ()
	Returns description of method parameters.
static	unenrol_users_returns ()
	Returns description of method result value.

Detailed Description

External course participation api.

This api is mostly read only, the actual enrol and unenrol support is in each enrol plugin.

Copyright

2011 Jerome Mouneyrac

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Since

Moodle 2.2

Member Function Documentation

enrol_users()

static enrol_manual_external::enrol_users ( $enrolments )

static

Enrolment of users.

Function throw an exception at the first error encountered.

Parameters

array

$enrolments

An array of user enrolment

Since

Moodle 2.2

enrol_users_parameters()

static enrol_manual_external::enrol_users_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 2.2

enrol_users_returns()

static enrol_manual_external::enrol_users_returns ( )

static

Returns description of method result value.

Return values

null

Since

Moodle 2.2

unenrol_users()

static enrol_manual_external::unenrol_users ( $enrolments )

static

Unenrolment of users.

Parameters

array

$enrolments

an array of course user and role ids

Exceptions

coding_exception
dml_transaction_exception
invalid_parameter_exception
moodle_exception
required_capability_exception
restricted_context_exception

unenrol_users_parameters()

static enrol_manual_external::unenrol_users_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

unenrol_users_returns()

static enrol_manual_external::unenrol_users_returns ( )

static

Returns description of method result value.

Return values

null

---

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

• enrol/manual/externallib.php