question_hint Class Reference

Class to represent a hint associated with a question. More...

Inheritance diagram for question_hint:

Public Member Functions
	__construct ($id, $hint, $hintformat)
	Constructor.
	adjust_display_options (question_display_options $options)
	Adjust this display options according to the hint settings.

Static Public Member Functions
static	load_from_record ($row)
	Create a basic hint from a row loaded from the question_hints table in the database.

Public Attributes
string	$hint
	The feedback hint to be shown.
integer	$hintformat
	The corresponding text FORMAT_... type.
integer	$id
	The hint id.

Detailed Description

Class to represent a hint associated with a question.

Used by iteractive mode, etc. A question has an array of these.

Copyright

2010 The Open University

License

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

Constructor & Destructor Documentation

__construct()

question_hint::__construct	(		$id,
			$hint,
			$hintformat )

Constructor.

Parameters

	int	the hint id from the database.
string	$hint	The hint text
	int	the corresponding text FORMAT_... type.

Member Function Documentation

adjust_display_options()

question_hint::adjust_display_options

(

question_display_options

$options

)

Adjust this display options according to the hint settings.

Parameters

question_display_options

$options

Reimplemented in question_hint_with_parts.

load_from_record()

static question_hint::load_from_record ( $row )

static

Create a basic hint from a row loaded from the question_hints table in the database.

Parameters

object

$row

with $row->hint set.

Return values

question_hint

Reimplemented in qtype_ordering\question_hint_ordering, question_hint_ddmarker, and question_hint_with_parts.

---

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

• question/type/questionbase.php