| [ Index ] |
PHP Cross Reference of Unnamed Project |
[Source view] [Print] [Project Stats]
External course participation api. This api is mostly read only, the actual enrol and unenrol support is in each enrol plugin.
| Copyright: | 2010 Jerome Mouneyrac |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 852 lines (44 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
core_enrol_external:: (12 methods):
get_enrolled_users_with_capability_parameters()
get_enrolled_users_with_capability()
get_enrolled_users_with_capability_returns()
get_users_courses_parameters()
get_users_courses()
get_users_courses_returns()
get_enrolled_users_parameters()
get_enrolled_users()
get_enrolled_users_returns()
get_course_enrolment_methods_parameters()
get_course_enrolment_methods()
get_course_enrolment_methods_returns()
core_role_external:: (6 methods):
assign_roles_parameters()
assign_roles()
assign_roles_returns()
unassign_roles_parameters()
unassign_roles()
unassign_roles_returns()
Class: core_enrol_external - X-Ref
Enrol external functions| get_enrolled_users_with_capability_parameters() X-Ref |
| Returns description of method parameters return: external_function_parameters |
| get_enrolled_users_with_capability($coursecapabilities, $options) X-Ref |
| Return users that have the capabilities for each course specified. For each course and capability specified, a list of the users that are enrolled in the course and have that capability are returned. param: array $coursecapabilities array of course ids and associated capability names {courseid, {capabilities}} return: array An array of arrays describing users for each associated courseid and capability |
| get_enrolled_users_with_capability_returns() X-Ref |
| Returns description of method result value return: external_multiple_structure |
| get_users_courses_parameters() X-Ref |
| Returns description of method parameters return: external_function_parameters |
| get_users_courses($userid) X-Ref |
| 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. param: int $userid return: array of courses |
| get_users_courses_returns() X-Ref |
| Returns description of method result value return: external_description |
| get_enrolled_users_parameters() X-Ref |
| Returns description of method parameters return: external_function_parameters |
| get_enrolled_users($courseid, $options = array() X-Ref |
| Get course participants details param: int $courseid course id param: array $options options { return: array An array of users |
| get_enrolled_users_returns() X-Ref |
| Returns description of method result value return: external_description |
| get_course_enrolment_methods_parameters() X-Ref |
| Returns description of get_course_enrolment_methods() parameters return: external_function_parameters |
| get_course_enrolment_methods($courseid) X-Ref |
| Get list of active course enrolment methods for current user. param: int $courseid return: array of course enrolment methods |
| get_course_enrolment_methods_returns() X-Ref |
| Returns description of get_course_enrolment_methods() result value return: external_description |
Class: core_role_external - X-Ref
Role external functions| assign_roles_parameters() X-Ref |
| Returns description of method parameters return: external_function_parameters |
| assign_roles($assignments) X-Ref |
| Manual role assignments to users param: array $assignments An array of manual role assignment |
| assign_roles_returns() X-Ref |
| Returns description of method result value return: null |
| unassign_roles_parameters() X-Ref |
| Returns description of method parameters return: external_function_parameters |
| unassign_roles($unassignments) X-Ref |
| Unassign roles from users param: array $unassignments An array of unassignment |
| unassign_roles_returns() X-Ref |
| Returns description of method result value return: null |
| Generated: Thu Aug 11 10:00:09 2016 | Cross-referenced by PHPXref 0.7.1 |