Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
enrol_manual_external Class Reference
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

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$enrolmentsAn 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$enrolmentsan 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: