Inheritance diagram for qbank_previewquestion\question_preview_options:

Public Member Functions
	__construct ($question)
	Constructor.

	add_question_identifier_to_label (string $label, bool $sridentifier=false, bool $addbefore=false)
	Helper to add the question identify (if there is one) to the label of an input field in a question.

	get_url_params ()
	Parameters needed in the URL when continuing this preview.

	has_question_identifier ()
	Whether a question number has been provided for the question that is being displayed.

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

	load_user_defaults ()
	Load the value of the options from the user_preferences table.

	save_user_preview_options ($newoptions)
	Save a change to the user's preview options to the database.

	set_from_request ()
	Set the value of any fields included in the request.

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

Public Attributes
string	$behaviour
	the behaviour to use for this preview.

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

context	$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.

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

string	$extrahistorycontent = ''

string	$extrainfocontent = ''

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

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.

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.

number	$maxmark
	the maximum mark to use for this preview.

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.

string	$questionidentifier = null
	This identifier should be added to the labels of all input fields in the question.

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

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.

int	$userinfoinhistory = self::HIDDEN
	The option to show the action author in the response history.

int	$variant
	the variant of the question to preview.

int const	ALWAYS_LATEST = 0
	Special value for question version ID to indicate that we should always use the latest version.

const	EDITABLE = 2

const	HIDDEN = 0

const	MARK_AND_MAX = 2

integer const	MAX_DP = 7
	#-

integer const	MAX_ONLY = 1
	#-

string const	OPTIONPREFIX = 'question_preview_options_'
	prefix to append to field names to get user_preference names.

integer const	SHOW_ALL = -1
	#+ named constants for the values that most of the options take.

const	VISIBLE = 1

Protected Member Functions
	get_field_types ()
	Names and param types of the options we read from the request.

	get_user_pref_fields ()
	Names of the options we store in the user preferences table.

Constructor & Destructor Documentation

◆ __construct()

qbank_previewquestion\question_preview_options::__construct ( $question )

Constructor.

Parameters

stdClass $question

Member Function Documentation

◆ add_question_identifier_to_label()

question_display_options::add_question_identifier_to_label	(	string	$label,
		bool	$sridentifier = false,
		bool	$addbefore = false )

inherited

Helper to add the question identify (if there is one) to the label of an input field in a question.

Parameters

string	$label	The plain field label. E.g. 'Answer 1'
bool	$sridentifier	If true, the question identifier, if added, will be wrapped in a sr-only span. Default false.
bool	$addbefore	If true, the question identifier will be added before the label.

Return values

string The amended label. For example 'Answer 1, Question 1'.

◆ get_dp_options()

static question_display_options::get_dp_options ( )

staticinherited

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.

◆ get_field_types()

qbank_previewquestion\question_preview_options::get_field_types ( )

protected

Names and param types of the options we read from the request.

Return values

array

◆ get_url_params()

qbank_previewquestion\question_preview_options::get_url_params ( )

Parameters needed in the URL when continuing this preview.

Return values

array URL fragment.

◆ get_user_pref_fields()

qbank_previewquestion\question_preview_options::get_user_pref_fields ( )

protected

Names of the options we store in the user preferences table.

Return values

array

◆ has_question_identifier()

question_display_options::has_question_identifier ( )

inherited

Whether a question number has been provided for the question that is being displayed.

Return values

bool

◆ save_user_preview_options()

qbank_previewquestion\question_preview_options::save_user_preview_options ( $newoptions )

Save a change to the user's preview options to the database.

Parameters

object $newoptions

Member Data Documentation

◆ $correctness

integer question_display_options::$correctness = self::VISIBLE

inherited

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()

inherited

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 = ''

inherited

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 = ''

inherited

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

inherited

Should the specific feedback be visible.

question_display_options::HIDDEN or question_display_options::VISIBLE

◆ $manualcomment

integer question_display_options::$manualcomment = self::VISIBLE

inherited

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

inherited

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

◆ $questionidentifier

string question_display_options::$questionidentifier = null

inherited

This identifier should be added to the labels of all input fields in the question.

This is so people using assistive technology can easily tell which input belong to which question. The helper {

See also: self\add_question_identifier_to_label() makes this easier.

If not set before the question is rendered, then it defaults to 'Question N'. (lang string)

The identifier that the question being rendered is associated with. E.g. The question number when it is rendered on a quiz.

◆ $questionreviewlink

moodle_url question_display_options::$questionreviewlink = null

inherited

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

inherited

#-

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

inherited

#-

#+ named constants for the $marks option.

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

question/bank/previewquestion/classes/question_preview_options.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ add_question_identifier_to_label()

◆ get_dp_options()

◆ get_field_types()

◆ get_url_params()

◆ get_user_pref_fields()

◆ has_question_identifier()

◆ save_user_preview_options()

Member Data Documentation

◆ $correctness

◆ $editquestionparams

◆ $extrahistorycontent

◆ $extrainfocontent

◆ $feedback

◆ $manualcomment

◆ $numpartscorrect

◆ $questionidentifier

◆ $questionreviewlink

◆ MAX_DP

◆ MAX_ONLY