This renderer controls the overall output of questions. More...

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

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

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

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

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

	question (question_attempt $qa, qbehaviour_renderer $behaviouroutput, qtype_renderer $qtoutput, question_display_options $options, $number)
	Generate the display of a question in a particular state, and with certain display options.

	question_preview_link ($questionid, context $context, $showlabel)
	Render an icon, optionally with the word 'Preview' beside it, to preview a given question.

	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.

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

	standard_mark_summary (question_attempt $qa, qbehaviour_renderer $behaviouroutput, question_display_options $options)
	Generate the display of the marks for this question.

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

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
	action_author (question_attempt_step $step, question_display_options $options)
	Action author's profile link.

	add_part_heading ($heading, $content)
	Add an invisible heading like 'question text', 'feebdack' at the top of a section's contents, but only if the section has some content.

	edit_question_link (question_attempt $qa, question_display_options $options)
	Generate the display of the edit question link.

	formulation (question_attempt $qa, qbehaviour_renderer $behaviouroutput, qtype_renderer $qtoutput, question_display_options $options)
	Generate the display of the formulation part of the question.

	get_flag_html ($flagged, $id='')
	Work out the actual img tag needed for the flag.

	get_mustache ()
	Return an instance of the mustache class.

	info (question_attempt $qa, qbehaviour_renderer $behaviouroutput, qtype_renderer $qtoutput, question_display_options $options, $number)
	Generate the information bit of the question display that contains the metadata like the question number, current state, and mark.

	manual_comment (question_attempt $qa, qbehaviour_renderer $behaviouroutput, qtype_renderer $qtoutput, question_display_options $options)

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

	number ($number)
	Generate the display of the question number.

	outcome (question_attempt $qa, qbehaviour_renderer $behaviouroutput, qtype_renderer $qtoutput, question_display_options $options)
	Generate the display of the outcome part of the question.

	question_flag (question_attempt $qa, $flagsoption)
	Render the question flag, assuming $flagsoption allows it.

	question_number_text (?string $number)
	Get the question number as a string.

	response_history (question_attempt $qa, qbehaviour_renderer $behaviouroutput, qtype_renderer $qtoutput, question_display_options $options)
	Generate the display of the response history part of the question.

	status (question_attempt $qa, qbehaviour_renderer $behaviouroutput, question_display_options $options)
	Generate the display of the status line that gives the current state of the question.

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

This renderer controls the overall output of questions.

It works with a qbehaviour_renderer and a qtype_renderer to output the type-specific bits. The main entry point is the question() method.

Copyright: 2009 The Open University

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

Member Function Documentation

◆ __call()

plugin_renderer_base::__call	(		$method,
			$arguments )

inherited

Magic method used to pass calls otherwise meant for the standard renderer to it to ensure we don't go causing unnecessary grief.

Parameters

string	$method
array	$arguments

Return values

mixed

◆ action_author()

core_question_renderer::action_author	(	question_attempt_step	$step,
		question_display_options	$options )

protected

Action author's profile link.

Parameters

question_attempt_step	$step	The step.
question_display_options	$options	The display options.

Return values

string The link to user's profile.

◆ add_action_handler()

renderer_base::add_action_handler	(	component_action	$action,
			$id = null )

inherited

Adds a JS action for the element with the provided id.

This method adds a JS event for the provided component action to the page and then returns the id that the event has been attached to. If no id has been provided then a new ID is generated by html_writer::random_id()

Parameters

component_action	$action
string	$id

Return values

string id of element, either original submitted or random new if not supplied

◆ add_part_heading()

core_question_renderer::add_part_heading	(		$heading,
			$content )

protected

Add an invisible heading like 'question text', 'feebdack' at the top of a section's contents, but only if the section has some content.

Parameters

string	$heading	the heading to add.
string	$content	the content of the section.

Return values

string HTML fragment with the heading added.

◆ edit_question_link()

core_question_renderer::edit_question_link	(	question_attempt	$qa,
		question_display_options	$options )

protected

Generate the display of the edit question link.

Parameters

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

Return values

string

◆ formulation()

core_question_renderer::formulation	(	question_attempt	$qa,
		qbehaviour_renderer	$behaviouroutput,
		qtype_renderer	$qtoutput,
		question_display_options	$options )

protected

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 feedback, for example ticks and crosses, in this area.

Parameters

question_attempt	$qa	the question attempt to display.
qbehaviour_renderer	$behaviouroutput	the renderer to output the behaviour specific parts.
qtype_renderer	$qtoutput	the renderer to output the question type specific parts.
question_display_options	$options	controls what should and should not be displayed.

Return values

HTML fragment.

◆ get_compact_logo_url()

renderer_base::get_compact_logo_url	(		$maxwidth = 300,
			$maxheight = 300 )

inherited

Return the site's compact logo URL, if any.

Parameters

int	$maxwidth	The maximum width, or null when the maximum width does not matter.
int	$maxheight	The maximum height, or null when the maximum height does not matter.

Return values

moodle_url|false

◆ get_flag_html()

core_question_renderer::get_flag_html	(		$flagged,
			$id = '' )

protected

Work out the actual img tag needed for the flag.

Parameters

bool	$flagged	whether the question is currently flagged.
string	$id	an id to be added as an attribute to the img (optional).

Return values

string the img tag.

◆ get_logo_url()

renderer_base::get_logo_url	(		$maxwidth = null,
			$maxheight = 200 )

inherited

Return the site's logo URL, if any.

Parameters

int	$maxwidth	The maximum width, or null when the maximum width does not matter.
int	$maxheight	The maximum height, or null when the maximum height does not matter.

Return values

moodle_url|false

◆ get_mustache()

renderer_base::get_mustache ( )

protectedinherited

Return an instance of the mustache class.

Since: 2.9

Return values

Mustache_Engine

◆ has_started()

renderer_base::has_started ( )

inherited

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

Return values

boolean true if the header has been printed.

◆ image_url()

renderer_base::image_url	(		$imagename,
			$component = 'moodle' )

inherited

Return the moodle_url for an image.

The exact image location and extension is determined automatically by searching for gif|png|jpg|jpeg, please note there can not be diferent images with the different extension. The imagename is for historical reasons a relative path name, it may be changed later for core images. It is recommended to not use subdirectories in plugin and theme pix directories.

There are three types of images: 1/ theme images - stored in theme/mytheme/pix/, use component 'theme' 2/ core images - stored in /pix/, overridden via theme/mytheme/pix_core/ 3/ plugin images - stored in mod/mymodule/pix, overridden via theme/mytheme/pix_plugins/mod/mymodule/, example: image_url('comment', 'mod_glossary')

Parameters

string	$imagename	the pathname of the image
string	$component	full plugin name (aka component) or 'theme'

Return values

moodle_url

◆ info()

core_question_renderer::info	(	question_attempt	$qa,
		qbehaviour_renderer	$behaviouroutput,
		qtype_renderer	$qtoutput,
		question_display_options	$options,
			$number )

protected

Generate the information bit of the question display that contains the metadata like the question number, current state, and mark.

Parameters

question_attempt	$qa	the question attempt to display.
qbehaviour_renderer	$behaviouroutput	the renderer to output the behaviour specific parts.
qtype_renderer	$qtoutput	the renderer to output the question type specific parts.
question_display_options	$options	controls what should and should not be displayed.
string \| null	$number	The question number to display. 'i' is a special value that gets displayed as Information. Null means no number is displayed.

Return values

HTML fragment.

◆ mark_summary()

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

protected

Generate the display of the marks for this question.

Parameters

question_attempt	$qa	the question attempt to display.
qbehaviour_renderer	$behaviouroutput	the behaviour renderer, which can generate a custom display.
question_display_options	$options	controls what should and should not be displayed.

Return values

HTML fragment.

◆ number()

core_question_renderer::number ( $number )

protected

Generate the display of the question number.

Parameters

string | null $number The question number to display. 'i' is a special value that gets displayed as Information. Null means no number is displayed.

Return values

HTML fragment.

◆ outcome()

core_question_renderer::outcome	(	question_attempt	$qa,
		qbehaviour_renderer	$behaviouroutput,
		qtype_renderer	$qtoutput,
		question_display_options	$options )

protected

Generate the display of the outcome part of the question.

This is the area that contains the various forms of feedback.

Parameters

question_attempt	$qa	the question attempt to display.
qbehaviour_renderer	$behaviouroutput	the renderer to output the behaviour specific parts.
qtype_renderer	$qtoutput	the renderer to output the question type specific parts.
question_display_options	$options	controls what should and should not be displayed.

Return values

HTML fragment.

◆ pix_url()

renderer_base::pix_url	(		$imagename,
			$component = 'moodle' )

inherited

Return the direct URL for an image from the pix folder.

Use this function sparingly and never for icons. For icons use pix_icon or the pix helper in a mustache template.

Deprecated: since Moodle 3.3

Parameters

string	$imagename	the name of the icon.
string	$component	specification of one plugin like in get_string()

Return values

moodle_url

◆ prepare_classes()

static renderer_base::prepare_classes ( $classes )

staticinherited

Given an array or space-separated list of classes, prepares and returns the HTML class attribute value.

Parameters

mixed $classes Space-separated string or array of classes

Return values

string HTML class attribute value

◆ question()

core_question_renderer::question	(	question_attempt	$qa,
		qbehaviour_renderer	$behaviouroutput,
		qtype_renderer	$qtoutput,
		question_display_options	$options,
			$number )

Generate the display of a question in a particular state, and with certain display options.

Normally you do not call this method directly. Intsead you call question_usage_by_activity::render_question() which will call this method with appropriate arguments.

Parameters

question_attempt	$qa	the question attempt to display.
qbehaviour_renderer	$behaviouroutput	the renderer to output the behaviour specific parts.
qtype_renderer	$qtoutput	the renderer to output the question type specific parts.
question_display_options	$options	controls what should and should not be displayed.
string \| null	$number	The question number to display. 'i' is a special value that gets displayed as Information. Null means no number is displayed.

Return values

string HTML representation of the question.

◆ question_flag()

core_question_renderer::question_flag	(	question_attempt	$qa,
			$flagsoption )

protected

Render the question flag, assuming $flagsoption allows it.

Parameters

question_attempt	$qa	the question attempt to display.
int	$flagsoption	the option that says whether flags should be displayed.

◆ question_number_text()

core_question_renderer::question_number_text ( ?string $number )

protected

Get the question number as a string.

Parameters

string | null $number e.g. '123' or 'i'. null or '' means do not display anything number-related.

Return values

string e.g. 'Question 123' or 'Information' or ''.

◆ question_preview_link()

core_question_renderer::question_preview_link	(		$questionid,
		context	$context,
			$showlabel )

Render an icon, optionally with the word 'Preview' beside it, to preview a given question.

Parameters

int	$questionid	the id of the question to be previewed.
context	$context	the context in which the preview is happening. Must be a course or category context.
bool	$showlabel	if true, show the word 'Preview' after the icon. If false, just show the icon.

Deprecated: since Moodle 4.0

See also: qbank_previewquestion\output\renderer

Todo: Final deprecation on Moodle 4.4 MDL-72438

◆ render()

plugin_renderer_base::render ( renderable $widget )

inherited

Renders the provided widget and returns the HTML to display it.

Parameters

renderable $widget instance with renderable interface

Return values

string

Reimplemented from renderer_base.

Reimplemented in core_courseformat\output\section_renderer, and tool_policy\output\renderer.

◆ render_from_template()

renderer_base::render_from_template	(		$templatename,
			$context )

inherited

Renders a template by name with the given context.

The provided data needs to be array/stdClass made up of only simple types. Simple types are array,stdClass,bool,int,float,string

Since: 2.9

Parameters

array | stdClass $context Context containing data for the template.

Return values

string|boolean

◆ response_history()

core_question_renderer::response_history	(	question_attempt	$qa,
		qbehaviour_renderer	$behaviouroutput,
		qtype_renderer	$qtoutput,
		question_display_options	$options )

protected

Generate the display of the response history part of the question.

This is the table showing all the steps the question has been through.

Parameters

question_attempt	$qa	the question attempt to display.
qbehaviour_renderer	$behaviouroutput	the renderer to output the behaviour specific parts.
qtype_renderer	$qtoutput	the renderer to output the question type specific parts.
question_display_options	$options	controls what should and should not be displayed.

Return values

HTML fragment.

◆ should_display_main_logo()

renderer_base::should_display_main_logo ( $headinglevel = 1 )

inherited

Whether we should display the main logo.

Deprecated: since Moodle 4.0

Todo: final deprecation. To be removed in Moodle 4.4 MDL-73165.

Parameters

int $headinglevel The heading level we want to check against.

Return values

bool

◆ should_display_navbar_logo()

renderer_base::should_display_navbar_logo ( )

inherited

Whether we should display the logo in the navbar.

We will when there are no main logos, and we have compact logo.

Return values

bool

◆ standard_mark_out_of_max()

core_question_renderer::standard_mark_out_of_max	(	question_attempt	$qa,
		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.
question_display_options	$options	controls what should and should not be displayed.

Return values

HTML fragment.

◆ standard_mark_summary()

core_question_renderer::standard_mark_summary	(	question_attempt	$qa,
		qbehaviour_renderer	$behaviouroutput,
		question_display_options	$options )

Generate the display of the marks for this question.

Parameters

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

Return values

HTML fragment.

◆ standard_marked_out_of_max()

core_question_renderer::standard_marked_out_of_max	(	question_attempt	$qa,
		question_display_options	$options )

Generate the display of the available marks for this question.

Parameters

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

Return values

HTML fragment.

◆ status()

core_question_renderer::status	(	question_attempt	$qa,
		qbehaviour_renderer	$behaviouroutput,
		question_display_options	$options )

protected

Generate the display of the status line that gives the current state of the question.

Parameters

question_attempt	$qa	the question attempt to display.
qbehaviour_renderer	$behaviouroutput	the renderer to output the behaviour specific parts.
question_display_options	$options	controls what should and should not be displayed.

Return values

HTML fragment.

Member Data Documentation

◆ $output

renderer_base core_renderer plugin_renderer_base::$output

protectedinherited

A reference to the current renderer.

The renderer provided here will be determined by the page but will in 90% of cases by the core_renderer

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

question/engine/renderer.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ __call()

◆ action_author()

◆ add_action_handler()

◆ add_part_heading()

◆ edit_question_link()

◆ formulation()

◆ get_compact_logo_url()

◆ get_flag_html()

◆ get_logo_url()

◆ get_mustache()

◆ has_started()

◆ image_url()

◆ info()

◆ mark_summary()

◆ number()

◆ outcome()

◆ pix_url()

◆ prepare_classes()

◆ question()

◆ question_flag()

◆ question_number_text()

◆ question_preview_link()

◆ render()

◆ render_from_template()

◆ response_history()

◆ should_display_main_logo()

◆ should_display_navbar_logo()

◆ standard_mark_out_of_max()

◆ standard_mark_summary()

◆ standard_marked_out_of_max()

◆ status()

Member Data Documentation

◆ $output