Renderer base class for question behaviours. More...

Inheritance diagram for qbehaviour_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.

	controls (question_attempt $qa, question_display_options $options)
	Generate some HTML (which may be blank) that appears in the question formulation area, afer the question type generated output.

	feedback (question_attempt $qa, question_display_options $options)
	Generate some HTML (which may be blank) that appears in the outcome area, after the question-type generated output.

	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 questions using this model are used.

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

	manual_comment (question_attempt $qa, question_display_options $options)
	Display the manual comment, and a link to edit it, if appropriate.

	manual_comment_fields (question_attempt $qa, question_display_options $options)

	manual_comment_view (question_attempt $qa, question_display_options $options)

	mark_out_of_max (question_attempt $qa, core_question_renderer $qoutput, question_display_options $options)
	Generate the display of the marks for this question out of the available marks.

	mark_summary (question_attempt $qa, core_question_renderer $qoutput, question_display_options $options)
	Generate the display of the marks for this question.

	marked_out_of_max (question_attempt $qa, core_question_renderer $qoutput, question_display_options $options)
	Generate the display of the available marks for this question.

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

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

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
	get_mustache ()
	Return an instance of the mustache class.

	submit_button (question_attempt $qa, question_display_options $options)
	Several behaviours need a submit button, so put the common code here.

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

Renderer base class for question behaviours.

The methods in this class are mostly called from core_question_renderer which coordinates the overall output of questions.

Copyright: 2009 The Open University

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

Member Function Documentation

◆ controls()

qbehaviour_renderer::controls	(	question_attempt	$qa,
		question_display_options	$options )

Generate some HTML (which may be blank) that appears in the question formulation area, afer the question type generated output.

For example. immediatefeedback and interactive mode use this to show the Submit button, and CBM use this to display the certainty choices.

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 qbehaviour_adaptive_renderer, qbehaviour_deferredcbm_renderer, qbehaviour_immediatecbm_renderer, qbehaviour_immediatefeedback_renderer, qbehaviour_informationitem_renderer, qbehaviour_interactive_renderer, and qbehaviour_missing_renderer.

◆ feedback()

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

Generate some HTML (which may be blank) that appears in the outcome area, after the question-type generated output.

For example, the CBM models use this to display an explanation of the score adjustment that was made based on the certainty selected.

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 qbehaviour_adaptive_renderer, qbehaviour_deferredcbm_renderer, and qbehaviour_interactive_renderer.

◆ head_code()

qbehaviour_renderer::head_code ( question_attempt $qa )

Return any HTML that needs to be included in the page's <head> when questions using this model are used.

Parameters

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

Return values

string HTML fragment.

◆ manual_comment()

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

Display the manual comment, and a link to edit it, 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.

◆ mark_out_of_max()

qbehaviour_renderer::mark_out_of_max	(	question_attempt	$qa,
		core_question_renderer	$qoutput,
		question_display_options	$options )

Generate the display of the marks for this question out of the available marks.

Parameters

question_attempt	$qa	the question attempt to display.
core_question_renderer	$qoutput	the renderer for standard parts of questions.
question_display_options	$options	controls what should and should not be displayed.

Return values

HTML fragment.

Reimplemented in qbehaviour_deferredcbm_renderer.

◆ mark_summary()

qbehaviour_renderer::mark_summary	(	question_attempt	$qa,
		core_question_renderer	$qoutput,
		question_display_options	$options )

Generate the display of the marks for this question.

Parameters

question_attempt	$qa	the question attempt to display.
core_question_renderer	$qoutput	the renderer for standard parts of questions.
question_display_options	$options	controls what should and should not be displayed.

Return values

HTML fragment.

◆ marked_out_of_max()

qbehaviour_renderer::marked_out_of_max	(	question_attempt	$qa,
		core_question_renderer	$qoutput,
		question_display_options	$options )

Generate the display of the available marks for this question.

Parameters

question_attempt	$qa	the question attempt to display.
core_question_renderer	$qoutput	the renderer for standard parts of questions.
question_display_options	$options	controls what should and should not be displayed.

Return values

HTML fragment.

Reimplemented in qbehaviour_deferredcbm_renderer.

◆ submit_button()

qbehaviour_renderer::submit_button	(	question_attempt	$qa,
		question_display_options	$options )

protected

Several behaviours need a submit button, so put the common code here.

The button is disabled if the question is displayed read-only.

Parameters

question_display_options $options controls what should and should not be displayed.

Return values

string HTML fragment.

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

question/behaviour/rendererbase.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ controls()

◆ feedback()

◆ head_code()

◆ manual_comment()

◆ mark_out_of_max()

◆ mark_summary()

◆ marked_out_of_max()

◆ submit_button()