Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
  • Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.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/>.

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

require_once(__DIR__ . '/../../config.php');
require_once($CFG->dirroot . '/' . $CFG->admin . '/roles/lib.php');

define("MAX_USERS_TO_LIST_PER_ROLE", 10);

$contextid = required_param('contextid', PARAM_INT);
$roleid    = optional_param('roleid', 0, PARAM_INT);
$returnurl = optional_param('returnurl', null, PARAM_LOCALURL);

list($context, $course, $cm) = get_context_info_array($contextid);

$url = new moodle_url('/admin/roles/assign.php', array('contextid' => $contextid));

if ($course) {
    $isfrontpage = ($course->id == SITEID);
} else {
    $isfrontpage = false;
    if ($context->contextlevel == CONTEXT_USER) {
        $course = $DB->get_record('course', array('id'=>optional_param('courseid', SITEID, PARAM_INT)), '*', MUST_EXIST);
        $user = $DB->get_record('user', array('id'=>$context->instanceid), '*', MUST_EXIST);
        $url->param('courseid', $course->id);
        $url->param('userid', $user->id);
    } else {
        $course = $SITE;
    }
}


// Security.
require_login($course, false, $cm);
require_capability('moodle/role:assign', $context);

navigation_node::override_active_url($url);
$pageurl = new moodle_url($url);
if ($returnurl) {
    $pageurl->param('returnurl', $returnurl);
}
$PAGE->set_url($pageurl);
$PAGE->set_context($context);
> $PAGE->activityheader->disable();
$contextname = $context->get_context_name(); $courseid = $course->id; // These are needed early because of tabs.php. list($assignableroles, $assigncounts, $nameswithcounts) = get_assignable_roles($context, ROLENAME_BOTH, true); $overridableroles = get_overridable_roles($context, ROLENAME_BOTH); // Make sure this user can assign this role. if ($roleid && !isset($assignableroles[$roleid])) { $a = new stdClass; $a->roleid = $roleid; $a->context = $contextname;
< print_error('cannotassignrolehere', '', $context->get_url(), $a);
> throw new \moodle_exception('cannotassignrolehere', '', $context->get_url(), $a);
} // Work out an appropriate page title. if ($roleid) { $a = new stdClass; $a->role = $assignableroles[$roleid]; $a->context = $contextname; $title = get_string('assignrolenameincontext', 'core_role', $a); } else { if ($isfrontpage) { $title = get_string('frontpageroles', 'admin'); } else { $title = get_string('assignrolesin', 'core_role', $contextname); } } // Process any incoming role assignments before printing the header. if ($roleid) { // Create the user selector objects. $options = array('context' => $context, 'roleid' => $roleid); $potentialuserselector = core_role_get_potential_user_selector($context, 'addselect', $options); $currentuserselector = new core_role_existing_role_holders('removeselect', $options); // Process incoming role assignments. $errors = array(); if (optional_param('add', false, PARAM_BOOL) && confirm_sesskey()) { $userstoassign = $potentialuserselector->get_selected_users(); if (!empty($userstoassign)) { foreach ($userstoassign as $adduser) { $allow = true; if ($allow) { role_assign($roleid, $adduser->id, $context->id); } } $potentialuserselector->invalidate_selected_users(); $currentuserselector->invalidate_selected_users(); // Counts have changed, so reload. list($assignableroles, $assigncounts, $nameswithcounts) = get_assignable_roles($context, ROLENAME_BOTH, true); } } // Process incoming role unassignments. if (optional_param('remove', false, PARAM_BOOL) && confirm_sesskey()) { $userstounassign = $currentuserselector->get_selected_users(); if (!empty($userstounassign)) { foreach ($userstounassign as $removeuser) { // Unassign only roles that are added manually, no messing with other components!!! role_unassign($roleid, $removeuser->id, $context->id, ''); } $potentialuserselector->invalidate_selected_users(); $currentuserselector->invalidate_selected_users(); // Counts have changed, so reload. list($assignableroles, $assigncounts, $nameswithcounts) = get_assignable_roles($context, ROLENAME_BOTH, true); } } } if (!empty($user) && ($user->id != $USER->id)) { $PAGE->navigation->extend_for_user($user); $PAGE->navbar->includesettingsbase = true; } $PAGE->set_pagelayout('admin'); if ($context->contextlevel == CONTEXT_BLOCK) { // Do not show blocks when changing block's settings, it is confusing. $PAGE->blocks->show_only_fake_blocks(true); } $PAGE->set_title($title); switch ($context->contextlevel) { case CONTEXT_SYSTEM: require_once($CFG->libdir.'/adminlib.php'); admin_externalpage_setup('assignroles', '', array('contextid' => $contextid, 'roleid' => $roleid)); break; case CONTEXT_USER: $fullname = fullname($user, has_capability('moodle/site:viewfullnames', $context)); $PAGE->set_heading($fullname); $showroles = 1; break; case CONTEXT_COURSECAT:
< $PAGE->set_heading($SITE->fullname);
> core_course_category::page_setup();
break; case CONTEXT_COURSE: if ($isfrontpage) { $PAGE->set_heading(get_string('frontpage', 'admin')); } else { $PAGE->set_heading($course->fullname); } break; case CONTEXT_MODULE: $PAGE->set_heading($context->get_context_name(false)); $PAGE->set_cacheable(false); break; case CONTEXT_BLOCK: $PAGE->set_heading($PAGE->course->fullname); break; }
> $PAGE->set_navigation_overflow_state(false); echo $OUTPUT->header(); > > // Within a course context we need to explicitly set active tab as there isn't a reference in the nav tree. // Print heading. > if ($context->contextlevel == CONTEXT_COURSE) { echo $OUTPUT->heading_with_help($title, 'assignroles', 'core_role'); > $PAGE->set_secondary_active_tab('participants'); > }
if ($roleid) {
> $backurl = null; // Show UI for assigning a particular role to users. > // We are looking at a particular role. The page URL has been set correctly. // Print a warning if we are assigning system roles. > if ($roleid) { if ($context->contextlevel == CONTEXT_SYSTEM) { > $backurl = $pageurl; echo $OUTPUT->notification(get_string('globalroleswarning', 'core_role')); > } else if ($context->contextlevel == CONTEXT_COURSE && !$isfrontpage) { } > // Return to the intermediary page when within the course context. > $backurl = new moodle_url('/enrol/otherusers.php', ['id' => $course->id]); // Print the form. > } else if ($returnurl) { $assignurl = new moodle_url($PAGE->url, array('roleid'=>$roleid)); > // Factor in for $returnurl being passed. ?> > $backurl = new moodle_url($returnurl); <form id="assignform" method="post" action="<?php echo $assignurl ?>"><div> > } <input type="hidden" name="sesskey" value="<?php echo sesskey() ?>" /> > > if ($backurl) { <table id="assigningrole" summary="" class="admintable roleassigntable generaltable" cellspacing="0"> > $backbutton = new single_button($backurl, get_string('back'), 'get'); <tr> > $backbutton->class = 'singlebutton navitem'; <td id="existingcell"> > echo html_writer::tag('div', $OUTPUT->render($backbutton), ['class' => 'tertiary-navigation']); <p><label for="removeselect"><?php print_string('extusers', 'core_role'); ?></label></p> > } else if (in_array($context->contextlevel, [CONTEXT_COURSE, CONTEXT_MODULE, CONTEXT_COURSECAT])) { <?php $currentuserselector->display() ?> > // The front page doesn't have an intermediate page 'other users' but needs similar tertiary nav like a standard course. </td> > echo $OUTPUT->render_participants_tertiary_nav($course); <td id="buttonscell"> > } <div id="addcontrols"> >
<input name="add" id="add" type="submit" value="<?php echo $OUTPUT->larrow().'&nbsp;'.get_string('add'); ?>" title="<?php print_string('add'); ?>" class="btn btn-secondary"/><br /> </div> <div id="removecontrols"> <input name="remove" id="remove" type="submit" value="<?php echo get_string('remove').'&nbsp;'.$OUTPUT->rarrow(); ?>" title="<?php print_string('remove'); ?>" class="btn btn-secondary"/> </div> </td> <td id="potentialcell"> <p><label for="addselect"><?php print_string('potusers', 'core_role'); ?></label></p> <?php $potentialuserselector->display() ?> </td> </tr> </table> </div></form> <?php $PAGE->requires->js_init_call('M.core_role.init_add_assign_page'); if (!empty($errors)) { $msg = '<p>'; foreach ($errors as $e) { $msg .= $e.'<br />'; } $msg .= '</p>'; echo $OUTPUT->box_start(); echo $OUTPUT->notification($msg); echo $OUTPUT->box_end(); } // Print a form to swap roles, and a link back to the all roles list. echo '<div class="backlink">'; $select = new single_select($PAGE->url, 'roleid', $nameswithcounts, $roleid, null); $select->label = get_string('assignanotherrole', 'core_role'); echo $OUTPUT->render($select);
< echo '<p><a href="' . $url . '">' . get_string('backtoallroles', 'core_role') . '</a></p>';
echo '</div>'; } else if (empty($assignableroles)) { // Print a message that there are no roles that can me assigned here. echo $OUTPUT->heading(get_string('notabletoassignroleshere', 'core_role'), 3); } else { // Show UI for choosing a role to assign. // Print a warning if we are assigning system roles. if ($context->contextlevel == CONTEXT_SYSTEM) { echo $OUTPUT->notification(get_string('globalroleswarning', 'core_role')); } // Print instruction. echo $OUTPUT->heading(get_string('chooseroletoassign', 'core_role'), 3); // Get the names of role holders for roles with between 1 and MAX_USERS_TO_LIST_PER_ROLE users, // and so determine whether to show the extra column. $roleholdernames = array(); $strmorethanmax = get_string('morethan', 'core_role', MAX_USERS_TO_LIST_PER_ROLE); $showroleholders = false; foreach ($assignableroles as $roleid => $notused) { $roleusers = ''; if (0 < $assigncounts[$roleid] && $assigncounts[$roleid] <= MAX_USERS_TO_LIST_PER_ROLE) { $userfieldsapi = \core_user\fields::for_name(); $userfields = 'u.id, u.username' . $userfieldsapi->get_sql('u')->selects; $roleusers = get_role_users($roleid, $context, false, $userfields); if (!empty($roleusers)) { $strroleusers = array(); foreach ($roleusers as $user) { $strroleusers[] = '<a href="' . $CFG->wwwroot . '/user/view.php?id=' . $user->id . '" >' . fullname($user) . '</a>'; } $roleholdernames[$roleid] = implode('<br />', $strroleusers); $showroleholders = true; } } else if ($assigncounts[$roleid] > MAX_USERS_TO_LIST_PER_ROLE) { $assignurl = new moodle_url($PAGE->url, array('roleid'=>$roleid)); $roleholdernames[$roleid] = '<a href="'.$assignurl.'">'.$strmorethanmax.'</a>'; } else { $roleholdernames[$roleid] = ''; } } // Print overview table. $table = new html_table(); $table->id = 'assignrole'; $table->head = array(get_string('role'), get_string('description'), get_string('userswiththisrole', 'core_role')); $table->colclasses = array('leftalign role', 'leftalign', 'centeralign userrole'); $table->attributes['class'] = 'admintable generaltable'; if ($showroleholders) { $table->headspan = array(1, 1, 2); $table->colclasses[] = 'leftalign roleholder'; } foreach ($assignableroles as $roleid => $rolename) { $description = format_string($DB->get_field('role', 'description', array('id'=>$roleid))); $assignurl = new moodle_url($PAGE->url, array('roleid'=>$roleid)); $row = array('<a href="'.$assignurl.'">'.$rolename.'</a>', $description, $assigncounts[$roleid]); if ($showroleholders) { $row[] = $roleholdernames[$roleid]; } $table->data[] = $row; } echo html_writer::table($table);
< if ($context->contextlevel > CONTEXT_USER) { < < if ($returnurl) { < $url = new moodle_url($returnurl); < } else {
> if (!$PAGE->has_secondary_navigation() && $context->contextlevel > CONTEXT_USER) { > if (!$returnurl) {
$url = $context->get_url();
< } <
echo html_writer::start_tag('div', array('class'=>'backlink')); echo html_writer::tag('a', get_string('backto', '', $contextname), array('href' => $url)); echo html_writer::end_tag('div');
> }
} } echo $OUTPUT->footer();