enrol_self_external Class Reference

Self enrolment external functions. More...

Inheritance diagram for enrol_self_external:

Static Public Member Functions
static	enrol_user ($courseid, $password='', $instanceid=0)
	Self enrol the current user in the given course.
static	enrol_user_parameters ()
	Returns description of method parameters.
static	enrol_user_returns ()
	Returns description of method result value.
static	get_instance_info ($instanceid)
	Return self-enrolment instance information.
static	get_instance_info_parameters ()
	Returns description of get_instance_info() parameters.
static	get_instance_info_returns ()
	Returns description of get_instance_info() result value.

Detailed Description

Self enrolment external functions.

Copyright

2012 Rajesh Taneja rajes.nosp@m.h@mo.nosp@m.odle..nosp@m.com

License

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

Since

Moodle 2.6

Member Function Documentation

enrol_user()

static enrol_self_external::enrol_user ( $courseid, $password = '', $instanceid = 0 )

static

Self enrol the current user in the given course.

Parameters

int	$courseid	id of course
string	$password	enrolment key
int	$instanceid	instance id of self enrolment plugin

Return values

array

of warnings and status result

Since

Moodle 3.0

Exceptions

moodle_exception

enrol_user_parameters()

static enrol_self_external::enrol_user_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 3.0

enrol_user_returns()

static enrol_self_external::enrol_user_returns ( )

static

Returns description of method result value.

Return values

core_external\external_description

Since

Moodle 3.0

get_instance_info()

static enrol_self_external::get_instance_info ( $instanceid )

static

Return self-enrolment instance information.

Parameters

int

$instanceid

instance id of self enrolment plugin.

Return values

array

instance information.

Exceptions

moodle_exception

get_instance_info_parameters()

static enrol_self_external::get_instance_info_parameters ( )

static

Returns description of get_instance_info() parameters.

Return values

external_function_parameters

get_instance_info_returns()

static enrol_self_external::get_instance_info_returns ( )

static

Returns description of get_instance_info() result value.

Return values

core_external\external_description

---

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

• enrol/self/externallib.php