Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
gradingform_guide_renderer Class Reference

Grading method plugin renderer. More...

Inheritance diagram for gradingform_guide_renderer:
plugin_renderer_base renderer_base

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.
 
 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 ($headinglevel=1)
 Whether we should display the 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.

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

◆ 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
stringid of element, either original submitted or random new if not supplied

◆ 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$modeguide display mode, one of gradingform_guide_controller\DISPLAY_* gradingform_guide_controller
string$elementnamethe 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$modeguide display mode, one of gradingform_guide_controller\DISPLAY_* gradingform_guide_controller()
array$optionsAn array of options. showmarkspercriterionstudents (bool) If true adds the current score to the display
string$elementnamethe name of the form element (in editor mode) or the prefix for div ids (in view mode)
array$criterioncriterion data
array$value(only in view mode) teacher's feedback on this criterion
array$validationerrorsAn array containing validation errors to be shown
array$commentsArray 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$criteriadata about the guide design
array$comments
array$options
int$modeguide display mode, one of gradingform_guide_controller\DISPLAY_* gradingform_guide_controller
string$elementnamethe name of the form element (in editor mode) or the prefix for div ids (in view mode)
array$valuesevaluation 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$idxunique number of instance on page
bool$cangradewhether 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$instancesarray of objects of type gradingform_guide_instance
string$defaultcontentdefault string that would be displayed without advanced grading
bool$cangradewhether 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$valueThe regrade option that was used
Return values
string

◆ 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$maxwidthThe maximum width, or null when the maximum width does not matter.
int$maxheightThe maximum height, or null when the maximum height does not matter.
Return values
moodle_url|false

◆ 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$idxindex of this element in the row/column
int$maxidxmaximum index of the element in the row/column
Return values
string

◆ get_logo_url()

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

Return the site's logo URL, if any.

Parameters
int$maxwidthThe maximum width, or null when the maximum width does not matter.
int$maxheightThe 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

◆ 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$modeguide 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$modeguide display mode, one of gradingform_guide_controller\DISPLAY_* gradingform_guide_controller
array$optionsAn array of options provided to gradingform_guide_renderer::guide_edit_options()
string$elementnamethe name of the form element (in editor mode) or the prefix for div ids (in view mode)
string$criteriastrevaluated templates for this guide's criteria
string$commentstr
Return values
string

◆ has_started()

renderer_base::has_started ( )
inherited

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

Return values
booleantrue 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$imagenamethe pathname of the image
string$componentfull plugin name (aka component) or 'theme'
Return values
moodle_url

◆ 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$imagenamethe name of the icon.
string$componentspecification 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$classesSpace-separated string or array of classes
Return values
stringHTML class attribute value

◆ render()

plugin_renderer_base::render ( renderable $widget)
inherited

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

Parameters
renderable$widgetinstance 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$contextContext containing data for the template.
Return values
string|boolean

◆ 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$headinglevelThe 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

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: