mirror of
https://github.com/moodle/moodle.git
synced 2025-01-19 14:27:22 +01:00
6a981b45c3
This change is logically the same as changing
$this->has_capability('mod/quiz:viewreports')
to
$this->has_capability('mod/quiz:viewreports') || $this->has_capability('mod/quiz:preview')
in the original code. However, I rewrote the logic so that we test the
most common and performance-critical case first - that of a student
lookign at their own attempt.
1808 lines
65 KiB
PHP
1808 lines
65 KiB
PHP
<?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/>.
|
|
|
|
/**
|
|
* Back-end code for handling data about quizzes and the current user's attempt.
|
|
*
|
|
* There are classes for loading all the information about a quiz and attempts,
|
|
* and for displaying the navigation panel.
|
|
*
|
|
* @package mod_quiz
|
|
* @copyright 2008 onwards Tim Hunt
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
|
|
/**
|
|
* Class for quiz exceptions. Just saves a couple of arguments on the
|
|
* constructor for a moodle_exception.
|
|
*
|
|
* @copyright 2008 Tim Hunt
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
* @since Moodle 2.0
|
|
*/
|
|
class moodle_quiz_exception extends moodle_exception {
|
|
public function __construct($quizobj, $errorcode, $a = null, $link = '', $debuginfo = null) {
|
|
if (!$link) {
|
|
$link = $quizobj->view_url();
|
|
}
|
|
parent::__construct($errorcode, 'quiz', $link, $a, $debuginfo);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* A class encapsulating a quiz and the questions it contains, and making the
|
|
* information available to scripts like view.php.
|
|
*
|
|
* Initially, it only loads a minimal amout of information about each question - loading
|
|
* extra information only when necessary or when asked. The class tracks which questions
|
|
* are loaded.
|
|
*
|
|
* @copyright 2008 Tim Hunt
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
* @since Moodle 2.0
|
|
*/
|
|
class quiz {
|
|
// Fields initialised in the constructor.
|
|
protected $course;
|
|
protected $cm;
|
|
protected $quiz;
|
|
protected $context;
|
|
|
|
// Fields set later if that data is needed.
|
|
protected $questions = null;
|
|
protected $accessmanager = null;
|
|
protected $ispreviewuser = null;
|
|
|
|
// Constructor =============================================================
|
|
/**
|
|
* Constructor, assuming we already have the necessary data loaded.
|
|
*
|
|
* @param object $quiz the row from the quiz table.
|
|
* @param object $cm the course_module object for this quiz.
|
|
* @param object $course the row from the course table for the course we belong to.
|
|
* @param bool $getcontext intended for testing - stops the constructor getting the context.
|
|
*/
|
|
public function __construct($quiz, $cm, $course, $getcontext = true) {
|
|
$this->quiz = $quiz;
|
|
$this->cm = $cm;
|
|
$this->quiz->cmid = $this->cm->id;
|
|
$this->course = $course;
|
|
if ($getcontext && !empty($cm->id)) {
|
|
$this->context = context_module::instance($cm->id);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Static function to create a new quiz object for a specific user.
|
|
*
|
|
* @param int $quizid the the quiz id.
|
|
* @param int $userid the the userid.
|
|
* @return quiz the new quiz object
|
|
*/
|
|
public static function create($quizid, $userid) {
|
|
global $DB;
|
|
|
|
$quiz = quiz_access_manager::load_quiz_and_settings($quizid);
|
|
$course = $DB->get_record('course', array('id' => $quiz->course), '*', MUST_EXIST);
|
|
$cm = get_coursemodule_from_instance('quiz', $quiz->id, $course->id, false, MUST_EXIST);
|
|
|
|
// Update quiz with override information.
|
|
$quiz = quiz_update_effective_access($quiz, $userid);
|
|
|
|
return new quiz($quiz, $cm, $course);
|
|
}
|
|
|
|
/**
|
|
* Create a {@link quiz_attempt} for an attempt at this quiz.
|
|
* @param object $attemptdata row from the quiz_attempts table.
|
|
* @return quiz_attempt the new quiz_attempt object.
|
|
*/
|
|
public function create_attempt_object($attemptdata) {
|
|
return new quiz_attempt($attemptdata, $this->quiz, $this->cm, $this->course);
|
|
}
|
|
|
|
// Functions for loading more data =========================================
|
|
|
|
/**
|
|
* Load just basic information about all the questions in this quiz.
|
|
*/
|
|
public function preload_questions() {
|
|
$this->questions = question_preload_questions(null,
|
|
'slot.maxmark, slot.id AS slotid, slot.slot, slot.page',
|
|
'{quiz_slots} slot ON slot.quizid = :quizid AND q.id = slot.questionid',
|
|
array('quizid' => $this->quiz->id), 'slot.slot');
|
|
}
|
|
|
|
/**
|
|
* Fully load some or all of the questions for this quiz. You must call
|
|
* {@link preload_questions()} first.
|
|
*
|
|
* @param array $questionids question ids of the questions to load. null for all.
|
|
*/
|
|
public function load_questions($questionids = null) {
|
|
if ($this->questions === null) {
|
|
throw new coding_exception('You must call preload_questions before calling load_questions.');
|
|
}
|
|
if (is_null($questionids)) {
|
|
$questionids = array_keys($this->questions);
|
|
}
|
|
$questionstoprocess = array();
|
|
foreach ($questionids as $id) {
|
|
if (array_key_exists($id, $this->questions)) {
|
|
$questionstoprocess[$id] = $this->questions[$id];
|
|
}
|
|
}
|
|
get_question_options($questionstoprocess);
|
|
}
|
|
|
|
// Simple getters ==========================================================
|
|
/** @return int the course id. */
|
|
public function get_courseid() {
|
|
return $this->course->id;
|
|
}
|
|
|
|
/** @return object the row of the course table. */
|
|
public function get_course() {
|
|
return $this->course;
|
|
}
|
|
|
|
/** @return int the quiz id. */
|
|
public function get_quizid() {
|
|
return $this->quiz->id;
|
|
}
|
|
|
|
/** @return object the row of the quiz table. */
|
|
public function get_quiz() {
|
|
return $this->quiz;
|
|
}
|
|
|
|
/** @return string the name of this quiz. */
|
|
public function get_quiz_name() {
|
|
return $this->quiz->name;
|
|
}
|
|
|
|
/** @return int the quiz navigation method. */
|
|
public function get_navigation_method() {
|
|
return $this->quiz->navmethod;
|
|
}
|
|
|
|
/** @return int the number of attempts allowed at this quiz (0 = infinite). */
|
|
public function get_num_attempts_allowed() {
|
|
return $this->quiz->attempts;
|
|
}
|
|
|
|
/** @return int the course_module id. */
|
|
public function get_cmid() {
|
|
return $this->cm->id;
|
|
}
|
|
|
|
/** @return object the course_module object. */
|
|
public function get_cm() {
|
|
return $this->cm;
|
|
}
|
|
|
|
/** @return object the module context for this quiz. */
|
|
public function get_context() {
|
|
return $this->context;
|
|
}
|
|
|
|
/**
|
|
* @return bool wether the current user is someone who previews the quiz,
|
|
* rather than attempting it.
|
|
*/
|
|
public function is_preview_user() {
|
|
if (is_null($this->ispreviewuser)) {
|
|
$this->ispreviewuser = has_capability('mod/quiz:preview', $this->context);
|
|
}
|
|
return $this->ispreviewuser;
|
|
}
|
|
|
|
/**
|
|
* @return whether any questions have been added to this quiz.
|
|
*/
|
|
public function has_questions() {
|
|
if ($this->questions === null) {
|
|
$this->preload_questions();
|
|
}
|
|
return !empty($this->questions);
|
|
}
|
|
|
|
/**
|
|
* @param int $id the question id.
|
|
* @return object the question object with that id.
|
|
*/
|
|
public function get_question($id) {
|
|
return $this->questions[$id];
|
|
}
|
|
|
|
/**
|
|
* @param array $questionids question ids of the questions to load. null for all.
|
|
*/
|
|
public function get_questions($questionids = null) {
|
|
if (is_null($questionids)) {
|
|
$questionids = array_keys($this->questions);
|
|
}
|
|
$questions = array();
|
|
foreach ($questionids as $id) {
|
|
if (!array_key_exists($id, $this->questions)) {
|
|
throw new moodle_exception('cannotstartmissingquestion', 'quiz', $this->view_url());
|
|
}
|
|
$questions[$id] = $this->questions[$id];
|
|
$this->ensure_question_loaded($id);
|
|
}
|
|
return $questions;
|
|
}
|
|
|
|
/**
|
|
* @param int $timenow the current time as a unix timestamp.
|
|
* @return quiz_access_manager and instance of the quiz_access_manager class
|
|
* for this quiz at this time.
|
|
*/
|
|
public function get_access_manager($timenow) {
|
|
if (is_null($this->accessmanager)) {
|
|
$this->accessmanager = new quiz_access_manager($this, $timenow,
|
|
has_capability('mod/quiz:ignoretimelimits', $this->context, null, false));
|
|
}
|
|
return $this->accessmanager;
|
|
}
|
|
|
|
/**
|
|
* Wrapper round the has_capability funciton that automatically passes in the quiz context.
|
|
*/
|
|
public function has_capability($capability, $userid = null, $doanything = true) {
|
|
return has_capability($capability, $this->context, $userid, $doanything);
|
|
}
|
|
|
|
/**
|
|
* Wrapper round the require_capability funciton that automatically passes in the quiz context.
|
|
*/
|
|
public function require_capability($capability, $userid = null, $doanything = true) {
|
|
return require_capability($capability, $this->context, $userid, $doanything);
|
|
}
|
|
|
|
// URLs related to this attempt ============================================
|
|
/**
|
|
* @return string the URL of this quiz's view page.
|
|
*/
|
|
public function view_url() {
|
|
global $CFG;
|
|
return $CFG->wwwroot . '/mod/quiz/view.php?id=' . $this->cm->id;
|
|
}
|
|
|
|
/**
|
|
* @return string the URL of this quiz's edit page.
|
|
*/
|
|
public function edit_url() {
|
|
global $CFG;
|
|
return $CFG->wwwroot . '/mod/quiz/edit.php?cmid=' . $this->cm->id;
|
|
}
|
|
|
|
/**
|
|
* @param int $attemptid the id of an attempt.
|
|
* @param int $page optional page number to go to in the attempt.
|
|
* @return string the URL of that attempt.
|
|
*/
|
|
public function attempt_url($attemptid, $page = 0) {
|
|
global $CFG;
|
|
$url = $CFG->wwwroot . '/mod/quiz/attempt.php?attempt=' . $attemptid;
|
|
if ($page) {
|
|
$url .= '&page=' . $page;
|
|
}
|
|
return $url;
|
|
}
|
|
|
|
/**
|
|
* @return string the URL of this quiz's edit page. Needs to be POSTed to with a cmid parameter.
|
|
*/
|
|
public function start_attempt_url($page = 0) {
|
|
$params = array('cmid' => $this->cm->id, 'sesskey' => sesskey());
|
|
if ($page) {
|
|
$params['page'] = $page;
|
|
}
|
|
return new moodle_url('/mod/quiz/startattempt.php', $params);
|
|
}
|
|
|
|
/**
|
|
* @param int $attemptid the id of an attempt.
|
|
* @return string the URL of the review of that attempt.
|
|
*/
|
|
public function review_url($attemptid) {
|
|
return new moodle_url('/mod/quiz/review.php', array('attempt' => $attemptid));
|
|
}
|
|
|
|
/**
|
|
* @param int $attemptid the id of an attempt.
|
|
* @return string the URL of the review of that attempt.
|
|
*/
|
|
public function summary_url($attemptid) {
|
|
return new moodle_url('/mod/quiz/summary.php', array('attempt' => $attemptid));
|
|
}
|
|
|
|
// Bits of content =========================================================
|
|
|
|
/**
|
|
* @param bool $unfinished whether there is currently an unfinished attempt active.
|
|
* @return string if the quiz policies merit it, return a warning string to
|
|
* be displayed in a javascript alert on the start attempt button.
|
|
*/
|
|
public function confirm_start_attempt_message($unfinished) {
|
|
if ($unfinished) {
|
|
return '';
|
|
}
|
|
|
|
if ($this->quiz->timelimit && $this->quiz->attempts) {
|
|
return get_string('confirmstartattempttimelimit', 'quiz', $this->quiz->attempts);
|
|
} else if ($this->quiz->timelimit) {
|
|
return get_string('confirmstarttimelimit', 'quiz');
|
|
} else if ($this->quiz->attempts) {
|
|
return get_string('confirmstartattemptlimit', 'quiz', $this->quiz->attempts);
|
|
}
|
|
|
|
return '';
|
|
}
|
|
|
|
/**
|
|
* If $reviewoptions->attempt is false, meaning that students can't review this
|
|
* attempt at the moment, return an appropriate string explaining why.
|
|
*
|
|
* @param int $when One of the mod_quiz_display_options::DURING,
|
|
* IMMEDIATELY_AFTER, LATER_WHILE_OPEN or AFTER_CLOSE constants.
|
|
* @param bool $short if true, return a shorter string.
|
|
* @return string an appropraite message.
|
|
*/
|
|
public function cannot_review_message($when, $short = false) {
|
|
|
|
if ($short) {
|
|
$langstrsuffix = 'short';
|
|
$dateformat = get_string('strftimedatetimeshort', 'langconfig');
|
|
} else {
|
|
$langstrsuffix = '';
|
|
$dateformat = '';
|
|
}
|
|
|
|
if ($when == mod_quiz_display_options::DURING ||
|
|
$when == mod_quiz_display_options::IMMEDIATELY_AFTER) {
|
|
return '';
|
|
} else if ($when == mod_quiz_display_options::LATER_WHILE_OPEN && $this->quiz->timeclose &&
|
|
$this->quiz->reviewattempt & mod_quiz_display_options::AFTER_CLOSE) {
|
|
return get_string('noreviewuntil' . $langstrsuffix, 'quiz',
|
|
userdate($this->quiz->timeclose, $dateformat));
|
|
} else {
|
|
return get_string('noreview' . $langstrsuffix, 'quiz');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param string $title the name of this particular quiz page.
|
|
* @return array the data that needs to be sent to print_header_simple as the $navigation
|
|
* parameter.
|
|
*/
|
|
public function navigation($title) {
|
|
global $PAGE;
|
|
$PAGE->navbar->add($title);
|
|
return '';
|
|
}
|
|
|
|
// Private methods =========================================================
|
|
/**
|
|
* Check that the definition of a particular question is loaded, and if not throw an exception.
|
|
* @param $id a questionid.
|
|
*/
|
|
protected function ensure_question_loaded($id) {
|
|
if (isset($this->questions[$id]->_partiallyloaded)) {
|
|
throw new moodle_quiz_exception($this, 'questionnotloaded', $id);
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* This class extends the quiz class to hold data about the state of a particular attempt,
|
|
* in addition to the data about the quiz.
|
|
*
|
|
* @copyright 2008 Tim Hunt
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
* @since Moodle 2.0
|
|
*/
|
|
class quiz_attempt {
|
|
|
|
/** @var string to identify the in progress state. */
|
|
const IN_PROGRESS = 'inprogress';
|
|
/** @var string to identify the overdue state. */
|
|
const OVERDUE = 'overdue';
|
|
/** @var string to identify the finished state. */
|
|
const FINISHED = 'finished';
|
|
/** @var string to identify the abandoned state. */
|
|
const ABANDONED = 'abandoned';
|
|
|
|
// Basic data.
|
|
protected $quizobj;
|
|
protected $attempt;
|
|
|
|
/** @var question_usage_by_activity the question usage for this quiz attempt. */
|
|
protected $quba;
|
|
|
|
/** @var array page no => array of slot numbers on the page in order. */
|
|
protected $pagelayout;
|
|
|
|
/** @var array slot => displayed question number for this slot. (E.g. 1, 2, 3 or 'i'.) */
|
|
protected $questionnumbers;
|
|
|
|
/** @var array slot => page number for this slot. */
|
|
protected $questionpages;
|
|
|
|
/** @var mod_quiz_display_options cache for the appropriate review options. */
|
|
protected $reviewoptions = null;
|
|
|
|
// Constructor =============================================================
|
|
/**
|
|
* Constructor assuming we already have the necessary data loaded.
|
|
*
|
|
* @param object $attempt the row of the quiz_attempts table.
|
|
* @param object $quiz the quiz object for this attempt and user.
|
|
* @param object $cm the course_module object for this quiz.
|
|
* @param object $course the row from the course table for the course we belong to.
|
|
* @param bool $loadquestions (optional) if true, the default, load all the details
|
|
* of the state of each question. Else just set up the basic details of the attempt.
|
|
*/
|
|
public function __construct($attempt, $quiz, $cm, $course, $loadquestions = true) {
|
|
$this->attempt = $attempt;
|
|
$this->quizobj = new quiz($quiz, $cm, $course);
|
|
|
|
if (!$loadquestions) {
|
|
return;
|
|
}
|
|
|
|
$this->quba = question_engine::load_questions_usage_by_activity($this->attempt->uniqueid);
|
|
$this->determine_layout();
|
|
$this->number_questions();
|
|
}
|
|
|
|
/**
|
|
* Used by {create()} and {create_from_usage_id()}.
|
|
* @param array $conditions passed to $DB->get_record('quiz_attempts', $conditions).
|
|
*/
|
|
protected static function create_helper($conditions) {
|
|
global $DB;
|
|
|
|
$attempt = $DB->get_record('quiz_attempts', $conditions, '*', MUST_EXIST);
|
|
$quiz = quiz_access_manager::load_quiz_and_settings($attempt->quiz);
|
|
$course = $DB->get_record('course', array('id' => $quiz->course), '*', MUST_EXIST);
|
|
$cm = get_coursemodule_from_instance('quiz', $quiz->id, $course->id, false, MUST_EXIST);
|
|
|
|
// Update quiz with override information.
|
|
$quiz = quiz_update_effective_access($quiz, $attempt->userid);
|
|
|
|
return new quiz_attempt($attempt, $quiz, $cm, $course);
|
|
}
|
|
|
|
/**
|
|
* Static function to create a new quiz_attempt object given an attemptid.
|
|
*
|
|
* @param int $attemptid the attempt id.
|
|
* @return quiz_attempt the new quiz_attempt object
|
|
*/
|
|
public static function create($attemptid) {
|
|
return self::create_helper(array('id' => $attemptid));
|
|
}
|
|
|
|
/**
|
|
* Static function to create a new quiz_attempt object given a usage id.
|
|
*
|
|
* @param int $usageid the attempt usage id.
|
|
* @return quiz_attempt the new quiz_attempt object
|
|
*/
|
|
public static function create_from_usage_id($usageid) {
|
|
return self::create_helper(array('uniqueid' => $usageid));
|
|
}
|
|
|
|
/**
|
|
* @param string $state one of the state constants like IN_PROGRESS.
|
|
* @return string the human-readable state name.
|
|
*/
|
|
public static function state_name($state) {
|
|
return quiz_attempt_state_name($state);
|
|
}
|
|
|
|
private function determine_layout() {
|
|
$this->pagelayout = array();
|
|
|
|
// Break up the layout string into pages.
|
|
$pagelayouts = explode(',0', $this->attempt->layout);
|
|
|
|
// Strip off any empty last page (normally there is one).
|
|
if (end($pagelayouts) == '') {
|
|
array_pop($pagelayouts);
|
|
}
|
|
|
|
// File the ids into the arrays.
|
|
$this->pagelayout = array();
|
|
foreach ($pagelayouts as $page => $pagelayout) {
|
|
$pagelayout = trim($pagelayout, ',');
|
|
if ($pagelayout == '') {
|
|
continue;
|
|
}
|
|
$this->pagelayout[$page] = explode(',', $pagelayout);
|
|
}
|
|
}
|
|
|
|
// Number the questions.
|
|
private function number_questions() {
|
|
$number = 1;
|
|
foreach ($this->pagelayout as $page => $slots) {
|
|
foreach ($slots as $slot) {
|
|
$question = $this->quba->get_question($slot);
|
|
if ($question->length > 0) {
|
|
$this->questionnumbers[$slot] = $number;
|
|
$number += $question->length;
|
|
} else {
|
|
$this->questionnumbers[$slot] = get_string('infoshort', 'quiz');
|
|
}
|
|
$this->questionpages[$slot] = $page;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* If the given page number is out of range (before the first page, or after
|
|
* the last page, chnage it to be within range).
|
|
* @param int $page the requested page number.
|
|
* @return int a safe page number to use.
|
|
*/
|
|
public function force_page_number_into_range($page) {
|
|
return min(max($page, 0), count($this->pagelayout) - 1);
|
|
}
|
|
|
|
// Simple getters ==========================================================
|
|
public function get_quiz() {
|
|
return $this->quizobj->get_quiz();
|
|
}
|
|
|
|
public function get_quizobj() {
|
|
return $this->quizobj;
|
|
}
|
|
|
|
/** @return int the course id. */
|
|
public function get_courseid() {
|
|
return $this->quizobj->get_courseid();
|
|
}
|
|
|
|
/** @return int the course id. */
|
|
public function get_course() {
|
|
return $this->quizobj->get_course();
|
|
}
|
|
|
|
/** @return int the quiz id. */
|
|
public function get_quizid() {
|
|
return $this->quizobj->get_quizid();
|
|
}
|
|
|
|
/** @return string the name of this quiz. */
|
|
public function get_quiz_name() {
|
|
return $this->quizobj->get_quiz_name();
|
|
}
|
|
|
|
/** @return int the quiz navigation method. */
|
|
public function get_navigation_method() {
|
|
return $this->quizobj->get_navigation_method();
|
|
}
|
|
|
|
/** @return object the course_module object. */
|
|
public function get_cm() {
|
|
return $this->quizobj->get_cm();
|
|
}
|
|
|
|
/** @return object the course_module object. */
|
|
public function get_cmid() {
|
|
return $this->quizobj->get_cmid();
|
|
}
|
|
|
|
/**
|
|
* @return bool wether the current user is someone who previews the quiz,
|
|
* rather than attempting it.
|
|
*/
|
|
public function is_preview_user() {
|
|
return $this->quizobj->is_preview_user();
|
|
}
|
|
|
|
/** @return int the number of attempts allowed at this quiz (0 = infinite). */
|
|
public function get_num_attempts_allowed() {
|
|
return $this->quizobj->get_num_attempts_allowed();
|
|
}
|
|
|
|
/** @return int number fo pages in this quiz. */
|
|
public function get_num_pages() {
|
|
return count($this->pagelayout);
|
|
}
|
|
|
|
/**
|
|
* @param int $timenow the current time as a unix timestamp.
|
|
* @return quiz_access_manager and instance of the quiz_access_manager class
|
|
* for this quiz at this time.
|
|
*/
|
|
public function get_access_manager($timenow) {
|
|
return $this->quizobj->get_access_manager($timenow);
|
|
}
|
|
|
|
/** @return int the attempt id. */
|
|
public function get_attemptid() {
|
|
return $this->attempt->id;
|
|
}
|
|
|
|
/** @return int the attempt unique id. */
|
|
public function get_uniqueid() {
|
|
return $this->attempt->uniqueid;
|
|
}
|
|
|
|
/** @return object the row from the quiz_attempts table. */
|
|
public function get_attempt() {
|
|
return $this->attempt;
|
|
}
|
|
|
|
/** @return int the number of this attemp (is it this user's first, second, ... attempt). */
|
|
public function get_attempt_number() {
|
|
return $this->attempt->attempt;
|
|
}
|
|
|
|
/** @return string one of the quiz_attempt::IN_PROGRESS, FINISHED, OVERDUE or ABANDONED constants. */
|
|
public function get_state() {
|
|
return $this->attempt->state;
|
|
}
|
|
|
|
/** @return int the id of the user this attempt belongs to. */
|
|
public function get_userid() {
|
|
return $this->attempt->userid;
|
|
}
|
|
|
|
/** @return int the current page of the attempt. */
|
|
public function get_currentpage() {
|
|
return $this->attempt->currentpage;
|
|
}
|
|
|
|
public function get_sum_marks() {
|
|
return $this->attempt->sumgrades;
|
|
}
|
|
|
|
/**
|
|
* @return bool whether this attempt has been finished (true) or is still
|
|
* in progress (false). Be warned that this is not just state == self::FINISHED,
|
|
* it also includes self::ABANDONED.
|
|
*/
|
|
public function is_finished() {
|
|
return $this->attempt->state == self::FINISHED || $this->attempt->state == self::ABANDONED;
|
|
}
|
|
|
|
/** @return bool whether this attempt is a preview attempt. */
|
|
public function is_preview() {
|
|
return $this->attempt->preview;
|
|
}
|
|
|
|
/**
|
|
* Is this a student dealing with their own attempt/teacher previewing,
|
|
* or someone with 'mod/quiz:viewreports' reviewing someone elses attempt.
|
|
*
|
|
* @return bool whether this situation should be treated as someone looking at their own
|
|
* attempt. The distinction normally only matters when an attempt is being reviewed.
|
|
*/
|
|
public function is_own_attempt() {
|
|
global $USER;
|
|
return $this->attempt->userid == $USER->id &&
|
|
(!$this->is_preview_user() || $this->attempt->preview);
|
|
}
|
|
|
|
/**
|
|
* @return bool whether this attempt is a preview belonging to the current user.
|
|
*/
|
|
public function is_own_preview() {
|
|
global $USER;
|
|
return $this->attempt->userid == $USER->id &&
|
|
$this->is_preview_user() && $this->attempt->preview;
|
|
}
|
|
|
|
/**
|
|
* Is the current user allowed to review this attempt. This applies when
|
|
* {@link is_own_attempt()} returns false.
|
|
* @return bool whether the review should be allowed.
|
|
*/
|
|
public function is_review_allowed() {
|
|
if (!$this->has_capability('mod/quiz:viewreports')) {
|
|
return false;
|
|
}
|
|
|
|
$cm = $this->get_cm();
|
|
if ($this->has_capability('moodle/site:accessallgroups') ||
|
|
groups_get_activity_groupmode($cm) != SEPARATEGROUPS) {
|
|
return true;
|
|
}
|
|
|
|
// Check the users have at least one group in common.
|
|
$teachersgroups = groups_get_activity_allowed_groups($cm);
|
|
$studentsgroups = groups_get_all_groups(
|
|
$cm->course, $this->attempt->userid, $cm->groupingid);
|
|
return $teachersgroups && $studentsgroups &&
|
|
array_intersect(array_keys($teachersgroups), array_keys($studentsgroups));
|
|
}
|
|
|
|
/**
|
|
* Get extra summary information about this attempt.
|
|
*
|
|
* Some behaviours may be able to provide interesting summary information
|
|
* about the attempt as a whole, and this method provides access to that data.
|
|
* To see how this works, try setting a quiz to one of the CBM behaviours,
|
|
* and then look at the extra information displayed at the top of the quiz
|
|
* review page once you have sumitted an attempt.
|
|
*
|
|
* In the return value, the array keys are identifiers of the form
|
|
* qbehaviour_behaviourname_meaningfullkey. For qbehaviour_deferredcbm_highsummary.
|
|
* The values are arrays with two items, title and content. Each of these
|
|
* will be either a string, or a renderable.
|
|
*
|
|
* @return array as described above.
|
|
*/
|
|
public function get_additional_summary_data(question_display_options $options) {
|
|
return $this->quba->get_summary_information($options);
|
|
}
|
|
|
|
/**
|
|
* Get the overall feedback corresponding to a particular mark.
|
|
* @param $grade a particular grade.
|
|
*/
|
|
public function get_overall_feedback($grade) {
|
|
return quiz_feedback_for_grade($grade, $this->get_quiz(),
|
|
$this->quizobj->get_context());
|
|
}
|
|
|
|
/**
|
|
* Wrapper round the has_capability funciton that automatically passes in the quiz context.
|
|
*/
|
|
public function has_capability($capability, $userid = null, $doanything = true) {
|
|
return $this->quizobj->has_capability($capability, $userid, $doanything);
|
|
}
|
|
|
|
/**
|
|
* Wrapper round the require_capability funciton that automatically passes in the quiz context.
|
|
*/
|
|
public function require_capability($capability, $userid = null, $doanything = true) {
|
|
return $this->quizobj->require_capability($capability, $userid, $doanything);
|
|
}
|
|
|
|
/**
|
|
* Check the appropriate capability to see whether this user may review their own attempt.
|
|
* If not, prints an error.
|
|
*/
|
|
public function check_review_capability() {
|
|
if ($this->get_attempt_state() == mod_quiz_display_options::IMMEDIATELY_AFTER) {
|
|
$capability = 'mod/quiz:attempt';
|
|
} else {
|
|
$capability = 'mod/quiz:reviewmyattempts';
|
|
}
|
|
|
|
// These next tests are in a slighly funny order. The point is that the
|
|
// common and most performance-critical case is students attempting a quiz
|
|
// so we want to check that permisison first.
|
|
|
|
if ($this->has_capability($capability)) {
|
|
// User has the permission that lets you do the quiz as a student. Fine.
|
|
return;
|
|
}
|
|
|
|
if ($this->has_capability('mod/quiz:viewreports') ||
|
|
$this->has_capability('mod/quiz:preview')) {
|
|
// User has the permission that lets teachers review. Fine.
|
|
return;
|
|
}
|
|
|
|
// They should not be here. Trigger the standard no-permission error
|
|
// but using the name of the student capability.
|
|
// We know this will fail. We just want the stadard exception thown.
|
|
$this->require_capability($capability);
|
|
}
|
|
|
|
/**
|
|
* Checks whether a user may navigate to a particular slot
|
|
*/
|
|
public function can_navigate_to($slot) {
|
|
switch ($this->get_navigation_method()) {
|
|
case QUIZ_NAVMETHOD_FREE:
|
|
return true;
|
|
break;
|
|
case QUIZ_NAVMETHOD_SEQ:
|
|
return false;
|
|
break;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @return int one of the mod_quiz_display_options::DURING,
|
|
* IMMEDIATELY_AFTER, LATER_WHILE_OPEN or AFTER_CLOSE constants.
|
|
*/
|
|
public function get_attempt_state() {
|
|
return quiz_attempt_state($this->get_quiz(), $this->attempt);
|
|
}
|
|
|
|
/**
|
|
* Wrapper that the correct mod_quiz_display_options for this quiz at the
|
|
* moment.
|
|
*
|
|
* @return question_display_options the render options for this user on this attempt.
|
|
*/
|
|
public function get_display_options($reviewing) {
|
|
if ($reviewing) {
|
|
if (is_null($this->reviewoptions)) {
|
|
$this->reviewoptions = quiz_get_review_options($this->get_quiz(),
|
|
$this->attempt, $this->quizobj->get_context());
|
|
}
|
|
return $this->reviewoptions;
|
|
|
|
} else {
|
|
$options = mod_quiz_display_options::make_from_quiz($this->get_quiz(),
|
|
mod_quiz_display_options::DURING);
|
|
$options->flags = quiz_get_flag_option($this->attempt, $this->quizobj->get_context());
|
|
return $options;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Wrapper that the correct mod_quiz_display_options for this quiz at the
|
|
* moment.
|
|
*
|
|
* @param bool $reviewing true for review page, else attempt page.
|
|
* @param int $slot which question is being displayed.
|
|
* @param moodle_url $thispageurl to return to after the editing form is
|
|
* submitted or cancelled. If null, no edit link will be generated.
|
|
*
|
|
* @return question_display_options the render options for this user on this
|
|
* attempt, with extra info to generate an edit link, if applicable.
|
|
*/
|
|
public function get_display_options_with_edit_link($reviewing, $slot, $thispageurl) {
|
|
$options = clone($this->get_display_options($reviewing));
|
|
|
|
if (!$thispageurl) {
|
|
return $options;
|
|
}
|
|
|
|
if (!($reviewing || $this->is_preview())) {
|
|
return $options;
|
|
}
|
|
|
|
$question = $this->quba->get_question($slot);
|
|
if (!question_has_capability_on($question, 'edit', $question->category)) {
|
|
return $options;
|
|
}
|
|
|
|
$options->editquestionparams['cmid'] = $this->get_cmid();
|
|
$options->editquestionparams['returnurl'] = $thispageurl;
|
|
|
|
return $options;
|
|
}
|
|
|
|
/**
|
|
* @param int $page page number
|
|
* @return bool true if this is the last page of the quiz.
|
|
*/
|
|
public function is_last_page($page) {
|
|
return $page == count($this->pagelayout) - 1;
|
|
}
|
|
|
|
/**
|
|
* Return the list of question ids for either a given page of the quiz, or for the
|
|
* whole quiz.
|
|
*
|
|
* @param mixed $page string 'all' or integer page number.
|
|
* @return array the reqested list of question ids.
|
|
*/
|
|
public function get_slots($page = 'all') {
|
|
if ($page === 'all') {
|
|
$numbers = array();
|
|
foreach ($this->pagelayout as $numbersonpage) {
|
|
$numbers = array_merge($numbers, $numbersonpage);
|
|
}
|
|
return $numbers;
|
|
} else {
|
|
return $this->pagelayout[$page];
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get the question_attempt object for a particular question in this attempt.
|
|
* @param int $slot the number used to identify this question within this attempt.
|
|
* @return question_attempt
|
|
*/
|
|
public function get_question_attempt($slot) {
|
|
return $this->quba->get_question_attempt($slot);
|
|
}
|
|
|
|
/**
|
|
* Is a particular question in this attempt a real question, or something like a description.
|
|
* @param int $slot the number used to identify this question within this attempt.
|
|
* @return bool whether that question is a real question.
|
|
*/
|
|
public function is_real_question($slot) {
|
|
return $this->quba->get_question($slot)->length != 0;
|
|
}
|
|
|
|
/**
|
|
* Is a particular question in this attempt a real question, or something like a description.
|
|
* @param int $slot the number used to identify this question within this attempt.
|
|
* @return bool whether that question is a real question.
|
|
*/
|
|
public function is_question_flagged($slot) {
|
|
return $this->quba->get_question_attempt($slot)->is_flagged();
|
|
}
|
|
|
|
/**
|
|
* @param int $slot the number used to identify this question within this attempt.
|
|
* @return string the displayed question number for the question in this slot.
|
|
* For example '1', '2', '3' or 'i'.
|
|
*/
|
|
public function get_question_number($slot) {
|
|
return $this->questionnumbers[$slot];
|
|
}
|
|
|
|
/**
|
|
* @param int $slot the number used to identify this question within this attempt.
|
|
* @return int the page of the quiz this question appears on.
|
|
*/
|
|
public function get_question_page($slot) {
|
|
return $this->questionpages[$slot];
|
|
}
|
|
|
|
/**
|
|
* Return the grade obtained on a particular question, if the user is permitted
|
|
* to see it. You must previously have called load_question_states to load the
|
|
* state data about this question.
|
|
*
|
|
* @param int $slot the number used to identify this question within this attempt.
|
|
* @return string the formatted grade, to the number of decimal places specified
|
|
* by the quiz.
|
|
*/
|
|
public function get_question_name($slot) {
|
|
return $this->quba->get_question($slot)->name;
|
|
}
|
|
|
|
/**
|
|
* Return the grade obtained on a particular question, if the user is permitted
|
|
* to see it. You must previously have called load_question_states to load the
|
|
* state data about this question.
|
|
*
|
|
* @param int $slot the number used to identify this question within this attempt.
|
|
* @param bool $showcorrectness Whether right/partial/wrong states should
|
|
* be distinguised.
|
|
* @return string the formatted grade, to the number of decimal places specified
|
|
* by the quiz.
|
|
*/
|
|
public function get_question_status($slot, $showcorrectness) {
|
|
return $this->quba->get_question_state_string($slot, $showcorrectness);
|
|
}
|
|
|
|
/**
|
|
* Return the grade obtained on a particular question, if the user is permitted
|
|
* to see it. You must previously have called load_question_states to load the
|
|
* state data about this question.
|
|
*
|
|
* @param int $slot the number used to identify this question within this attempt.
|
|
* @param bool $showcorrectness Whether right/partial/wrong states should
|
|
* be distinguised.
|
|
* @return string class name for this state.
|
|
*/
|
|
public function get_question_state_class($slot, $showcorrectness) {
|
|
return $this->quba->get_question_state_class($slot, $showcorrectness);
|
|
}
|
|
|
|
/**
|
|
* Return the grade obtained on a particular question.
|
|
* You must previously have called load_question_states to load the state
|
|
* data about this question.
|
|
*
|
|
* @param int $slot the number used to identify this question within this attempt.
|
|
* @return string the formatted grade, to the number of decimal places specified by the quiz.
|
|
*/
|
|
public function get_question_mark($slot) {
|
|
return quiz_format_question_grade($this->get_quiz(), $this->quba->get_question_mark($slot));
|
|
}
|
|
|
|
/**
|
|
* Get the time of the most recent action performed on a question.
|
|
* @param int $slot the number used to identify this question within this usage.
|
|
* @return int timestamp.
|
|
*/
|
|
public function get_question_action_time($slot) {
|
|
return $this->quba->get_question_action_time($slot);
|
|
}
|
|
|
|
/**
|
|
* Get the time remaining for an in-progress attempt, if the time is short
|
|
* enought that it would be worth showing a timer.
|
|
* @param int $timenow the time to consider as 'now'.
|
|
* @return int|false the number of seconds remaining for this attempt.
|
|
* False if there is no limit.
|
|
*/
|
|
public function get_time_left_display($timenow) {
|
|
if ($this->attempt->state != self::IN_PROGRESS) {
|
|
return false;
|
|
}
|
|
return $this->get_access_manager($timenow)->get_time_left_display($this->attempt, $timenow);
|
|
}
|
|
|
|
|
|
/**
|
|
* @return int the time when this attempt was submitted. 0 if it has not been
|
|
* submitted yet.
|
|
*/
|
|
public function get_submitted_date() {
|
|
return $this->attempt->timefinish;
|
|
}
|
|
|
|
/**
|
|
* If the attempt is in an applicable state, work out the time by which the
|
|
* student should next do something.
|
|
* @return int timestamp by which the student needs to do something.
|
|
*/
|
|
public function get_due_date() {
|
|
$deadlines = array();
|
|
if ($this->quizobj->get_quiz()->timelimit) {
|
|
$deadlines[] = $this->attempt->timestart + $this->quizobj->get_quiz()->timelimit;
|
|
}
|
|
if ($this->quizobj->get_quiz()->timeclose) {
|
|
$deadlines[] = $this->quizobj->get_quiz()->timeclose;
|
|
}
|
|
if ($deadlines) {
|
|
$duedate = min($deadlines);
|
|
} else {
|
|
return false;
|
|
}
|
|
|
|
switch ($this->attempt->state) {
|
|
case self::IN_PROGRESS:
|
|
return $duedate;
|
|
|
|
case self::OVERDUE:
|
|
return $duedate + $this->quizobj->get_quiz()->graceperiod;
|
|
|
|
default:
|
|
throw new coding_exception('Unexpected state: ' . $this->attempt->state);
|
|
}
|
|
}
|
|
|
|
// URLs related to this attempt ============================================
|
|
/**
|
|
* @return string quiz view url.
|
|
*/
|
|
public function view_url() {
|
|
return $this->quizobj->view_url();
|
|
}
|
|
|
|
/**
|
|
* @return string the URL of this quiz's edit page. Needs to be POSTed to with a cmid parameter.
|
|
*/
|
|
public function start_attempt_url($slot = null, $page = -1) {
|
|
if ($page == -1 && !is_null($slot)) {
|
|
$page = $this->get_question_page($slot);
|
|
} else {
|
|
$page = 0;
|
|
}
|
|
return $this->quizobj->start_attempt_url($page);
|
|
}
|
|
|
|
/**
|
|
* @param int $slot if speified, the slot number of a specific question to link to.
|
|
* @param int $page if specified, a particular page to link to. If not givem deduced
|
|
* from $slot, or goes to the first page.
|
|
* @param int $questionid a question id. If set, will add a fragment to the URL
|
|
* to jump to a particuar question on the page.
|
|
* @param int $thispage if not -1, the current page. Will cause links to other things on
|
|
* this page to be output as only a fragment.
|
|
* @return string the URL to continue this attempt.
|
|
*/
|
|
public function attempt_url($slot = null, $page = -1, $thispage = -1) {
|
|
return $this->page_and_question_url('attempt', $slot, $page, false, $thispage);
|
|
}
|
|
|
|
/**
|
|
* @return string the URL of this quiz's summary page.
|
|
*/
|
|
public function summary_url() {
|
|
return new moodle_url('/mod/quiz/summary.php', array('attempt' => $this->attempt->id));
|
|
}
|
|
|
|
/**
|
|
* @return string the URL of this quiz's summary page.
|
|
*/
|
|
public function processattempt_url() {
|
|
return new moodle_url('/mod/quiz/processattempt.php');
|
|
}
|
|
|
|
/**
|
|
* @param int $slot indicates which question to link to.
|
|
* @param int $page if specified, the URL of this particular page of the attempt, otherwise
|
|
* the URL will go to the first page. If -1, deduce $page from $slot.
|
|
* @param bool $showall if true, the URL will be to review the entire attempt on one page,
|
|
* and $page will be ignored.
|
|
* @param int $thispage if not -1, the current page. Will cause links to other things on
|
|
* this page to be output as only a fragment.
|
|
* @return string the URL to review this attempt.
|
|
*/
|
|
public function review_url($slot = null, $page = -1, $showall = false, $thispage = -1) {
|
|
return $this->page_and_question_url('review', $slot, $page, $showall, $thispage);
|
|
}
|
|
|
|
// Bits of content =========================================================
|
|
|
|
/**
|
|
* If $reviewoptions->attempt is false, meaning that students can't review this
|
|
* attempt at the moment, return an appropriate string explaining why.
|
|
*
|
|
* @param bool $short if true, return a shorter string.
|
|
* @return string an appropraite message.
|
|
*/
|
|
public function cannot_review_message($short = false) {
|
|
return $this->quizobj->cannot_review_message(
|
|
$this->get_attempt_state(), $short);
|
|
}
|
|
|
|
/**
|
|
* Initialise the JS etc. required all the questions on a page.
|
|
* @param mixed $page a page number, or 'all'.
|
|
*/
|
|
public function get_html_head_contributions($page = 'all', $showall = false) {
|
|
if ($showall) {
|
|
$page = 'all';
|
|
}
|
|
$result = '';
|
|
foreach ($this->get_slots($page) as $slot) {
|
|
$result .= $this->quba->render_question_head_html($slot);
|
|
}
|
|
$result .= question_engine::initialise_js();
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Initialise the JS etc. required by one question.
|
|
* @param int $questionid the question id.
|
|
*/
|
|
public function get_question_html_head_contributions($slot) {
|
|
return $this->quba->render_question_head_html($slot) .
|
|
question_engine::initialise_js();
|
|
}
|
|
|
|
/**
|
|
* Print the HTML for the start new preview button, if the current user
|
|
* is allowed to see one.
|
|
*/
|
|
public function restart_preview_button() {
|
|
global $OUTPUT;
|
|
if ($this->is_preview() && $this->is_preview_user()) {
|
|
return $OUTPUT->single_button(new moodle_url(
|
|
$this->start_attempt_url(), array('forcenew' => true)),
|
|
get_string('startnewpreview', 'quiz'));
|
|
} else {
|
|
return '';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Generate the HTML that displayes the question in its current state, with
|
|
* the appropriate display options.
|
|
*
|
|
* @param int $id the id of a question in this quiz attempt.
|
|
* @param bool $reviewing is the being printed on an attempt or a review page.
|
|
* @param moodle_url $thispageurl the URL of the page this question is being printed on.
|
|
* @return string HTML for the question in its current state.
|
|
*/
|
|
public function render_question($slot, $reviewing, $thispageurl = null) {
|
|
return $this->quba->render_question($slot,
|
|
$this->get_display_options_with_edit_link($reviewing, $slot, $thispageurl),
|
|
$this->get_question_number($slot));
|
|
}
|
|
|
|
/**
|
|
* Like {@link render_question()} but displays the question at the past step
|
|
* indicated by $seq, rather than showing the latest step.
|
|
*
|
|
* @param int $id the id of a question in this quiz attempt.
|
|
* @param int $seq the seq number of the past state to display.
|
|
* @param bool $reviewing is the being printed on an attempt or a review page.
|
|
* @param string $thispageurl the URL of the page this question is being printed on.
|
|
* @return string HTML for the question in its current state.
|
|
*/
|
|
public function render_question_at_step($slot, $seq, $reviewing, $thispageurl = '') {
|
|
return $this->quba->render_question_at_step($slot, $seq,
|
|
$this->get_display_options_with_edit_link($reviewing, $slot, $thispageurl),
|
|
$this->get_question_number($slot));
|
|
}
|
|
|
|
/**
|
|
* Wrapper round print_question from lib/questionlib.php.
|
|
*
|
|
* @param int $id the id of a question in this quiz attempt.
|
|
*/
|
|
public function render_question_for_commenting($slot) {
|
|
$options = $this->get_display_options(true);
|
|
$options->hide_all_feedback();
|
|
$options->manualcomment = question_display_options::EDITABLE;
|
|
return $this->quba->render_question($slot, $options,
|
|
$this->get_question_number($slot));
|
|
}
|
|
|
|
/**
|
|
* Check wheter access should be allowed to a particular file.
|
|
*
|
|
* @param int $id the id of a question in this quiz attempt.
|
|
* @param bool $reviewing is the being printed on an attempt or a review page.
|
|
* @param string $thispageurl the URL of the page this question is being printed on.
|
|
* @return string HTML for the question in its current state.
|
|
*/
|
|
public function check_file_access($slot, $reviewing, $contextid, $component,
|
|
$filearea, $args, $forcedownload) {
|
|
return $this->quba->check_file_access($slot, $this->get_display_options($reviewing),
|
|
$component, $filearea, $args, $forcedownload);
|
|
}
|
|
|
|
/**
|
|
* Get the navigation panel object for this attempt.
|
|
*
|
|
* @param $panelclass The type of panel, quiz_attempt_nav_panel or quiz_review_nav_panel
|
|
* @param $page the current page number.
|
|
* @param $showall whether we are showing the whole quiz on one page. (Used by review.php)
|
|
* @return quiz_nav_panel_base the requested object.
|
|
*/
|
|
public function get_navigation_panel(mod_quiz_renderer $output,
|
|
$panelclass, $page, $showall = false) {
|
|
$panel = new $panelclass($this, $this->get_display_options(true), $page, $showall);
|
|
|
|
$bc = new block_contents();
|
|
$bc->attributes['id'] = 'mod_quiz_navblock';
|
|
$bc->title = get_string('quiznavigation', 'quiz');
|
|
$bc->content = $output->navigation_panel($panel);
|
|
return $bc;
|
|
}
|
|
|
|
/**
|
|
* Given a URL containing attempt={this attempt id}, return an array of variant URLs
|
|
* @param moodle_url $url a URL.
|
|
* @return string HTML fragment. Comma-separated list of links to the other
|
|
* attempts with the attempt number as the link text. The curent attempt is
|
|
* included but is not a link.
|
|
*/
|
|
public function links_to_other_attempts(moodle_url $url) {
|
|
$attempts = quiz_get_user_attempts($this->get_quiz()->id, $this->attempt->userid, 'all');
|
|
if (count($attempts) <= 1) {
|
|
return false;
|
|
}
|
|
|
|
$links = new mod_quiz_links_to_other_attempts();
|
|
foreach ($attempts as $at) {
|
|
if ($at->id == $this->attempt->id) {
|
|
$links->links[$at->attempt] = null;
|
|
} else {
|
|
$links->links[$at->attempt] = new moodle_url($url, array('attempt' => $at->id));
|
|
}
|
|
}
|
|
return $links;
|
|
}
|
|
|
|
// Methods for processing ==================================================
|
|
|
|
/**
|
|
* Check this attempt, to see if there are any state transitions that should
|
|
* happen automatically. This function will update the attempt checkstatetime.
|
|
* @param int $timestamp the timestamp that should be stored as the modifed
|
|
* @param bool $studentisonline is the student currently interacting with Moodle?
|
|
*/
|
|
public function handle_if_time_expired($timestamp, $studentisonline) {
|
|
global $DB;
|
|
|
|
$timeclose = $this->get_access_manager($timestamp)->get_end_time($this->attempt);
|
|
|
|
if ($timeclose === false || $this->is_preview()) {
|
|
$this->update_timecheckstate(null);
|
|
return; // No time limit
|
|
}
|
|
if ($timestamp < $timeclose) {
|
|
$this->update_timecheckstate($timeclose);
|
|
return; // Time has not yet expired.
|
|
}
|
|
|
|
// If the attempt is already overdue, look to see if it should be abandoned ...
|
|
if ($this->attempt->state == self::OVERDUE) {
|
|
$timeoverdue = $timestamp - $timeclose;
|
|
$graceperiod = $this->quizobj->get_quiz()->graceperiod;
|
|
if ($timeoverdue >= $graceperiod) {
|
|
$this->process_abandon($timestamp, $studentisonline);
|
|
} else {
|
|
// Overdue time has not yet expired
|
|
$this->update_timecheckstate($timeclose + $graceperiod);
|
|
}
|
|
return; // ... and we are done.
|
|
}
|
|
|
|
if ($this->attempt->state != self::IN_PROGRESS) {
|
|
$this->update_timecheckstate(null);
|
|
return; // Attempt is already in a final state.
|
|
}
|
|
|
|
// Otherwise, we were in quiz_attempt::IN_PROGRESS, and time has now expired.
|
|
// Transition to the appropriate state.
|
|
switch ($this->quizobj->get_quiz()->overduehandling) {
|
|
case 'autosubmit':
|
|
$this->process_finish($timestamp, false);
|
|
return;
|
|
|
|
case 'graceperiod':
|
|
$this->process_going_overdue($timestamp, $studentisonline);
|
|
return;
|
|
|
|
case 'autoabandon':
|
|
$this->process_abandon($timestamp, $studentisonline);
|
|
return;
|
|
}
|
|
|
|
// This is an overdue attempt with no overdue handling defined, so just abandon.
|
|
$this->process_abandon($timestamp, $studentisonline);
|
|
return;
|
|
}
|
|
|
|
/**
|
|
* Process all the actions that were submitted as part of the current request.
|
|
*
|
|
* @param int $timestamp the timestamp that should be stored as the modifed
|
|
* time in the database for these actions. If null, will use the current time.
|
|
* @param bool $becomingoverdue
|
|
* @param array|null $simulatedresponses If not null, then we are testing, and this is an array of simulated data, keys are slot
|
|
* nos and values are arrays representing student responses which will be passed to
|
|
* question_definition::prepare_simulated_post_data method and then have the
|
|
* appropriate prefix added.
|
|
*/
|
|
public function process_submitted_actions($timestamp, $becomingoverdue = false, $simulatedresponses = null) {
|
|
global $DB;
|
|
|
|
$transaction = $DB->start_delegated_transaction();
|
|
|
|
if ($simulatedresponses !== null) {
|
|
$simulatedpostdata = $this->quba->prepare_simulated_post_data($simulatedresponses);
|
|
} else {
|
|
$simulatedpostdata = null;
|
|
}
|
|
|
|
$this->quba->process_all_actions($timestamp, $simulatedpostdata);
|
|
question_engine::save_questions_usage_by_activity($this->quba);
|
|
|
|
$this->attempt->timemodified = $timestamp;
|
|
if ($this->attempt->state == self::FINISHED) {
|
|
$this->attempt->sumgrades = $this->quba->get_total_mark();
|
|
}
|
|
if ($becomingoverdue) {
|
|
$this->process_going_overdue($timestamp, true);
|
|
} else {
|
|
$DB->update_record('quiz_attempts', $this->attempt);
|
|
}
|
|
|
|
if (!$this->is_preview() && $this->attempt->state == self::FINISHED) {
|
|
quiz_save_best_grade($this->get_quiz(), $this->get_userid());
|
|
}
|
|
|
|
$transaction->allow_commit();
|
|
}
|
|
|
|
/**
|
|
* Process all the autosaved data that was part of the current request.
|
|
*
|
|
* @param int $timestamp the timestamp that should be stored as the modifed
|
|
* time in the database for these actions. If null, will use the current time.
|
|
*/
|
|
public function process_auto_save($timestamp) {
|
|
global $DB;
|
|
|
|
$transaction = $DB->start_delegated_transaction();
|
|
|
|
$this->quba->process_all_autosaves($timestamp);
|
|
question_engine::save_questions_usage_by_activity($this->quba);
|
|
|
|
$transaction->allow_commit();
|
|
}
|
|
|
|
/**
|
|
* Update the flagged state for all question_attempts in this usage, if their
|
|
* flagged state was changed in the request.
|
|
*/
|
|
public function save_question_flags() {
|
|
global $DB;
|
|
|
|
$transaction = $DB->start_delegated_transaction();
|
|
$this->quba->update_question_flags();
|
|
question_engine::save_questions_usage_by_activity($this->quba);
|
|
$transaction->allow_commit();
|
|
}
|
|
|
|
public function process_finish($timestamp, $processsubmitted) {
|
|
global $DB;
|
|
|
|
$transaction = $DB->start_delegated_transaction();
|
|
|
|
if ($processsubmitted) {
|
|
$this->quba->process_all_actions($timestamp);
|
|
}
|
|
$this->quba->finish_all_questions($timestamp);
|
|
|
|
question_engine::save_questions_usage_by_activity($this->quba);
|
|
|
|
$this->attempt->timemodified = $timestamp;
|
|
$this->attempt->timefinish = $timestamp;
|
|
$this->attempt->sumgrades = $this->quba->get_total_mark();
|
|
$this->attempt->state = self::FINISHED;
|
|
$this->attempt->timecheckstate = null;
|
|
$DB->update_record('quiz_attempts', $this->attempt);
|
|
|
|
if (!$this->is_preview()) {
|
|
quiz_save_best_grade($this->get_quiz(), $this->attempt->userid);
|
|
|
|
// Trigger event.
|
|
$this->fire_state_transition_event('\mod_quiz\event\attempt_submitted', $timestamp);
|
|
|
|
// Tell any access rules that care that the attempt is over.
|
|
$this->get_access_manager($timestamp)->current_attempt_finished();
|
|
}
|
|
|
|
$transaction->allow_commit();
|
|
}
|
|
|
|
/**
|
|
* Update this attempt timecheckstate if necessary.
|
|
* @param int|null the timecheckstate
|
|
*/
|
|
public function update_timecheckstate($time) {
|
|
global $DB;
|
|
if ($this->attempt->timecheckstate !== $time) {
|
|
$this->attempt->timecheckstate = $time;
|
|
$DB->set_field('quiz_attempts', 'timecheckstate', $time, array('id'=>$this->attempt->id));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Mark this attempt as now overdue.
|
|
* @param int $timestamp the time to deem as now.
|
|
* @param bool $studentisonline is the student currently interacting with Moodle?
|
|
*/
|
|
public function process_going_overdue($timestamp, $studentisonline) {
|
|
global $DB;
|
|
|
|
$transaction = $DB->start_delegated_transaction();
|
|
$this->attempt->timemodified = $timestamp;
|
|
$this->attempt->state = self::OVERDUE;
|
|
// If we knew the attempt close time, we could compute when the graceperiod ends.
|
|
// Instead we'll just fix it up through cron.
|
|
$this->attempt->timecheckstate = $timestamp;
|
|
$DB->update_record('quiz_attempts', $this->attempt);
|
|
|
|
$this->fire_state_transition_event('\mod_quiz\event\attempt_becameoverdue', $timestamp);
|
|
|
|
$transaction->allow_commit();
|
|
}
|
|
|
|
/**
|
|
* Mark this attempt as abandoned.
|
|
* @param int $timestamp the time to deem as now.
|
|
* @param bool $studentisonline is the student currently interacting with Moodle?
|
|
*/
|
|
public function process_abandon($timestamp, $studentisonline) {
|
|
global $DB;
|
|
|
|
$transaction = $DB->start_delegated_transaction();
|
|
$this->attempt->timemodified = $timestamp;
|
|
$this->attempt->state = self::ABANDONED;
|
|
$this->attempt->timecheckstate = null;
|
|
$DB->update_record('quiz_attempts', $this->attempt);
|
|
|
|
$this->fire_state_transition_event('\mod_quiz\event\attempt_abandoned', $timestamp);
|
|
|
|
$transaction->allow_commit();
|
|
}
|
|
|
|
/**
|
|
* Fire a state transition event.
|
|
* the same event information.
|
|
* @param string $eventclass the event class name.
|
|
* @param int $timestamp the timestamp to include in the event.
|
|
* @return void
|
|
*/
|
|
protected function fire_state_transition_event($eventclass, $timestamp) {
|
|
global $USER;
|
|
$quizrecord = $this->get_quiz();
|
|
$params = array(
|
|
'context' => $this->get_quizobj()->get_context(),
|
|
'courseid' => $this->get_courseid(),
|
|
'objectid' => $this->attempt->id,
|
|
'relateduserid' => $this->attempt->userid,
|
|
'other' => array(
|
|
'submitterid' => CLI_SCRIPT ? null : $USER->id,
|
|
'quizid' => $quizrecord->id
|
|
)
|
|
);
|
|
|
|
$event = $eventclass::create($params);
|
|
$event->add_record_snapshot('quiz', $this->get_quiz());
|
|
$event->add_record_snapshot('quiz_attempts', $this->get_attempt());
|
|
$event->trigger();
|
|
}
|
|
|
|
/**
|
|
* Print the fields of the comment form for questions in this attempt.
|
|
* @param $slot which question to output the fields for.
|
|
* @param $prefix Prefix to add to all field names.
|
|
*/
|
|
public function question_print_comment_fields($slot, $prefix) {
|
|
// Work out a nice title.
|
|
$student = get_record('user', 'id', $this->get_userid());
|
|
$a = new object();
|
|
$a->fullname = fullname($student, true);
|
|
$a->attempt = $this->get_attempt_number();
|
|
|
|
question_print_comment_fields($this->quba->get_question_attempt($slot),
|
|
$prefix, $this->get_display_options(true)->markdp,
|
|
get_string('gradingattempt', 'quiz_grading', $a));
|
|
}
|
|
|
|
// Private methods =========================================================
|
|
|
|
/**
|
|
* Get a URL for a particular question on a particular page of the quiz.
|
|
* Used by {@link attempt_url()} and {@link review_url()}.
|
|
*
|
|
* @param string $script. Used in the URL like /mod/quiz/$script.php
|
|
* @param int $slot identifies the specific question on the page to jump to.
|
|
* 0 to just use the $page parameter.
|
|
* @param int $page -1 to look up the page number from the slot, otherwise
|
|
* the page number to go to.
|
|
* @param bool $showall if true, return a URL with showall=1, and not page number
|
|
* @param int $thispage the page we are currently on. Links to questions on this
|
|
* page will just be a fragment #q123. -1 to disable this.
|
|
* @return The requested URL.
|
|
*/
|
|
protected function page_and_question_url($script, $slot, $page, $showall, $thispage) {
|
|
// Fix up $page.
|
|
if ($page == -1) {
|
|
if (!is_null($slot) && !$showall) {
|
|
$page = $this->get_question_page($slot);
|
|
} else {
|
|
$page = 0;
|
|
}
|
|
}
|
|
|
|
if ($showall) {
|
|
$page = 0;
|
|
}
|
|
|
|
// Add a fragment to scroll down to the question.
|
|
$fragment = '';
|
|
if (!is_null($slot)) {
|
|
if ($slot == reset($this->pagelayout[$page])) {
|
|
// First question on page, go to top.
|
|
$fragment = '#';
|
|
} else {
|
|
$fragment = '#q' . $slot;
|
|
}
|
|
}
|
|
|
|
// Work out the correct start to the URL.
|
|
if ($thispage == $page) {
|
|
return new moodle_url($fragment);
|
|
|
|
} else {
|
|
$url = new moodle_url('/mod/quiz/' . $script . '.php' . $fragment,
|
|
array('attempt' => $this->attempt->id));
|
|
if ($showall) {
|
|
$url->param('showall', 1);
|
|
} else if ($page > 0) {
|
|
$url->param('page', $page);
|
|
}
|
|
return $url;
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Represents a single link in the navigation panel.
|
|
*
|
|
* @copyright 2011 The Open University
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
* @since Moodle 2.1
|
|
*/
|
|
class quiz_nav_question_button implements renderable {
|
|
public $id;
|
|
public $number;
|
|
public $stateclass;
|
|
public $statestring;
|
|
public $currentpage;
|
|
public $flagged;
|
|
public $url;
|
|
}
|
|
|
|
|
|
/**
|
|
* Represents the navigation panel, and builds a {@link block_contents} to allow
|
|
* it to be output.
|
|
*
|
|
* @copyright 2008 Tim Hunt
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
* @since Moodle 2.0
|
|
*/
|
|
abstract class quiz_nav_panel_base {
|
|
/** @var quiz_attempt */
|
|
protected $attemptobj;
|
|
/** @var question_display_options */
|
|
protected $options;
|
|
/** @var integer */
|
|
protected $page;
|
|
/** @var boolean */
|
|
protected $showall;
|
|
|
|
public function __construct(quiz_attempt $attemptobj,
|
|
question_display_options $options, $page, $showall) {
|
|
$this->attemptobj = $attemptobj;
|
|
$this->options = $options;
|
|
$this->page = $page;
|
|
$this->showall = $showall;
|
|
}
|
|
|
|
public function get_question_buttons() {
|
|
$buttons = array();
|
|
foreach ($this->attemptobj->get_slots() as $slot) {
|
|
$qa = $this->attemptobj->get_question_attempt($slot);
|
|
$showcorrectness = $this->options->correctness && $qa->has_marks();
|
|
|
|
$button = new quiz_nav_question_button();
|
|
$button->id = 'quiznavbutton' . $slot;
|
|
$button->number = $this->attemptobj->get_question_number($slot);
|
|
$button->stateclass = $qa->get_state_class($showcorrectness);
|
|
$button->navmethod = $this->attemptobj->get_navigation_method();
|
|
if (!$showcorrectness && $button->stateclass == 'notanswered') {
|
|
$button->stateclass = 'complete';
|
|
}
|
|
$button->statestring = $this->get_state_string($qa, $showcorrectness);
|
|
$button->currentpage = $this->showall || $this->attemptobj->get_question_page($slot) == $this->page;
|
|
$button->flagged = $qa->is_flagged();
|
|
$button->url = $this->get_question_url($slot);
|
|
$buttons[] = $button;
|
|
}
|
|
|
|
return $buttons;
|
|
}
|
|
|
|
protected function get_state_string(question_attempt $qa, $showcorrectness) {
|
|
if ($qa->get_question()->length > 0) {
|
|
return $qa->get_state_string($showcorrectness);
|
|
}
|
|
|
|
// Special case handling for 'information' items.
|
|
if ($qa->get_state() == question_state::$todo) {
|
|
return get_string('notyetviewed', 'quiz');
|
|
} else {
|
|
return get_string('viewed', 'quiz');
|
|
}
|
|
}
|
|
|
|
public function render_before_button_bits(mod_quiz_renderer $output) {
|
|
return '';
|
|
}
|
|
|
|
abstract public function render_end_bits(mod_quiz_renderer $output);
|
|
|
|
protected function render_restart_preview_link($output) {
|
|
if (!$this->attemptobj->is_own_preview()) {
|
|
return '';
|
|
}
|
|
return $output->restart_preview_button(new moodle_url(
|
|
$this->attemptobj->start_attempt_url(), array('forcenew' => true)));
|
|
}
|
|
|
|
protected abstract function get_question_url($slot);
|
|
|
|
public function user_picture() {
|
|
global $DB;
|
|
if ($this->attemptobj->get_quiz()->showuserpicture == QUIZ_SHOWIMAGE_NONE) {
|
|
return null;
|
|
}
|
|
$user = $DB->get_record('user', array('id' => $this->attemptobj->get_userid()));
|
|
$userpicture = new user_picture($user);
|
|
$userpicture->courseid = $this->attemptobj->get_courseid();
|
|
if ($this->attemptobj->get_quiz()->showuserpicture == QUIZ_SHOWIMAGE_LARGE) {
|
|
$userpicture->size = true;
|
|
}
|
|
return $userpicture;
|
|
}
|
|
|
|
/**
|
|
* Return 'allquestionsononepage' as CSS class name when $showall is set,
|
|
* otherwise, return 'multipages' as CSS class name.
|
|
* @return string, CSS class name
|
|
*/
|
|
public function get_button_container_class() {
|
|
// Quiz navigation is set on 'Show all questions on one page'.
|
|
if ($this->showall) {
|
|
return 'allquestionsononepage';
|
|
}
|
|
// Quiz navigation is set on 'Show one page at a time'.
|
|
return 'multipages';
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Specialisation of {@link quiz_nav_panel_base} for the attempt quiz page.
|
|
*
|
|
* @copyright 2008 Tim Hunt
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
* @since Moodle 2.0
|
|
*/
|
|
class quiz_attempt_nav_panel extends quiz_nav_panel_base {
|
|
public function get_question_url($slot) {
|
|
if ($this->attemptobj->can_navigate_to($slot)) {
|
|
return $this->attemptobj->attempt_url($slot, -1, $this->page);
|
|
} else {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
public function render_before_button_bits(mod_quiz_renderer $output) {
|
|
return html_writer::tag('div', get_string('navnojswarning', 'quiz'),
|
|
array('id' => 'quiznojswarning'));
|
|
}
|
|
|
|
public function render_end_bits(mod_quiz_renderer $output) {
|
|
return html_writer::link($this->attemptobj->summary_url(),
|
|
get_string('endtest', 'quiz'), array('class' => 'endtestlink')) .
|
|
$output->countdown_timer($this->attemptobj, time()) .
|
|
$this->render_restart_preview_link($output);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Specialisation of {@link quiz_nav_panel_base} for the review quiz page.
|
|
*
|
|
* @copyright 2008 Tim Hunt
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
* @since Moodle 2.0
|
|
*/
|
|
class quiz_review_nav_panel extends quiz_nav_panel_base {
|
|
public function get_question_url($slot) {
|
|
return $this->attemptobj->review_url($slot, -1, $this->showall, $this->page);
|
|
}
|
|
|
|
public function render_end_bits(mod_quiz_renderer $output) {
|
|
$html = '';
|
|
if ($this->attemptobj->get_num_pages() > 1) {
|
|
if ($this->showall) {
|
|
$html .= html_writer::link($this->attemptobj->review_url(null, 0, false),
|
|
get_string('showeachpage', 'quiz'));
|
|
} else {
|
|
$html .= html_writer::link($this->attemptobj->review_url(null, 0, true),
|
|
get_string('showall', 'quiz'));
|
|
}
|
|
}
|
|
$html .= $output->finish_review_link($this->attemptobj);
|
|
$html .= $this->render_restart_preview_link($output);
|
|
return $html;
|
|
}
|
|
}
|