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/>.
  16
  17
  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  */
  29
  30 defined('MOODLE_INTERNAL') || die();
  31
  32 require_once("$CFG->libdir/externallib.php");
  33
  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 {
  44
  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     }
  78
  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;
  89         require_once($CFG->dirroot . "/user/lib.php");
  90
  91         if (empty($coursecapabilities)) {
  92             throw new invalid_parameter_exception('Parameter can not be empty');
  93         }
  94         $params = self::validate_parameters(self::get_enrolled_users_with_capability_parameters(),
  95             array ('coursecapabilities' => $coursecapabilities,  'options'=>$options));
  96         $result = array();
  97         $userlist = array();
  98         $groupid        = 0;
  99         $onlyactive     = false;
 100         $userfields     = array();
 101         $limitfrom = 0;
 102         $limitnumber = 0;
 103         foreach ($params['options'] as $option) {
 104             switch ($option['name']) {
 105                 case 'groupid':
 106                     $groupid = (int)$option['value'];
 107                     break;
 108                 case 'onlyactive':
 109                     $onlyactive = !empty($option['value']);
 110                     break;
 111                 case 'userfields':
 112                     $thefields = explode(',', $option['value']);
 113                     foreach ($thefields as $f) {
 114                         $userfields[] = clean_param($f, PARAM_ALPHANUMEXT);
 115                     }
 116                     break;
 117                 case 'limitfrom' :
 118                     $limitfrom = clean_param($option['value'], PARAM_INT);
 119                     break;
 120                 case 'limitnumber' :
 121                     $limitnumber = clean_param($option['value'], PARAM_INT);
 122                     break;
 123             }
 124         }
 125
 126         foreach ($params['coursecapabilities'] as $coursecapability) {
 127             $courseid = $coursecapability['courseid'];
 128             $course = $DB->get_record('course', array('id'=>$courseid), '*', MUST_EXIST);
 129             $coursecontext = context_course::instance($courseid);
 130             if (!$coursecontext) {
 131                 throw new moodle_exception('cannotfindcourse', 'error', '', null,
 132                         'The course id ' . $courseid . ' doesn\'t exist.');
 133             }
 134             if ($courseid == SITEID) {
 135                 $context = context_system::instance();
 136             } else {
 137                 $context = $coursecontext;
 138             }
 139             try {
 140                 self::validate_context($context);
 141             } catch (Exception $e) {
 142                 $exceptionparam = new stdClass();
 143                 $exceptionparam->message = $e->getMessage();
 144                 $exceptionparam->courseid = $params['courseid'];
 145                 throw new moodle_exception(get_string('errorcoursecontextnotvalid' , 'webservice', $exceptionparam));
 146             }
 147
 148             if ($courseid == SITEID) {
 149                 require_capability('moodle/site:viewparticipants', $context);
 150             } else {
 151                 require_capability('moodle/course:viewparticipants', $context);
 152             }
 153             // The accessallgroups capability is needed to use this option.
 154             if (!empty($groupid) && groups_is_member($groupid)) {
 155                 require_capability('moodle/site:accessallgroups', $coursecontext);
 156             }
 157             // The course:enrolereview capability is needed to use this option.
 158             if ($onlyactive) {
 159                 require_capability('moodle/course:enrolreview', $coursecontext);
 160             }
 161
 162             // To see the permissions of others role:review capability is required.
 163             require_capability('moodle/role:review', $coursecontext);
 164             foreach ($coursecapability['capabilities'] as $capability) {
 165                 $courseusers['courseid'] = $courseid;
 166                 $courseusers['capability'] = $capability;
 167
 168                 list($enrolledsql, $enrolledparams) = get_enrolled_sql($coursecontext, $capability, $groupid, $onlyactive);
 169
 170                 $sql = "SELECT u.* FROM {user} u WHERE u.id IN ($enrolledsql) ORDER BY u.id ASC";
 171
 172                 $enrolledusers = $DB->get_recordset_sql($sql, $enrolledparams, $limitfrom, $limitnumber);
 173                 $users = array();
 174                 foreach ($enrolledusers as $courseuser) {
 175                     if ($userdetails = user_get_user_details($courseuser, $course, $userfields)) {
 176                         $users[] = $userdetails;
 177                     }
 178                 }
 179                 $enrolledusers->close();
 180                 $courseusers['users'] = $users;
 181                 $result[] = $courseusers;
 182             }
 183         }
 184         return $result;
 185     }
 186
 187     /**
 188      * Returns description of method result value
 189      *
 190      * @return external_multiple_structure
 191      * @since Moodle 2.4
 192      */
 193     public static function get_enrolled_users_with_capability_returns() {
 194         return  new external_multiple_structure( new external_single_structure (
 195                 array (
 196                     'courseid' => new external_value(PARAM_INT, 'Course ID number in the Moodle course table'),
 197                     'capability' => new external_value(PARAM_CAPABILITY, 'Capability name'),
 198                     'users' => new external_multiple_structure(
 199                         new external_single_structure(
 200                 array(
 201                     'id'    => new external_value(PARAM_INT, 'ID of the user'),
 202                     'username'    => new external_value(PARAM_RAW, 'Username', VALUE_OPTIONAL),
 203                     'firstname'   => new external_value(PARAM_NOTAGS, 'The first name(s) of the user', VALUE_OPTIONAL),
 204                     'lastname'    => new external_value(PARAM_NOTAGS, 'The family name of the user', VALUE_OPTIONAL),
 205                     'fullname'    => new external_value(PARAM_NOTAGS, 'The fullname of the user'),
 206                     'email'       => new external_value(PARAM_TEXT, 'Email address', VALUE_OPTIONAL),
 207                     'address'     => new external_value(PARAM_MULTILANG, 'Postal address', VALUE_OPTIONAL),
 208                     'phone1'      => new external_value(PARAM_NOTAGS, 'Phone 1', VALUE_OPTIONAL),
 209                     'phone2'      => new external_value(PARAM_NOTAGS, 'Phone 2', VALUE_OPTIONAL),
 210                     'icq'         => new external_value(PARAM_NOTAGS, 'icq number', VALUE_OPTIONAL),
 211                     'skype'       => new external_value(PARAM_NOTAGS, 'skype id', VALUE_OPTIONAL),
 212                     'yahoo'       => new external_value(PARAM_NOTAGS, 'yahoo id', VALUE_OPTIONAL),
 213                     'aim'         => new external_value(PARAM_NOTAGS, 'aim id', VALUE_OPTIONAL),
 214                     'msn'         => new external_value(PARAM_NOTAGS, 'msn number', VALUE_OPTIONAL),
 215                     'department'  => new external_value(PARAM_TEXT, 'department', VALUE_OPTIONAL),
 216                     'institution' => new external_value(PARAM_TEXT, 'institution', VALUE_OPTIONAL),
 217                     'interests'   => new external_value(PARAM_TEXT, 'user interests (separated by commas)', VALUE_OPTIONAL),
 218                     'firstaccess' => new external_value(PARAM_INT, 'first access to the site (0 if never)', VALUE_OPTIONAL),
 219                     'lastaccess'  => new external_value(PARAM_INT, 'last access to the site (0 if never)', VALUE_OPTIONAL),
 220                     'description' => new external_value(PARAM_RAW, 'User profile description', VALUE_OPTIONAL),
 221                     'descriptionformat' => new external_value(PARAM_INT, 'User profile description format', VALUE_OPTIONAL),
 222                     'city'        => new external_value(PARAM_NOTAGS, 'Home city of the user', VALUE_OPTIONAL),
 223                     'url'         => new external_value(PARAM_URL, 'URL of the user', VALUE_OPTIONAL),
 224                     'country'     => new external_value(PARAM_ALPHA, 'Country code of the user, such as AU or CZ', VALUE_OPTIONAL),
 225                     'profileimageurlsmall' => new external_value(PARAM_URL, 'User image profile URL - small', VALUE_OPTIONAL),
 226                     'profileimageurl' => new external_value(PARAM_URL, 'User image profile URL - big', VALUE_OPTIONAL),
 227                     'customfields' => new external_multiple_structure(
 228                         new external_single_structure(
 229                             array(
 230                                 'type'  => new external_value(PARAM_ALPHANUMEXT, 'The type of the custom field'),
 231                                 'value' => new external_value(PARAM_RAW, 'The value of the custom field'),
 232                                 'name' => new external_value(PARAM_RAW, 'The name of the custom field'),
 233                                 'shortname' => new external_value(PARAM_RAW, 'The shortname of the custom field'),
 234                             )
 235                         ), 'User custom fields (also known as user profil fields)', VALUE_OPTIONAL),
 236                     'groups' => new external_multiple_structure(
 237                         new external_single_structure(
 238                             array(
 239                                 'id'  => new external_value(PARAM_INT, 'group id'),
 240                                 'name' => new external_value(PARAM_RAW, 'group name'),
 241                                 'description' => new external_value(PARAM_RAW, 'group description'),
 242                             )
 243                         ), 'user groups', VALUE_OPTIONAL),
 244                     'roles' => new external_multiple_structure(
 245                         new external_single_structure(
 246                             array(
 247                                 'roleid'       => new external_value(PARAM_INT, 'role id'),
 248                                 'name'         => new external_value(PARAM_RAW, 'role name'),
 249                                 'shortname'    => new external_value(PARAM_ALPHANUMEXT, 'role shortname'),
 250                                 'sortorder'    => new external_value(PARAM_INT, 'role sortorder')
 251                             )
 252                         ), 'user roles', VALUE_OPTIONAL),
 253                     'preferences' => new external_multiple_structure(
 254                         new external_single_structure(
 255                             array(
 256                                 'name'  => new external_value(PARAM_ALPHANUMEXT, 'The name of the preferences'),
 257                                 'value' => new external_value(PARAM_RAW, 'The value of the custom field'),
 258                             )
 259                     ), 'User preferences', VALUE_OPTIONAL),
 260                     'enrolledcourses' => new external_multiple_structure(
 261                         new external_single_structure(
 262                             array(
 263                                 'id'  => new external_value(PARAM_INT, 'Id of the course'),
 264                                 'fullname' => new external_value(PARAM_RAW, 'Fullname of the course'),
 265                                 'shortname' => new external_value(PARAM_RAW, 'Shortname of the course')
 266                             )
 267                     ), 'Courses where the user is enrolled - limited by which courses the user is able to see', VALUE_OPTIONAL)
 268                 )
 269                         ), 'List of users that are enrolled in the course and have the specified capability'),
 270                     )
 271                 )
 272             );
 273     }
 274
 275     /**
 276      * Returns description of method parameters
 277      *
 278      * @return external_function_parameters
 279      */
 280     public static function get_users_courses_parameters() {
 281         return new external_function_parameters(
 282             array(
 283                 'userid' => new external_value(PARAM_INT, 'user id'),
 284             )
 285         );
 286     }
 287
 288     /**
 289      * Get list of courses user is enrolled in (only active enrolments are returned).
 290      * Please note the current user must be able to access the course, otherwise the course is not included.
 291      *
 292      * @param int $userid
 293      * @return array of courses
 294      */
 295     public static function get_users_courses($userid) {
 296         global $USER, $DB;
 297
 298         // Do basic automatic PARAM checks on incoming data, using params description
 299         // If any problems are found then exceptions are thrown with helpful error messages
 300         $params = self::validate_parameters(self::get_users_courses_parameters(), array('userid'=>$userid));
 301
 302         $courses = enrol_get_users_courses($params['userid'], true, 'id, shortname, fullname, idnumber, visible,
 303                    summary, summaryformat, format, showgrades, lang, enablecompletion');
 304         $result = array();
 305
 306         foreach ($courses as $course) {
 307             $context = context_course::instance($course->id, IGNORE_MISSING);
 308             try {
 309                 self::validate_context($context);
 310             } catch (Exception $e) {
 311                 // current user can not access this course, sorry we can not disclose who is enrolled in this course!
 312                 continue;
 313             }
 314
 315             if ($userid != $USER->id and !has_capability('moodle/course:viewparticipants', $context)) {
 316                 // we need capability to view participants
 317                 continue;
 318             }
 319
 320             list($enrolledsqlselect, $enrolledparams) = get_enrolled_sql($context);
 321             $enrolledsql = "SELECT COUNT('x') FROM ($enrolledsqlselect) enrolleduserids";
 322             $enrolledusercount = $DB->count_records_sql($enrolledsql, $enrolledparams);
 323
 324             list($course->summary, $course->summaryformat) =
 325                 external_format_text($course->summary, $course->summaryformat, $context->id, 'course', 'summary', null);
 326
 327             $result[] = array('id' => $course->id, 'shortname' => $course->shortname, 'fullname' => $course->fullname,
 328                 'idnumber' => $course->idnumber, 'visible' => $course->visible, 'enrolledusercount' => $enrolledusercount,
 329                 'summary' => $course->summary, 'summaryformat' => $course->summaryformat, 'format' => $course->format,
 330                 'showgrades' => $course->showgrades, 'lang' => $course->lang, 'enablecompletion' => $course->enablecompletion
 331                 );
 332         }
 333
 334         return $result;
 335     }
 336
 337     /**
 338      * Returns description of method result value
 339      *
 340      * @return external_description
 341      */
 342     public static function get_users_courses_returns() {
 343         return new external_multiple_structure(
 344             new external_single_structure(
 345                 array(
 346                     'id'        => new external_value(PARAM_INT, 'id of course'),
 347                     'shortname' => new external_value(PARAM_RAW, 'short name of course'),
 348                     'fullname'  => new external_value(PARAM_RAW, 'long name of course'),
 349                     'enrolledusercount' => new external_value(PARAM_INT, 'Number of enrolled users in this course'),
 350                     'idnumber'  => new external_value(PARAM_RAW, 'id number of course'),
 351                     'visible'   => new external_value(PARAM_INT, '1 means visible, 0 means hidden course'),
 352                     'summary'   => new external_value(PARAM_RAW, 'summary', VALUE_OPTIONAL),
 353                     'summaryformat' => new external_format_value('summary', VALUE_OPTIONAL),
 354                     'format'    => new external_value(PARAM_PLUGIN, 'course format: weeks, topics, social, site', VALUE_OPTIONAL),
 355                     'showgrades' => new external_value(PARAM_BOOL, 'true if grades are shown, otherwise false', VALUE_OPTIONAL),
 356                     'lang'      => new external_value(PARAM_LANG, 'forced course language', VALUE_OPTIONAL),
 357                     'enablecompletion' => new external_value(PARAM_BOOL, 'true if completion is enabled, otherwise false',
 358                                                                 VALUE_OPTIONAL)
 359                 )
 360             )
 361         );
 362     }
 363
 364     /**
 365      * Returns description of method parameters
 366      *
 367      * @return external_function_parameters
 368      */
 369     public static function get_enrolled_users_parameters() {
 370         return new external_function_parameters(
 371             array(
 372                 'courseid' => new external_value(PARAM_INT, 'course id'),
 373                 'options'  => new external_multiple_structure(
 374                     new external_single_structure(
 375                         array(
 376                             'name'  => new external_value(PARAM_ALPHANUMEXT, 'option name'),
 377                             'value' => new external_value(PARAM_RAW, 'option value')
 378                         )
 379                     ), 'Option names:
 380                             * withcapability (string) return only users with this capability. This option requires \'moodle/role:review\' on the course context.
 381                             * groupid (integer) return only users in this group id. If the course has groups enabled and this param
 382                                                 isn\'t defined, returns all the viewable users.
 383                                                 This option requires \'moodle/site:accessallgroups\' on the course context if the
 384                                                 user doesn\'t belong to the group.
 385                             * onlyactive (integer) return only users with active enrolments and matching time restrictions. This option requires \'moodle/course:enrolreview\' on the course context.
 386                             * userfields (\'string, string, ...\') return only the values of these user fields.
 387                             * limitfrom (integer) sql limit from.
 388                             * limitnumber (integer) maximum number of returned users.
 389                             * sortby (string) sort by id, firstname or lastname. For ordering like the site does, use siteorder.
 390                             * sortdirection (string) ASC or DESC',
 391                             VALUE_DEFAULT, array()),
 392             )
 393         );
 394     }
 395
 396     /**
 397      * Get course participants details
 398      *
 399      * @param int $courseid  course id
 400      * @param array $options options {
 401      *                                'name' => option name
 402      *                                'value' => option value
 403      *                               }
 404      * @return array An array of users
 405      */
 406     public static function get_enrolled_users($courseid, $options = array()) {
 407         global $CFG, $USER, $DB;
 408         require_once($CFG->dirroot . "/user/lib.php");
 409
 410         $params = self::validate_parameters(
 411             self::get_enrolled_users_parameters(),
 412             array(
 413                 'courseid'=>$courseid,
 414                 'options'=>$options
 415             )
 416         );
 417         $withcapability = '';
 418         $groupid        = 0;
 419         $onlyactive     = false;
 420         $userfields     = array();
 421         $limitfrom = 0;
 422         $limitnumber = 0;
 423         $sortby = 'us.id';
 424         $sortparams = array();
 425         $sortdirection = 'ASC';
 426         foreach ($options as $option) {
 427             switch ($option['name']) {
 428             case 'withcapability':
 429                 $withcapability = $option['value'];
 430                 break;
 431             case 'groupid':
 432                 $groupid = (int)$option['value'];
 433                 break;
 434             case 'onlyactive':
 435                 $onlyactive = !empty($option['value']);
 436                 break;
 437             case 'userfields':
 438                 $thefields = explode(',', $option['value']);
 439                 foreach ($thefields as $f) {
 440                     $userfields[] = clean_param($f, PARAM_ALPHANUMEXT);
 441                 }
 442                 break;
 443             case 'limitfrom' :
 444                 $limitfrom = clean_param($option['value'], PARAM_INT);
 445                 break;
 446             case 'limitnumber' :
 447                 $limitnumber = clean_param($option['value'], PARAM_INT);
 448                 break;
 449             case 'sortby':
 450                 $sortallowedvalues = array('id', 'firstname', 'lastname', 'siteorder');
 451                 if (!in_array($option['value'], $sortallowedvalues)) {
 452                     throw new invalid_parameter_exception('Invalid value for sortby parameter (value: ' . $option['value'] . '),' .
 453                         'allowed values are: ' . implode(',', $sortallowedvalues));
 454                 }
 455                 if ($option['value'] == 'siteorder') {
 456                     list($sortby, $sortparams) = users_order_by_sql('us');
 457                 } else {
 458                     $sortby = 'us.' . $option['value'];
 459                 }
 460                 break;
 461             case 'sortdirection':
 462                 $sortdirection = strtoupper($option['value']);
 463                 $directionallowedvalues = array('ASC', 'DESC');
 464                 if (!in_array($sortdirection, $directionallowedvalues)) {
 465                     throw new invalid_parameter_exception('Invalid value for sortdirection parameter
 466                         (value: ' . $sortdirection . '),' . 'allowed values are: ' . implode(',', $directionallowedvalues));
 467                 }
 468                 break;
 469             }
 470         }
 471
 472         $course = $DB->get_record('course', array('id'=>$courseid), '*', MUST_EXIST);
 473         $coursecontext = context_course::instance($courseid, IGNORE_MISSING);
 474         if ($courseid == SITEID) {
 475             $context = context_system::instance();
 476         } else {
 477             $context = $coursecontext;
 478         }
 479         try {
 480             self::validate_context($context);
 481         } catch (Exception $e) {
 482             $exceptionparam = new stdClass();
 483             $exceptionparam->message = $e->getMessage();
 484             $exceptionparam->courseid = $params['courseid'];
 485             throw new moodle_exception('errorcoursecontextnotvalid' , 'webservice', '', $exceptionparam);
 486         }
 487
 488         if ($courseid == SITEID) {
 489             require_capability('moodle/site:viewparticipants', $context);
 490         } else {
 491             require_capability('moodle/course:viewparticipants', $context);
 492         }
 493         // to overwrite this parameter, you need role:review capability
 494         if ($withcapability) {
 495             require_capability('moodle/role:review', $coursecontext);
 496         }
 497         // need accessallgroups capability if you want to overwrite this option
 498         if (!empty($groupid) && !groups_is_member($groupid)) {
 499             require_capability('moodle/site:accessallgroups', $coursecontext);
 500         }
 501         // to overwrite this option, you need course:enrolereview permission
 502         if ($onlyactive) {
 503             require_capability('moodle/course:enrolreview', $coursecontext);
 504         }
 505
 506         list($enrolledsql, $enrolledparams) = get_enrolled_sql($coursecontext, $withcapability, $groupid, $onlyactive);
 507         $ctxselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
 508         $ctxjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = u.id AND ctx.contextlevel = :contextlevel)";
 509         $enrolledparams['contextlevel'] = CONTEXT_USER;
 510
 511         $groupjoin = '';
 512         if (empty($groupid) && groups_get_course_groupmode($course) == SEPARATEGROUPS &&
 513                 !has_capability('moodle/site:accessallgroups', $coursecontext)) {
 514             // Filter by groups the user can view.
 515             $usergroups = groups_get_user_groups($course->id);
 516             if (!empty($usergroups['0'])) {
 517                 list($groupsql, $groupparams) = $DB->get_in_or_equal($usergroups['0'], SQL_PARAMS_NAMED);
 518                 $groupjoin = "JOIN {groups_members} gm ON (u.id = gm.userid AND gm.groupid $groupsql)";
 519                 $enrolledparams = array_merge($enrolledparams, $groupparams);
 520             } else {
 521                 // User doesn't belong to any group, so he can't see any user. Return an empty array.
 522                 return array();
 523             }
 524         }
 525         $sql = "SELECT us.*
 526                   FROM {user} us
 527                   JOIN (
 528                       SELECT DISTINCT u.id $ctxselect
 529                         FROM {user} u $ctxjoin $groupjoin
 530                        WHERE u.id IN ($enrolledsql)
 531                   ) q ON q.id = us.id
 532                 ORDER BY $sortby $sortdirection";
 533         $enrolledparams = array_merge($enrolledparams, $sortparams);
 534         $enrolledusers = $DB->get_recordset_sql($sql, $enrolledparams, $limitfrom, $limitnumber);
 535         $users = array();
 536         foreach ($enrolledusers as $user) {
 537             context_helper::preload_from_record($user);
 538             if ($userdetails = user_get_user_details($user, $course, $userfields)) {
 539                 $users[] = $userdetails;
 540             }
 541         }
 542         $enrolledusers->close();
 543
 544         return $users;
 545     }
 546
 547     /**
 548      * Returns description of method result value
 549      *
 550      * @return external_description
 551      */
 552     public static function get_enrolled_users_returns() {
 553         return new external_multiple_structure(
 554             new external_single_structure(
 555                 array(
 556                     'id'    => new external_value(PARAM_INT, 'ID of the user'),
 557                     'username'    => new external_value(PARAM_RAW, 'Username policy is defined in Moodle security config', VALUE_OPTIONAL),
 558                     'firstname'   => new external_value(PARAM_NOTAGS, 'The first name(s) of the user', VALUE_OPTIONAL),
 559                     'lastname'    => new external_value(PARAM_NOTAGS, 'The family name of the user', VALUE_OPTIONAL),
 560                     'fullname'    => new external_value(PARAM_NOTAGS, 'The fullname of the user'),
 561                     'email'       => new external_value(PARAM_TEXT, 'An email address - allow email as root@localhost', VALUE_OPTIONAL),
 562                     'address'     => new external_value(PARAM_TEXT, 'Postal address', VALUE_OPTIONAL),
 563                     'phone1'      => new external_value(PARAM_NOTAGS, 'Phone 1', VALUE_OPTIONAL),
 564                     'phone2'      => new external_value(PARAM_NOTAGS, 'Phone 2', VALUE_OPTIONAL),
 565                     'icq'         => new external_value(PARAM_NOTAGS, 'icq number', VALUE_OPTIONAL),
 566                     'skype'       => new external_value(PARAM_NOTAGS, 'skype id', VALUE_OPTIONAL),
 567                     'yahoo'       => new external_value(PARAM_NOTAGS, 'yahoo id', VALUE_OPTIONAL),
 568                     'aim'         => new external_value(PARAM_NOTAGS, 'aim id', VALUE_OPTIONAL),
 569                     'msn'         => new external_value(PARAM_NOTAGS, 'msn number', VALUE_OPTIONAL),
 570                     'department'  => new external_value(PARAM_TEXT, 'department', VALUE_OPTIONAL),
 571                     'institution' => new external_value(PARAM_TEXT, 'institution', VALUE_OPTIONAL),
 572                     'idnumber'    => new external_value(PARAM_RAW, 'An arbitrary ID code number perhaps from the institution', VALUE_OPTIONAL),
 573                     'interests'   => new external_value(PARAM_TEXT, 'user interests (separated by commas)', VALUE_OPTIONAL),
 574                     'firstaccess' => new external_value(PARAM_INT, 'first access to the site (0 if never)', VALUE_OPTIONAL),
 575                     'lastaccess'  => new external_value(PARAM_INT, 'last access to the site (0 if never)', VALUE_OPTIONAL),
 576                     'description' => new external_value(PARAM_RAW, 'User profile description', VALUE_OPTIONAL),
 577                     'descriptionformat' => new external_format_value('description', VALUE_OPTIONAL),
 578                     'city'        => new external_value(PARAM_NOTAGS, 'Home city of the user', VALUE_OPTIONAL),
 579                     'url'         => new external_value(PARAM_URL, 'URL of the user', VALUE_OPTIONAL),
 580                     'country'     => new external_value(PARAM_ALPHA, 'Home country code of the user, such as AU or CZ', VALUE_OPTIONAL),
 581                     'profileimageurlsmall' => new external_value(PARAM_URL, 'User image profile URL - small version', VALUE_OPTIONAL),
 582                     'profileimageurl' => new external_value(PARAM_URL, 'User image profile URL - big version', VALUE_OPTIONAL),
 583                     'customfields' => new external_multiple_structure(
 584                         new external_single_structure(
 585                             array(
 586                                 'type'  => new external_value(PARAM_ALPHANUMEXT, 'The type of the custom field - text field, checkbox...'),
 587                                 'value' => new external_value(PARAM_RAW, 'The value of the custom field'),
 588                                 'name' => new external_value(PARAM_RAW, 'The name of the custom field'),
 589                                 'shortname' => new external_value(PARAM_RAW, 'The shortname of the custom field - to be able to build the field class in the code'),
 590                             )
 591                         ), 'User custom fields (also known as user profil fields)', VALUE_OPTIONAL),
 592                     'groups' => new external_multiple_structure(
 593                         new external_single_structure(
 594                             array(
 595                                 'id'  => new external_value(PARAM_INT, 'group id'),
 596                                 'name' => new external_value(PARAM_RAW, 'group name'),
 597                                 'description' => new external_value(PARAM_RAW, 'group description'),
 598                                 'descriptionformat' => new external_format_value('description'),
 599                             )
 600                         ), 'user groups', VALUE_OPTIONAL),
 601                     'roles' => new external_multiple_structure(
 602                         new external_single_structure(
 603                             array(
 604                                 'roleid'       => new external_value(PARAM_INT, 'role id'),
 605                                 'name'         => new external_value(PARAM_RAW, 'role name'),
 606                                 'shortname'    => new external_value(PARAM_ALPHANUMEXT, 'role shortname'),
 607                                 'sortorder'    => new external_value(PARAM_INT, 'role sortorder')
 608                             )
 609                         ), 'user roles', VALUE_OPTIONAL),
 610                     'preferences' => new external_multiple_structure(
 611                         new external_single_structure(
 612                             array(
 613                                 'name'  => new external_value(PARAM_ALPHANUMEXT, 'The name of the preferences'),
 614                                 'value' => new external_value(PARAM_RAW, 'The value of the custom field'),
 615                             )
 616                     ), 'User preferences', VALUE_OPTIONAL),
 617                     'enrolledcourses' => new external_multiple_structure(
 618                         new external_single_structure(
 619                             array(
 620                                 'id'  => new external_value(PARAM_INT, 'Id of the course'),
 621                                 'fullname' => new external_value(PARAM_RAW, 'Fullname of the course'),
 622                                 'shortname' => new external_value(PARAM_RAW, 'Shortname of the course')
 623                             )
 624                     ), 'Courses where the user is enrolled - limited by which courses the user is able to see', VALUE_OPTIONAL)
 625                 )
 626             )
 627         );
 628     }
 629
 630     /**
 631      * Returns description of get_course_enrolment_methods() parameters
 632      *
 633      * @return external_function_parameters
 634      */
 635     public static function get_course_enrolment_methods_parameters() {
 636         return new external_function_parameters(
 637             array(
 638                 'courseid' => new external_value(PARAM_INT, 'Course id')
 639             )
 640         );
 641     }
 642
 643     /**
 644      * Get list of active course enrolment methods for current user.
 645      *
 646      * @param int $courseid
 647      * @return array of course enrolment methods
 648      * @throws moodle_exception
 649      */
 650     public static function get_course_enrolment_methods($courseid) {
 651         global $DB;
 652
 653         $params = self::validate_parameters(self::get_course_enrolment_methods_parameters(), array('courseid' => $courseid));
 654         self::validate_context(context_system::instance());
 655
 656         $course = $DB->get_record('course', array('id' => $params['courseid']), '*', MUST_EXIST);
 657         $context = context_course::instance($course->id);
 658         if (!$course->visible and !has_capability('moodle/course:viewhiddencourses', $context)) {
 659             throw new moodle_exception('coursehidden');
 660         }
 661
 662         $result = array();
 663         $enrolinstances = enrol_get_instances($params['courseid'], true);
 664         foreach ($enrolinstances as $enrolinstance) {
 665             if ($enrolplugin = enrol_get_plugin($enrolinstance->enrol)) {
 666                 if ($instanceinfo = $enrolplugin->get_enrol_info($enrolinstance)) {
 667                     $result[] = (array) $instanceinfo;
 668                 }
 669             }
 670         }
 671         return $result;
 672     }
 673
 674     /**
 675      * Returns description of get_course_enrolment_methods() result value
 676      *
 677      * @return external_description
 678      */
 679     public static function get_course_enrolment_methods_returns() {
 680         return new external_multiple_structure(
 681             new external_single_structure(
 682                 array(
 683                     'id' => new external_value(PARAM_INT, 'id of course enrolment instance'),
 684                     'courseid' => new external_value(PARAM_INT, 'id of course'),
 685                     'type' => new external_value(PARAM_PLUGIN, 'type of enrolment plugin'),
 686                     'name' => new external_value(PARAM_RAW, 'name of enrolment plugin'),
 687                     'status' => new external_value(PARAM_RAW, 'status of enrolment plugin'),
 688                     'wsfunction' => new external_value(PARAM_ALPHANUMEXT, 'webservice function to get more information', VALUE_OPTIONAL),
 689                 )
 690             )
 691         );
 692     }
 693 }
 694
 695 /**
 696  * Role external functions
 697  *
 698  * @package    core_role
 699  * @category   external
 700  * @copyright  2011 Jerome Mouneyrac
 701  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 702  * @since Moodle 2.2
 703  */
 704 class core_role_external extends external_api {
 705
 706     /**
 707      * Returns description of method parameters
 708      *
 709      * @return external_function_parameters
 710      */
 711     public static function assign_roles_parameters() {
 712         return new external_function_parameters(
 713             array(
 714                 'assignments' => new external_multiple_structure(
 715                     new external_single_structure(
 716                         array(
 717                             'roleid'    => new external_value(PARAM_INT, 'Role to assign to the user'),
 718                             'userid'    => new external_value(PARAM_INT, 'The user that is going to be assigned'),
 719                             'contextid' => new external_value(PARAM_INT, 'The context to assign the user role in', VALUE_OPTIONAL),
 720                             'contextlevel' => new external_value(PARAM_ALPHA, 'The context level to assign the user role in
 721                                     (block, course, coursecat, system, user, module)', VALUE_OPTIONAL),
 722                             'instanceid' => new external_value(PARAM_INT, 'The Instance id of item where the role needs to be assigned', VALUE_OPTIONAL),
 723                         )
 724                     )
 725                 )
 726             )
 727         );
 728     }
 729
 730     /**
 731      * Manual role assignments to users
 732      *
 733      * @param array $assignments An array of manual role assignment
 734      */
 735     public static function assign_roles($assignments) {
 736         global $DB;
 737
 738         // Do basic automatic PARAM checks on incoming data, using params description
 739         // If any problems are found then exceptions are thrown with helpful error messages
 740         $params = self::validate_parameters(self::assign_roles_parameters(), array('assignments'=>$assignments));
 741
 742         $transaction = $DB->start_delegated_transaction();
 743
 744         foreach ($params['assignments'] as $assignment) {
 745             // Ensure correct context level with a instance id or contextid is passed.
 746             $context = self::get_context_from_params($assignment);
 747
 748             // Ensure the current user is allowed to run this function in the enrolment context.
 749             self::validate_context($context);
 750             require_capability('moodle/role:assign', $context);
 751
 752             // throw an exception if user is not able to assign the role in this context
 753             $roles = get_assignable_roles($context, ROLENAME_SHORT);
 754
 755             if (!array_key_exists($assignment['roleid'], $roles)) {
 756                 throw new invalid_parameter_exception('Can not assign roleid='.$assignment['roleid'].' in contextid='.$assignment['contextid']);
 757             }
 758
 759             role_assign($assignment['roleid'], $assignment['userid'], $context->id);
 760         }
 761
 762         $transaction->allow_commit();
 763     }
 764
 765     /**
 766      * Returns description of method result value
 767      *
 768      * @return null
 769      */
 770     public static function assign_roles_returns() {
 771         return null;
 772     }
 773
 774
 775     /**
 776      * Returns description of method parameters
 777      *
 778      * @return external_function_parameters
 779      */
 780     public static function unassign_roles_parameters() {
 781         return new external_function_parameters(
 782             array(
 783                 'unassignments' => new external_multiple_structure(
 784                     new external_single_structure(
 785                         array(
 786                             'roleid'    => new external_value(PARAM_INT, 'Role to assign to the user'),
 787                             'userid'    => new external_value(PARAM_INT, 'The user that is going to be assigned'),
 788                             'contextid' => new external_value(PARAM_INT, 'The context to unassign the user role from', VALUE_OPTIONAL),
 789                             'contextlevel' => new external_value(PARAM_ALPHA, 'The context level to unassign the user role in
 790 +                                    (block, course, coursecat, system, user, module)', VALUE_OPTIONAL),
 791                             'instanceid' => new external_value(PARAM_INT, 'The Instance id of item where the role needs to be unassigned', VALUE_OPTIONAL),
 792                         )
 793                     )
 794                 )
 795             )
 796         );
 797     }
 798
 799      /**
 800      * Unassign roles from users
 801      *
 802      * @param array $unassignments An array of unassignment
 803      */
 804     public static function unassign_roles($unassignments) {
 805          global $DB;
 806
 807         // Do basic automatic PARAM checks on incoming data, using params description
 808         // If any problems are found then exceptions are thrown with helpful error messages
 809         $params = self::validate_parameters(self::unassign_roles_parameters(), array('unassignments'=>$unassignments));
 810
 811         $transaction = $DB->start_delegated_transaction();
 812
 813         foreach ($params['unassignments'] as $unassignment) {
 814             // Ensure the current user is allowed to run this function in the unassignment context
 815             $context = self::get_context_from_params($unassignment);
 816             self::validate_context($context);
 817             require_capability('moodle/role:assign', $context);
 818
 819             // throw an exception if user is not able to unassign the role in this context
 820             $roles = get_assignable_roles($context, ROLENAME_SHORT);
 821             if (!array_key_exists($unassignment['roleid'], $roles)) {
 822                 throw new invalid_parameter_exception('Can not unassign roleid='.$unassignment['roleid'].' in contextid='.$unassignment['contextid']);
 823             }
 824
 825             role_unassign($unassignment['roleid'], $unassignment['userid'], $context->id);
 826         }
 827
 828         $transaction->allow_commit();
 829     }
 830
 831    /**
 832      * Returns description of method result value
 833      *
 834      * @return null
 835      */
 836     public static function unassign_roles_returns() {
 837         return null;
 838     }
 839 }