moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-04 16:36:37 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

MDL-74923 quiz: clean up the display_options class

Browse source
This commit is contained in:
Tim Hunt 2022-12-08 15:22:31 +00:00
parent cefbf74d02
commit 3e05d77874
1 changed files with 42 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

63
mod/quiz/classes/question/display_options.php
View file

@ -20,43 +20,54 @@ defined('MOODLE_INTERNAL') || die();
require_once($CFG->dirroot . '/question/engine/lib.php'); require_once($CFG->dirroot . '/question/engine/lib.php');
/** /**
* An extension of question_display_options that includes the extra options used * An extension of question_display_options that includes the extra options used by the quiz.
* by the quiz.
* *
* @copyright 2022 The Open University * @package mod_quiz
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * @category question
* @copyright 2022 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/ */
class display_options extends \question_display_options { class display_options extends \question_display_options {
/**#@+ /**
* @var integer bits used to indicate various times in relation to a * The bitmask patterns use in the review option settings.
* quiz attempt. *
* In the quiz settings, the review... (e.g. reviewmarks) values are
* bit patterns that allow what is visible to be change at different times.
* These constants define which bit is for which time.
*
* @var int bit used to indicate 'during the attempt'.
*/ */
const DURING = 0x10000; const DURING = 0x10000;
/** @var int as above, bit used to indicate 'immediately after the attempt'. */
const IMMEDIATELY_AFTER = 0x01000; const IMMEDIATELY_AFTER = 0x01000;
const LATER_WHILE_OPEN = 0x00100;
const AFTER_CLOSE = 0x00010; /** @var int as above, bit used to indicate 'later while the quiz is still open'. */
/**#@-*/ const LATER_WHILE_OPEN = 0x00100;
/** @var int as above, bit used to indicate 'after the quiz is closed'. */
const AFTER_CLOSE = 0x00010;
/** /**
* @var boolean if this is false, then the student is not allowed to review * @var bool if this is false, then the student is not allowed to review
* anything about the attempt. * anything about the attempt.
*/ */
public $attempt = true; public $attempt = true;
/** /**
* @var boolean if this is false, then the student is not allowed to review * @var int whether the attempt overall feedback is visible.
* anything about the attempt.
*/ */
public $overallfeedback = self::VISIBLE; public $overallfeedback = self::VISIBLE;
/** /**
* Set up the various options from the quiz settings, and a time constant. * Set up the various options from the quiz settings, and a time constant.
* @param object $quiz the quiz settings. *
* @param int $one of the {@link DURING}, {@link IMMEDIATELY_AFTER}, * @param \stdClass $quiz the quiz settings from the database.
* {@link LATER_WHILE_OPEN} or {@link AFTER_CLOSE} constants. * @param int $when of the constants {@see DURING}, {@see IMMEDIATELY_AFTER},
* @return display_options set up appropriately. * {@see LATER_WHILE_OPEN} or {@see AFTER_CLOSE}.
* @return display_options instance of this class set up appropriately.
*/ */
public static function make_from_quiz($quiz, $when) { public static function make_from_quiz(\stdClass $quiz, int $when): self {
$options = new self(); $options = new self();
$options->attempt = self::extract($quiz->reviewattempt, $when, true, false); $options->attempt = self::extract($quiz->reviewattempt, $when, true, false);
@ -80,9 +91,19 @@ class display_options extends \question_display_options {
return $options; return $options;
} }
protected static function extract($bitmask, $bit, /**
* Helper function to return one value or another depending on whether one bit is set.
*
* @param int $setting the setting to unpack (e.g. $quiz->reviewmarks).
* @param int $when of the constants {@see DURING}, {@see IMMEDIATELY_AFTER},
* {@see LATER_WHILE_OPEN} or {@see AFTER_CLOSE}.
* @param bool|int $whenset value to return when the bit is set.
* @param bool|int $whennotset value to return when the bit is set.
* @return bool|int $whenset or $whennotset, depending.
*/
protected static function extract(int $setting, int $when,
$whenset = self::VISIBLE, $whennotset = self::HIDDEN) { $whenset = self::VISIBLE, $whennotset = self::HIDDEN) {
if ($bitmask & $bit) { if ($setting & $when) {
return $whenset; return $whenset;
} else { } else {
return $whennotset; return $whennotset;