Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 3.9.x will end* 10 May 2021 (12 months).
  • Bug fixes for security issues in 3.9.x will end* 8 May 2023 (36 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are 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/>.

/**
 * This page handles listing of quiz overrides
 *
 * @package    mod_quiz
 * @copyright  2010 Matt Petro
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

> use mod_quiz\quiz_settings;
require_once(__DIR__ . '/../../config.php'); require_once($CFG->dirroot.'/mod/quiz/lib.php'); require_once($CFG->dirroot.'/mod/quiz/locallib.php');
< require_once($CFG->dirroot.'/mod/quiz/override_form.php'); <
$cmid = required_param('cmid', PARAM_INT); $mode = optional_param('mode', '', PARAM_ALPHA); // One of 'user' or 'group', default is 'group'.
< list($course, $cm) = get_course_and_cm_from_cmid($cmid, 'quiz'); < $quiz = $DB->get_record('quiz', array('id' => $cm->instance), '*', MUST_EXIST);
> $quizobj = quiz_settings::create_for_cmid($cmid); > $quiz = $quizobj->get_quiz(); > $cm = $quizobj->get_cm(); > $course = $quizobj->get_course(); > $context = $quizobj->get_context();
require_login($course, false, $cm);
< $context = context_module::instance($cm->id); <
// Check the user has the required capabilities to list overrides.
< require_capability('mod/quiz:manageoverrides', $context);
> $canedit = has_capability('mod/quiz:manageoverrides', $context); > if (!$canedit) { > require_capability('mod/quiz:viewoverrides', $context); > }
$quizgroupmode = groups_get_activity_groupmode($cm);
< $accessallgroups = ($quizgroupmode == NOGROUPS) || has_capability('moodle/site:accessallgroups', $context);
> $showallgroups = ($quizgroupmode == NOGROUPS) || has_capability('moodle/site:accessallgroups', $context);
// Get the course groups that the current user can access.
< $groups = $accessallgroups ? groups_get_all_groups($cm->course) : groups_get_activity_allowed_groups($cm);
> $groups = $showallgroups ? groups_get_all_groups($cm->course) : groups_get_activity_allowed_groups($cm);
// Default mode is "group", unless there are no groups. if ($mode != "user" and $mode != "group") { if (!empty($groups)) { $mode = "group"; } else { $mode = "user"; } } $groupmode = ($mode == "group");
< $url = new moodle_url('/mod/quiz/overrides.php', array('cmid'=>$cm->id, 'mode'=>$mode));
> $url = new moodle_url('/mod/quiz/overrides.php', ['cmid' => $cm->id, 'mode' => $mode]);
> $title = get_string('overridesforquiz', 'quiz', $PAGE->set_url($url); > format_string($quiz->name, true, ['context' => $context]));
< < // Display a list of overrides.
$PAGE->set_pagelayout('admin');
< $PAGE->set_title(get_string('overrides', 'quiz'));
> $PAGE->add_body_class('limitedwidth'); > $PAGE->set_title($title);
$PAGE->set_heading($course->fullname);
< echo $OUTPUT->header(); < echo $OUTPUT->heading(format_string($quiz->name, true, array('context' => $context)));
> $PAGE->activityheader->disable(); > > // Activate the secondary nav tab. > $PAGE->set_secondary_active_tab("mod_quiz_useroverrides");
// Delete orphaned group overrides. $sql = 'SELECT o.id FROM {quiz_overrides} o LEFT JOIN {groups} g ON o.groupid = g.id WHERE o.groupid IS NOT NULL AND g.id IS NULL AND o.quiz = ?';
< $params = array($quiz->id);
> $params = [$quiz->id];
$orphaned = $DB->get_records_sql($sql, $params); if (!empty($orphaned)) { $DB->delete_records_list('quiz_overrides', 'id', array_keys($orphaned)); } $overrides = [];
> $colclasses = []; > $headers = [];
// Fetch all overrides. if ($groupmode) {
< $colname = get_string('group');
> $headers[] = get_string('group');
// To filter the result by the list of groups that the current user has access to. if ($groups) { $params = ['quizid' => $quiz->id]; list($insql, $inparams) = $DB->get_in_or_equal(array_keys($groups), SQL_PARAMS_NAMED); $params += $inparams; $sql = "SELECT o.*, g.name FROM {quiz_overrides} o JOIN {groups} g ON o.groupid = g.id WHERE o.quiz = :quizid AND g.id $insql ORDER BY g.name"; $overrides = $DB->get_records_sql($sql, $params); }
>
} else {
< $colname = get_string('user'); < list($sort, $params) = users_order_by_sql('u');
> // User overrides. > $colclasses[] = 'colname'; > $headers[] = get_string('user'); > $userfieldsapi = \core_user\fields::for_identity($context)->with_name()->with_userpic(); > $extrauserfields = $userfieldsapi->get_required_fields([\core_user\fields::PURPOSE_IDENTITY]); > $userfieldssql = $userfieldsapi->get_sql('u', true, '', 'userid', false); > foreach ($extrauserfields as $field) { > $colclasses[] = 'col' . $field; > $headers[] = \core_user\fields::get_display_name($field); > } > > list($sort, $params) = users_order_by_sql('u', null, $context, $extrauserfields);
$params['quizid'] = $quiz->id;
< if ($accessallgroups) { < $sql = 'SELECT o.*, ' . get_all_user_name_fields(true, 'u') . ' < FROM {quiz_overrides} o < JOIN {user} u ON o.userid = u.id < WHERE o.quiz = :quizid < ORDER BY ' . $sort;
> if ($showallgroups) { > $groupsjoin = ''; > $groupswhere = '';
< $overrides = $DB->get_records_sql($sql, $params);
} else if ($groups) { list($insql, $inparams) = $DB->get_in_or_equal(array_keys($groups), SQL_PARAMS_NAMED);
> $groupsjoin = 'JOIN {groups_members} gm ON u.id = gm.userid'; $params += $inparams; > $groupswhere = ' AND gm.groupid ' . $insql;
< $sql = 'SELECT o.*, ' . get_all_user_name_fields(true, 'u') . '
> } else { > // User cannot see any data. > $groupsjoin = ''; > $groupswhere = ' AND 1 = 2'; > } > > $overrides = $DB->get_records_sql(" > SELECT o.*, {$userfieldssql->selects}
FROM {quiz_overrides} o JOIN {user} u ON o.userid = u.id
< JOIN {groups_members} gm ON u.id = gm.userid < WHERE o.quiz = :quizid AND gm.groupid ' . $insql . ' < ORDER BY ' . $sort; < < $overrides = $DB->get_records_sql($sql, $params); < }
> {$userfieldssql->joins} > $groupsjoin > WHERE o.quiz = :quizid > $groupswhere > ORDER BY $sort > ", array_merge($params, $userfieldssql->params));
} // Initialise table. $table = new html_table();
< $table->headspan = array(1, 2, 1); < $table->colclasses = array('colname', 'colsetting', 'colvalue', 'colaction'); < $table->head = array( < $colname, < get_string('overrides', 'quiz'), < get_string('action'), < ); < < $userurl = new moodle_url('/user/view.php', array()); < $groupurl = new moodle_url('/group/overview.php', array('id' => $cm->course));
> $table->head = $headers; > $table->colclasses = $colclasses; > $table->headspan = array_fill(0, count($headers), 1); > > $table->head[] = get_string('overrides', 'quiz'); > $table->colclasses[] = 'colsetting'; > $table->colclasses[] = 'colvalue'; > $table->headspan[] = 2; > > if ($canedit) { > $table->head[] = get_string('action'); > $table->colclasses[] = 'colaction'; > $table->headspan[] = 1; > } > $userurl = new moodle_url('/user/view.php', []); > $groupurl = new moodle_url('/group/overview.php', ['id' => $cm->course]);
$overridedeleteurl = new moodle_url('/mod/quiz/overridedelete.php'); $overrideediturl = new moodle_url('/mod/quiz/overrideedit.php'); $hasinactive = false; // Whether there are any inactive overrides. foreach ($overrides as $override) {
< $fields = array(); < $values = array();
> // Check if this override is active.
$active = true;
< < // Check for inactive overrides.
if (!$groupmode) { if (!has_capability('mod/quiz:attempt', $context, $override->userid)) { // User not allowed to take the quiz. $active = false; } else if (!\core_availability\info_module::is_user_visible($cm, $override->userid)) { // User cannot access the module. $active = false; } }
> if (!$active) { > $hasinactive = true; // Format timeopen. > } if (isset($override->timeopen)) { > $fields[] = get_string('quizopens', 'quiz'); > // Prepare the information about which settings are overridden. $values[] = $override->timeopen > 0 ? > $fields = []; userdate($override->timeopen) : get_string('noopen', 'quiz'); > $values = [];
}
<
// Format timeclose. if (isset($override->timeclose)) { $fields[] = get_string('quizcloses', 'quiz'); $values[] = $override->timeclose > 0 ? userdate($override->timeclose) : get_string('noclose', 'quiz'); }
<
// Format timelimit. if (isset($override->timelimit)) { $fields[] = get_string('timelimit', 'quiz'); $values[] = $override->timelimit > 0 ? format_time($override->timelimit) : get_string('none', 'quiz'); }
<
// Format number of attempts. if (isset($override->attempts)) { $fields[] = get_string('attempts', 'quiz'); $values[] = $override->attempts > 0 ? $override->attempts : get_string('unlimited'); }
<
// Format password. if (isset($override->password)) { $fields[] = get_string('requirepassword', 'quiz'); $values[] = $override->password !== '' ? get_string('enabled', 'quiz') : get_string('none', 'quiz'); }
> // Prepare the information about who this override applies to. // Icons. > $extranamebit = $active ? '' : '*'; $iconstr = ''; > $usercells = []; > if ($groupmode) { // Edit. > $groupcell = new html_table_cell(); $editurlstr = $overrideediturl->out(true, array('id' => $override->id)); > $groupcell->rowspan = count($fields); $iconstr = '<a title="' . get_string('edit') . '" href="'. $editurlstr . '">' . > $groupcell->text = html_writer::link(new moodle_url($groupurl, ['group' => $override->groupid]), $OUTPUT->pix_icon('t/edit', get_string('edit')) . '</a> '; > format_string($override->name, true, ['context' => $context]) . $extranamebit); // Duplicate. > $usercells[] = $groupcell; $copyurlstr = $overrideediturl->out(true, > } else { array('id' => $override->id, 'action' => 'duplicate')); > $usercell = new html_table_cell(); $iconstr .= '<a title="' . get_string('copy') . '" href="' . $copyurlstr . '">' . > $usercell->rowspan = count($fields); $OUTPUT->pix_icon('t/copy', get_string('copy')) . '</a> '; > $usercell->text = html_writer::link(new moodle_url($userurl, ['id' => $override->userid]), // Delete. > fullname($override) . $extranamebit); $deleteurlstr = $overridedeleteurl->out(true, > $usercells[] = $usercell; array('id' => $override->id, 'sesskey' => sesskey())); > $iconstr .= '<a title="' . get_string('delete') . '" href="' . $deleteurlstr . '">' . > foreach ($extrauserfields as $field) { $OUTPUT->pix_icon('t/delete', get_string('delete')) . '</a> '; > $usercell = new html_table_cell(); > $usercell->rowspan = count($fields); if ($groupmode) { > $usercell->text = s($override->$field); $usergroupstr = '<a href="' . $groupurl->out(true, > $usercells[] = $usercell; array('group' => $override->groupid)) . '" >' . $override->name . '</a>'; > } } else { > } $usergroupstr = '<a href="' . $userurl->out(true, > array('id' => $override->userid)) . '" >' . fullname($override) . '</a>'; > // Prepare the actions. } > if ($canedit) {
< $editurlstr = $overrideediturl->out(true, array('id' => $override->id));
> $editurlstr = $overrideediturl->out(true, ['id' => $override->id]);
< array('id' => $override->id, 'action' => 'duplicate'));
> ['id' => $override->id, 'action' => 'duplicate']);
< array('id' => $override->id, 'sesskey' => sesskey()));
> ['id' => $override->id, 'sesskey' => sesskey()]);
< if ($groupmode) { < $usergroupstr = '<a href="' . $groupurl->out(true, < array('group' => $override->groupid)) . '" >' . $override->name . '</a>'; < } else { < $usergroupstr = '<a href="' . $userurl->out(true, < array('id' => $override->userid)) . '" >' . fullname($override) . '</a>'; < } < < $class = ''; < if (!$active) { < $class = "dimmed_text"; < $usergroupstr .= '*'; < $hasinactive = true; < } < < $usergroupcell = new html_table_cell(); < $usergroupcell->rowspan = count($fields); < $usergroupcell->text = $usergroupstr;
$cell1 = new html_table_cell();
> }
$cell1->text = $fields[$i];
> // Add the data to the table.
< $row->attributes['class'] = $class; < if ($i == 0) { < $row->cells[] = $usergroupcell;
> if (!$active) { > $row->attributes['class'] = 'dimmed_text';
< $cell1 = new html_table_cell(); < $cell1->text = $fields[$i]; < $row->cells[] = $cell1; < $cell2 = new html_table_cell(); < $cell2->text = $values[$i]; < $row->cells[] = $cell2;
>
< $row->cells[] = $actioncell; < } < $table->data[] = $row;
> $row->cells = $usercells;
echo html_writer::start_tag('div', array('id' => 'quizoverrides'));
> if (count($table->data)) { > $labelcell = new html_table_cell(); echo html_writer::table($table); > $labelcell->text = $fields[$i]; } > $row->cells[] = $labelcell; if ($hasinactive) { > $valuecell = new html_table_cell(); echo $OUTPUT->notification(get_string('inactiveoverridehelp', 'quiz'), 'dimmed_text'); > $valuecell->text = $values[$i]; } > $row->cells[] = $valuecell; > echo html_writer::start_tag('div', array('class' => 'buttons')); > if ($canedit && $i == 0) { $options = array(); > $row->cells[] = $actioncell;
< // Output the table and button. < echo html_writer::start_tag('div', array('id' => 'quizoverrides')); < if (count($table->data)) { < echo html_writer::table($table);
> $table->data[] = $row;
< if ($hasinactive) { < echo $OUTPUT->notification(get_string('inactiveoverridehelp', 'quiz'), 'dimmed_text');
< echo html_writer::start_tag('div', array('class' => 'buttons')); < $options = array();
> // Work out what else needs to be displayed. > $addenabled = true; > $warningmessage = ''; > if ($canedit) {
< echo $OUTPUT->notification(get_string('groupsnone', 'quiz'), 'error'); < $options['disabled'] = true;
> $warningmessage = get_string('groupsnone', 'quiz'); > $addenabled = false;
< echo $OUTPUT->single_button($overrideediturl->out(true, < array('action' => 'addgroup', 'cmid' => $cm->id)), < get_string('addnewgroupoverride', 'quiz'), 'post', $options);
< $users = array();
< if ($accessallgroups) {
> if ($showallgroups) {
} else if ($groups) { $users = get_users_by_capability($context, 'mod/quiz:attempt', 'u.id', '', '', '', array_keys($groups)); $nousermessage = get_string('usersnone', 'quiz'); } else {
> $users = [];
$nousermessage = get_string('groupsnone', 'quiz'); } $info = new \core_availability\info_module($cm); $users = $info->filter_user_list($users); if (empty($users)) { // There are no students.
< echo $OUTPUT->notification($nousermessage, 'error'); < $options['disabled'] = true;
> $warningmessage = $nousermessage; > $addenabled = false; > }
}
< echo $OUTPUT->single_button($overrideediturl->out(true, < array('action' => 'adduser', 'cmid' => $cm->id)), < get_string('addnewuseroverride', 'quiz'), 'get', $options);
}
< echo html_writer::end_tag('div');
> > // Tertiary navigation. > echo $OUTPUT->header(); > $renderer = $PAGE->get_renderer('mod_quiz'); > $tertiarynav = new \mod_quiz\output\overrides_actions($cmid, $mode, $canedit, $addenabled); > echo $renderer->render($tertiarynav); > > if ($mode === 'user') { > echo $OUTPUT->heading(get_string('useroverrides', 'quiz')); > } else { > echo $OUTPUT->heading(get_string('groupoverrides', 'quiz')); > } > > // Output the table and button. > echo html_writer::start_tag('div', ['id' => 'quizoverrides']); > if (count($table->data)) { > echo html_writer::table($table); > } else { > if ($groupmode) { > echo $OUTPUT->notification(get_string('overridesnoneforgroups', 'quiz'), 'info', false); > } else { > echo $OUTPUT->notification(get_string('overridesnoneforusers', 'quiz'), 'info', false); > } > } > if ($hasinactive) { > echo $OUTPUT->notification(get_string('inactiveoverridehelp', 'quiz'), 'info', false); > } > > if ($warningmessage) { > echo $OUTPUT->notification($warningmessage, 'error'); > } >
echo html_writer::end_tag('div'); // Finish the page. echo $OUTPUT->footer();