Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
/mod/quiz/ -> lib.php (source)
<?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/>.

/**
 * Library of functions for the quiz module.
 *
 * This contains functions that are called also from outside the quiz module
 * Functions that are only called by the quiz module itself are in {@link locallib.php}
 *
 * @package    mod_quiz
 * @copyright  1999 onwards Martin Dougiamas {@link http://moodle.com}
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */


> use qbank_managecategories\helper; defined('MOODLE_INTERNAL') || die(); >
use mod_quiz\access_manager;
< use mod_quiz\form\add_random_form;
use mod_quiz\grade_calculator; use mod_quiz\question\bank\custom_view; use mod_quiz\question\bank\qbank_helper; use mod_quiz\question\display_options; use mod_quiz\question\qubaids_for_quiz; use mod_quiz\question\qubaids_for_users_attempts; use core_question\statistics\questions\all_calculated_for_qubaid_condition; use mod_quiz\quiz_attempt; use mod_quiz\quiz_settings; require_once($CFG->dirroot . '/calendar/lib.php');
> require_once($CFG->dirroot . '/question/editlib.php');
/**#@+ * Option controlling what options are offered on the quiz settings form. */ define('QUIZ_MAX_ATTEMPT_OPTION', 10); define('QUIZ_MAX_QPP_OPTION', 50); define('QUIZ_MAX_DECIMAL_OPTION', 5); define('QUIZ_MAX_Q_DECIMAL_OPTION', 7); /**#@-*/ /**#@+ * Options determining how the grades from individual attempts are combined to give * the overall grade for a user */ define('QUIZ_GRADEHIGHEST', '1'); define('QUIZ_GRADEAVERAGE', '2'); define('QUIZ_ATTEMPTFIRST', '3'); define('QUIZ_ATTEMPTLAST', '4'); /**#@-*/ /** * @var int If start and end date for the quiz are more than this many seconds apart * they will be represented by two separate events in the calendar */ define('QUIZ_MAX_EVENT_LENGTH', 5*24*60*60); // 5 days. /**#@+ * Options for navigation method within quizzes. */ define('QUIZ_NAVMETHOD_FREE', 'free'); define('QUIZ_NAVMETHOD_SEQ', 'sequential'); /**#@-*/ /** * Event types. */ define('QUIZ_EVENT_TYPE_OPEN', 'open'); define('QUIZ_EVENT_TYPE_CLOSE', 'close'); require_once(__DIR__ . '/deprecatedlib.php'); /** * Given an object containing all the necessary data, * (defined by the form in mod_form.php) this function * will create a new instance and return the id number * of the new instance. * * @param stdClass $quiz the data that came from the form. * @return mixed the id of the new instance on success, * false or a string error message on failure. */ function quiz_add_instance($quiz) { global $DB; $cmid = $quiz->coursemodule; // Process the options from the form. $quiz->timecreated = time(); $result = quiz_process_options($quiz); if ($result && is_string($result)) { return $result; } // Try to store it in the database. $quiz->id = $DB->insert_record('quiz', $quiz); // Create the first section for this quiz. $DB->insert_record('quiz_sections', ['quizid' => $quiz->id, 'firstslot' => 1, 'heading' => '', 'shufflequestions' => 0]); // Do the processing required after an add or an update. quiz_after_add_or_update($quiz); return $quiz->id; } /** * Given an object containing all the necessary data, * (defined by the form in mod_form.php) this function * will update an existing instance with new data. * * @param stdClass $quiz the data that came from the form. * @param stdClass $mform no longer used. * @return mixed true on success, false or a string error message on failure. */ function quiz_update_instance($quiz, $mform) { global $CFG, $DB; require_once($CFG->dirroot . '/mod/quiz/locallib.php'); // Process the options from the form. $result = quiz_process_options($quiz); if ($result && is_string($result)) { return $result; } // Get the current value, so we can see what changed. $oldquiz = $DB->get_record('quiz', ['id' => $quiz->instance]); // We need two values from the existing DB record that are not in the form, // in some of the function calls below. $quiz->sumgrades = $oldquiz->sumgrades; $quiz->grade = $oldquiz->grade; // Update the database. $quiz->id = $quiz->instance; $DB->update_record('quiz', $quiz); // Do the processing required after an add or an update. quiz_after_add_or_update($quiz); if ($oldquiz->grademethod != $quiz->grademethod) { $gradecalculator = quiz_settings::create($quiz->id)->get_grade_calculator(); $gradecalculator->recompute_all_final_grades(); quiz_update_grades($quiz); } $quizdateschanged = $oldquiz->timelimit != $quiz->timelimit || $oldquiz->timeclose != $quiz->timeclose || $oldquiz->graceperiod != $quiz->graceperiod; if ($quizdateschanged) { quiz_update_open_attempts(['quizid' => $quiz->id]); } // Delete any previous preview attempts. quiz_delete_previews($quiz); // Repaginate, if asked to. if (!empty($quiz->repaginatenow) && !quiz_has_attempts($quiz->id)) { quiz_repaginate_questions($quiz->id, $quiz->questionsperpage); } return true; } /** * Given an ID of an instance of this module, * this function will permanently delete the instance * and any data that depends on it. * * @param int $id the id of the quiz to delete. * @return bool success or failure. */ function quiz_delete_instance($id) { global $DB; $quiz = $DB->get_record('quiz', ['id' => $id], '*', MUST_EXIST); quiz_delete_all_attempts($quiz); quiz_delete_all_overrides($quiz); quiz_delete_references($quiz->id); // We need to do the following deletes before we try and delete randoms, otherwise they would still be 'in use'. $DB->delete_records('quiz_slots', ['quizid' => $quiz->id]); $DB->delete_records('quiz_sections', ['quizid' => $quiz->id]); $DB->delete_records('quiz_feedback', ['quizid' => $quiz->id]); access_manager::delete_settings($quiz); $events = $DB->get_records('event', ['modulename' => 'quiz', 'instance' => $quiz->id]); foreach ($events as $event) { $event = calendar_event::load($event); $event->delete(); } quiz_grade_item_delete($quiz); // We must delete the module record after we delete the grade item. $DB->delete_records('quiz', ['id' => $quiz->id]); return true; } /** * Deletes a quiz override from the database and clears any corresponding calendar events * * @param stdClass $quiz The quiz object. * @param int $overrideid The id of the override being deleted * @param bool $log Whether to trigger logs. * @return bool true on success */ function quiz_delete_override($quiz, $overrideid, $log = true) { global $DB; if (!isset($quiz->cmid)) { $cm = get_coursemodule_from_instance('quiz', $quiz->id, $quiz->course); $quiz->cmid = $cm->id; } $override = $DB->get_record('quiz_overrides', ['id' => $overrideid], '*', MUST_EXIST); // Delete the events. if (isset($override->groupid)) { // Create the search array for a group override. $eventsearcharray = ['modulename' => 'quiz', 'instance' => $quiz->id, 'groupid' => (int)$override->groupid]; $cachekey = "{$quiz->id}_g_{$override->groupid}"; } else { // Create the search array for a user override. $eventsearcharray = ['modulename' => 'quiz', 'instance' => $quiz->id, 'userid' => (int)$override->userid]; $cachekey = "{$quiz->id}_u_{$override->userid}"; } $events = $DB->get_records('event', $eventsearcharray); foreach ($events as $event) { $eventold = calendar_event::load($event); $eventold->delete(); } $DB->delete_records('quiz_overrides', ['id' => $overrideid]); cache::make('mod_quiz', 'overrides')->delete($cachekey); if ($log) { // Set the common parameters for one of the events we will be triggering. $params = [ 'objectid' => $override->id, 'context' => context_module::instance($quiz->cmid), 'other' => [ 'quizid' => $override->quiz ] ]; // Determine which override deleted event to fire. if (!empty($override->userid)) { $params['relateduserid'] = $override->userid; $event = \mod_quiz\event\user_override_deleted::create($params); } else { $params['other']['groupid'] = $override->groupid; $event = \mod_quiz\event\group_override_deleted::create($params); } // Trigger the override deleted event. $event->add_record_snapshot('quiz_overrides', $override); $event->trigger(); } return true; } /** * Deletes all quiz overrides from the database and clears any corresponding calendar events * * @param stdClass $quiz The quiz object. * @param bool $log Whether to trigger logs. */ function quiz_delete_all_overrides($quiz, $log = true) { global $DB; $overrides = $DB->get_records('quiz_overrides', ['quiz' => $quiz->id], 'id'); foreach ($overrides as $override) { quiz_delete_override($quiz, $override->id, $log); } } /** * Updates a quiz object with override information for a user. * * Algorithm: For each quiz setting, if there is a matching user-specific override, * then use that otherwise, if there are group-specific overrides, return the most * lenient combination of them. If neither applies, leave the quiz setting unchanged. * * Special case: if there is more than one password that applies to the user, then * quiz->extrapasswords will contain an array of strings giving the remaining * passwords. * * @param stdClass $quiz The quiz object. * @param int $userid The userid. * @return stdClass $quiz The updated quiz object. */ function quiz_update_effective_access($quiz, $userid) { global $DB; // Check for user override. $override = $DB->get_record('quiz_overrides', ['quiz' => $quiz->id, 'userid' => $userid]); if (!$override) { $override = new stdClass(); $override->timeopen = null; $override->timeclose = null; $override->timelimit = null; $override->attempts = null; $override->password = null; } // Check for group overrides. $groupings = groups_get_user_groups($quiz->course, $userid); if (!empty($groupings[0])) { // Select all overrides that apply to the User's groups. list($extra, $params) = $DB->get_in_or_equal(array_values($groupings[0])); $sql = "SELECT * FROM {quiz_overrides} WHERE groupid $extra AND quiz = ?"; $params[] = $quiz->id; $records = $DB->get_records_sql($sql, $params); // Combine the overrides. $opens = []; $closes = []; $limits = []; $attempts = []; $passwords = []; foreach ($records as $gpoverride) { if (isset($gpoverride->timeopen)) { $opens[] = $gpoverride->timeopen; } if (isset($gpoverride->timeclose)) { $closes[] = $gpoverride->timeclose; } if (isset($gpoverride->timelimit)) { $limits[] = $gpoverride->timelimit; } if (isset($gpoverride->attempts)) { $attempts[] = $gpoverride->attempts; } if (isset($gpoverride->password)) { $passwords[] = $gpoverride->password; } } // If there is a user override for a setting, ignore the group override. if (is_null($override->timeopen) && count($opens)) { $override->timeopen = min($opens); } if (is_null($override->timeclose) && count($closes)) { if (in_array(0, $closes)) { $override->timeclose = 0; } else { $override->timeclose = max($closes); } } if (is_null($override->timelimit) && count($limits)) { if (in_array(0, $limits)) { $override->timelimit = 0; } else { $override->timelimit = max($limits); } } if (is_null($override->attempts) && count($attempts)) { if (in_array(0, $attempts)) { $override->attempts = 0; } else { $override->attempts = max($attempts); } } if (is_null($override->password) && count($passwords)) { $override->password = array_shift($passwords); if (count($passwords)) { $override->extrapasswords = $passwords; } } } // Merge with quiz defaults. $keys = ['timeopen', 'timeclose', 'timelimit', 'attempts', 'password', 'extrapasswords']; foreach ($keys as $key) { if (isset($override->{$key})) { $quiz->{$key} = $override->{$key}; } } return $quiz; } /** * Delete all the attempts belonging to a quiz. * * @param stdClass $quiz The quiz object. */ function quiz_delete_all_attempts($quiz) { global $CFG, $DB; require_once($CFG->dirroot . '/mod/quiz/locallib.php'); question_engine::delete_questions_usage_by_activities(new qubaids_for_quiz($quiz->id)); $DB->delete_records('quiz_attempts', ['quiz' => $quiz->id]); $DB->delete_records('quiz_grades', ['quiz' => $quiz->id]); } /** * Delete all the attempts belonging to a user in a particular quiz. * * @param \mod_quiz\quiz_settings $quiz The quiz object. * @param stdClass $user The user object. */ function quiz_delete_user_attempts($quiz, $user) { global $CFG, $DB; require_once($CFG->dirroot . '/mod/quiz/locallib.php'); question_engine::delete_questions_usage_by_activities(new qubaids_for_users_attempts( $quiz->get_quizid(), $user->id, 'all')); $params = [ 'quiz' => $quiz->get_quizid(), 'userid' => $user->id, ]; $DB->delete_records('quiz_attempts', $params); $DB->delete_records('quiz_grades', $params); } /** * Get the best current grade for a particular user in a quiz. * * @param stdClass $quiz the quiz settings. * @param int $userid the id of the user. * @return float the user's current grade for this quiz, or null if this user does * not have a grade on this quiz. */ function quiz_get_best_grade($quiz, $userid) { global $DB; $grade = $DB->get_field('quiz_grades', 'grade', ['quiz' => $quiz->id, 'userid' => $userid]); // Need to detect errors/no result, without catching 0 grades. if ($grade === false) { return null; } return $grade + 0; // Convert to number. } /** * Is this a graded quiz? If this method returns true, you can assume that * $quiz->grade and $quiz->sumgrades are non-zero (for example, if you want to * divide by them). * * @param stdClass $quiz a row from the quiz table. * @return bool whether this is a graded quiz. */ function quiz_has_grades($quiz) { return $quiz->grade >= grade_calculator::ALMOST_ZERO && $quiz->sumgrades >= grade_calculator::ALMOST_ZERO; } /** * Does this quiz allow multiple tries? * * @return bool */ function quiz_allows_multiple_tries($quiz) { $bt = question_engine::get_behaviour_type($quiz->preferredbehaviour); return $bt->allows_multiple_submitted_responses(); } /** * Return a small object with summary information about what a * user has done with a given particular instance of this module * Used for user activity reports. * $return->time = the time they did it * $return->info = a short text description * * @param stdClass $course * @param stdClass $user * @param stdClass $mod * @param stdClass $quiz * @return stdClass|null */ function quiz_user_outline($course, $user, $mod, $quiz) { global $DB, $CFG; require_once($CFG->libdir . '/gradelib.php'); $grades = grade_get_grades($course->id, 'mod', 'quiz', $quiz->id, $user->id); if (empty($grades->items[0]->grades)) { return null; } else { $grade = reset($grades->items[0]->grades); } $result = new stdClass(); // If the user can't see hidden grades, don't return that information. $gitem = grade_item::fetch(['id' => $grades->items[0]->id]); if (!$gitem->hidden || has_capability('moodle/grade:viewhidden', context_course::instance($course->id))) { $result->info = get_string('gradenoun') . ': ' . $grade->str_long_grade; } else { $result->info = get_string('gradenoun') . ': ' . get_string('hidden', 'grades'); } $result->time = grade_get_date_for_user_grade($grade, $user); return $result; } /** * Print a detailed representation of what a user has done with * a given particular instance of this module, for user activity reports. * * @param stdClass $course * @param stdClass $user * @param stdClass $mod * @param stdClass $quiz * @return bool */ function quiz_user_complete($course, $user, $mod, $quiz) { global $DB, $CFG, $OUTPUT; require_once($CFG->libdir . '/gradelib.php'); require_once($CFG->dirroot . '/mod/quiz/locallib.php'); $grades = grade_get_grades($course->id, 'mod', 'quiz', $quiz->id, $user->id); if (!empty($grades->items[0]->grades)) { $grade = reset($grades->items[0]->grades); // If the user can't see hidden grades, don't return that information. $gitem = grade_item::fetch(['id' => $grades->items[0]->id]); if (!$gitem->hidden || has_capability('moodle/grade:viewhidden', context_course::instance($course->id))) { echo $OUTPUT->container(get_string('gradenoun').': '.$grade->str_long_grade); if ($grade->str_feedback) { echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback); } } else { echo $OUTPUT->container(get_string('gradenoun') . ': ' . get_string('hidden', 'grades')); if ($grade->str_feedback) { echo $OUTPUT->container(get_string('feedback').': '.get_string('hidden', 'grades')); } } } if ($attempts = $DB->get_records('quiz_attempts', ['userid' => $user->id, 'quiz' => $quiz->id], 'attempt')) { foreach ($attempts as $attempt) { echo get_string('attempt', 'quiz', $attempt->attempt) . ': '; if ($attempt->state != quiz_attempt::FINISHED) { echo quiz_attempt_state_name($attempt->state); } else { if (!isset($gitem)) { if (!empty($grades->items[0]->grades)) { $gitem = grade_item::fetch(['id' => $grades->items[0]->id]); } else { $gitem = new stdClass(); $gitem->hidden = true; } } if (!$gitem->hidden || has_capability('moodle/grade:viewhidden', context_course::instance($course->id))) { echo quiz_format_grade($quiz, $attempt->sumgrades) . '/' . quiz_format_grade($quiz, $quiz->sumgrades); } else { echo get_string('hidden', 'grades'); } echo ' - '.userdate($attempt->timefinish).'<br />'; } } } else { print_string('noattempts', 'quiz'); } return true; } /** * @param int|array $quizids A quiz ID, or an array of quiz IDs. * @param int $userid the userid. * @param string $status 'all', 'finished' or 'unfinished' to control * @param bool $includepreviews * @return array of all the user's attempts at this quiz. Returns an empty * array if there are none. */ function quiz_get_user_attempts($quizids, $userid, $status = 'finished', $includepreviews = false) { global $DB; $params = []; switch ($status) { case 'all': $statuscondition = ''; break; case 'finished': $statuscondition = ' AND state IN (:state1, :state2)'; $params['state1'] = quiz_attempt::FINISHED; $params['state2'] = quiz_attempt::ABANDONED; break; case 'unfinished': $statuscondition = ' AND state IN (:state1, :state2)'; $params['state1'] = quiz_attempt::IN_PROGRESS; $params['state2'] = quiz_attempt::OVERDUE; break; } $quizids = (array) $quizids; list($insql, $inparams) = $DB->get_in_or_equal($quizids, SQL_PARAMS_NAMED); $params += $inparams; $params['userid'] = $userid; $previewclause = ''; if (!$includepreviews) { $previewclause = ' AND preview = 0'; } return $DB->get_records_select('quiz_attempts', "quiz $insql AND userid = :userid" . $previewclause . $statuscondition, $params, 'quiz, attempt ASC'); } /** * Return grade for given user or all users. * * @param int $quizid id of quiz * @param int $userid optional user id, 0 means all users * @return array array of grades, false if none. These are raw grades. They should * be processed with quiz_format_grade for display. */ function quiz_get_user_grades($quiz, $userid = 0) { global $CFG, $DB; $params = [$quiz->id]; $usertest = ''; if ($userid) { $params[] = $userid; $usertest = 'AND u.id = ?'; } return $DB->get_records_sql(" SELECT u.id, u.id AS userid, qg.grade AS rawgrade, qg.timemodified AS dategraded, MAX(qa.timefinish) AS datesubmitted FROM {user} u JOIN {quiz_grades} qg ON u.id = qg.userid JOIN {quiz_attempts} qa ON qa.quiz = qg.quiz AND qa.userid = u.id WHERE qg.quiz = ? $usertest GROUP BY u.id, qg.grade, qg.timemodified", $params); } /** * Round a grade to the correct number of decimal places, and format it for display. * * @param stdClass $quiz The quiz table row, only $quiz->decimalpoints is used. * @param float $grade The grade to round. * @return string */ function quiz_format_grade($quiz, $grade) { if (is_null($grade)) { return get_string('notyetgraded', 'quiz'); } return format_float($grade, $quiz->decimalpoints); } /** * Determine the correct number of decimal places required to format a grade. * * @param stdClass $quiz The quiz table row, only $quiz->decimalpoints and * ->questiondecimalpoints are used. * @return integer */ function quiz_get_grade_format($quiz) { if (empty($quiz->questiondecimalpoints)) { $quiz->questiondecimalpoints = -1; } if ($quiz->questiondecimalpoints == -1) { return $quiz->decimalpoints; } return $quiz->questiondecimalpoints; } /** * Round a grade to the correct number of decimal places, and format it for display. * * @param stdClass $quiz The quiz table row, only $quiz->decimalpoints is used. * @param float $grade The grade to round. * @return string */ function quiz_format_question_grade($quiz, $grade) { return format_float($grade, quiz_get_grade_format($quiz)); } /** * Update grades in central gradebook * * @category grade * @param stdClass $quiz the quiz settings. * @param int $userid specific user only, 0 means all users. * @param bool $nullifnone If a single user is specified and $nullifnone is true a grade item with a null rawgrade will be inserted */ function quiz_update_grades($quiz, $userid = 0, $nullifnone = true) { global $CFG, $DB; require_once($CFG->libdir . '/gradelib.php'); if ($quiz->grade == 0) { quiz_grade_item_update($quiz); } else if ($grades = quiz_get_user_grades($quiz, $userid)) { quiz_grade_item_update($quiz, $grades); } else if ($userid && $nullifnone) { $grade = new stdClass(); $grade->userid = $userid; $grade->rawgrade = null; quiz_grade_item_update($quiz, $grade); } else { quiz_grade_item_update($quiz); } } /** * Create or update the grade item for given quiz * * @category grade * @param stdClass $quiz object with extra cmidnumber * @param mixed $grades optional array/object of grade(s); 'reset' means reset grades in gradebook * @return int 0 if ok, error code otherwise */ function quiz_grade_item_update($quiz, $grades = null) { global $CFG, $OUTPUT; require_once($CFG->dirroot . '/mod/quiz/locallib.php'); require_once($CFG->libdir . '/gradelib.php'); if (property_exists($quiz, 'cmidnumber')) { // May not be always present. $params = ['itemname' => $quiz->name, 'idnumber' => $quiz->cmidnumber]; } else { $params = ['itemname' => $quiz->name]; } if ($quiz->grade > 0) { $params['gradetype'] = GRADE_TYPE_VALUE; $params['grademax'] = $quiz->grade; $params['grademin'] = 0; } else { $params['gradetype'] = GRADE_TYPE_NONE; } // What this is trying to do: // 1. If the quiz is set to not show grades while the quiz is still open, // and is set to show grades after the quiz is closed, then create the // grade_item with a show-after date that is the quiz close date. // 2. If the quiz is set to not show grades at either of those times, // create the grade_item as hidden. // 3. If the quiz is set to show grades, create the grade_item visible. $openreviewoptions = display_options::make_from_quiz($quiz, display_options::LATER_WHILE_OPEN); $closedreviewoptions = display_options::make_from_quiz($quiz, display_options::AFTER_CLOSE); if ($openreviewoptions->marks < question_display_options::MARK_AND_MAX && $closedreviewoptions->marks < question_display_options::MARK_AND_MAX) { $params['hidden'] = 1; } else if ($openreviewoptions->marks < question_display_options::MARK_AND_MAX && $closedreviewoptions->marks >= question_display_options::MARK_AND_MAX) { if ($quiz->timeclose) { $params['hidden'] = $quiz->timeclose; } else { $params['hidden'] = 1; } } else { // Either // a) both open and closed enabled // b) open enabled, closed disabled - we can not "hide after", // grades are kept visible even after closing. $params['hidden'] = 0; } if (!$params['hidden']) { // If the grade item is not hidden by the quiz logic, then we need to // hide it if the quiz is hidden from students. if (property_exists($quiz, 'visible')) { // Saving the quiz form, and cm not yet updated in the database. $params['hidden'] = !$quiz->visible; } else { $cm = get_coursemodule_from_instance('quiz', $quiz->id); $params['hidden'] = !$cm->visible; } } if ($grades === 'reset') { $params['reset'] = true; $grades = null; } $gradebook_grades = grade_get_grades($quiz->course, 'mod', 'quiz', $quiz->id); if (!empty($gradebook_grades->items)) { $grade_item = $gradebook_grades->items[0]; if ($grade_item->locked) { // NOTE: this is an extremely nasty hack! It is not a bug if this confirmation fails badly. --skodak. $confirm_regrade = optional_param('confirm_regrade', 0, PARAM_INT); if (!$confirm_regrade) { if (!AJAX_SCRIPT) { $message = get_string('gradeitemislocked', 'grades'); $back_link = $CFG->wwwroot . '/mod/quiz/report.php?q=' . $quiz->id . '&amp;mode=overview'; $regrade_link = qualified_me() . '&amp;confirm_regrade=1'; echo $OUTPUT->box_start('generalbox', 'notice'); echo '<p>'. $message .'</p>'; echo $OUTPUT->container_start('buttons'); echo $OUTPUT->single_button($regrade_link, get_string('regradeanyway', 'grades')); echo $OUTPUT->single_button($back_link, get_string('cancel')); echo $OUTPUT->container_end(); echo $OUTPUT->box_end(); } return GRADE_UPDATE_ITEM_LOCKED; } } } return grade_update('mod/quiz', $quiz->course, 'mod', 'quiz', $quiz->id, 0, $grades, $params); } /** * Delete grade item for given quiz * * @category grade * @param stdClass $quiz object * @return int */ function quiz_grade_item_delete($quiz) { global $CFG; require_once($CFG->libdir . '/gradelib.php'); return grade_update('mod/quiz', $quiz->course, 'mod', 'quiz', $quiz->id, 0, null, ['deleted' => 1]); } /** * This standard function will check all instances of this module * and make sure there are up-to-date events created for each of them. * If courseid = 0, then every quiz event in the site is checked, else * only quiz events belonging to the course specified are checked. * This function is used, in its new format, by restore_refresh_events() * * @param int $courseid * @param int|stdClass $instance Quiz module instance or ID. * @param int|stdClass $cm Course module object or ID (not used in this module). * @return bool */ function quiz_refresh_events($courseid = 0, $instance = null, $cm = null) { global $DB; // If we have instance information then we can just update the one event instead of updating all events. if (isset($instance)) { if (!is_object($instance)) { $instance = $DB->get_record('quiz', ['id' => $instance], '*', MUST_EXIST); } quiz_update_events($instance); return true; } if ($courseid == 0) { if (!$quizzes = $DB->get_records('quiz')) { return true; } } else { if (!$quizzes = $DB->get_records('quiz', ['course' => $courseid])) { return true; } } foreach ($quizzes as $quiz) { quiz_update_events($quiz); } return true; } /** * Returns all quiz graded users since a given time for specified quiz */ function quiz_get_recent_mod_activity(&$activities, &$index, $timestart, $courseid, $cmid, $userid = 0, $groupid = 0) { global $CFG, $USER, $DB; require_once($CFG->dirroot . '/mod/quiz/locallib.php'); $course = get_course($courseid); $modinfo = get_fast_modinfo($course); $cm = $modinfo->cms[$cmid]; $quiz = $DB->get_record('quiz', ['id' => $cm->instance]); if ($userid) { $userselect = "AND u.id = :userid"; $params['userid'] = $userid; } else { $userselect = ''; } if ($groupid) { $groupselect = 'AND gm.groupid = :groupid'; $groupjoin = 'JOIN {groups_members} gm ON gm.userid=u.id'; $params['groupid'] = $groupid; } else { $groupselect = ''; $groupjoin = ''; } $params['timestart'] = $timestart; $params['quizid'] = $quiz->id; $userfieldsapi = \core_user\fields::for_userpic(); $ufields = $userfieldsapi->get_sql('u', false, '', 'useridagain', false)->selects; if (!$attempts = $DB->get_records_sql(" SELECT qa.*, {$ufields} FROM {quiz_attempts} qa JOIN {user} u ON u.id = qa.userid $groupjoin WHERE qa.timefinish > :timestart AND qa.quiz = :quizid AND qa.preview = 0 $userselect $groupselect ORDER BY qa.timefinish ASC", $params)) { return; } $context = context_module::instance($cm->id); $accessallgroups = has_capability('moodle/site:accessallgroups', $context); $viewfullnames = has_capability('moodle/site:viewfullnames', $context); $grader = has_capability('mod/quiz:viewreports', $context); $groupmode = groups_get_activity_groupmode($cm, $course); $usersgroups = null; $aname = format_string($cm->name, true); foreach ($attempts as $attempt) { if ($attempt->userid != $USER->id) { if (!$grader) { // Grade permission required. continue; } if ($groupmode == SEPARATEGROUPS and !$accessallgroups) { $usersgroups = groups_get_all_groups($course->id, $attempt->userid, $cm->groupingid); $usersgroups = array_keys($usersgroups); if (!array_intersect($usersgroups, $modinfo->get_groups($cm->groupingid))) { continue; } } } $options = quiz_get_review_options($quiz, $attempt, $context); $tmpactivity = new stdClass(); $tmpactivity->type = 'quiz'; $tmpactivity->cmid = $cm->id; $tmpactivity->name = $aname; $tmpactivity->sectionnum = $cm->sectionnum; $tmpactivity->timestamp = $attempt->timefinish; $tmpactivity->content = new stdClass(); $tmpactivity->content->attemptid = $attempt->id; $tmpactivity->content->attempt = $attempt->attempt; if (quiz_has_grades($quiz) && $options->marks >= question_display_options::MARK_AND_MAX) { $tmpactivity->content->sumgrades = quiz_format_grade($quiz, $attempt->sumgrades); $tmpactivity->content->maxgrade = quiz_format_grade($quiz, $quiz->sumgrades); } else { $tmpactivity->content->sumgrades = null; $tmpactivity->content->maxgrade = null; } $tmpactivity->user = user_picture::unalias($attempt, null, 'useridagain'); $tmpactivity->user->fullname = fullname($tmpactivity->user, $viewfullnames); $activities[$index++] = $tmpactivity; } } function quiz_print_recent_mod_activity($activity, $courseid, $detail, $modnames) { global $CFG, $OUTPUT; echo '<table border="0" cellpadding="3" cellspacing="0" class="forum-recent">'; echo '<tr><td class="userpicture" valign="top">'; echo $OUTPUT->user_picture($activity->user, ['courseid' => $courseid]); echo '</td><td>'; if ($detail) { $modname = $modnames[$activity->type]; echo '<div class="title">'; echo $OUTPUT->image_icon('monologo', $modname, $activity->type); echo '<a href="' . $CFG->wwwroot . '/mod/quiz/view.php?id=' . $activity->cmid . '">' . $activity->name . '</a>'; echo '</div>'; } echo '<div class="grade">'; echo get_string('attempt', 'quiz', $activity->content->attempt); if (isset($activity->content->maxgrade)) { $grades = $activity->content->sumgrades . ' / ' . $activity->content->maxgrade; echo ': (<a href="' . $CFG->wwwroot . '/mod/quiz/review.php?attempt=' . $activity->content->attemptid . '">' . $grades . '</a>)'; } echo '</div>'; echo '<div class="user">'; echo '<a href="' . $CFG->wwwroot . '/user/view.php?id=' . $activity->user->id . '&amp;course=' . $courseid . '">' . $activity->user->fullname . '</a> - ' . userdate($activity->timestamp); echo '</div>'; echo '</td></tr></table>'; return; } /** * Pre-process the quiz options form data, making any necessary adjustments. * Called by add/update instance in this file. * * @param stdClass $quiz The variables set on the form. */ function quiz_process_options($quiz) { global $CFG; require_once($CFG->dirroot . '/mod/quiz/locallib.php'); require_once($CFG->libdir . '/questionlib.php'); $quiz->timemodified = time(); // Quiz name. if (!empty($quiz->name)) { $quiz->name = trim($quiz->name); } // Password field - different in form to stop browsers that remember passwords // getting confused. $quiz->password = $quiz->quizpassword; unset($quiz->quizpassword); // Quiz feedback. if (isset($quiz->feedbacktext)) { // Clean up the boundary text. for ($i = 0; $i < count($quiz->feedbacktext); $i += 1) { if (empty($quiz->feedbacktext[$i]['text'])) { $quiz->feedbacktext[$i]['text'] = ''; } else { $quiz->feedbacktext[$i]['text'] = trim($quiz->feedbacktext[$i]['text']); } } // Check the boundary value is a number or a percentage, and in range. $i = 0; while (!empty($quiz->feedbackboundaries[$i])) { $boundary = trim($quiz->feedbackboundaries[$i]); if (!is_numeric($boundary)) { if (strlen($boundary) > 0 && $boundary[strlen($boundary) - 1] == '%') { $boundary = trim(substr($boundary, 0, -1)); if (is_numeric($boundary)) { $boundary = $boundary * $quiz->grade / 100.0; } else { return get_string('feedbackerrorboundaryformat', 'quiz', $i + 1); } } } if ($boundary <= 0 || $boundary >= $quiz->grade) { return get_string('feedbackerrorboundaryoutofrange', 'quiz', $i + 1); } if ($i > 0 && $boundary >= $quiz->feedbackboundaries[$i - 1]) { return get_string('feedbackerrororder', 'quiz', $i + 1); } $quiz->feedbackboundaries[$i] = $boundary; $i += 1; } $numboundaries = $i; // Check there is nothing in the remaining unused fields. if (!empty($quiz->feedbackboundaries)) { for ($i = $numboundaries; $i < count($quiz->feedbackboundaries); $i += 1) { if (!empty($quiz->feedbackboundaries[$i]) && trim($quiz->feedbackboundaries[$i]) != '') { return get_string('feedbackerrorjunkinboundary', 'quiz', $i + 1); } } } for ($i = $numboundaries + 1; $i < count($quiz->feedbacktext); $i += 1) { if (!empty($quiz->feedbacktext[$i]['text']) && trim($quiz->feedbacktext[$i]['text']) != '') { return get_string('feedbackerrorjunkinfeedback', 'quiz', $i + 1); } } // Needs to be bigger than $quiz->grade because of '<' test in quiz_feedback_for_grade(). $quiz->feedbackboundaries[-1] = $quiz->grade + 1; $quiz->feedbackboundaries[$numboundaries] = 0; $quiz->feedbackboundarycount = $numboundaries; } else { $quiz->feedbackboundarycount = -1; } // Combing the individual settings into the review columns. $quiz->reviewattempt = quiz_review_option_form_to_db($quiz, 'attempt'); $quiz->reviewcorrectness = quiz_review_option_form_to_db($quiz, 'correctness');
> $quiz->reviewmaxmarks = quiz_review_option_form_to_db($quiz, 'maxmarks');
$quiz->reviewmarks = quiz_review_option_form_to_db($quiz, 'marks'); $quiz->reviewspecificfeedback = quiz_review_option_form_to_db($quiz, 'specificfeedback'); $quiz->reviewgeneralfeedback = quiz_review_option_form_to_db($quiz, 'generalfeedback'); $quiz->reviewrightanswer = quiz_review_option_form_to_db($quiz, 'rightanswer'); $quiz->reviewoverallfeedback = quiz_review_option_form_to_db($quiz, 'overallfeedback'); $quiz->reviewattempt |= display_options::DURING; $quiz->reviewoverallfeedback &= ~display_options::DURING; // Ensure that disabled checkboxes in completion settings are set to 0. // But only if the completion settinsg are unlocked. if (!empty($quiz->completionunlocked)) { if (empty($quiz->completionusegrade)) { $quiz->completionpassgrade = 0; } if (empty($quiz->completionpassgrade)) { $quiz->completionattemptsexhausted = 0; } if (empty($quiz->completionminattemptsenabled)) { $quiz->completionminattempts = 0; } } } /** * Helper function for {@link quiz_process_options()}. * @param stdClass $fromform the sumbitted form date. * @param string $field one of the review option field names. */ function quiz_review_option_form_to_db($fromform, $field) { static $times = [ 'during' => display_options::DURING, 'immediately' => display_options::IMMEDIATELY_AFTER, 'open' => display_options::LATER_WHILE_OPEN, 'closed' => display_options::AFTER_CLOSE, ]; $review = 0; foreach ($times as $whenname => $when) { $fieldname = $field . $whenname; if (!empty($fromform->$fieldname)) { $review |= $when; unset($fromform->$fieldname); } } return $review; } /** * In place editable callback for slot displaynumber. * * @param string $itemtype slotdisplarnumber * @param int $itemid the id of the slot in the quiz_slots table * @param string $newvalue the new value for displaynumber field for a given slot in the quiz_slots table * @return \core\output\inplace_editable|void */ function mod_quiz_inplace_editable(string $itemtype, int $itemid, string $newvalue): \core\output\inplace_editable { global $DB; if ($itemtype === 'slotdisplaynumber') { // Work out which quiz and slot this is. $slot = $DB->get_record('quiz_slots', ['id' => $itemid], '*', MUST_EXIST); $quizobj = quiz_settings::create($slot->quizid); // Validate the context, and check the required capability. $context = $quizobj->get_context(); \core_external\external_api::validate_context($context); require_capability('mod/quiz:manage', $context); // Update the value - truncating the size of the DB column. $structure = $quizobj->get_structure(); $structure->update_slot_display_number($itemid, core_text::substr($newvalue, 0, 16)); // Prepare the element for the output. return $structure->make_slot_display_number_in_place_editable($itemid, $context); } } /** * This function is called at the end of quiz_add_instance * and quiz_update_instance, to do the common processing. * * @param stdClass $quiz the quiz object. */ function quiz_after_add_or_update($quiz) { global $DB; $cmid = $quiz->coursemodule; // We need to use context now, so we need to make sure all needed info is already in db. $DB->set_field('course_modules', 'instance', $quiz->id, ['id' => $cmid]); $context = context_module::instance($cmid); // Save the feedback. $DB->delete_records('quiz_feedback', ['quizid' => $quiz->id]); for ($i = 0; $i <= $quiz->feedbackboundarycount; $i++) { $feedback = new stdClass(); $feedback->quizid = $quiz->id; $feedback->feedbacktext = $quiz->feedbacktext[$i]['text']; $feedback->feedbacktextformat = $quiz->feedbacktext[$i]['format']; $feedback->mingrade = $quiz->feedbackboundaries[$i]; $feedback->maxgrade = $quiz->feedbackboundaries[$i - 1]; $feedback->id = $DB->insert_record('quiz_feedback', $feedback); $feedbacktext = file_save_draft_area_files((int)$quiz->feedbacktext[$i]['itemid'], $context->id, 'mod_quiz', 'feedback', $feedback->id, ['subdirs' => false, 'maxfiles' => -1, 'maxbytes' => 0], $quiz->feedbacktext[$i]['text']); $DB->set_field('quiz_feedback', 'feedbacktext', $feedbacktext, ['id' => $feedback->id]); } // Store any settings belonging to the access rules. access_manager::save_settings($quiz); // Update the events relating to this quiz. quiz_update_events($quiz); $completionexpected = (!empty($quiz->completionexpected)) ? $quiz->completionexpected : null; \core_completion\api::update_completion_date_event($quiz->coursemodule, 'quiz', $quiz->id, $completionexpected); // Update related grade item. quiz_grade_item_update($quiz); } /** * This function updates the events associated to the quiz. * If $override is non-zero, then it updates only the events * associated with the specified override. * * @param stdClass $quiz the quiz object. * @param stdClass|null $override limit to a specific override */ function quiz_update_events($quiz, $override = null) { global $DB; // Load the old events relating to this quiz. $conds = ['modulename' => 'quiz', 'instance' => $quiz->id]; if (!empty($override)) { // Only load events for this override. if (isset($override->userid)) { $conds['userid'] = $override->userid; } else { $conds['groupid'] = $override->groupid; } } $oldevents = $DB->get_records('event', $conds, 'id ASC'); // Now make a to-do list of all that needs to be updated. if (empty($override)) { // We are updating the primary settings for the quiz, so we need to add all the overrides. $overrides = $DB->get_records('quiz_overrides', ['quiz' => $quiz->id], 'id ASC'); // It is necessary to add an empty stdClass to the beginning of the array as the $oldevents // list contains the original (non-override) event for the module. If this is not included // the logic below will end up updating the wrong row when we try to reconcile this $overrides // list against the $oldevents list. array_unshift($overrides, new stdClass()); } else { // Just do the one override. $overrides = [$override]; } // Get group override priorities. $grouppriorities = quiz_get_group_override_priorities($quiz->id); foreach ($overrides as $current) { $groupid = isset($current->groupid)? $current->groupid : 0; $userid = isset($current->userid)? $current->userid : 0; $timeopen = isset($current->timeopen)? $current->timeopen : $quiz->timeopen; $timeclose = isset($current->timeclose)? $current->timeclose : $quiz->timeclose; // Only add open/close events for an override if they differ from the quiz default. $addopen = empty($current->id) || !empty($current->timeopen); $addclose = empty($current->id) || !empty($current->timeclose); if (!empty($quiz->coursemodule)) { $cmid = $quiz->coursemodule; } else { $cmid = get_coursemodule_from_instance('quiz', $quiz->id, $quiz->course)->id; } $event = new stdClass(); $event->type = !$timeclose ? CALENDAR_EVENT_TYPE_ACTION : CALENDAR_EVENT_TYPE_STANDARD; $event->description = format_module_intro('quiz', $quiz, $cmid, false); $event->format = FORMAT_HTML; // Events module won't show user events when the courseid is nonzero. $event->courseid = ($userid) ? 0 : $quiz->course; $event->groupid = $groupid; $event->userid = $userid; $event->modulename = 'quiz'; $event->instance = $quiz->id; $event->timestart = $timeopen; $event->timeduration = max($timeclose - $timeopen, 0); $event->timesort = $timeopen; $event->visible = instance_is_visible('quiz', $quiz); $event->eventtype = QUIZ_EVENT_TYPE_OPEN; $event->priority = null; // Determine the event name and priority. if ($groupid) { // Group override event. $params = new stdClass(); $params->quiz = $quiz->name; $params->group = groups_get_group_name($groupid); if ($params->group === false) { // Group doesn't exist, just skip it. continue; } $eventname = get_string('overridegroupeventname', 'quiz', $params); // Set group override priority. if ($grouppriorities !== null) { $openpriorities = $grouppriorities['open']; if (isset($openpriorities[$timeopen])) { $event->priority = $openpriorities[$timeopen]; } } } else if ($userid) { // User override event. $params = new stdClass(); $params->quiz = $quiz->name; $eventname = get_string('overrideusereventname', 'quiz', $params); // Set user override priority. $event->priority = CALENDAR_EVENT_USER_OVERRIDE_PRIORITY; } else { // The parent event. $eventname = $quiz->name; } if ($addopen or $addclose) { // Separate start and end events. $event->timeduration = 0; if ($timeopen && $addopen) { if ($oldevent = array_shift($oldevents)) { $event->id = $oldevent->id; } else { unset($event->id); } $event->name = get_string('quizeventopens', 'quiz', $eventname); // The method calendar_event::create will reuse a db record if the id field is set. calendar_event::create($event, false); } if ($timeclose && $addclose) { if ($oldevent = array_shift($oldevents)) { $event->id = $oldevent->id; } else { unset($event->id); } $event->type = CALENDAR_EVENT_TYPE_ACTION; $event->name = get_string('quizeventcloses', 'quiz', $eventname); $event->timestart = $timeclose; $event->timesort = $timeclose; $event->eventtype = QUIZ_EVENT_TYPE_CLOSE; if ($groupid && $grouppriorities !== null) { $closepriorities = $grouppriorities['close']; if (isset($closepriorities[$timeclose])) { $event->priority = $closepriorities[$timeclose]; } } calendar_event::create($event, false); } } } // Delete any leftover events. foreach ($oldevents as $badevent) { $badevent = calendar_event::load($badevent); $badevent->delete(); } } /** * Calculates the priorities of timeopen and timeclose values for group overrides for a quiz. * * @param int $quizid The quiz ID. * @return array|null Array of group override priorities for open and close times. Null if there are no group overrides. */ function quiz_get_group_override_priorities($quizid) { global $DB; // Fetch group overrides. $where = 'quiz = :quiz AND groupid IS NOT NULL'; $params = ['quiz' => $quizid]; $overrides = $DB->get_records_select('quiz_overrides', $where, $params, '', 'id, timeopen, timeclose'); if (!$overrides) { return null; } $grouptimeopen = []; $grouptimeclose = []; foreach ($overrides as $override) { if ($override->timeopen !== null && !in_array($override->timeopen, $grouptimeopen)) { $grouptimeopen[] = $override->timeopen; } if ($override->timeclose !== null && !in_array($override->timeclose, $grouptimeclose)) { $grouptimeclose[] = $override->timeclose; } } // Sort open times in ascending manner. The earlier open time gets higher priority. sort($grouptimeopen); // Set priorities. $opengrouppriorities = []; $openpriority = 1; foreach ($grouptimeopen as $timeopen) { $opengrouppriorities[$timeopen] = $openpriority++; } // Sort close times in descending manner. The later close time gets higher priority. rsort($grouptimeclose); // Set priorities. $closegrouppriorities = []; $closepriority = 1; foreach ($grouptimeclose as $timeclose) { $closegrouppriorities[$timeclose] = $closepriority++; } return [ 'open' => $opengrouppriorities, 'close' => $closegrouppriorities ]; } /** * List the actions that correspond to a view of this module. * This is used by the participation report. * * Note: This is not used by new logging system. Event with * crud = 'r' and edulevel = LEVEL_PARTICIPATING will * be considered as view action. * * @return array */ function quiz_get_view_actions() { return ['view', 'view all', 'report', 'review']; } /** * List the actions that correspond to a post of this module. * This is used by the participation report. * * Note: This is not used by new logging system. Event with * crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING * will be considered as post action. * * @return array */ function quiz_get_post_actions() { return ['attempt', 'close attempt', 'preview', 'editquestions', 'delete attempt', 'manualgrade']; } /** * Standard callback used by questions_in_use. * * @param array $questionids of question ids. * @return bool whether any of these questions are used by any instance of this module. */ function quiz_questions_in_use($questionids) { return question_engine::questions_in_use($questionids, new qubaid_join('{quiz_attempts} quiza', 'quiza.uniqueid', 'quiza.preview = 0')); } /** * Implementation of the function for printing the form elements that control * whether the course reset functionality affects the quiz. * * @param MoodleQuickForm $mform the course reset form that is being built. */ function quiz_reset_course_form_definition($mform) { $mform->addElement('header', 'quizheader', get_string('modulenameplural', 'quiz')); $mform->addElement('advcheckbox', 'reset_quiz_attempts', get_string('removeallquizattempts', 'quiz')); $mform->addElement('advcheckbox', 'reset_quiz_user_overrides', get_string('removealluseroverrides', 'quiz')); $mform->addElement('advcheckbox', 'reset_quiz_group_overrides', get_string('removeallgroupoverrides', 'quiz')); } /** * Course reset form defaults. * @return array the defaults. */ function quiz_reset_course_form_defaults($course) { return ['reset_quiz_attempts' => 1, 'reset_quiz_group_overrides' => 1, 'reset_quiz_user_overrides' => 1]; } /** * Removes all grades from gradebook * * @param int $courseid * @param string optional type */ function quiz_reset_gradebook($courseid, $type='') { global $CFG, $DB; $quizzes = $DB->get_records_sql(" SELECT q.*, cm.idnumber as cmidnumber, q.course as courseid FROM {modules} m JOIN {course_modules} cm ON m.id = cm.module JOIN {quiz} q ON cm.instance = q.id WHERE m.name = 'quiz' AND cm.course = ?", [$courseid]); foreach ($quizzes as $quiz) { quiz_grade_item_update($quiz, 'reset'); } } /** * Actual implementation of the reset course functionality, delete all the * quiz attempts for course $data->courseid, if $data->reset_quiz_attempts is * set and true. * * Also, move the quiz open and close dates, if the course start date is changing. * * @param stdClass $data the data submitted from the reset course. * @return array status array */ function quiz_reset_userdata($data) { global $CFG, $DB; require_once($CFG->libdir . '/questionlib.php'); $componentstr = get_string('modulenameplural', 'quiz'); $status = []; // Delete attempts. if (!empty($data->reset_quiz_attempts)) { question_engine::delete_questions_usage_by_activities(new qubaid_join( '{quiz_attempts} quiza JOIN {quiz} quiz ON quiza.quiz = quiz.id', 'quiza.uniqueid', 'quiz.course = :quizcourseid', ['quizcourseid' => $data->courseid])); $DB->delete_records_select('quiz_attempts', 'quiz IN (SELECT id FROM {quiz} WHERE course = ?)', [$data->courseid]); $status[] = [ 'component' => $componentstr, 'item' => get_string('attemptsdeleted', 'quiz'), 'error' => false]; // Remove all grades from gradebook. $DB->delete_records_select('quiz_grades', 'quiz IN (SELECT id FROM {quiz} WHERE course = ?)', [$data->courseid]); if (empty($data->reset_gradebook_grades)) { quiz_reset_gradebook($data->courseid); } $status[] = [ 'component' => $componentstr, 'item' => get_string('gradesdeleted', 'quiz'), 'error' => false]; } $purgeoverrides = false; // Remove user overrides. if (!empty($data->reset_quiz_user_overrides)) { $DB->delete_records_select('quiz_overrides', 'quiz IN (SELECT id FROM {quiz} WHERE course = ?) AND userid IS NOT NULL', [$data->courseid]); $status[] = [ 'component' => $componentstr, 'item' => get_string('useroverridesdeleted', 'quiz'), 'error' => false]; $purgeoverrides = true; } // Remove group overrides. if (!empty($data->reset_quiz_group_overrides)) { $DB->delete_records_select('quiz_overrides', 'quiz IN (SELECT id FROM {quiz} WHERE course = ?) AND groupid IS NOT NULL', [$data->courseid]); $status[] = [ 'component' => $componentstr, 'item' => get_string('groupoverridesdeleted', 'quiz'), 'error' => false]; $purgeoverrides = true; } // Updating dates - shift may be negative too. if ($data->timeshift) { $DB->execute("UPDATE {quiz_overrides} SET timeopen = timeopen + ? WHERE quiz IN (SELECT id FROM {quiz} WHERE course = ?) AND timeopen <> 0", [$data->timeshift, $data->courseid]); $DB->execute("UPDATE {quiz_overrides} SET timeclose = timeclose + ? WHERE quiz IN (SELECT id FROM {quiz} WHERE course = ?) AND timeclose <> 0", [$data->timeshift, $data->courseid]); $purgeoverrides = true; // Any changes to the list of dates that needs to be rolled should be same during course restore and course reset. // See MDL-9367. shift_course_mod_dates('quiz', ['timeopen', 'timeclose'], $data->timeshift, $data->courseid); $status[] = [ 'component' => $componentstr, 'item' => get_string('openclosedatesupdated', 'quiz'), 'error' => false]; } if ($purgeoverrides) { cache::make('mod_quiz', 'overrides')->purge(); } return $status; } /** * Return a textual summary of the number of attempts that have been made at a particular quiz, * returns '' if no attempts have been made yet, unless $returnzero is passed as true. * * @param stdClass $quiz the quiz object. Only $quiz->id is used at the moment. * @param stdClass $cm the cm object. Only $cm->course, $cm->groupmode and * $cm->groupingid fields are used at the moment. * @param bool $returnzero if false (default), when no attempts have been * made '' is returned instead of 'Attempts: 0'. * @param int $currentgroup if there is a concept of current group where this method is being called * (e.g. a report) pass it in here. Default 0 which means no current group. * @return string a string like "Attempts: 123", "Attemtps 123 (45 from your groups)" or * "Attemtps 123 (45 from this group)". */ function quiz_num_attempt_summary($quiz, $cm, $returnzero = false, $currentgroup = 0) { global $DB, $USER; $numattempts = $DB->count_records('quiz_attempts', ['quiz' => $quiz->id, 'preview' => 0]); if ($numattempts || $returnzero) { if (groups_get_activity_groupmode($cm)) { $a = new stdClass(); $a->total = $numattempts; if ($currentgroup) { $a->group = $DB->count_records_sql('SELECT COUNT(DISTINCT qa.id) FROM ' . '{quiz_attempts} qa JOIN ' . '{groups_members} gm ON qa.userid = gm.userid ' . 'WHERE quiz = ? AND preview = 0 AND groupid = ?', [$quiz->id, $currentgroup]); return get_string('attemptsnumthisgroup', 'quiz', $a); } else if ($groups = groups_get_all_groups($cm->course, $USER->id, $cm->groupingid)) { list($usql, $params) = $DB->get_in_or_equal(array_keys($groups)); $a->group = $DB->count_records_sql('SELECT COUNT(DISTINCT qa.id) FROM ' . '{quiz_attempts} qa JOIN ' . '{groups_members} gm ON qa.userid = gm.userid ' . 'WHERE quiz = ? AND preview = 0 AND ' . "groupid $usql", array_merge([$quiz->id], $params)); return get_string('attemptsnumyourgroups', 'quiz', $a); } } return get_string('attemptsnum', 'quiz', $numattempts); } return ''; } /** * Returns the same as {@link quiz_num_attempt_summary()} but wrapped in a link * to the quiz reports. * * @param stdClass $quiz the quiz object. Only $quiz->id is used at the moment. * @param stdClass $cm the cm object. Only $cm->course, $cm->groupmode and * $cm->groupingid fields are used at the moment. * @param stdClass $context the quiz context. * @param bool $returnzero if false (default), when no attempts have been made * '' is returned instead of 'Attempts: 0'. * @param int $currentgroup if there is a concept of current group where this method is being called * (e.g. a report) pass it in here. Default 0 which means no current group. * @return string HTML fragment for the link. */ function quiz_attempt_summary_link_to_reports($quiz, $cm, $context, $returnzero = false, $currentgroup = 0) { global $PAGE; return $PAGE->get_renderer('mod_quiz')->quiz_attempt_summary_link_to_reports( $quiz, $cm, $context, $returnzero, $currentgroup); } /** * @param string $feature FEATURE_xx constant for requested feature * @return mixed True if module supports feature, false if not, null if doesn't know or string for the module purpose. */ function quiz_supports($feature) { switch($feature) { case FEATURE_GROUPS: return true; case FEATURE_GROUPINGS: return true; case FEATURE_MOD_INTRO: return true; case FEATURE_COMPLETION_TRACKS_VIEWS: return true; case FEATURE_COMPLETION_HAS_RULES: return true; case FEATURE_GRADE_HAS_GRADE: return true; case FEATURE_GRADE_OUTCOMES: return true; case FEATURE_BACKUP_MOODLE2: return true; case FEATURE_SHOW_DESCRIPTION: return true; case FEATURE_CONTROLS_GRADE_VISIBILITY: return true; case FEATURE_USES_QUESTIONS: return true; case FEATURE_PLAGIARISM: return true; case FEATURE_MOD_PURPOSE: return MOD_PURPOSE_ASSESSMENT; default: return null; } } /** * @return array all other caps used in module */ function quiz_get_extra_capabilities() { global $CFG; require_once($CFG->libdir . '/questionlib.php'); return question_get_all_capabilities(); } /** * This function extends the settings navigation block for the site. * * It is safe to rely on PAGE here as we will only ever be within the module * context when this is called * * @param settings_navigation $settings * @param navigation_node $quiznode * @return void */ function quiz_extend_settings_navigation(settings_navigation $settings, navigation_node $quiznode) { global $CFG; // Require {@link questionlib.php} // Included here as we only ever want to include this file if we really need to. require_once($CFG->libdir . '/questionlib.php'); // We want to add these new nodes after the Edit settings node, and before the // Locally assigned roles node. Of course, both of those are controlled by capabilities. $keys = $quiznode->get_children_key_list(); $beforekey = null; $i = array_search('modedit', $keys); if ($i === false and array_key_exists(0, $keys)) { $beforekey = $keys[0]; } else if (array_key_exists($i + 1, $keys)) { $beforekey = $keys[$i + 1]; } if (has_any_capability(['mod/quiz:manageoverrides', 'mod/quiz:viewoverrides'], $settings->get_page()->cm->context)) { $url = new moodle_url('/mod/quiz/overrides.php', ['cmid' => $settings->get_page()->cm->id, 'mode' => 'user']); $node = navigation_node::create(get_string('overrides', 'quiz'), $url, navigation_node::TYPE_SETTING, null, 'mod_quiz_useroverrides'); $settingsoverride = $quiznode->add_node($node, $beforekey); } if (has_capability('mod/quiz:manage', $settings->get_page()->cm->context)) { $node = navigation_node::create(get_string('questions', 'quiz'), new moodle_url('/mod/quiz/edit.php', ['cmid' => $settings->get_page()->cm->id]), navigation_node::TYPE_SETTING, null, 'mod_quiz_edit', new pix_icon('t/edit', '')); $quiznode->add_node($node, $beforekey); } if (has_capability('mod/quiz:preview', $settings->get_page()->cm->context)) { $url = new moodle_url('/mod/quiz/startattempt.php', ['cmid' => $settings->get_page()->cm->id, 'sesskey' => sesskey()]); $node = navigation_node::create(get_string('preview', 'quiz'), $url, navigation_node::TYPE_SETTING, null, 'mod_quiz_preview', new pix_icon('i/preview', '')); $previewnode = $quiznode->add_node($node, $beforekey); $previewnode->set_show_in_secondary_navigation(false); } question_extend_settings_navigation($quiznode, $settings->get_page()->cm->context)->trim_if_empty(); if (has_any_capability(['mod/quiz:viewreports', 'mod/quiz:grade'], $settings->get_page()->cm->context)) { require_once($CFG->dirroot . '/mod/quiz/report/reportlib.php'); $reportlist = quiz_report_list($settings->get_page()->cm->context); $url = new moodle_url('/mod/quiz/report.php', ['id' => $settings->get_page()->cm->id, 'mode' => reset($reportlist)]); $reportnode = $quiznode->add_node(navigation_node::create(get_string('results', 'quiz'), $url, navigation_node::TYPE_SETTING, null, 'quiz_report', new pix_icon('i/report', ''))); foreach ($reportlist as $report) { $url = new moodle_url('/mod/quiz/report.php', ['id' => $settings->get_page()->cm->id, 'mode' => $report]); $reportnode->add_node(navigation_node::create(get_string($report, 'quiz_'.$report), $url, navigation_node::TYPE_SETTING, null, 'quiz_report_' . $report, new pix_icon('i/item', ''))); } } } /** * Serves the quiz files. * * @package mod_quiz * @category files * @param stdClass $course course object * @param stdClass $cm course module object * @param stdClass $context context object * @param string $filearea file area * @param array $args extra arguments * @param bool $forcedownload whether or not force download * @param array $options additional options affecting the file serving * @return bool false if file not found, does not return if found - justsend the file */ function quiz_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options= []) { global $CFG, $DB; if ($context->contextlevel != CONTEXT_MODULE) { return false; } require_login($course, false, $cm); if (!$quiz = $DB->get_record('quiz', ['id' => $cm->instance])) { return false; } // The 'intro' area is served by pluginfile.php. $fileareas = ['feedback']; if (!in_array($filearea, $fileareas)) { return false; } $feedbackid = (int)array_shift($args); if (!$feedback = $DB->get_record('quiz_feedback', ['id' => $feedbackid])) { return false; } $fs = get_file_storage(); $relativepath = implode('/', $args); $fullpath = "/$context->id/mod_quiz/$filearea/$feedbackid/$relativepath"; if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) { return false; } send_stored_file($file, 0, 0, true, $options); } /** * Called via pluginfile.php -> question_pluginfile to serve files belonging to * a question in a question_attempt when that attempt is a quiz attempt. * * @package mod_quiz * @category files * @param stdClass $course course settings object * @param stdClass $context context object * @param string $component the name of the component we are serving files for. * @param string $filearea the name of the file area. * @param int $qubaid the attempt usage id. * @param int $slot the id of a question in this quiz attempt. * @param array $args the remaining bits of the file path. * @param bool $forcedownload whether the user must be forced to download the file. * @param array $options additional options affecting the file serving * @return bool false if file not found, does not return if found - justsend the file */ function quiz_question_pluginfile($course, $context, $component, $filearea, $qubaid, $slot, $args, $forcedownload, array $options= []) { global $CFG; require_once($CFG->dirroot . '/mod/quiz/locallib.php'); $attemptobj = quiz_attempt::create_from_usage_id($qubaid); require_login($attemptobj->get_course(), false, $attemptobj->get_cm()); if ($attemptobj->is_own_attempt() && !$attemptobj->is_finished()) { // In the middle of an attempt. if (!$attemptobj->is_preview_user()) { $attemptobj->require_capability('mod/quiz:attempt'); } $isreviewing = false; } else { // Reviewing an attempt. $attemptobj->check_review_capability(); $isreviewing = true; } if (!$attemptobj->check_file_access($slot, $isreviewing, $context->id, $component, $filearea, $args, $forcedownload)) { send_file_not_found(); } $fs = get_file_storage(); $relativepath = implode('/', $args); $fullpath = "/$context->id/$component/$filearea/$relativepath"; if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) { send_file_not_found(); } send_stored_file($file, 0, 0, $forcedownload, $options); } /** * Return a list of page types * @param string $pagetype current page type * @param stdClass $parentcontext Block's parent context * @param stdClass $currentcontext Current context of block */ function quiz_page_type_list($pagetype, $parentcontext, $currentcontext) { $modulepagetype = [ 'mod-quiz-*' => get_string('page-mod-quiz-x', 'quiz'), 'mod-quiz-view' => get_string('page-mod-quiz-view', 'quiz'), 'mod-quiz-attempt' => get_string('page-mod-quiz-attempt', 'quiz'), 'mod-quiz-summary' => get_string('page-mod-quiz-summary', 'quiz'), 'mod-quiz-review' => get_string('page-mod-quiz-review', 'quiz'), 'mod-quiz-edit' => get_string('page-mod-quiz-edit', 'quiz'), 'mod-quiz-report' => get_string('page-mod-quiz-report', 'quiz'), ]; return $modulepagetype; } /** * @return the options for quiz navigation. */ function quiz_get_navigation_options() { return [ QUIZ_NAVMETHOD_FREE => get_string('navmethod_free', 'quiz'), QUIZ_NAVMETHOD_SEQ => get_string('navmethod_seq', 'quiz') ]; } /** * Check if the module has any update that affects the current user since a given time. * * @param cm_info $cm course module data * @param int $from the time to check updates from * @param array $filter if we need to check only specific updates * @return stdClass an object with the different type of areas indicating if they were updated or not * @since Moodle 3.2 */ function quiz_check_updates_since(cm_info $cm, $from, $filter = []) { global $DB, $USER, $CFG; require_once($CFG->dirroot . '/mod/quiz/locallib.php'); $updates = course_check_module_updates_since($cm, $from, [], $filter); // Check if questions were updated. $updates->questions = (object) ['updated' => false]; $quizobj = quiz_settings::create($cm->instance, $USER->id); $quizobj->preload_questions();
< $quizobj->load_questions(); < $questionids = array_keys($quizobj->get_questions());
> $questionids = array_keys($quizobj->get_questions(null, false));
if (!empty($questionids)) { list($questionsql, $params) = $DB->get_in_or_equal($questionids, SQL_PARAMS_NAMED); $select = 'id ' . $questionsql . ' AND (timemodified > :time1 OR timecreated > :time2)'; $params['time1'] = $from; $params['time2'] = $from; $questions = $DB->get_records_select('question', $select, $params, '', 'id'); if (!empty($questions)) { $updates->questions->updated = true; $updates->questions->itemids = array_keys($questions); } } // Check for new attempts or grades. $updates->attempts = (object) ['updated' => false]; $updates->grades = (object) ['updated' => false]; $select = 'quiz = ? AND userid = ? AND timemodified > ?'; $params = [$cm->instance, $USER->id, $from]; $attempts = $DB->get_records_select('quiz_attempts', $select, $params, '', 'id'); if (!empty($attempts)) { $updates->attempts->updated = true; $updates->attempts->itemids = array_keys($attempts); } $grades = $DB->get_records_select('quiz_grades', $select, $params, '', 'id'); if (!empty($grades)) { $updates->grades->updated = true; $updates->grades->itemids = array_keys($grades); } // Now, teachers should see other students updates. if (has_capability('mod/quiz:viewreports', $cm->context)) { $select = 'quiz = ? AND timemodified > ?'; $params = [$cm->instance, $from]; if (groups_get_activity_groupmode($cm) == SEPARATEGROUPS) { $groupusers = array_keys(groups_get_activity_shared_group_members($cm)); if (empty($groupusers)) { return $updates; } list($insql, $inparams) = $DB->get_in_or_equal($groupusers); $select .= ' AND userid ' . $insql; $params = array_merge($params, $inparams); } $updates->userattempts = (object) ['updated' => false]; $attempts = $DB->get_records_select('quiz_attempts', $select, $params, '', 'id'); if (!empty($attempts)) { $updates->userattempts->updated = true; $updates->userattempts->itemids = array_keys($attempts); } $updates->usergrades = (object) ['updated' => false]; $grades = $DB->get_records_select('quiz_grades', $select, $params, '', 'id'); if (!empty($grades)) { $updates->usergrades->updated = true; $updates->usergrades->itemids = array_keys($grades); } } return $updates; } /** * Get icon mapping for font-awesome. */ function mod_quiz_get_fontawesome_icon_map() { return [ 'mod_quiz:navflagged' => 'fa-flag', ]; } /** * This function receives a calendar event and returns the action associated with it, or null if there is none. * * This is used by block_myoverview in order to display the event appropriately. If null is returned then the event * is not displayed on the block. * * @param calendar_event $event * @param \core_calendar\action_factory $factory * @param int $userid User id to use for all capability checks, etc. Set to 0 for current user (default). * @return \core_calendar\local\event\entities\action_interface|null */ function mod_quiz_core_calendar_provide_event_action(calendar_event $event, \core_calendar\action_factory $factory, int $userid = 0) { global $CFG, $USER; require_once($CFG->dirroot . '/mod/quiz/locallib.php'); if (empty($userid)) { $userid = $USER->id; } $cm = get_fast_modinfo($event->courseid, $userid)->instances['quiz'][$event->instance]; $quizobj = quiz_settings::create($cm->instance, $userid); $quiz = $quizobj->get_quiz(); // Check they have capabilities allowing them to view the quiz. if (!has_any_capability(['mod/quiz:reviewmyattempts', 'mod/quiz:attempt'], $quizobj->get_context(), $userid)) { return null; } $completion = new \completion_info($cm->get_course()); $completiondata = $completion->get_data($cm, false, $userid); if ($completiondata->completionstate != COMPLETION_INCOMPLETE) { return null; } quiz_update_effective_access($quiz, $userid); // Check if quiz is closed, if so don't display it. if (!empty($quiz->timeclose) && $quiz->timeclose <= time()) { return null; } if (!$quizobj->is_participant($userid)) { // If the user is not a participant then they have // no action to take. This will filter out the events for teachers. return null; } $attempts = quiz_get_user_attempts($quizobj->get_quizid(), $userid); if (!empty($attempts)) { // The student's last attempt is finished. return null; } $name = get_string('attemptquiznow', 'quiz'); $url = new \moodle_url('/mod/quiz/view.php', [ 'id' => $cm->id ]); $itemcount = 1; $actionable = true; // Check if the quiz is not currently actionable. if (!empty($quiz->timeopen) && $quiz->timeopen > time()) { $actionable = false; } return $factory->create_instance( $name, $url, $itemcount, $actionable ); } /** * Add a get_coursemodule_info function in case any quiz type wants to add 'extra' information * for the course (see resource). * * Given a course_module object, this function returns any "extra" information that may be needed * when printing this activity in a course listing. See get_array_of_activities() in course/lib.php. * * @param stdClass $coursemodule The coursemodule object (record). * @return cached_cm_info|false An object on information that the courses * will know about (most noticeably, an icon). */ function quiz_get_coursemodule_info($coursemodule) { global $DB; $dbparams = ['id' => $coursemodule->instance]; $fields = 'id, name, intro, introformat, completionattemptsexhausted, completionminattempts, timeopen, timeclose'; if (!$quiz = $DB->get_record('quiz', $dbparams, $fields)) { return false; } $result = new cached_cm_info(); $result->name = $quiz->name; if ($coursemodule->showdescription) { // Convert intro to html. Do not filter cached version, filters run at display time. $result->content = format_module_intro('quiz', $quiz, $coursemodule->id, false); } // Populate the custom completion rules as key => value pairs, but only if the completion mode is 'automatic'. if ($coursemodule->completion == COMPLETION_TRACKING_AUTOMATIC) { if ($quiz->completionattemptsexhausted) { $result->customdata['customcompletionrules']['completionpassorattemptsexhausted'] = [ 'completionpassgrade' => $coursemodule->completionpassgrade, 'completionattemptsexhausted' => $quiz->completionattemptsexhausted, ]; } else { $result->customdata['customcompletionrules']['completionpassorattemptsexhausted'] = []; } $result->customdata['customcompletionrules']['completionminattempts'] = $quiz->completionminattempts; } // Populate some other values that can be used in calendar or on dashboard. if ($quiz->timeopen) { $result->customdata['timeopen'] = $quiz->timeopen; } if ($quiz->timeclose) { $result->customdata['timeclose'] = $quiz->timeclose; } return $result; } /** * Sets dynamic information about a course module * * This function is called from cm_info when displaying the module * * @param cm_info $cm */ function mod_quiz_cm_info_dynamic(cm_info $cm) { global $USER; $cache = cache::make('mod_quiz', 'overrides'); $override = $cache->get("{$cm->instance}_u_{$USER->id}"); if (!$override) { $override = (object) [ 'timeopen' => null, 'timeclose' => null, ]; } // No need to look for group overrides if there are user overrides for both timeopen and timeclose. if (is_null($override->timeopen) || is_null($override->timeclose)) { $opens = []; $closes = []; $groupings = groups_get_user_groups($cm->course, $USER->id); foreach ($groupings[0] as $groupid) { $groupoverride = $cache->get("{$cm->instance}_g_{$groupid}"); if (isset($groupoverride->timeopen)) { $opens[] = $groupoverride->timeopen; } if (isset($groupoverride->timeclose)) { $closes[] = $groupoverride->timeclose; } } // If there is a user override for a setting, ignore the group override. if (is_null($override->timeopen) && count($opens)) { $override->timeopen = min($opens); } if (is_null($override->timeclose) && count($closes)) { if (in_array(0, $closes)) { $override->timeclose = 0; } else { $override->timeclose = max($closes); } } } // Populate some other values that can be used in calendar or on dashboard. if (!is_null($override->timeopen)) { $cm->override_customdata('timeopen', $override->timeopen); } if (!is_null($override->timeclose)) { $cm->override_customdata('timeclose', $override->timeclose); } } /** * Callback which returns human-readable strings describing the active completion custom rules for the module instance. * * @param cm_info|stdClass $cm object with fields ->completion and ->customdata['customcompletionrules'] * @return array $descriptions the array of descriptions for the custom rules. */ function mod_quiz_get_completion_active_rule_descriptions($cm) { // Values will be present in cm_info, and we assume these are up to date. if (empty($cm->customdata['customcompletionrules']) || $cm->completion != COMPLETION_TRACKING_AUTOMATIC) { return []; } $descriptions = []; $rules = $cm->customdata['customcompletionrules']; if (!empty($rules['completionpassorattemptsexhausted'])) { if (!empty($rules['completionpassorattemptsexhausted']['completionattemptsexhausted'])) { $descriptions[] = get_string('completionpassorattemptsexhausteddesc', 'quiz'); } } else { // Fallback. if (!empty($rules['completionattemptsexhausted'])) { $descriptions[] = get_string('completionpassorattemptsexhausteddesc', 'quiz'); } } if (!empty($rules['completionminattempts'])) { $descriptions[] = get_string('completionminattemptsdesc', 'quiz', $rules['completionminattempts']); } return $descriptions; } /** * Returns the min and max values for the timestart property of a quiz * activity event. * * The min and max values will be the timeopen and timeclose properties * of the quiz, respectively, if they are set. * * If either value isn't set then null will be returned instead to * indicate that there is no cutoff for that value. * * If the vent has no valid timestart range then [false, false] will * be returned. This is the case for overriden events. * * A minimum and maximum cutoff return value will look like: * [ * [1505704373, 'The date must be after this date'], * [1506741172, 'The date must be before this date'] * ] * * @throws \moodle_exception * @param \calendar_event $event The calendar event to get the time range for * @param stdClass $quiz The module instance to get the range from * @return array */ function mod_quiz_core_calendar_get_valid_event_timestart_range(\calendar_event $event, \stdClass $quiz) { global $CFG, $DB; require_once($CFG->dirroot . '/mod/quiz/locallib.php'); // Overrides do not have a valid timestart range. if (quiz_is_overriden_calendar_event($event)) { return [false, false]; } $mindate = null; $maxdate = null; if ($event->eventtype == QUIZ_EVENT_TYPE_OPEN) { if (!empty($quiz->timeclose)) { $maxdate = [ $quiz->timeclose, get_string('openafterclose', 'quiz') ]; } } else if ($event->eventtype == QUIZ_EVENT_TYPE_CLOSE) { if (!empty($quiz->timeopen)) { $mindate = [ $quiz->timeopen, get_string('closebeforeopen', 'quiz') ]; } } return [$mindate, $maxdate]; } /** * This function will update the quiz module according to the * event that has been modified. * * It will set the timeopen or timeclose value of the quiz instance * according to the type of event provided. * * @throws \moodle_exception * @param \calendar_event $event A quiz activity calendar event * @param \stdClass $quiz A quiz activity instance */ function mod_quiz_core_calendar_event_timestart_updated(\calendar_event $event, \stdClass $quiz) { global $CFG, $DB; require_once($CFG->dirroot . '/mod/quiz/locallib.php'); if (!in_array($event->eventtype, [QUIZ_EVENT_TYPE_OPEN, QUIZ_EVENT_TYPE_CLOSE])) { // This isn't an event that we care about so we can ignore it. return; } $courseid = $event->courseid; $modulename = $event->modulename; $instanceid = $event->instance; $modified = false; $closedatechanged = false; // Something weird going on. The event is for a different module so // we should ignore it. if ($modulename != 'quiz') { return; } if ($quiz->id != $instanceid) { // The provided quiz instance doesn't match the event so // there is nothing to do here. return; } // We don't update the activity if it's an override event that has // been modified. if (quiz_is_overriden_calendar_event($event)) { return; } $coursemodule = get_fast_modinfo($courseid)->instances[$modulename][$instanceid]; $context = context_module::instance($coursemodule->id); // The user does not have the capability to modify this activity. if (!has_capability('moodle/course:manageactivities', $context)) { return; } if ($event->eventtype == QUIZ_EVENT_TYPE_OPEN) { // If the event is for the quiz activity opening then we should // set the start time of the quiz activity to be the new start // time of the event. if ($quiz->timeopen != $event->timestart) { $quiz->timeopen = $event->timestart; $modified = true; } } else if ($event->eventtype == QUIZ_EVENT_TYPE_CLOSE) { // If the event is for the quiz activity closing then we should // set the end time of the quiz activity to be the new start // time of the event. if ($quiz->timeclose != $event->timestart) { $quiz->timeclose = $event->timestart; $modified = true; $closedatechanged = true; } } if ($modified) { $quiz->timemodified = time(); $DB->update_record('quiz', $quiz); if ($closedatechanged) { quiz_update_open_attempts(['quizid' => $quiz->id]); } // Delete any previous preview attempts. quiz_delete_previews($quiz); quiz_update_events($quiz); $event = \core\event\course_module_updated::create_from_cm($coursemodule, $context); $event->trigger(); } } /** * Generates the question bank in a fragment output. This allows * the question bank to be displayed in a modal. * * The only expected argument provided in the $args array is * 'querystring'. The value should be the list of parameters * URL encoded and used to build the question bank page. * * The individual list of parameters expected can be found in * question_build_edit_resources. * * @param array $args The fragment arguments. * @return string The rendered mform fragment. */
< function mod_quiz_output_fragment_quiz_question_bank($args) { < global $CFG, $DB, $PAGE; < require_once($CFG->dirroot . '/mod/quiz/locallib.php'); < require_once($CFG->dirroot . '/question/editlib.php');
> function mod_quiz_output_fragment_quiz_question_bank($args): string { > global $PAGE;
< $querystring = preg_replace('/^\?/', '', $args['querystring']);
> // Retrieve params.
$params = [];
> $extraparams = []; parse_str($querystring, $params); > $querystring = parse_url($args['querystring'], PHP_URL_QUERY);
< // Build the required resources. The $params are all cleaned as < // part of this process. < list($thispageurl, $contexts, $cmid, $cm, $quiz, $pagevars) = < question_build_edit_resources('editq', '/mod/quiz/edit.php', $params, custom_view::DEFAULT_PAGE_SIZE);
> $viewclass = \mod_quiz\question\bank\custom_view::class; > $extraparams['view'] = $viewclass;
< // Get the course object and related bits. < $course = get_course($quiz->course);
> // Build required parameters. > [$contexts, $thispageurl, $cm, $pagevars, $extraparams] = > build_required_parameters_for_custom_view($params, $extraparams); > > $course = get_course($cm->course);
require_capability('mod/quiz:manage', $contexts->lowest());
< // Create quiz question bank view. < $questionbank = new custom_view($contexts, $thispageurl, $course, $cm, $quiz); < $questionbank->set_quiz_has_attempts(quiz_has_attempts($quiz->id));
> // Custom View. > $questionbank = new $viewclass($contexts, $thispageurl, $course, $cm, $pagevars, $extraparams);
// Output. $renderer = $PAGE->get_renderer('mod_quiz', 'edit'); return $renderer->question_bank_contents($questionbank, $pagevars); } /** * Generates the add random question in a fragment output. This allows the * form to be rendered in javascript, for example inside a modal. * * The required arguments as keys in the $args array are: * cat {string} The category and category context ids comma separated. * addonpage {int} The page id to add this question to. * returnurl {string} URL to return to after form submission. * cmid {int} The course module id the questions are being added to. * * @param array $args The fragment arguments. * @return string The rendered mform fragment. */ function mod_quiz_output_fragment_add_random_question_form($args) {
< global $CFG;
> global $PAGE, $OUTPUT;
< $contexts = new \core_question\local\bank\question_edit_contexts($args['context']); < $formoptions = [ < 'contexts' => $contexts, < 'cat' => $args['cat'] < ]; < $formdata = [ < 'category' => $args['cat'], < 'addonpage' => $args['addonpage'], < 'returnurl' => $args['returnurl'], < 'cmid' => $args['cmid']
> $extraparams = []; > > // Build required parameters. > [$contexts, $thispageurl, $cm, $pagevars, $extraparams] = > build_required_parameters_for_custom_view($args, $extraparams); > > // Additional param to differentiate with other question bank view. > $extraparams['view'] = mod_quiz\question\bank\random_question_view::class; > > $course = get_course($cm->course); > require_capability('mod/quiz:manage', $contexts->lowest()); > > // Custom View. > $questionbank = new mod_quiz\question\bank\random_question_view($contexts, $thispageurl, $course, $cm, $pagevars, $extraparams); > > $renderer = $PAGE->get_renderer('mod_quiz', 'edit'); > $questionbankoutput = $renderer->question_bank_contents($questionbank, $pagevars); > > $maxrand = 100; > for ($i = 1; $i <= min(100, $maxrand); $i++) { > $randomcount[] = ['value' => $i, 'name' => $i]; > } > > // Parent category select. > $usablecontexts = $contexts->having_cap('moodle/question:useall'); > $categoriesarray = helper::question_category_options($usablecontexts); > $catoptions = []; > foreach ($categoriesarray as $group => $opts) { > // Options for each category group. > $categories = []; > foreach ($opts as $context => $name) { > $categories[] = ['value' => $context, 'name' => $name]; > } > $catoptions[] = ['label' => $group, 'options' => $categories]; > } > > // Template data. > $data = [ > 'questionbank' => $questionbankoutput, > 'randomoptions' => $randomcount, > 'questioncategoryoptions' => $catoptions,
];
< $form = new add_random_form( < new \moodle_url('/mod/quiz/addrandom.php'), < $formoptions, < 'post', < '', < null, < true, < $formdata < ); < $form->set_data($formdata);
> $result = $OUTPUT->render_from_template('mod_quiz/add_random_question_form', $data);
< return $form->render();
> return $result;
} /** * Callback to fetch the activity event type lang string. * * @param string $eventtype The event type. * @return lang_string The event type lang string. */ function mod_quiz_core_calendar_get_event_action_string(string $eventtype): string { $modulename = get_string('modulename', 'quiz'); switch ($eventtype) { case QUIZ_EVENT_TYPE_OPEN: $identifier = 'quizeventopens'; break; case QUIZ_EVENT_TYPE_CLOSE: $identifier = 'quizeventcloses'; break; default: return get_string('requiresaction', 'calendar', $modulename); } return get_string($identifier, 'quiz', $modulename); } /** * Delete question reference data. * * @param int $quizid The id of quiz. */ function quiz_delete_references($quizid): void { global $DB; $slots = $DB->get_records('quiz_slots', ['quizid' => $quizid]); foreach ($slots as $slot) { $params = [ 'itemid' => $slot->id, 'component' => 'mod_quiz', 'questionarea' => 'slot' ]; // Delete any set references. $DB->delete_records('question_set_references', $params); // Delete any references. $DB->delete_records('question_references', $params); }
> } } > > /** /** > * Question data fragment to get the question html via ajax call. * Implement the calculate_question_stats callback. > * * > * @param array $args * This enables quiz statistics to be shown in statistics columns in the database. > * @return string * > */ * @param context $context return the statistics related to this context (which will be a quiz context). > function mod_quiz_output_fragment_question_data(array $args): string { * @return all_calculated_for_qubaid_condition|null The statistics for this quiz, if available, else null. > // Return if there is no args. */ > if (empty($args)) { function mod_quiz_calculate_question_stats(context $context): ?all_calculated_for_qubaid_condition { > return ''; global $CFG; > } require_once($CFG->dirroot . '/mod/quiz/report/statistics/report.php'); > $cm = get_coursemodule_from_id('quiz', $context->instanceid); > // Retrieve params from query string. $report = new quiz_statistics_report(); > [$params, $extraparams] = \core_question\local\bank\filter_condition_manager::extract_parameters_from_fragment_args($args); return $report->calculate_questions_stats_for_question_bank($cm->instance, false, false); > } > // Build required parameters. > $cmid = clean_param($args['cmid'], PARAM_INT); > $thispageurl = new \moodle_url('/mod/quiz/edit.php', ['cmid' => $cmid]); > $thiscontext = \context_module::instance($cmid); > $contexts = new \core_question\local\bank\question_edit_contexts($thiscontext); > $defaultcategory = question_make_default_categories($contexts->all()); > $params['cat'] = implode(',', [$defaultcategory->id, $defaultcategory->contextid]); > > $course = get_course($params['courseid']); > [, $cm] = get_module_from_cmid($cmid); > $params['tabname'] = 'questions'; > > // Custom question bank View. > $viewclass = clean_param($args['view'], PARAM_NOTAGS); > $questionbank = new $viewclass($contexts, $thispageurl, $course, $cm, $params, $extraparams); > > // Question table. > $questionbank->add_standard_search_conditions(); > ob_start(); > $questionbank->display_question_list(); > return ob_get_clean(); > } > > /** > * Build required parameters for question bank custom view > * > * @param array $params the page parameters > * @param array $extraparams additional parameters > * @return array > */ > function build_required_parameters_for_custom_view(array $params, array $extraparams): array { > // Retrieve questions per page. > $viewclass = $extraparams['view'] ?? null; > $defaultpagesize = $viewclass ? $viewclass::DEFAULT_PAGE_SIZE : DEFAULT_QUESTIONS_PER_PAGE; > // Build the required params. > [$thispageurl, $contexts, $cmid, $cm, , $pagevars] = question_build_edit_resources( > 'editq', > '/mod/quiz/edit.php', > array_merge($params, $extraparams), > $defaultpagesize); > > // Add cmid so we can retrieve later in extra params. > $extraparams['cmid'] = $cmid; > > return [$contexts, $thispageurl, $cm, $pagevars, $extraparams];