L-electron-Rare/moodle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

MDL-81039 question: Improve some comments in question_display_options

Browse Source
This commit is contained in:
Tim Hunt
2024-02-23 22:36:06 +00:00
parent e567c21d6e
commit e73888a107
1 changed files with 40 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
question/engine/lib.php
+40 -30
View File
@@ -477,7 +477,7 @@ abstract class question_engine {
*/
class question_display_options {
/**#@+
* @var integer named constants for the values that most of the options take.
* @var int named constants for the values that most of the options take.
*/
const SHOW_ALL = -1;
const HIDDEN = 0;
@@ -485,13 +485,13 @@ class question_display_options {
const EDITABLE = 2;
/**#@-*/
/**#@+ @var integer named constants for the {@link $marks} option. */
/**#@+ @var int named constants for the {@see $marks} option. */
const MAX_ONLY = 1;
const MARK_AND_MAX = 2;
/**#@-*/
/**
* @var integer maximum value for the {@link $markpd} option. This is
* @var int maximum value for the {@see $markpd} option. This is
* effectively set by the database structure, which uses NUMBER(12,7) columns
* for question marks/fractions.
*/
@@ -514,33 +514,40 @@ class question_display_options {
* This includes the green/red hilighting of the bits of their response,
* whether the one-line summary of the current state of the question says
* correct/incorrect or just answered.
* @var integer {@link question_display_options::HIDDEN} or
* {@link question_display_options::VISIBLE}
* @var int {@see question_display_options::HIDDEN} or
* {@see question_display_options::VISIBLE}
*/
public $correctness = self::VISIBLE;
/**
* The the mark and/or the maximum available mark for this question be visible?
* @var integer {@link question_display_options::HIDDEN},
* {@link question_display_options::MAX_ONLY} or {@link question_display_options::MARK_AND_MAX}
* @var int {@see question_display_options::HIDDEN},
* {@see question_display_options::MAX_ONLY} or {@see question_display_options::MARK_AND_MAX}
*/
public $marks = self::MARK_AND_MAX;
/** @var number of decimal places to use when formatting marks for output. */
/** @var int of decimal places to use when formatting marks for output. */
public $markdp = 2;
/**
* Should the flag this question UI element be visible, and if so, should the
* flag state be changable?
* @var integer {@link question_display_options::HIDDEN},
* {@link question_display_options::VISIBLE} or {@link question_display_options::EDITABLE}
* flag state be changeable?
*
* @var int {@see question_display_options::HIDDEN},
* {@see question_display_options::VISIBLE} or {@see question_display_options::EDITABLE}
*/
public $flags = self::VISIBLE;
/**
* Should the specific feedback be visible.
* @var integer {@link question_display_options::HIDDEN} or
* {@link question_display_options::VISIBLE}
*
* Specific feedback is typically the part of the feedback that changes based on the
* answer that the student gave. For example the feedback shown if a particular choice
* has been chosen in a multi-choice question. It also includes the combined feedback
* that a lost of question types have (e.g. feedback for any correct/incorrect response.)
*
* @var int {@see question_display_options::HIDDEN} or
* {@see question_display_options::VISIBLE}
*/
public $feedback = self::VISIBLE;
@@ -548,31 +555,35 @@ class question_display_options {
* For questions with a number of sub-parts (like matching, or
* multiple-choice, multiple-reponse) display the number of sub-parts that
* were correct.
* @var integer {@link question_display_options::HIDDEN} or
* {@link question_display_options::VISIBLE}
* @var int {@see question_display_options::HIDDEN} or
* {@see question_display_options::VISIBLE}
*/
public $numpartscorrect = self::VISIBLE;
/**
* Should the general feedback be visible?
* @var integer {@link question_display_options::HIDDEN} or
* {@link question_display_options::VISIBLE}
*
* This is typically feedback shown to all students after the question
* is finished, irrespective of which answer they gave.
*
* @var int {@see question_display_options::HIDDEN} or
* {@see question_display_options::VISIBLE}
*/
public $generalfeedback = self::VISIBLE;
/**
* Should the automatically generated display of what the correct answer is
* be visible?
* @var integer {@link question_display_options::HIDDEN} or
* {@link question_display_options::VISIBLE}
* Should the automatically generated display of what the correct answer be visible?
*
* @var int {@see question_display_options::HIDDEN} or
* {@see question_display_options::VISIBLE}
*/
public $rightanswer = self::VISIBLE;
/**
* Should the manually added marker's comment be visible. Should the link for
* adding/editing the comment be there.
* @var integer {@link question_display_options::HIDDEN},
* {@link question_display_options::VISIBLE}, or {@link question_display_options::EDITABLE}.
* @var int {@see question_display_options::HIDDEN},
* {@see question_display_options::VISIBLE}, or {@see question_display_options::EDITABLE}.
* Editable means that form fields are displayed inline.
*/
public $manualcomment = self::VISIBLE;
@@ -593,8 +604,8 @@ class question_display_options {
/**
* Should the history of previous question states table be visible?
* @var integer {@link question_display_options::HIDDEN} or
* {@link question_display_options::VISIBLE}
* @var int {@see question_display_options::HIDDEN} or
* {@see question_display_options::VISIBLE}
*/
public $history = self::HIDDEN;
@@ -659,9 +670,8 @@ class question_display_options {
public ?bool $versioninfo = null;
/**
* Set all the feedback-related fields {@link $feedback}, {@link generalfeedback},
* {@link rightanswer} and {@link manualcomment} to
* {@link question_display_options::HIDDEN}.
* Set all the feedback-related fields, feedback, numpartscorrect, generalfeedback,
* rightanswer, manualcomment} and correctness to {@see question_display_options::HIDDEN}.
*/
public function hide_all_feedback() {
$this->feedback = self::HIDDEN;
@@ -676,10 +686,10 @@ class question_display_options {
* Returns the valid choices for the number of decimal places for showing
* question marks. For use in the user interface.
*
* Calling code should probably use {@link question_engine::get_dp_options()}
* Calling code should probably use {@see question_engine::get_dp_options()}
* rather than calling this method directly.
*
* @return array suitable for passing to {@link html_writer::select()} or similar.
* @return array suitable for passing to {@see html_writer::select()} or similar.
*/
public static function get_dp_options() {
$options = array();