Inheritance diagram for gradingform_rubric_renderer:

Collaboration diagram for gradingform_rubric_renderer:

Public Member Functions
	criterion_template ($mode, $options, $elementname= '{NAME}', $criterion=null, $levelsstr= '{LEVELS}', $value=null)
	level_template ($mode, $options, $elementname= '{NAME}', $criterionid= '{CRITERION-id}', $level=null)
	display_rubric ($criteria, $options, $mode, $elementname=null, $values=null)
	display_instances ($instances, $defaultcontent, $cangrade)
	display_instance (gradingform_rubric_instance $instance, $idx, $cangrade)
	display_regrade_confirmation ($elementname, $changelevel, $value)
	display_rubric_mapping_explained ($scores)
Protected Member Functions
	rubric_template ($mode, $options, $elementname, $criteriastr)
	rubric_edit_options ($mode, $options)
	get_css_class_suffix ($idx, $maxidx)

Detailed Description

Grading method plugin renderer

Definition at line 30 of file renderer.php.

Member Function Documentation

criterion_template	(	$	mode,
		$	options
	)

This function returns html code for displaying criterion. Depending on $mode it may be the code to edit rubric, to preview the rubric, to evaluate somebody or to review the evaluation.

This function may be called from display_rubric() to display the whole rubric, or it can be called by itself to return a template used by JavaScript to add new empty criteria to the rubric 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 rubric display mode

See also:: gradingform_rubric_controller

Parameters:

string	$elementname	the name of the form element (in editor mode) or the prefix for div ids (in view mode)
array \| null	$criterion	criterion data
string	$levelsstr	evaluated templates for this criterion levels
array \| null	$value	(only in view mode) teacher's feedback on this criterion

Returns:: string

Definition at line 54 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

display_instance	(	gradingform_rubric_instance $	instance,
		$	idx,
		$	cangrade
	)

Displays one grading instance

Parameters:

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

Definition at line 429 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

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_rubric_instance
string	$defaultcontent	default string that would be displayed without advanced grading
boolean	$cangrade	whether current user has capability to grade in this context

Returns:: string

Definition at line 409 of file renderer.php.

Here is the call graph for this function:

display_regrade_confirmation	(	$	elementname,
		$	changelevel,
		$	value
	)

Definition at line 448 of file renderer.php.

Here is the call graph for this function:

display_rubric	(	$	criteria,
		$	options,
		$	mode,
		$	elementname = `null`,
		$	values = `null`
	)

This function returns html code for displaying rubric. Depending on $mode it may be the code to edit rubric, to preview the rubric, 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 rubric design and evaluation, adds the CSS class to elements and calls the functions level_template, criterion_template and rubric_template

Parameters:

array	$criteria	data about the rubric design
int	$mode	rubric display mode

See also:: gradingform_rubric_controller

Parameters:

string	$elementname	the name of the form element (in editor mode) or the prefix for div ids (in view mode)
array	$values	evaluation result

Returns:: string

Definition at line 346 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

display_rubric_mapping_explained ( $ scores )

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

Parameters:

array $scores

Returns:: string

Definition at line 471 of file renderer.php.

Here is the call graph for this function:

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

Returns:: string

Definition at line 385 of file renderer.php.

Here is the caller graph for this function:

level_template	(	$	mode,
		$	options
	)

This function returns html code for displaying one level of one criterion. Depending on $mode it may be the code to edit rubric, to preview the rubric, to evaluate somebody or to review the evaluation.

This function may be called from display_rubric() to display the whole rubric, or it can be called by itself to return a template used by JavaScript to add new empty level to the criterion during the design of rubric. In this case it will use macros like {NAME}, {CRITERION-id}, {LEVEL-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 rubric display mode

See also:: gradingform_rubric_controller

Parameters:

string	$elementname	the name of the form element (in editor mode) or the prefix for div ids (in view mode)
string \| int	$criterionid	either id of the nesting criterion or a macro for template
array \| null	$level	level data, also in view mode it might also have property $level['checked'] whether this level is checked

Returns:: string

Definition at line 145 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

rubric_edit_options	(	$	mode,
		$	options
	)		`[protected]`

Generates html template to view/edit the rubric options. Expression {NAME} is used in template for the form element name

Parameters:

int	$mode
array	$options

Returns:: string

Definition at line 277 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

rubric_template	(	$	mode,
		$	options,
		$	elementname,
		$	criteriastr
	)		`[protected]`

This function returns html code for displaying rubric template (content before and after criteria list). Depending on $mode it may be the code to edit rubric, to preview the rubric, to evaluate somebody or to review the evaluation.

This function is called from display_rubric() to display the whole rubric.

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 rubric display mode

See also:: gradingform_rubric_controller

Parameters:

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 rubric's criteria

Returns:: string

Definition at line 236 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

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

C:/xampp/htdocs/moodle/grade/grading/form/rubric/renderer.php

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation