This class contains all the options that controls how a question is displayed. More...

Inheritance diagram for question_display_options:

Public Member Functions
	hide_all_feedback ()
	Set all the feedback-related fields $feedback, generalfeedback, rightanswer and manualcomment to question_display_options::HIDDEN.

Static Public Member Functions
static	get_dp_options ()
	Returns the valid choices for the number of decimal places for showing question marks. More...

Public Attributes
boolean	$clearwrong = false
	whether the question type should output hidden form fields to reset any incorrect parts of the resonse to blank.

int	$context
	the context the attempt being output belongs to.

integer	$correctness = self::VISIBLE
	Should the student have what they got right and wrong clearly indicated. More...

array	$editquestionparams = array()
	If not empty, then a link to edit the question will be included in the info box for the question. More...

string	$extrahistorycontent = ''

string	$extrainfocontent = ''

integer	$feedback = self::VISIBLE
	Should the specific feedback be visible. More...

integer	$flags = self::VISIBLE
	Should the flag this question UI element be visible, and if so, should the flag state be changable? question_display_options::HIDDEN, question_display_options::VISIBLE or question_display_options::EDITABLE.

integer	$generalfeedback = self::VISIBLE
	Should the general feedback be visible? question_display_options::HIDDEN or question_display_options::VISIBLE.

integer	$history = self::HIDDEN
	Should the history of previous question states table be visible? question_display_options::HIDDEN or question_display_options::VISIBLE.

integer	$manualcomment = self::VISIBLE
	Should the manually added marker's comment be visible. More...

string	$manualcommentlink = null
	Should we show a 'Make comment or override grade' link? base URL for the edit comment script, which will be shown if $manualcomment = self::VISIBLE.

number	$markdp = 2
	of decimal places to use when formatting marks for output.

integer	$marks = self::MARK_AND_MAX
	The the mark and/or the maximum available mark for this question be visible? question_display_options::HIDDEN, question_display_options::MAX_ONLY or question_display_options::MARK_AND_MAX.

integer	$numpartscorrect = self::VISIBLE
	For questions with a number of sub-parts (like matching, or multiple-choice, multiple-reponse) display the number of sub-parts that were correct. More...

moodle_url	$questionreviewlink = null
	Used in places like the question history table, to show a link to review this question in a certain state. More...

boolean	$readonly = false
	whether the question should be displayed as a read-only review, or in an active state where you can change the answer.

integer	$rightanswer = self::VISIBLE
	Should the automatically generated display of what the correct answer is be visible? question_display_options::HIDDEN or question_display_options::VISIBLE.

const	EDITABLE = 2

integer const	HIDDEN = 0
	#+ named constants for the values that most of the options take.

const	MARK_AND_MAX = 2

integer const	MAX_DP = 7
	#- More...

integer const	MAX_ONLY = 1
	#- More...

const	VISIBLE = 1

Detailed Description

This class contains all the options that controls how a question is displayed.

Normally, what will happen is that the calling code will set up some display options to indicate what sort of question display it wants, and then before the question is rendered, the behaviour will be given a chance to modify the display options, so that, for example, A question that is finished will only be shown read-only, and a question that has not been submitted will not have any sort of feedback displayed.

Copyright: 2009 The Open University

License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ get_dp_options()

static question_display_options::get_dp_options ( )

static

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 question_engine::get_dp_options() rather than calling this method directly.

Return values

array suitable for passing to html_writer::select() or similar.

Member Data Documentation

◆ $correctness

integer question_display_options::$correctness = self::VISIBLE

Should the student have what they got right and wrong clearly indicated.

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. question_display_options::HIDDEN or question_display_options::VISIBLE

◆ $editquestionparams

array question_display_options::$editquestionparams = array()

If not empty, then a link to edit the question will be included in the info box for the question.

If used, this array must contain an element courseid or cmid.

It shoudl also contain a parameter returnurl => moodle_url giving a sensible URL to go back to when the editing form is submitted or cancelled.

url parameter for the edit link. id => questiosnid will be added automatically.

◆ $extrahistorycontent

string question_display_options::$extrahistorycontent = ''

Since: 2.9 extra HTML to include in the history box of the question display, if it is shown.

◆ $extrainfocontent

string question_display_options::$extrainfocontent = ''

Since: 2.9 extra HTML to include at the end of the outcome (feedback) box of the question display.

This field is now badly named. The place it included is was changed (for the better) but the name was left unchanged for backwards compatibility.

◆ $feedback

integer question_display_options::$feedback = self::VISIBLE

Should the specific feedback be visible.

question_display_options::HIDDEN or question_display_options::VISIBLE

◆ $manualcomment

integer question_display_options::$manualcomment = self::VISIBLE

Should the manually added marker's comment be visible.

Should the link for adding/editing the comment be there. question_display_options::HIDDEN, question_display_options::VISIBLE, or question_display_options::EDITABLE. Editable means that form fields are displayed inline.

◆ $numpartscorrect

integer question_display_options::$numpartscorrect = self::VISIBLE

For questions with a number of sub-parts (like matching, or multiple-choice, multiple-reponse) display the number of sub-parts that were correct.

question_display_options::HIDDEN or question_display_options::VISIBLE

◆ $questionreviewlink

moodle_url question_display_options::$questionreviewlink = null

Used in places like the question history table, to show a link to review this question in a certain state.

If blank, a link is not shown. base URL for a review question script.

◆ MAX_DP

integer const question_display_options::MAX_DP = 7

#-

maximum value for the $markpd option. This is effectively set by the database structure, which uses NUMBER(12,7) columns for question marks/fractions.

◆ MAX_ONLY

integer const question_display_options::MAX_ONLY = 1

#-

#+ named constants for the $marks option.

The documentation for this class was generated from the following file:

question/engine/lib.php

Public Member Functions

Static Public Member Functions

Public Attributes