Generates the output for drag-and-drop words into sentences questions. More...

Inheritance diagram for qtype_ddwtos_renderer:

Public Member Functions
	__call ($method, $arguments)
	Magic method used to pass calls otherwise meant for the standard renderer to it to ensure we don't go causing unnecessary grief.

	add_action_handler (component_action $action, $id=null)
	Adds a JS action for the element with the provided id.

	clear_wrong (question_attempt $qa, $reallyclear=true)
	Actually, this question type abuses this method to always output the hidden fields it needs.

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

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

	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.

	get_compact_logo_url ($maxwidth=300, $maxheight=300)
	Return the site's compact logo URL, if any.

	get_logo_url ($maxwidth=null, $maxheight=200)
	Return the site's logo URL, if any.

	get_page ()
	Returns the moodle page object.

	has_started ()
	Returns true is output has already started, and false if not.

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

	image_url ($imagename, $component='moodle')
	Return the moodle_url for an image.

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

	pix_url ($imagename, $component='moodle')
	Return the direct URL for an image from the pix folder.

	render (renderable $widget)
	Renders the provided widget and returns the HTML to display it.

	render_from_template ($templatename, $context)
	Renders a template by name with the given context.

	should_display_main_logo ($headinglevel=1)
	Whether we should display the main logo.

	should_display_navbar_logo ()
	Whether we should display the logo in the navbar.

	specific_feedback (question_attempt $qa)
	Generate the specific feedback.

Static Public Member Functions
static	prepare_classes ($classes)
	Given an array or space-separated list of classes, prepares and returns the HTML class attribute value.

Protected Member Functions
	box_id (question_attempt $qa, $place)

	combined_feedback (question_attempt $qa)

	drag_boxes ($qa, $group, $choices, question_display_options $options)

	embedded_element (question_attempt $qa, $place, question_display_options $options)

	feedback_class ($fraction)

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

	general_feedback (question_attempt $qa)
	Gereate the general feedback.

	get_fragments_glue_placeholders ($fragments)
	Find strings that we can use to glue the fragments with.

	get_mustache ()
	Return an instance of the mustache class.

	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.

	post_qtext_elements (question_attempt $qa, question_display_options $options)

	qtext_id ($qa)

Protected Attributes
xhtml_container_stack	$opencontainers
	The xhtml_container_stack to use.

renderer_base core_renderer	$output
	A reference to the current renderer.

moodle_page	$page
	The Moodle page the renderer has been created to assist with.

string	$target
	The requested rendering target.

array	$templatecache = []
	$templatecache The mustache template cache.

Detailed Description

Generates the output for drag-and-drop words into sentences questions.

Copyright: 2010 The Open University

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

Member Function Documentation

◆ clear_wrong() [1/2]

qtype_ddwtos_renderer::clear_wrong	(	question_attempt	$qa,
			$reallyclear = true )

Actually, this question type abuses this method to always output the hidden fields it needs.

Parameters

question_attempt	$qa	the question attempt.
bool	$reallyclear	whether we are really clearing the responses, or just outputting them.

Return values

string HTML to output.

◆ clear_wrong() [2/2]

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_elements_embedded_in_question_text_renderer::correct_response ( question_attempt $qa )

inherited

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 from qtype_renderer.

◆ embedded_element()

qtype_ddwtos_renderer::embedded_element	(	question_attempt	$qa,
			$place,
		question_display_options	$options )

protected

Reimplemented from qtype_elements_embedded_in_question_text_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.

◆ formulation_and_controls()

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

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 from qtype_elements_embedded_in_question_text_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_fragments_glue_placeholders()

qtype_elements_embedded_in_question_text_renderer::get_fragments_glue_placeholders ( $fragments )

protectedinherited

Find strings that we can use to glue the fragments with.

These strings have to be all different and neither of them can be present in the text

Parameters

array $fragments

Return values

array array with indexes from 1 to count($fragments)-1

◆ 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.

◆ post_qtext_elements()

qtype_ddwtos_renderer::post_qtext_elements	(	question_attempt	$qa,
		question_display_options	$options )

protected

Reimplemented from qtype_elements_embedded_in_question_text_renderer.

◆ specific_feedback()

qtype_elements_embedded_in_question_text_renderer::specific_feedback ( question_attempt $qa )

inherited

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 from qtype_renderer.

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

question/type/ddwtos/renderer.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ clear_wrong() [1/2]

◆ clear_wrong() [2/2]

◆ correct_response()

◆ embedded_element()

◆ feedback()

◆ feedback_image()

◆ formulation_and_controls()

◆ formulation_heading()

◆ general_feedback()

◆ get_fragments_glue_placeholders()

◆ head_code()

◆ hint()

◆ manual_comment()

◆ num_parts_correct()

◆ post_qtext_elements()

◆ specific_feedback()