Subclass for generating the bits of output specific to shortanswer subquestions. More...

Inheritance diagram for qtype_multianswer_subq_renderer_base:

Public Member Functions
	clear_wrong (question_attempt $qa)
	Output hidden form fields to clear any wrong parts of the student's response.

	feedback (question_attempt $qa, question_display_options $options)
	Generate the display of the outcome part of the question.

	formulation_and_controls (question_attempt $qa, question_display_options $options)
	Generate the display of the formulation part of the question.

	formulation_heading ()
	In the question output there are some class="accesshide" headers to help screen-readers.

	head_code (question_attempt $qa)
	Return any HTML that needs to be included in the page's <head> when this question is used.

	manual_comment (question_attempt $qa, question_display_options $options)
	Display any extra question-type specific content that should be visible when grading, if appropriate.

	subquestion (question_attempt $qa, question_display_options $options, $index, question_graded_automatically $subq)

Protected Member Functions
	correct_response (question_attempt $qa)
	Gereate an automatic description of the correct response to this question.

	feedback_class ($fraction)

	feedback_image ($fraction, $selected=true)
	Return an appropriate icon (green tick, red cross, etc.) for a grade.

	feedback_popup (question_graded_automatically $subq, $fraction, $feedbacktext, $rightanswer, question_display_options $options)
	Render the feedback pop-up contents.

	general_feedback (question_attempt $qa)
	Gereate the general feedback.

	get_answer_label (string $langkey='answerx', string $component='question')
	Generates a label for an answer field.

	get_feedback_image (string $icon, string $feedbackcontents)
	Render the feedback icon for a sub-question which is also the trigger for the feedback popover.

	hint (question_attempt $qa, question_hint $hint)
	Gereate the specific feedback.

	num_parts_correct (question_attempt $qa)
	Gereate a brief statement of how many sub-parts of this question the student got right.

	specific_feedback (question_attempt $qa)
	Generate the specific feedback.

Protected Attributes
question_display_options	$displayoptions
	Question display options instance for any necessary information for rendering the question.

Static Protected Attributes
static int[]	$answercount = []
	Stores the counts of answer instances for questions.

Detailed Description

Subclass for generating the bits of output specific to shortanswer subquestions.

Copyright: 2011 The Open University

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

Member Function Documentation

◆ clear_wrong()

qtype_renderer::clear_wrong ( question_attempt $qa )

inherited

Output hidden form fields to clear any wrong parts of the student's response.

This method will only be called if the question is in read-only mode.

Parameters

question_attempt $qa the question attempt to display.

Return values

string HTML fragment.

Reimplemented in qtype_ddtoimage_renderer_base.

◆ correct_response()

qtype_renderer::correct_response ( question_attempt $qa )

protectedinherited

Gereate an automatic description of the correct response to this question.

Not all question types can do this. If it is not possible, this method should just return an empty string.

Parameters

question_attempt $qa the question attempt to display.

Return values

string HTML fragment.

Reimplemented in qtype_calculated_renderer, qtype_ddtoimage_renderer_base, qtype_elements_embedded_in_question_text_renderer, qtype_match_renderer, qtype_multianswer_renderer, qtype_multichoice_multi_renderer, qtype_multichoice_single_renderer, qtype_numerical_renderer, qtype_ordering_renderer, qtype_shortanswer_renderer, and qtype_truefalse_renderer.

◆ feedback()

qtype_renderer::feedback	(	question_attempt	$qa,
		question_display_options	$options )

inherited

Generate the display of the outcome part of the question.

This is the area that contains the various forms of feedback. This function generates the content of this area belonging to the question type.

Subclasses will normally want to override the more specific methods {specific_feedback()}, {general_feedback()} and {correct_response()} that this method calls.

Parameters

question_attempt	$qa	the question attempt to display.
question_display_options	$options	controls what should and should not be displayed.

Return values

string HTML fragment.

Reimplemented in qtype_ordering_renderer.

◆ feedback_image()

qtype_renderer::feedback_image	(		$fraction,
			$selected = true )

protectedinherited

Return an appropriate icon (green tick, red cross, etc.) for a grade.

Parameters

float	$fraction	grade on a scale 0..1.
bool	$selected	whether to show a big or small icon. (Deprecated)

Return values

string html fragment.

Reimplemented in qtype_ordering_renderer.

◆ feedback_popup()

qtype_multianswer_subq_renderer_base::feedback_popup	(	question_graded_automatically	$subq,
			$fraction,
			$feedbacktext,
			$rightanswer,
		question_display_options	$options )

protected

Render the feedback pop-up contents.

Parameters

question_graded_automatically	$subq	the subquestion.
float	$fraction	the mark the student got. null if this subq was not answered.
string	$feedbacktext	the feedback text, already processed with format_text etc.
string	$rightanswer	the right answer, already processed with format_text etc.
question_display_options	$options	the display options.

Return values

string the HTML for the feedback popup.

◆ formulation_and_controls()

qtype_renderer::formulation_and_controls	(	question_attempt	$qa,
		question_display_options	$options )

inherited

Generate the display of the formulation part of the question.

This is the area that contains the quetsion text, and the controls for students to input their answers. Some question types also embed bits of feedback, for example ticks and crosses, in this area.

Parameters

question_attempt	$qa	the question attempt to display.
question_display_options	$options	controls what should and should not be displayed.

Return values

string HTML fragment.

Reimplemented in qtype_ddmarker_renderer, qtype_ddtoimage_renderer_base, qtype_ddwtos_renderer, qtype_description_renderer, qtype_elements_embedded_in_question_text_renderer, qtype_essay_renderer, qtype_match_renderer, qtype_multianswer_renderer, qtype_multichoice_renderer_base, qtype_numerical_renderer, qtype_ordering_renderer, qtype_shortanswer_renderer, and qtype_truefalse_renderer.

◆ formulation_heading()

qtype_renderer::formulation_heading ( )

inherited

In the question output there are some class="accesshide" headers to help screen-readers.

This method returns the text to use for the heading above the formulation_and_controls section.

Return values

string to use as the heading.

Reimplemented in qtype_description_renderer.

◆ general_feedback()

qtype_renderer::general_feedback ( question_attempt $qa )

protectedinherited

Gereate the general feedback.

This is feedback is shown ot all students.

Parameters

question_attempt $qa the question attempt to display.

Return values

string HTML fragment.

◆ get_answer_label()

qtype_multianswer_subq_renderer_base::get_answer_label	(	string	$langkey = 'answerx',
		string	$component = 'question' )

protected

Generates a label for an answer field.

If the question number is set ({

See also: qtype_renderer::$questionnumber}), the label will include the question number in order to indicate which question the answer field belongs to.

Parameters

string	$langkey	The lang string key for the lang string that does not include the question number.
string	$component	The Frankenstyle component name.

Return values

string

Exceptions

coding_exception

◆ get_feedback_image()

qtype_multianswer_subq_renderer_base::get_feedback_image	(	string	$icon,
		string	$feedbackcontents )

protected

Render the feedback icon for a sub-question which is also the trigger for the feedback popover.

Parameters

string	$icon	The feedback icon
string	$feedbackcontents	The feedback contents to be shown on the popover.

Return values

string

◆ head_code()

qtype_renderer::head_code ( question_attempt $qa )

inherited

Return any HTML that needs to be included in the page's <head> when this question is used.

Parameters

$qa	the question attempt that will be displayed on the page.

Return values

string HTML fragment.

◆ hint()

qtype_renderer::hint	(	question_attempt	$qa,
		question_hint	$hint )

protectedinherited

Gereate the specific feedback.

This is feedback that varies according to the response the student gave.

Parameters

question_attempt $qa the question attempt to display.

Return values

string HTML fragment.

Reimplemented in qtype_ddmarker_renderer.

◆ manual_comment()

qtype_renderer::manual_comment	(	question_attempt	$qa,
		question_display_options	$options )

inherited

Display any extra question-type specific content that should be visible when grading, if appropriate.

Parameters

question_attempt	$qa	a question attempt.
question_display_options	$options	controls what should and should not be displayed.

Return values

string HTML fragment.

Reimplemented in qtype_essay_renderer.

◆ num_parts_correct()

qtype_renderer::num_parts_correct ( question_attempt $qa )

protectedinherited

Gereate a brief statement of how many sub-parts of this question the student got right.

Parameters

question_attempt $qa the question attempt to display.

Return values

string HTML fragment.

Reimplemented in qtype_multichoice_multi_renderer, and qtype_ordering_renderer.

◆ specific_feedback()

qtype_renderer::specific_feedback ( question_attempt $qa )

protectedinherited

Generate the specific feedback.

This is feedback that varies according to the response the student gave.

Parameters

question_attempt $qa the question attempt to display.

Return values

string HTML fragment.

Reimplemented in qtype_ddtoimage_renderer_base, qtype_elements_embedded_in_question_text_renderer, qtype_match_renderer, qtype_multichoice_renderer_base, qtype_numerical_renderer, qtype_ordering_renderer, qtype_shortanswer_renderer, and qtype_truefalse_renderer.

◆ subquestion()

qtype_multianswer_subq_renderer_base::subquestion	(	question_attempt	$qa,
		question_display_options	$options,
			$index,
		question_graded_automatically	$subq )

abstract

Reimplemented in qtype_multianswer_multiresponse_vertical_renderer.

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

question/type/multianswer/renderer.php

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Function Documentation

◆ clear_wrong()

◆ correct_response()

◆ feedback()

◆ feedback_image()

◆ feedback_popup()

◆ formulation_and_controls()

◆ formulation_heading()

◆ general_feedback()

◆ get_answer_label()

◆ get_feedback_image()

◆ head_code()

◆ hint()

◆ manual_comment()

◆ num_parts_correct()

◆ specific_feedback()

◆ subquestion()