Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * Existing user selector.
 *
 * @package    core_role
 * @copyright  1999 onwards Martin Dougiamas (http://dougiamas.com)
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

defined('MOODLE_INTERNAL') || die();

/**
 * User selector subclass for the list of users who already have the role in
 * question on the assign roles page.
 */
class core_role_existing_role_holders extends core_role_assign_user_selector_base {

    public function find_users($search) {
        global $DB;

        list($wherecondition, $params) = $this->search_sql($search, 'u');
        list($ctxcondition, $ctxparams) = $DB->get_in_or_equal($this->context->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'ctx');
< $params = array_merge($params, $ctxparams);
> $params = array_merge($params, $ctxparams, $this->userfieldsparams);
$params['roleid'] = $this->roleid;
< list($sort, $sortparams) = users_order_by_sql('u', $search, $this->accesscontext);
> list($sort, $sortparams) = users_order_by_sql('u', $search, $this->accesscontext, $this->userfieldsmappings);
$params = array_merge($params, $sortparams);
< $fields = "SELECT ra.id AS raid," . $this->required_fields_sql('u') . ",ra.contextid,ra.component ";
> $fields = "SELECT ra.id AS raid, u.id, " . $this->userfieldsselects . ", ra.contextid, ra.component ";
$countfields = "SELECT COUNT(1) "; $sql = "FROM {role_assignments} ra JOIN {user} u ON u.id = ra.userid JOIN {context} ctx ON ra.contextid = ctx.id
> $this->userfieldsjoin
WHERE $wherecondition AND ctx.id $ctxcondition AND ra.roleid = :roleid"; $order = " ORDER BY ctx.depth DESC, ra.component, $sort"; if (!$this->is_validating()) { $existinguserscount = $DB->count_records_sql($countfields . $sql, $params); if ($existinguserscount > $this->maxusersperpage) { return $this->too_many_results($search, $existinguserscount); } } $contextusers = $DB->get_records_sql($fields . $sql . $order, $params); // No users at all. if (empty($contextusers)) { return array(); } // We have users. Out put them in groups by context depth. // To help the loop below, tack a dummy user on the end of the results // array, to trigger output of the last group. $dummyuser = new stdClass; $dummyuser->contextid = 0; $dummyuser->id = 0; $dummyuser->component = ''; $contextusers[] = $dummyuser; $results = array(); // The results array we are building up. $doneusers = array(); // Ensures we only list each user at most once. $currentcontextid = $this->context->id; $currentgroup = array(); foreach ($contextusers as $user) { if (isset($doneusers[$user->id])) { continue; } $doneusers[$user->id] = 1; if ($user->contextid != $currentcontextid) { // We have got to the end of the previous group. Add it to the results array. if ($currentcontextid == $this->context->id) { $groupname = $this->this_con_group_name($search, count($currentgroup)); } else { $groupname = $this->parent_con_group_name($search, $currentcontextid); } $results[$groupname] = $currentgroup; // Get ready for the next group. $currentcontextid = $user->contextid; $currentgroup = array(); } // Add this user to the group we are building up. unset($user->contextid); if ($currentcontextid != $this->context->id) { $user->disabled = true; } if ($user->component !== '') { // Bad luck, you can tweak only manual role assignments. $user->disabled = true; } unset($user->component); $currentgroup[$user->id] = $user; } return $results; } protected function this_con_group_name($search, $numusers) { if ($this->context->contextlevel == CONTEXT_SYSTEM) { // Special case in the System context. if ($search) { return get_string('extusersmatching', 'core_role', $search); } else { return get_string('extusers', 'core_role'); } } $contexttype = context_helper::get_level_name($this->context->contextlevel); if ($search) { $a = new stdClass; $a->search = $search; $a->contexttype = $contexttype; if ($numusers) { return get_string('usersinthisxmatching', 'core_role', $a); } else { return get_string('noneinthisxmatching', 'core_role', $a); } } else { if ($numusers) { return get_string('usersinthisx', 'core_role', $contexttype); } else { return get_string('noneinthisx', 'core_role', $contexttype); } } } protected function parent_con_group_name($search, $contextid) { $context = context::instance_by_id($contextid); $contextname = $context->get_context_name(true, true); if ($search) { $a = new stdClass; $a->contextname = $contextname; $a->search = $search; return get_string('usersfrommatching', 'core_role', $a); } else { return get_string('usersfrom', 'core_role', $contextname); } } }