Grading method plugin renderer. More...

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

	comment_template ($mode, $elementname='{NAME}', $comment=null)
	This function returns html code for displaying criterion.

	criterion_template ($mode, $options, $elementname='{NAME}', $criterion=null, $value=null, $validationerrors=null, $comments=null)
	This function returns html code for displaying criterion.

	display_guide ($criteria, $comments, $options, $mode, $elementname=null, $values=null, $validationerrors=null)
	This function returns html code for displaying guide.

	display_guide_mapping_explained ($scores)
	Generates and returns HTML code to display information box about how guide score is converted to the grade.

	display_instance (gradingform_guide_instance $instance, $idx, $cangrade)
	Displays one grading instance.

	display_instances ($instances, $defaultcontent, $cangrade)
	Displays for the student the list of instances or default content if no instances found.

	display_regrade_confirmation ($elementname, $changelevel, $value)
	Displays a confirmation message after a regrade has occured.

	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.

	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.

	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_css_class_suffix ($idx, $maxidx)
	Help function to return CSS class names for element (first/last/even/odd) with leading space.

	get_mustache ()
	Return an instance of the mustache class.

	guide_edit_options ($mode, $options)
	Generates html template to view/edit the guide options.

	guide_template ($mode, $options, $elementname, $criteriastr, $commentstr)
	This function returns html code for displaying guide template (content before and after criteria list).

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

Grading method plugin renderer.

Copyright: 2012 Dan Marsden dan@d.nosp@m.anma.nosp@m.rsden.nosp@m..com

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

Member Function Documentation

◆ comment_template()

gradingform_guide_renderer::comment_template	(	$mode,
		$elementname = '{NAME}',
		$comment = null )

This function returns html code for displaying criterion.

Depending on $mode it may be the code to edit guide, to preview the guide, to evaluate somebody or to review the evaluation.

This function may be called from display_guide() to display the whole guide, or it can be called by itself to return a template used by JavaScript to add new empty criteria to the guide being designed. In this case it will use macros like {NAME}, {LEVELS}, {CRITERION-id}, etc.

When overriding this function it is very important to remember that all elements of html form (in edit or evaluate mode) must have the name $elementname.

Also JavaScript relies on the class names of elements and when developer changes them script might stop working.

Parameters

int	$mode	guide display mode, one of gradingform_guide_controller\DISPLAY_* gradingform_guide_controller
string	$elementname	the name of the form element (in editor mode) or the prefix for div ids (in view mode)
array	$comment

Return values

string

◆ criterion_template()

gradingform_guide_renderer::criterion_template	(	$mode,
		$options,
		$elementname = '{NAME}',
		$criterion = null,
		$value = null,
		$validationerrors = null,
		$comments = null )

This function returns html code for displaying criterion.

Depending on $mode it may be the code to edit guide, to preview the guide, to evaluate somebody or to review the evaluation.

This function may be called from display_guide() to display the whole guide, or it can be called by itself to return a template used by JavaScript to add new empty criteria to the guide being designed. In this case it will use macros like {NAME}, {LEVELS}, {CRITERION-id}, etc.

When overriding this function it is very important to remember that all elements of html form (in edit or evaluate mode) must have the name $elementname.

Also JavaScript relies on the class names of elements and when developer changes them script might stop working.

Parameters

int	$mode	guide display mode, one of gradingform_guide_controller\DISPLAY_* gradingform_guide_controller()
array	$options	An array of options. showmarkspercriterionstudents (bool) If true adds the current score to the display
string	$elementname	the name of the form element (in editor mode) or the prefix for div ids (in view mode)
array	$criterion	criterion data
array	$value	(only in view mode) teacher's feedback on this criterion
array	$validationerrors	An array containing validation errors to be shown
array	$comments	Array of frequently used comments.

Return values

string

◆ display_guide()

gradingform_guide_renderer::display_guide	(	$criteria,
		$comments,
		$options,
		$mode,
		$elementname = null,
		$values = null,
		$validationerrors = null )

This function returns html code for displaying guide.

Depending on $mode it may be the code to edit guide, to preview the guide, to evaluate somebody or to review the evaluation.

It is very unlikely that this function needs to be overriden by theme. It does not produce any html code, it just prepares data about guide design and evaluation, adds the CSS class to elements and calls the functions level_template, criterion_template and guide_template

Parameters

array	$criteria	data about the guide design
array	$comments
array	$options
int	$mode	guide display mode, one of gradingform_guide_controller\DISPLAY_* gradingform_guide_controller
string	$elementname	the name of the form element (in editor mode) or the prefix for div ids (in view mode)
array	$values	evaluation result
array	$validationerrors

Return values

string

◆ display_guide_mapping_explained()

gradingform_guide_renderer::display_guide_mapping_explained ( $scores )

Generates and returns HTML code to display information box about how guide score is converted to the grade.

Parameters

array $scores

Return values

string

◆ display_instance()

gradingform_guide_renderer::display_instance	(	gradingform_guide_instance	$instance,
			$idx,
			$cangrade )

Displays one grading instance.

Parameters

gradingform_guide_instance	$instance
int	$idx	unique number of instance on page
bool	$cangrade	whether current user has capability to grade in this context

◆ display_instances()

gradingform_guide_renderer::display_instances	(	$instances,
		$defaultcontent,
		$cangrade )

Displays for the student the list of instances or default content if no instances found.

Parameters

array	$instances	array of objects of type gradingform_guide_instance
string	$defaultcontent	default string that would be displayed without advanced grading
bool	$cangrade	whether current user has capability to grade in this context

Return values

string

◆ display_regrade_confirmation()

gradingform_guide_renderer::display_regrade_confirmation	(	$elementname,
		$changelevel,
		$value )

Displays a confirmation message after a regrade has occured.

Parameters

string	$elementname
int	$changelevel
int	$value	The regrade option that was used

Return values

string

◆ get_css_class_suffix()

gradingform_guide_renderer::get_css_class_suffix	(		$idx,
			$maxidx )

protected

Help function to return CSS class names for element (first/last/even/odd) with leading space.

Parameters

int	$idx	index of this element in the row/column
int	$maxidx	maximum index of the element in the row/column

Return values

string

◆ guide_edit_options()

gradingform_guide_renderer::guide_edit_options	(		$mode,
			$options )

protected

Generates html template to view/edit the guide options.

Expression {NAME} is used in template for the form element name

Parameters

int	$mode	guide display mode, one of gradingform_guide_controller\DISPLAY_* gradingform_guide_controller
array	$options

Return values

string

◆ guide_template()

gradingform_guide_renderer::guide_template	(	$mode,
		$options,
		$elementname,
		$criteriastr,
		$commentstr )

protected

This function returns html code for displaying guide template (content before and after criteria list).

Depending on $mode it may be the code to edit guide, to preview the guide, to evaluate somebody or to review the evaluation.

This function is called from display_guide() to display the whole guide.

When overriding this function it is very important to remember that all elements of html form (in edit or evaluate mode) must have the name $elementname.

Also JavaScript relies on the class names of elements and when developer changes them script might stop working.

Parameters

int	$mode	guide display mode, one of gradingform_guide_controller\DISPLAY_* gradingform_guide_controller
array	$options	An array of options provided to gradingform_guide_renderer::guide_edit_options()
string	$elementname	the name of the form element (in editor mode) or the prefix for div ids (in view mode)
string	$criteriastr	evaluated templates for this guide's criteria
string	$commentstr

Return values

string

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

grade/grading/form/guide/renderer.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ comment_template()

◆ criterion_template()

◆ display_guide()

◆ display_guide_mapping_explained()

◆ display_instance()

◆ display_instances()

◆ display_regrade_confirmation()

◆ get_css_class_suffix()

◆ guide_edit_options()

◆ guide_template()