Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/enrol/self/ -> externallib.php (source)

[Source view]

Differences Between: [Versions 401 and 402] [Versions 401 and 403]

Self enrol plugin external functions

Copyright: 2013 Rajesh Taneja <rajesh@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 257 lines (10 kb)
Included or required:0 times
Referenced: 4 times
Includes or requires: 0 files

Defines 1 class

enrol_self_external:: (6 methods):
  get_instance_info_parameters()
  get_instance_info()
  get_instance_info_returns()
  enrol_user_parameters()
  enrol_user()
  enrol_user_returns()


Class: enrol_self_external  - X-Ref

Self enrolment external functions.

get_instance_info_parameters()   X-Ref
Returns description of get_instance_info() parameters.

return: external_function_parameters

get_instance_info($instanceid)   X-Ref
Return self-enrolment instance information.

param: int $instanceid instance id of self enrolment plugin.
return: array instance information.

get_instance_info_returns()   X-Ref
Returns description of get_instance_info() result value.

return: external_description

enrol_user_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

enrol_user($courseid, $password = '', $instanceid = 0)   X-Ref
Self enrol the current user in the given course.

param: int $courseid id of course
param: string $password enrolment key
param: int $instanceid instance id of self enrolment plugin
return: array of warnings and status result

enrol_user_returns()   X-Ref
Returns description of method result value

return: external_description