Merge branch 'MDL-65211-master' of git://github.com/jleyva/moodle
[moodle.git] / enrol / externallib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * External course participation api.
20  *
21  * This api is mostly read only, the actual enrol and unenrol
22  * support is in each enrol plugin.
23  *
24  * @package    core_enrol
25  * @category   external
26  * @copyright  2010 Jerome Mouneyrac
27  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
28  */
30 defined('MOODLE_INTERNAL') || die();
32 require_once("$CFG->libdir/externallib.php");
34 /**
35  * Enrol external functions
36  *
37  * @package    core_enrol
38  * @category   external
39  * @copyright  2011 Jerome Mouneyrac
40  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
41  * @since Moodle 2.2
42  */
43 class core_enrol_external extends external_api {
45     /**
46      * Returns description of method parameters
47      *
48      * @return external_function_parameters
49      * @since Moodle 2.4
50      */
51     public static function get_enrolled_users_with_capability_parameters() {
52         return new external_function_parameters(
53             array (
54                 'coursecapabilities' => new external_multiple_structure(
55                     new external_single_structure(
56                         array (
57                             'courseid' => new external_value(PARAM_INT, 'Course ID number in the Moodle course table'),
58                             'capabilities' => new external_multiple_structure(
59                                 new external_value(PARAM_CAPABILITY, 'Capability name, such as mod/forum:viewdiscussion')),
60                         )
61                     )
62                 , 'course id and associated capability name'),
63                  'options'  => new external_multiple_structure(
64                     new external_single_structure(
65                         array(
66                             'name'  => new external_value(PARAM_ALPHANUMEXT, 'option name'),
67                             'value' => new external_value(PARAM_RAW, 'option value')
68                         )
69                     ), 'Option names:
70                             * groupid (integer) return only users in this group id. Requires \'moodle/site:accessallgroups\' .
71                             * onlyactive (integer) only users with active enrolments. Requires \'moodle/course:enrolreview\' .
72                             * userfields (\'string, string, ...\') return only the values of these user fields.
73                             * limitfrom (integer) sql limit from.
74                             * limitnumber (integer) max number of users per course and capability.', VALUE_DEFAULT, array())
75             )
76         );
77     }
79     /**
80      * Return users that have the capabilities for each course specified. For each course and capability specified,
81      * a list of the users that are enrolled in the course and have that capability are returned.
82      *
83      * @param array $coursecapabilities array of course ids and associated capability names {courseid, {capabilities}}
84      * @return array An array of arrays describing users for each associated courseid and capability
85      * @since  Moodle 2.4
86      */
87     public static function get_enrolled_users_with_capability($coursecapabilities, $options) {
88         global $CFG, $DB;
90         require_once($CFG->dirroot . '/course/lib.php');
91         require_once($CFG->dirroot . "/user/lib.php");
93         if (empty($coursecapabilities)) {
94             throw new invalid_parameter_exception('Parameter can not be empty');
95         }
96         $params = self::validate_parameters(self::get_enrolled_users_with_capability_parameters(),
97             array ('coursecapabilities' => $coursecapabilities,  'options'=>$options));
98         $result = array();
99         $userlist = array();
100         $groupid        = 0;
101         $onlyactive     = false;
102         $userfields     = array();
103         $limitfrom = 0;
104         $limitnumber = 0;
105         foreach ($params['options'] as $option) {
106             switch ($option['name']) {
107                 case 'groupid':
108                     $groupid = (int)$option['value'];
109                     break;
110                 case 'onlyactive':
111                     $onlyactive = !empty($option['value']);
112                     break;
113                 case 'userfields':
114                     $thefields = explode(',', $option['value']);
115                     foreach ($thefields as $f) {
116                         $userfields[] = clean_param($f, PARAM_ALPHANUMEXT);
117                     }
118                     break;
119                 case 'limitfrom' :
120                     $limitfrom = clean_param($option['value'], PARAM_INT);
121                     break;
122                 case 'limitnumber' :
123                     $limitnumber = clean_param($option['value'], PARAM_INT);
124                     break;
125             }
126         }
128         foreach ($params['coursecapabilities'] as $coursecapability) {
129             $courseid = $coursecapability['courseid'];
130             $course = $DB->get_record('course', array('id'=>$courseid), '*', MUST_EXIST);
131             $coursecontext = context_course::instance($courseid);
132             if (!$coursecontext) {
133                 throw new moodle_exception('cannotfindcourse', 'error', '', null,
134                         'The course id ' . $courseid . ' doesn\'t exist.');
135             }
136             if ($courseid == SITEID) {
137                 $context = context_system::instance();
138             } else {
139                 $context = $coursecontext;
140             }
141             try {
142                 self::validate_context($context);
143             } catch (Exception $e) {
144                 $exceptionparam = new stdClass();
145                 $exceptionparam->message = $e->getMessage();
146                 $exceptionparam->courseid = $params['courseid'];
147                 throw new moodle_exception(get_string('errorcoursecontextnotvalid' , 'webservice', $exceptionparam));
148             }
150             course_require_view_participants($context);
152             // The accessallgroups capability is needed to use this option.
153             if (!empty($groupid) && groups_is_member($groupid)) {
154                 require_capability('moodle/site:accessallgroups', $coursecontext);
155             }
156             // The course:enrolereview capability is needed to use this option.
157             if ($onlyactive) {
158                 require_capability('moodle/course:enrolreview', $coursecontext);
159             }
161             // To see the permissions of others role:review capability is required.
162             require_capability('moodle/role:review', $coursecontext);
163             foreach ($coursecapability['capabilities'] as $capability) {
164                 $courseusers['courseid'] = $courseid;
165                 $courseusers['capability'] = $capability;
167                 list($enrolledsql, $enrolledparams) = get_enrolled_sql($coursecontext, $capability, $groupid, $onlyactive);
168                 $enrolledparams['courseid'] = $courseid;
170                 $sql = "SELECT u.*, COALESCE(ul.timeaccess, 0) AS lastcourseaccess
171                           FROM {user} u
172                      LEFT JOIN {user_lastaccess} ul ON (ul.userid = u.id AND ul.courseid = :courseid)
173                          WHERE u.id IN ($enrolledsql)
174                       ORDER BY u.id ASC";
176                 $enrolledusers = $DB->get_recordset_sql($sql, $enrolledparams, $limitfrom, $limitnumber);
177                 $users = array();
178                 foreach ($enrolledusers as $courseuser) {
179                     if ($userdetails = user_get_user_details($courseuser, $course, $userfields)) {
180                         $users[] = $userdetails;
181                     }
182                 }
183                 $enrolledusers->close();
184                 $courseusers['users'] = $users;
185                 $result[] = $courseusers;
186             }
187         }
188         return $result;
189     }
191     /**
192      * Returns description of method result value
193      *
194      * @return external_multiple_structure
195      * @since Moodle 2.4
196      */
197     public static function get_enrolled_users_with_capability_returns() {
198         return  new external_multiple_structure( new external_single_structure (
199                 array (
200                     'courseid' => new external_value(PARAM_INT, 'Course ID number in the Moodle course table'),
201                     'capability' => new external_value(PARAM_CAPABILITY, 'Capability name'),
202                     'users' => new external_multiple_structure(
203                         new external_single_structure(
204                 array(
205                     'id'    => new external_value(PARAM_INT, 'ID of the user'),
206                     'username'    => new external_value(PARAM_RAW, 'Username', VALUE_OPTIONAL),
207                     'firstname'   => new external_value(PARAM_NOTAGS, 'The first name(s) of the user', VALUE_OPTIONAL),
208                     'lastname'    => new external_value(PARAM_NOTAGS, 'The family name of the user', VALUE_OPTIONAL),
209                     'fullname'    => new external_value(PARAM_NOTAGS, 'The fullname of the user'),
210                     'email'       => new external_value(PARAM_TEXT, 'Email address', VALUE_OPTIONAL),
211                     'address'     => new external_value(PARAM_MULTILANG, 'Postal address', VALUE_OPTIONAL),
212                     'phone1'      => new external_value(PARAM_NOTAGS, 'Phone 1', VALUE_OPTIONAL),
213                     'phone2'      => new external_value(PARAM_NOTAGS, 'Phone 2', VALUE_OPTIONAL),
214                     'icq'         => new external_value(PARAM_NOTAGS, 'icq number', VALUE_OPTIONAL),
215                     'skype'       => new external_value(PARAM_NOTAGS, 'skype id', VALUE_OPTIONAL),
216                     'yahoo'       => new external_value(PARAM_NOTAGS, 'yahoo id', VALUE_OPTIONAL),
217                     'aim'         => new external_value(PARAM_NOTAGS, 'aim id', VALUE_OPTIONAL),
218                     'msn'         => new external_value(PARAM_NOTAGS, 'msn number', VALUE_OPTIONAL),
219                     'department'  => new external_value(PARAM_TEXT, 'department', VALUE_OPTIONAL),
220                     'institution' => new external_value(PARAM_TEXT, 'institution', VALUE_OPTIONAL),
221                     'interests'   => new external_value(PARAM_TEXT, 'user interests (separated by commas)', VALUE_OPTIONAL),
222                     'firstaccess' => new external_value(PARAM_INT, 'first access to the site (0 if never)', VALUE_OPTIONAL),
223                     'lastaccess'  => new external_value(PARAM_INT, 'last access to the site (0 if never)', VALUE_OPTIONAL),
224                     'lastcourseaccess'  => new external_value(PARAM_INT, 'last access to the course (0 if never)', VALUE_OPTIONAL),
225                     'description' => new external_value(PARAM_RAW, 'User profile description', VALUE_OPTIONAL),
226                     'descriptionformat' => new external_value(PARAM_INT, 'User profile description format', VALUE_OPTIONAL),
227                     'city'        => new external_value(PARAM_NOTAGS, 'Home city of the user', VALUE_OPTIONAL),
228                     'url'         => new external_value(PARAM_URL, 'URL of the user', VALUE_OPTIONAL),
229                     'country'     => new external_value(PARAM_ALPHA, 'Country code of the user, such as AU or CZ', VALUE_OPTIONAL),
230                     'profileimageurlsmall' => new external_value(PARAM_URL, 'User image profile URL - small', VALUE_OPTIONAL),
231                     'profileimageurl' => new external_value(PARAM_URL, 'User image profile URL - big', VALUE_OPTIONAL),
232                     'customfields' => new external_multiple_structure(
233                         new external_single_structure(
234                             array(
235                                 'type'  => new external_value(PARAM_ALPHANUMEXT, 'The type of the custom field'),
236                                 'value' => new external_value(PARAM_RAW, 'The value of the custom field'),
237                                 'name' => new external_value(PARAM_RAW, 'The name of the custom field'),
238                                 'shortname' => new external_value(PARAM_RAW, 'The shortname of the custom field'),
239                             )
240                         ), 'User custom fields (also known as user profil fields)', VALUE_OPTIONAL),
241                     'groups' => new external_multiple_structure(
242                         new external_single_structure(
243                             array(
244                                 'id'  => new external_value(PARAM_INT, 'group id'),
245                                 'name' => new external_value(PARAM_RAW, 'group name'),
246                                 'description' => new external_value(PARAM_RAW, 'group description'),
247                             )
248                         ), 'user groups', VALUE_OPTIONAL),
249                     'roles' => new external_multiple_structure(
250                         new external_single_structure(
251                             array(
252                                 'roleid'       => new external_value(PARAM_INT, 'role id'),
253                                 'name'         => new external_value(PARAM_RAW, 'role name'),
254                                 'shortname'    => new external_value(PARAM_ALPHANUMEXT, 'role shortname'),
255                                 'sortorder'    => new external_value(PARAM_INT, 'role sortorder')
256                             )
257                         ), 'user roles', VALUE_OPTIONAL),
258                     'preferences' => new external_multiple_structure(
259                         new external_single_structure(
260                             array(
261                                 'name'  => new external_value(PARAM_RAW, 'The name of the preferences'),
262                                 'value' => new external_value(PARAM_RAW, 'The value of the custom field'),
263                             )
264                     ), 'User preferences', VALUE_OPTIONAL),
265                     'enrolledcourses' => new external_multiple_structure(
266                         new external_single_structure(
267                             array(
268                                 'id'  => new external_value(PARAM_INT, 'Id of the course'),
269                                 'fullname' => new external_value(PARAM_RAW, 'Fullname of the course'),
270                                 'shortname' => new external_value(PARAM_RAW, 'Shortname of the course')
271                             )
272                     ), 'Courses where the user is enrolled - limited by which courses the user is able to see', VALUE_OPTIONAL)
273                 )
274                         ), 'List of users that are enrolled in the course and have the specified capability'),
275                     )
276                 )
277             );
278     }
280     /**
281      * Returns description of method parameters
282      *
283      * @return external_function_parameters
284      */
285     public static function get_users_courses_parameters() {
286         return new external_function_parameters(
287             array(
288                 'userid' => new external_value(PARAM_INT, 'user id'),
289                 'returnusercount' => new external_value(PARAM_BOOL,
290                         'Include count of enrolled users for each course? This can add several seconds to the response time'
291                             . ' if a user is on several large courses, so set this to false if the value will not be used to'
292                             . ' improve performance.',
293                         VALUE_DEFAULT, true),
294             )
295         );
296     }
298     /**
299      * Get list of courses user is enrolled in (only active enrolments are returned).
300      * Please note the current user must be able to access the course, otherwise the course is not included.
301      *
302      * @param int $userid
303      * @param bool $returnusercount
304      * @return array of courses
305      */
306     public static function get_users_courses($userid, $returnusercount = true) {
307         global $CFG, $USER, $DB;
309         require_once($CFG->dirroot . '/course/lib.php');
310         require_once($CFG->libdir . '/completionlib.php');
312         // Do basic automatic PARAM checks on incoming data, using params description
313         // If any problems are found then exceptions are thrown with helpful error messages
314         $params = self::validate_parameters(self::get_users_courses_parameters(),
315                 ['userid' => $userid, 'returnusercount' => $returnusercount]);
316         $userid = $params['userid'];
317         $returnusercount = $params['returnusercount'];
319         $courses = enrol_get_users_courses($userid, true, '*');
320         $result = array();
322         // Get user data including last access to courses.
323         $user = get_complete_user_data('id', $userid);
324         $sameuser = $USER->id == $userid;
326         // Retrieve favourited courses (starred).
327         $favouritecourseids = array();
328         if ($sameuser) {
329             $ufservice = \core_favourites\service_factory::get_service_for_user_context(\context_user::instance($userid));
330             $favourites = $ufservice->find_favourites_by_type('core_course', 'courses');
332             if ($favourites) {
333                 $favouritecourseids = array_flip(array_map(
334                     function($favourite) {
335                         return $favourite->itemid;
336                     }, $favourites));
337             }
338         }
340         foreach ($courses as $course) {
341             $context = context_course::instance($course->id, IGNORE_MISSING);
342             try {
343                 self::validate_context($context);
344             } catch (Exception $e) {
345                 // current user can not access this course, sorry we can not disclose who is enrolled in this course!
346                 continue;
347             }
349             if (!$sameuser and !course_can_view_participants($context)) {
350                 // we need capability to view participants
351                 continue;
352             }
354             if ($returnusercount) {
355                 list($enrolledsqlselect, $enrolledparams) = get_enrolled_sql($context);
356                 $enrolledsql = "SELECT COUNT('x') FROM ($enrolledsqlselect) enrolleduserids";
357                 $enrolledusercount = $DB->count_records_sql($enrolledsql, $enrolledparams);
358             }
360             $displayname = external_format_string(get_course_display_name_for_list($course), $context->id);
361             list($course->summary, $course->summaryformat) =
362                 external_format_text($course->summary, $course->summaryformat, $context->id, 'course', 'summary', null);
363             $course->fullname = external_format_string($course->fullname, $context->id);
364             $course->shortname = external_format_string($course->shortname, $context->id);
366             $progress = null;
367             $completed = null;
368             $completionhascriteria = false;
369             $completionusertracked = false;
371             // Return only private information if the user should be able to see it.
372             if ($sameuser || completion_can_view_data($userid, $course)) {
373                 if ($course->enablecompletion) {
374                     $completion = new completion_info($course);
375                     $completed = $completion->is_course_complete($userid);
376                     $completionhascriteria = $completion->has_criteria();
377                     $completionusertracked = $completion->is_tracked_user($userid);
378                     $progress = \core_completion\progress::get_course_progress_percentage($course, $userid);
379                 }
380             }
382             $lastaccess = null;
383             // Check if last access is a hidden field.
384             $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields));
385             $canviewlastaccess = $sameuser || !isset($hiddenfields['lastaccess']);
386             if (!$canviewlastaccess) {
387                 $canviewlastaccess = has_capability('moodle/course:viewhiddenuserfields', $context);
388             }
390             if ($canviewlastaccess && isset($user->lastcourseaccess[$course->id])) {
391                 $lastaccess = $user->lastcourseaccess[$course->id];
392             }
394             $hidden = false;
395             if ($sameuser) {
396                 $hidden = boolval(get_user_preferences('block_myoverview_hidden_course_' . $course->id, 0));
397             }
399             // Retrieve course overview used files.
400             $courselist = new core_course_list_element($course);
401             $overviewfiles = array();
402             foreach ($courselist->get_course_overviewfiles() as $file) {
403                 $fileurl = moodle_url::make_webservice_pluginfile_url($file->get_contextid(), $file->get_component(),
404                                                                         $file->get_filearea(), null, $file->get_filepath(),
405                                                                         $file->get_filename())->out(false);
406                 $overviewfiles[] = array(
407                     'filename' => $file->get_filename(),
408                     'fileurl' => $fileurl,
409                     'filesize' => $file->get_filesize(),
410                     'filepath' => $file->get_filepath(),
411                     'mimetype' => $file->get_mimetype(),
412                     'timemodified' => $file->get_timemodified(),
413                 );
414             }
416             $courseresult = [
417                 'id' => $course->id,
418                 'shortname' => $course->shortname,
419                 'fullname' => $course->fullname,
420                 'displayname' => $displayname,
421                 'idnumber' => $course->idnumber,
422                 'visible' => $course->visible,
423                 'summary' => $course->summary,
424                 'summaryformat' => $course->summaryformat,
425                 'format' => $course->format,
426                 'showgrades' => $course->showgrades,
427                 'lang' => clean_param($course->lang, PARAM_LANG),
428                 'enablecompletion' => $course->enablecompletion,
429                 'completionhascriteria' => $completionhascriteria,
430                 'completionusertracked' => $completionusertracked,
431                 'category' => $course->category,
432                 'progress' => $progress,
433                 'completed' => $completed,
434                 'startdate' => $course->startdate,
435                 'enddate' => $course->enddate,
436                 'marker' => $course->marker,
437                 'lastaccess' => $lastaccess,
438                 'isfavourite' => isset($favouritecourseids[$course->id]),
439                 'hidden' => $hidden,
440                 'overviewfiles' => $overviewfiles,
441             ];
442             if ($returnusercount) {
443                 $courseresult['enrolledusercount'] = $enrolledusercount;
444             }
445             $result[] = $courseresult;
446         }
448         return $result;
449     }
451     /**
452      * Returns description of method result value
453      *
454      * @return external_description
455      */
456     public static function get_users_courses_returns() {
457         return new external_multiple_structure(
458             new external_single_structure(
459                 array(
460                     'id'        => new external_value(PARAM_INT, 'id of course'),
461                     'shortname' => new external_value(PARAM_RAW, 'short name of course'),
462                     'fullname'  => new external_value(PARAM_RAW, 'long name of course'),
463                     'displayname' => new external_value(PARAM_TEXT, 'course display name for lists.', VALUE_OPTIONAL),
464                     'enrolledusercount' => new external_value(PARAM_INT, 'Number of enrolled users in this course',
465                             VALUE_OPTIONAL),
466                     'idnumber'  => new external_value(PARAM_RAW, 'id number of course'),
467                     'visible'   => new external_value(PARAM_INT, '1 means visible, 0 means not yet visible course'),
468                     'summary'   => new external_value(PARAM_RAW, 'summary', VALUE_OPTIONAL),
469                     'summaryformat' => new external_format_value('summary', VALUE_OPTIONAL),
470                     'format'    => new external_value(PARAM_PLUGIN, 'course format: weeks, topics, social, site', VALUE_OPTIONAL),
471                     'showgrades' => new external_value(PARAM_BOOL, 'true if grades are shown, otherwise false', VALUE_OPTIONAL),
472                     'lang'      => new external_value(PARAM_LANG, 'forced course language', VALUE_OPTIONAL),
473                     'enablecompletion' => new external_value(PARAM_BOOL, 'true if completion is enabled, otherwise false',
474                                                                 VALUE_OPTIONAL),
475                     'completionhascriteria' => new external_value(PARAM_BOOL, 'If completion criteria is set.', VALUE_OPTIONAL),
476                     'completionusertracked' => new external_value(PARAM_BOOL, 'If the user is completion tracked.', VALUE_OPTIONAL),
477                     'category' => new external_value(PARAM_INT, 'course category id', VALUE_OPTIONAL),
478                     'progress' => new external_value(PARAM_FLOAT, 'Progress percentage', VALUE_OPTIONAL),
479                     'completed' => new external_value(PARAM_BOOL, 'Whether the course is completed.', VALUE_OPTIONAL),
480                     'startdate' => new external_value(PARAM_INT, 'Timestamp when the course start', VALUE_OPTIONAL),
481                     'enddate' => new external_value(PARAM_INT, 'Timestamp when the course end', VALUE_OPTIONAL),
482                     'marker' => new external_value(PARAM_INT, 'Course section marker.', VALUE_OPTIONAL),
483                     'lastaccess' => new external_value(PARAM_INT, 'Last access to the course (timestamp).', VALUE_OPTIONAL),
484                     'isfavourite' => new external_value(PARAM_BOOL, 'If the user marked this course a favourite.', VALUE_OPTIONAL),
485                     'hidden' => new external_value(PARAM_BOOL, 'If the user hide the course from the dashboard.', VALUE_OPTIONAL),
486                     'overviewfiles' => new external_files('Overview files attached to this course.', VALUE_OPTIONAL),
487                 )
488             )
489         );
490     }
492     /**
493      * Returns description of method parameters value
494      *
495      * @return external_description
496      */
497     public static function get_potential_users_parameters() {
498         return new external_function_parameters(
499             array(
500                 'courseid' => new external_value(PARAM_INT, 'course id'),
501                 'enrolid' => new external_value(PARAM_INT, 'enrolment id'),
502                 'search' => new external_value(PARAM_RAW, 'query'),
503                 'searchanywhere' => new external_value(PARAM_BOOL, 'find a match anywhere, or only at the beginning'),
504                 'page' => new external_value(PARAM_INT, 'Page number'),
505                 'perpage' => new external_value(PARAM_INT, 'Number per page'),
506             )
507         );
508     }
510     /**
511      * Get potential users.
512      *
513      * @param int $courseid Course id
514      * @param int $enrolid Enrolment id
515      * @param string $search The query
516      * @param boolean $searchanywhere Match anywhere in the string
517      * @param int $page Page number
518      * @param int $perpage Max per page
519      * @return array An array of users
520      */
521     public static function get_potential_users($courseid, $enrolid, $search, $searchanywhere, $page, $perpage) {
522         global $PAGE, $DB, $CFG;
524         require_once($CFG->dirroot.'/enrol/locallib.php');
525         require_once($CFG->dirroot.'/user/lib.php');
527         $params = self::validate_parameters(
528             self::get_potential_users_parameters(),
529             array(
530                 'courseid' => $courseid,
531                 'enrolid' => $enrolid,
532                 'search' => $search,
533                 'searchanywhere' => $searchanywhere,
534                 'page' => $page,
535                 'perpage' => $perpage
536             )
537         );
538         $context = context_course::instance($params['courseid']);
539         try {
540             self::validate_context($context);
541         } catch (Exception $e) {
542             $exceptionparam = new stdClass();
543             $exceptionparam->message = $e->getMessage();
544             $exceptionparam->courseid = $params['courseid'];
545             throw new moodle_exception('errorcoursecontextnotvalid' , 'webservice', '', $exceptionparam);
546         }
547         require_capability('moodle/course:enrolreview', $context);
549         $course = $DB->get_record('course', array('id' => $params['courseid']));
550         $manager = new course_enrolment_manager($PAGE, $course);
552         $users = $manager->get_potential_users($params['enrolid'],
553                                                $params['search'],
554                                                $params['searchanywhere'],
555                                                $params['page'],
556                                                $params['perpage']);
558         $results = array();
559         // Add also extra user fields.
560         $requiredfields = array_merge(
561             ['id', 'fullname', 'profileimageurl', 'profileimageurlsmall'],
562             get_extra_user_fields($context)
563         );
564         foreach ($users['users'] as $id => $user) {
565             // Note: We pass the course here to validate that the current user can at least view user details in this course.
566             // The user we are looking at is not in this course yet though - but we only fetch the minimal set of
567             // user records, and the user has been validated to have course:enrolreview in this course. Otherwise
568             // there is no way to find users who aren't in the course in order to enrol them.
569             if ($userdetails = user_get_user_details($user, $course, $requiredfields)) {
570                 $results[] = $userdetails;
571             }
572         }
573         return $results;
574     }
576     /**
577      * Returns description of method result value
578      *
579      * @return external_description
580      */
581     public static function get_potential_users_returns() {
582         global $CFG;
583         require_once($CFG->dirroot . '/user/externallib.php');
584         return new external_multiple_structure(core_user_external::user_description());
585     }
587     /**
588      * Returns description of method parameters
589      *
590      * @return external_function_parameters
591      */
592     public static function get_enrolled_users_parameters() {
593         return new external_function_parameters(
594             array(
595                 'courseid' => new external_value(PARAM_INT, 'course id'),
596                 'options'  => new external_multiple_structure(
597                     new external_single_structure(
598                         array(
599                             'name'  => new external_value(PARAM_ALPHANUMEXT, 'option name'),
600                             'value' => new external_value(PARAM_RAW, 'option value')
601                         )
602                     ), 'Option names:
603                             * withcapability (string) return only users with this capability. This option requires \'moodle/role:review\' on the course context.
604                             * groupid (integer) return only users in this group id. If the course has groups enabled and this param
605                                                 isn\'t defined, returns all the viewable users.
606                                                 This option requires \'moodle/site:accessallgroups\' on the course context if the
607                                                 user doesn\'t belong to the group.
608                             * onlyactive (integer) return only users with active enrolments and matching time restrictions. This option requires \'moodle/course:enrolreview\' on the course context.
609                             * userfields (\'string, string, ...\') return only the values of these user fields.
610                             * limitfrom (integer) sql limit from.
611                             * limitnumber (integer) maximum number of returned users.
612                             * sortby (string) sort by id, firstname or lastname. For ordering like the site does, use siteorder.
613                             * sortdirection (string) ASC or DESC',
614                             VALUE_DEFAULT, array()),
615             )
616         );
617     }
619     /**
620      * Get course participants details
621      *
622      * @param int $courseid  course id
623      * @param array $options options {
624      *                                'name' => option name
625      *                                'value' => option value
626      *                               }
627      * @return array An array of users
628      */
629     public static function get_enrolled_users($courseid, $options = array()) {
630         global $CFG, $USER, $DB;
632         require_once($CFG->dirroot . '/course/lib.php');
633         require_once($CFG->dirroot . "/user/lib.php");
635         $params = self::validate_parameters(
636             self::get_enrolled_users_parameters(),
637             array(
638                 'courseid'=>$courseid,
639                 'options'=>$options
640             )
641         );
642         $withcapability = '';
643         $groupid        = 0;
644         $onlyactive     = false;
645         $userfields     = array();
646         $limitfrom = 0;
647         $limitnumber = 0;
648         $sortby = 'us.id';
649         $sortparams = array();
650         $sortdirection = 'ASC';
651         foreach ($options as $option) {
652             switch ($option['name']) {
653             case 'withcapability':
654                 $withcapability = $option['value'];
655                 break;
656             case 'groupid':
657                 $groupid = (int)$option['value'];
658                 break;
659             case 'onlyactive':
660                 $onlyactive = !empty($option['value']);
661                 break;
662             case 'userfields':
663                 $thefields = explode(',', $option['value']);
664                 foreach ($thefields as $f) {
665                     $userfields[] = clean_param($f, PARAM_ALPHANUMEXT);
666                 }
667                 break;
668             case 'limitfrom' :
669                 $limitfrom = clean_param($option['value'], PARAM_INT);
670                 break;
671             case 'limitnumber' :
672                 $limitnumber = clean_param($option['value'], PARAM_INT);
673                 break;
674             case 'sortby':
675                 $sortallowedvalues = array('id', 'firstname', 'lastname', 'siteorder');
676                 if (!in_array($option['value'], $sortallowedvalues)) {
677                     throw new invalid_parameter_exception('Invalid value for sortby parameter (value: ' . $option['value'] . '),' .
678                         'allowed values are: ' . implode(',', $sortallowedvalues));
679                 }
680                 if ($option['value'] == 'siteorder') {
681                     list($sortby, $sortparams) = users_order_by_sql('us');
682                 } else {
683                     $sortby = 'us.' . $option['value'];
684                 }
685                 break;
686             case 'sortdirection':
687                 $sortdirection = strtoupper($option['value']);
688                 $directionallowedvalues = array('ASC', 'DESC');
689                 if (!in_array($sortdirection, $directionallowedvalues)) {
690                     throw new invalid_parameter_exception('Invalid value for sortdirection parameter
691                         (value: ' . $sortdirection . '),' . 'allowed values are: ' . implode(',', $directionallowedvalues));
692                 }
693                 break;
694             }
695         }
697         $course = $DB->get_record('course', array('id'=>$courseid), '*', MUST_EXIST);
698         $coursecontext = context_course::instance($courseid, IGNORE_MISSING);
699         if ($courseid == SITEID) {
700             $context = context_system::instance();
701         } else {
702             $context = $coursecontext;
703         }
704         try {
705             self::validate_context($context);
706         } catch (Exception $e) {
707             $exceptionparam = new stdClass();
708             $exceptionparam->message = $e->getMessage();
709             $exceptionparam->courseid = $params['courseid'];
710             throw new moodle_exception('errorcoursecontextnotvalid' , 'webservice', '', $exceptionparam);
711         }
713         course_require_view_participants($context);
715         // to overwrite this parameter, you need role:review capability
716         if ($withcapability) {
717             require_capability('moodle/role:review', $coursecontext);
718         }
719         // need accessallgroups capability if you want to overwrite this option
720         if (!empty($groupid) && !groups_is_member($groupid)) {
721             require_capability('moodle/site:accessallgroups', $coursecontext);
722         }
723         // to overwrite this option, you need course:enrolereview permission
724         if ($onlyactive) {
725             require_capability('moodle/course:enrolreview', $coursecontext);
726         }
728         list($enrolledsql, $enrolledparams) = get_enrolled_sql($coursecontext, $withcapability, $groupid, $onlyactive);
729         $ctxselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
730         $ctxjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = u.id AND ctx.contextlevel = :contextlevel)";
731         $enrolledparams['contextlevel'] = CONTEXT_USER;
733         $groupjoin = '';
734         if (empty($groupid) && groups_get_course_groupmode($course) == SEPARATEGROUPS &&
735                 !has_capability('moodle/site:accessallgroups', $coursecontext)) {
736             // Filter by groups the user can view.
737             $usergroups = groups_get_user_groups($course->id);
738             if (!empty($usergroups['0'])) {
739                 list($groupsql, $groupparams) = $DB->get_in_or_equal($usergroups['0'], SQL_PARAMS_NAMED);
740                 $groupjoin = "JOIN {groups_members} gm ON (u.id = gm.userid AND gm.groupid $groupsql)";
741                 $enrolledparams = array_merge($enrolledparams, $groupparams);
742             } else {
743                 // User doesn't belong to any group, so he can't see any user. Return an empty array.
744                 return array();
745             }
746         }
747         $sql = "SELECT us.*, COALESCE(ul.timeaccess, 0) AS lastcourseaccess
748                   FROM {user} us
749                   JOIN (
750                       SELECT DISTINCT u.id $ctxselect
751                         FROM {user} u $ctxjoin $groupjoin
752                        WHERE u.id IN ($enrolledsql)
753                   ) q ON q.id = us.id
754              LEFT JOIN {user_lastaccess} ul ON (ul.userid = us.id AND ul.courseid = :courseid)
755                 ORDER BY $sortby $sortdirection";
756         $enrolledparams = array_merge($enrolledparams, $sortparams);
757         $enrolledparams['courseid'] = $courseid;
759         $enrolledusers = $DB->get_recordset_sql($sql, $enrolledparams, $limitfrom, $limitnumber);
760         $users = array();
761         foreach ($enrolledusers as $user) {
762             context_helper::preload_from_record($user);
763             if ($userdetails = user_get_user_details($user, $course, $userfields)) {
764                 $users[] = $userdetails;
765             }
766         }
767         $enrolledusers->close();
769         return $users;
770     }
772     /**
773      * Returns description of method result value
774      *
775      * @return external_description
776      */
777     public static function get_enrolled_users_returns() {
778         return new external_multiple_structure(
779             new external_single_structure(
780                 array(
781                     'id'    => new external_value(PARAM_INT, 'ID of the user'),
782                     'username'    => new external_value(PARAM_RAW, 'Username policy is defined in Moodle security config', VALUE_OPTIONAL),
783                     'firstname'   => new external_value(PARAM_NOTAGS, 'The first name(s) of the user', VALUE_OPTIONAL),
784                     'lastname'    => new external_value(PARAM_NOTAGS, 'The family name of the user', VALUE_OPTIONAL),
785                     'fullname'    => new external_value(PARAM_NOTAGS, 'The fullname of the user'),
786                     'email'       => new external_value(PARAM_TEXT, 'An email address - allow email as root@localhost', VALUE_OPTIONAL),
787                     'address'     => new external_value(PARAM_TEXT, 'Postal address', VALUE_OPTIONAL),
788                     'phone1'      => new external_value(PARAM_NOTAGS, 'Phone 1', VALUE_OPTIONAL),
789                     'phone2'      => new external_value(PARAM_NOTAGS, 'Phone 2', VALUE_OPTIONAL),
790                     'icq'         => new external_value(PARAM_NOTAGS, 'icq number', VALUE_OPTIONAL),
791                     'skype'       => new external_value(PARAM_NOTAGS, 'skype id', VALUE_OPTIONAL),
792                     'yahoo'       => new external_value(PARAM_NOTAGS, 'yahoo id', VALUE_OPTIONAL),
793                     'aim'         => new external_value(PARAM_NOTAGS, 'aim id', VALUE_OPTIONAL),
794                     'msn'         => new external_value(PARAM_NOTAGS, 'msn number', VALUE_OPTIONAL),
795                     'department'  => new external_value(PARAM_TEXT, 'department', VALUE_OPTIONAL),
796                     'institution' => new external_value(PARAM_TEXT, 'institution', VALUE_OPTIONAL),
797                     'idnumber'    => new external_value(PARAM_RAW, 'An arbitrary ID code number perhaps from the institution', VALUE_OPTIONAL),
798                     'interests'   => new external_value(PARAM_TEXT, 'user interests (separated by commas)', VALUE_OPTIONAL),
799                     'firstaccess' => new external_value(PARAM_INT, 'first access to the site (0 if never)', VALUE_OPTIONAL),
800                     'lastaccess'  => new external_value(PARAM_INT, 'last access to the site (0 if never)', VALUE_OPTIONAL),
801                     'lastcourseaccess'  => new external_value(PARAM_INT, 'last access to the course (0 if never)', VALUE_OPTIONAL),
802                     'description' => new external_value(PARAM_RAW, 'User profile description', VALUE_OPTIONAL),
803                     'descriptionformat' => new external_format_value('description', VALUE_OPTIONAL),
804                     'city'        => new external_value(PARAM_NOTAGS, 'Home city of the user', VALUE_OPTIONAL),
805                     'url'         => new external_value(PARAM_URL, 'URL of the user', VALUE_OPTIONAL),
806                     'country'     => new external_value(PARAM_ALPHA, 'Home country code of the user, such as AU or CZ', VALUE_OPTIONAL),
807                     'profileimageurlsmall' => new external_value(PARAM_URL, 'User image profile URL - small version', VALUE_OPTIONAL),
808                     'profileimageurl' => new external_value(PARAM_URL, 'User image profile URL - big version', VALUE_OPTIONAL),
809                     'customfields' => new external_multiple_structure(
810                         new external_single_structure(
811                             array(
812                                 'type'  => new external_value(PARAM_ALPHANUMEXT, 'The type of the custom field - text field, checkbox...'),
813                                 'value' => new external_value(PARAM_RAW, 'The value of the custom field'),
814                                 'name' => new external_value(PARAM_RAW, 'The name of the custom field'),
815                                 'shortname' => new external_value(PARAM_RAW, 'The shortname of the custom field - to be able to build the field class in the code'),
816                             )
817                         ), 'User custom fields (also known as user profil fields)', VALUE_OPTIONAL),
818                     'groups' => new external_multiple_structure(
819                         new external_single_structure(
820                             array(
821                                 'id'  => new external_value(PARAM_INT, 'group id'),
822                                 'name' => new external_value(PARAM_RAW, 'group name'),
823                                 'description' => new external_value(PARAM_RAW, 'group description'),
824                                 'descriptionformat' => new external_format_value('description'),
825                             )
826                         ), 'user groups', VALUE_OPTIONAL),
827                     'roles' => new external_multiple_structure(
828                         new external_single_structure(
829                             array(
830                                 'roleid'       => new external_value(PARAM_INT, 'role id'),
831                                 'name'         => new external_value(PARAM_RAW, 'role name'),
832                                 'shortname'    => new external_value(PARAM_ALPHANUMEXT, 'role shortname'),
833                                 'sortorder'    => new external_value(PARAM_INT, 'role sortorder')
834                             )
835                         ), 'user roles', VALUE_OPTIONAL),
836                     'preferences' => new external_multiple_structure(
837                         new external_single_structure(
838                             array(
839                                 'name'  => new external_value(PARAM_RAW, 'The name of the preferences'),
840                                 'value' => new external_value(PARAM_RAW, 'The value of the custom field'),
841                             )
842                     ), 'User preferences', VALUE_OPTIONAL),
843                     'enrolledcourses' => new external_multiple_structure(
844                         new external_single_structure(
845                             array(
846                                 'id'  => new external_value(PARAM_INT, 'Id of the course'),
847                                 'fullname' => new external_value(PARAM_RAW, 'Fullname of the course'),
848                                 'shortname' => new external_value(PARAM_RAW, 'Shortname of the course')
849                             )
850                     ), 'Courses where the user is enrolled - limited by which courses the user is able to see', VALUE_OPTIONAL)
851                 )
852             )
853         );
854     }
856     /**
857      * Returns description of get_course_enrolment_methods() parameters
858      *
859      * @return external_function_parameters
860      */
861     public static function get_course_enrolment_methods_parameters() {
862         return new external_function_parameters(
863             array(
864                 'courseid' => new external_value(PARAM_INT, 'Course id')
865             )
866         );
867     }
869     /**
870      * Get list of active course enrolment methods for current user.
871      *
872      * @param int $courseid
873      * @return array of course enrolment methods
874      * @throws moodle_exception
875      */
876     public static function get_course_enrolment_methods($courseid) {
877         global $DB;
879         $params = self::validate_parameters(self::get_course_enrolment_methods_parameters(), array('courseid' => $courseid));
880         self::validate_context(context_system::instance());
882         $course = $DB->get_record('course', array('id' => $params['courseid']), '*', MUST_EXIST);
883         if (!core_course_category::can_view_course_info($course) && !can_access_course($course)) {
884             throw new moodle_exception('coursehidden');
885         }
887         $result = array();
888         $enrolinstances = enrol_get_instances($params['courseid'], true);
889         foreach ($enrolinstances as $enrolinstance) {
890             if ($enrolplugin = enrol_get_plugin($enrolinstance->enrol)) {
891                 if ($instanceinfo = $enrolplugin->get_enrol_info($enrolinstance)) {
892                     $result[] = (array) $instanceinfo;
893                 }
894             }
895         }
896         return $result;
897     }
899     /**
900      * Returns description of get_course_enrolment_methods() result value
901      *
902      * @return external_description
903      */
904     public static function get_course_enrolment_methods_returns() {
905         return new external_multiple_structure(
906             new external_single_structure(
907                 array(
908                     'id' => new external_value(PARAM_INT, 'id of course enrolment instance'),
909                     'courseid' => new external_value(PARAM_INT, 'id of course'),
910                     'type' => new external_value(PARAM_PLUGIN, 'type of enrolment plugin'),
911                     'name' => new external_value(PARAM_RAW, 'name of enrolment plugin'),
912                     'status' => new external_value(PARAM_RAW, 'status of enrolment plugin'),
913                     'wsfunction' => new external_value(PARAM_ALPHANUMEXT, 'webservice function to get more information', VALUE_OPTIONAL),
914                 )
915             )
916         );
917     }
919     /**
920      * Returns description of edit_user_enrolment() parameters
921      *
922      * @return external_function_parameters
923      */
924     public static function edit_user_enrolment_parameters() {
925         return new external_function_parameters(
926             array(
927                 'courseid' => new external_value(PARAM_INT, 'User enrolment ID'),
928                 'ueid' => new external_value(PARAM_INT, 'User enrolment ID'),
929                 'status' => new external_value(PARAM_INT, 'Enrolment status'),
930                 'timestart' => new external_value(PARAM_INT, 'Enrolment start timestamp', VALUE_DEFAULT, 0),
931                 'timeend' => new external_value(PARAM_INT, 'Enrolment end timestamp', VALUE_DEFAULT, 0),
932             )
933         );
934     }
936     /**
937      * External function that updates a given user enrolment.
938      *
939      * @param int $courseid The course ID.
940      * @param int $ueid The user enrolment ID.
941      * @param int $status The enrolment status.
942      * @param int $timestart Enrolment start timestamp.
943      * @param int $timeend Enrolment end timestamp.
944      * @return array An array consisting of the processing result, errors and form output, if available.
945      */
946     public static function edit_user_enrolment($courseid, $ueid, $status, $timestart = 0, $timeend = 0) {
947         global $CFG, $DB, $PAGE;
949         $params = self::validate_parameters(self::edit_user_enrolment_parameters(), [
950             'courseid' => $courseid,
951             'ueid' => $ueid,
952             'status' => $status,
953             'timestart' => $timestart,
954             'timeend' => $timeend,
955         ]);
957         $course = get_course($courseid);
958         $context = context_course::instance($course->id);
959         self::validate_context($context);
961         $userenrolment = $DB->get_record('user_enrolments', ['id' => $params['ueid']], '*', MUST_EXIST);
962         $userenroldata = [
963             'status' => $params['status'],
964             'timestart' => $params['timestart'],
965             'timeend' => $params['timeend'],
966         ];
968         $result = false;
969         $errors = [];
971         // Validate data against the edit user enrolment form.
972         $instance = $DB->get_record('enrol', ['id' => $userenrolment->enrolid], '*', MUST_EXIST);
973         $plugin = enrol_get_plugin($instance->enrol);
974         require_once("$CFG->dirroot/enrol/editenrolment_form.php");
975         $customformdata = [
976             'ue' => $userenrolment,
977             'modal' => true,
978             'enrolinstancename' => $plugin->get_instance_name($instance)
979         ];
980         $mform = new \enrol_user_enrolment_form(null, $customformdata, 'post', '', null, true, $userenroldata);
981         $mform->set_data($userenroldata);
982         $validationerrors = $mform->validation($userenroldata, null);
983         if (empty($validationerrors)) {
984             require_once($CFG->dirroot . '/enrol/locallib.php');
985             $manager = new course_enrolment_manager($PAGE, $course);
986             $result = $manager->edit_enrolment($userenrolment, (object)$userenroldata);
987         } else {
988             foreach ($validationerrors as $key => $errormessage) {
989                 $errors[] = (object)[
990                     'key' => $key,
991                     'message' => $errormessage
992                 ];
993             }
994         }
996         return [
997             'result' => $result,
998             'errors' => $errors,
999         ];
1000     }
1002     /**
1003      * Returns description of edit_user_enrolment() result value
1004      *
1005      * @return external_description
1006      */
1007     public static function edit_user_enrolment_returns() {
1008         return new external_single_structure(
1009             array(
1010                 'result' => new external_value(PARAM_BOOL, 'True if the user\'s enrolment was successfully updated'),
1011                 'errors' => new external_multiple_structure(
1012                     new external_single_structure(
1013                         array(
1014                             'key' => new external_value(PARAM_TEXT, 'The data that failed the validation'),
1015                             'message' => new external_value(PARAM_TEXT, 'The error message'),
1016                         )
1017                     ), 'List of validation errors'
1018                 ),
1019             )
1020         );
1021     }
1023     /**
1024      * Returns description of unenrol_user_enrolment() parameters
1025      *
1026      * @return external_function_parameters
1027      */
1028     public static function unenrol_user_enrolment_parameters() {
1029         return new external_function_parameters(
1030             array(
1031                 'ueid' => new external_value(PARAM_INT, 'User enrolment ID')
1032             )
1033         );
1034     }
1036     /**
1037      * External function that unenrols a given user enrolment.
1038      *
1039      * @param int $ueid The user enrolment ID.
1040      * @return array An array consisting of the processing result, errors.
1041      */
1042     public static function unenrol_user_enrolment($ueid) {
1043         global $CFG, $DB, $PAGE;
1045         $params = self::validate_parameters(self::unenrol_user_enrolment_parameters(), [
1046             'ueid' => $ueid
1047         ]);
1049         $result = false;
1050         $errors = [];
1052         $userenrolment = $DB->get_record('user_enrolments', ['id' => $params['ueid']], '*');
1053         if ($userenrolment) {
1054             $userid = $userenrolment->userid;
1055             $enrolid = $userenrolment->enrolid;
1056             $enrol = $DB->get_record('enrol', ['id' => $enrolid], '*', MUST_EXIST);
1057             $courseid = $enrol->courseid;
1058             $course = get_course($courseid);
1059             $context = context_course::instance($course->id);
1060             self::validate_context($context);
1061         } else {
1062             $validationerrors['invalidrequest'] = get_string('invalidrequest', 'enrol');
1063         }
1065         // If the userenrolment exists, unenrol the user.
1066         if (!isset($validationerrors)) {
1067             require_once($CFG->dirroot . '/enrol/locallib.php');
1068             $manager = new course_enrolment_manager($PAGE, $course);
1069             $result = $manager->unenrol_user($userenrolment);
1070         } else {
1071             foreach ($validationerrors as $key => $errormessage) {
1072                 $errors[] = (object)[
1073                     'key' => $key,
1074                     'message' => $errormessage
1075                 ];
1076             }
1077         }
1079         return [
1080             'result' => $result,
1081             'errors' => $errors,
1082         ];
1083     }
1085     /**
1086      * Returns description of unenrol_user_enrolment() result value
1087      *
1088      * @return external_description
1089      */
1090     public static function unenrol_user_enrolment_returns() {
1091         return new external_single_structure(
1092             array(
1093                 'result' => new external_value(PARAM_BOOL, 'True if the user\'s enrolment was successfully updated'),
1094                 'errors' => new external_multiple_structure(
1095                     new external_single_structure(
1096                         array(
1097                             'key' => new external_value(PARAM_TEXT, 'The data that failed the validation'),
1098                             'message' => new external_value(PARAM_TEXT, 'The error message'),
1099                         )
1100                     ), 'List of validation errors'
1101                 ),
1102             )
1103         );
1104     }
1107 /**
1108  * Role external functions
1109  *
1110  * @package    core_role
1111  * @category   external
1112  * @copyright  2011 Jerome Mouneyrac
1113  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1114  * @since Moodle 2.2
1115  */
1116 class core_role_external extends external_api {
1118     /**
1119      * Returns description of method parameters
1120      *
1121      * @return external_function_parameters
1122      */
1123     public static function assign_roles_parameters() {
1124         return new external_function_parameters(
1125             array(
1126                 'assignments' => new external_multiple_structure(
1127                     new external_single_structure(
1128                         array(
1129                             'roleid'    => new external_value(PARAM_INT, 'Role to assign to the user'),
1130                             'userid'    => new external_value(PARAM_INT, 'The user that is going to be assigned'),
1131                             'contextid' => new external_value(PARAM_INT, 'The context to assign the user role in', VALUE_OPTIONAL),
1132                             'contextlevel' => new external_value(PARAM_ALPHA, 'The context level to assign the user role in
1133                                     (block, course, coursecat, system, user, module)', VALUE_OPTIONAL),
1134                             'instanceid' => new external_value(PARAM_INT, 'The Instance id of item where the role needs to be assigned', VALUE_OPTIONAL),
1135                         )
1136                     )
1137                 )
1138             )
1139         );
1140     }
1142     /**
1143      * Manual role assignments to users
1144      *
1145      * @param array $assignments An array of manual role assignment
1146      */
1147     public static function assign_roles($assignments) {
1148         global $DB;
1150         // Do basic automatic PARAM checks on incoming data, using params description
1151         // If any problems are found then exceptions are thrown with helpful error messages
1152         $params = self::validate_parameters(self::assign_roles_parameters(), array('assignments'=>$assignments));
1154         $transaction = $DB->start_delegated_transaction();
1156         foreach ($params['assignments'] as $assignment) {
1157             // Ensure correct context level with a instance id or contextid is passed.
1158             $context = self::get_context_from_params($assignment);
1160             // Ensure the current user is allowed to run this function in the enrolment context.
1161             self::validate_context($context);
1162             require_capability('moodle/role:assign', $context);
1164             // throw an exception if user is not able to assign the role in this context
1165             $roles = get_assignable_roles($context, ROLENAME_SHORT);
1167             if (!array_key_exists($assignment['roleid'], $roles)) {
1168                 throw new invalid_parameter_exception('Can not assign roleid='.$assignment['roleid'].' in contextid='.$assignment['contextid']);
1169             }
1171             role_assign($assignment['roleid'], $assignment['userid'], $context->id);
1172         }
1174         $transaction->allow_commit();
1175     }
1177     /**
1178      * Returns description of method result value
1179      *
1180      * @return null
1181      */
1182     public static function assign_roles_returns() {
1183         return null;
1184     }
1187     /**
1188      * Returns description of method parameters
1189      *
1190      * @return external_function_parameters
1191      */
1192     public static function unassign_roles_parameters() {
1193         return new external_function_parameters(
1194             array(
1195                 'unassignments' => new external_multiple_structure(
1196                     new external_single_structure(
1197                         array(
1198                             'roleid'    => new external_value(PARAM_INT, 'Role to assign to the user'),
1199                             'userid'    => new external_value(PARAM_INT, 'The user that is going to be assigned'),
1200                             'contextid' => new external_value(PARAM_INT, 'The context to unassign the user role from', VALUE_OPTIONAL),
1201                             'contextlevel' => new external_value(PARAM_ALPHA, 'The context level to unassign the user role in
1202 +                                    (block, course, coursecat, system, user, module)', VALUE_OPTIONAL),
1203                             'instanceid' => new external_value(PARAM_INT, 'The Instance id of item where the role needs to be unassigned', VALUE_OPTIONAL),
1204                         )
1205                     )
1206                 )
1207             )
1208         );
1209     }
1211      /**
1212      * Unassign roles from users
1213      *
1214      * @param array $unassignments An array of unassignment
1215      */
1216     public static function unassign_roles($unassignments) {
1217          global $DB;
1219         // Do basic automatic PARAM checks on incoming data, using params description
1220         // If any problems are found then exceptions are thrown with helpful error messages
1221         $params = self::validate_parameters(self::unassign_roles_parameters(), array('unassignments'=>$unassignments));
1223         $transaction = $DB->start_delegated_transaction();
1225         foreach ($params['unassignments'] as $unassignment) {
1226             // Ensure the current user is allowed to run this function in the unassignment context
1227             $context = self::get_context_from_params($unassignment);
1228             self::validate_context($context);
1229             require_capability('moodle/role:assign', $context);
1231             // throw an exception if user is not able to unassign the role in this context
1232             $roles = get_assignable_roles($context, ROLENAME_SHORT);
1233             if (!array_key_exists($unassignment['roleid'], $roles)) {
1234                 throw new invalid_parameter_exception('Can not unassign roleid='.$unassignment['roleid'].' in contextid='.$unassignment['contextid']);
1235             }
1237             role_unassign($unassignment['roleid'], $unassignment['userid'], $context->id);
1238         }
1240         $transaction->allow_commit();
1241     }
1243    /**
1244      * Returns description of method result value
1245      *
1246      * @return null
1247      */
1248     public static function unassign_roles_returns() {
1249         return null;
1250     }