qtype_shortanswer_question Class Reference

Inheritance diagram for qtype_shortanswer_question:

Collaboration diagram for qtype_shortanswer_question:

Public Member Functions
	__construct ()
	get_expected_data ()
	summarise_response (array $response)
	is_complete_response (array $response)
	get_validation_error (array $response)
	is_same_response (array $prevresponse, array $newresponse)
	get_answers ()
	compare_response_with_answer (array $response, question_answer $answer)
	check_file_access ($qa, $options, $component, $filearea, $args, $forcedownload)
Static Public Member Functions
static	compare_string_with_wildcard ($string, $pattern, $ignorecase)
Data Fields
	$usecase
	$answers = array()

---

Detailed Description

Represents a short answer question.

Copyright:

2009 The Open University http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Definition at line 36 of file question.php.

---

Constructor & Destructor Documentation

__construct

(

)

Constructor. Normally to get a question, you call question_bank::load_question(), but questions can be created directly, for example in unit test code.

Returns:

unknown_type

Reimplemented from question_definition.

Definition at line 43 of file question.php.

---

Member Function Documentation

check_file_access	(	$	qa,
		$	options,
		$	component,
		$	filearea,
		$	args,
		$	forcedownload
	)

Checks whether the users is allow to be served a particular file.

Parameters:

question_attempt	$qa	the question attempt being displayed.
question_display_options	$options	the options that control display of the question.
string	$component	the name of the component we are serving files for.
string	$filearea	the name of the file area.
array	$args	the remaining bits of the file path.
bool	$forcedownload	whether the user must be forced to download the file.

Returns:

bool true if the user can access this file.

Reimplemented from question_definition.

Definition at line 104 of file question.php.

Here is the call graph for this function:

compare_response_with_answer	(	array $	response,
		question_answer $	answer
	)

Parameters:

array	$response	the response.
question_answer	$answer	an answer.

Returns:

bool whether the response matches the answer.

Implements question_response_answer_comparer.

Definition at line 80 of file question.php.

Here is the call graph for this function:

static compare_string_with_wildcard	(	$	string,
		$	pattern,
		$	ignorecase
	)		[static]

Definition at line 85 of file question.php.

Here is the caller graph for this function:

get_answers

(

)

Returns:

array of question_answers.

Implements question_response_answer_comparer.

Definition at line 76 of file question.php.

get_expected_data

(

)

What data may be included in the form submission when a student submits this question in its current state?

This information is used in calls to optional_param. The parameter name has question_attempt::get_field_prefix() automatically prepended.

Returns:

array|string variable name => PARAM_... constant, or, as a special case that should only be used in unavoidable, the constant question_attempt::USE_RAW_DATA meaning take all the raw submitted data belonging to this question.

Reimplemented from question_definition.

Definition at line 47 of file question.php.

get_validation_error

(

array $

response

)

In situations where is_gradable_response() returns false, this method should generate a description of what the problem is.

Returns:

string the message.

Implements question_automatically_gradable.

Definition at line 64 of file question.php.

Here is the call graph for this function:

is_complete_response

(

array $

response

)

Used by many of the behaviours, to work out whether the student's response to the question is complete. That is, whether the question attempt should move to the COMPLETE or INCOMPLETE state.

Parameters:

array

$response

responses, as returned by question_attempt_step::get_qt_data().

Returns:

bool whether this response is a complete answer to this question.

Implements question_manually_gradable.

Definition at line 59 of file question.php.

is_same_response	(	array $	prevresponse,
		array $	newresponse
	)

Use by many of the behaviours to determine whether the student's response has changed. This is normally used to determine that a new set of responses can safely be discarded.

Parameters:

array	$prevresponse	the responses previously recorded for this question, as returned by question_attempt_step::get_qt_data()
array	$newresponse	the new responses, in the same format.

Returns:

bool whether the two sets of responses are the same - that is whether the new set of responses can safely be discarded.

Implements question_manually_gradable.

Definition at line 71 of file question.php.

Here is the call graph for this function:

summarise_response

(

array $

response

)

Produce a plain text summary of a response.

Parameters:

$response

a response, as might be passed to grade_response().

Returns:

string a plain text summary of that response, that could be used in reports.

Implements question_manually_gradable.

Definition at line 51 of file question.php.

---

Field Documentation

$answers = array()

Definition at line 41 of file question.php.

$usecase

Definition at line 39 of file question.php.

---

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

• C:/xampp/htdocs/moodle/question/type/shortanswer/question.php