Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
quiz_grading_renderer Class Reference

The renderer for the quiz_grading module. More...

Inheritance diagram for quiz_grading_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. More...
 
 add_action_handler (component_action $action, $id=null)
 Adds a JS action for the element with the provided id. More...
 
 get_compact_logo_url ($maxwidth=300, $maxheight=300)
 Return the site's compact logo URL, if any. More...
 
 get_logo_url ($maxwidth=null, $maxheight=200)
 Return the site's logo URL, if any. More...
 
 has_started ()
 Returns true is output has already started, and false if not. More...
 
 image_url ($imagename, $component='moodle')
 Return the moodle_url for an image. More...
 
 pix_url ($imagename, $component='moodle')
 Return the direct URL for an image from the pix folder. More...
 
 render (renderable $widget)
 Renders the provided widget and returns the HTML to display it. More...
 
 render_display_index_heading ($linktext, $listquestionurl)
 Render index display. More...
 
 render_from_template ($templatename, $context)
 Renders a template by name with the given context. More...
 
 render_grade_link ($counts, $type, $gradestring, $gradequestionurl)
 Render grade link for question. More...
 
 render_grade_question ($questionusage, $slot, $displayoptions, $questionnumber, $heading)
 Render grade question content. More...
 
 render_grading_interface ($questioninfo, $listquestionsurl, $filterform, $paginginfo, $pagingbar, $formaction, $hiddeninputs, $gradequestioncontent)
 Render grading page. More...
 
 render_questions_table ($includeauto, $data, $header)
 Render questions list table. More...
 
 render_quiz_no_grade_question_notification ()
 Render no question need to grade notification. More...
 
 render_quiz_no_question_notification ($quiz, $cm, $context)
 Render no question notification. More...
 
 should_display_main_logo ($headinglevel=1)
 Whether we should display the main logo. More...
 
 should_display_navbar_logo ()
 Whether we should display the logo in the navbar. More...
 

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. More...
 

Protected Member Functions

 get_mustache ()
 Return an instance of the mustache class. More...
 

Protected Attributes

xhtml_container_stack $opencontainers
 The xhtml_container_stack to use.
 
renderer_base core_renderer $output
 A reference to the current renderer. More...
 
moodle_page $page
 The Moodle page the renderer has been created to assist with.
 
string $target
 The requested rendering target.
 

Detailed Description

The renderer for the quiz_grading module.

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

◆ 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_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

◆ 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 tool_policy\output\renderer.

◆ render_display_index_heading()

quiz_grading_renderer::render_display_index_heading (   $linktext,
  $listquestionurl 
)

Render index display.

Parameters
string$linktextThe text of the link.
moodle_url$listquestionurlUrl of the page that list all questions.
Return values
stringThe HTML for the display heading.
Exceptions
coding_exception

◆ 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

◆ render_grade_link()

quiz_grading_renderer::render_grade_link (   $counts,
  $type,
  $gradestring,
  $gradequestionurl 
)

Render grade link for question.

Parameters
object$counts
string$typeType of grade.
string$gradestringLang string.
moodle_url$gradequestionurlUrl to grade question.
Return values
stringThe HTML for the question grade link.
Exceptions
coding_exception

◆ render_grade_question()

quiz_grading_renderer::render_grade_question (   $questionusage,
  $slot,
  $displayoptions,
  $questionnumber,
  $heading 
)

Render grade question content.

Parameters
question_usage_by_activity$questionusageThe question usage that need to grade.
int$slotthe number used to identify this question within this usage.
question_display_options$displayoptionsthe display options to use.
int$questionnumberthe number of the question to check.
string$headingthe question heading text.
Return values
stringThe HTML for the question display.

◆ render_grading_interface()

quiz_grading_renderer::render_grading_interface (   $questioninfo,
  $listquestionsurl,
  $filterform,
  $paginginfo,
  $pagingbar,
  $formaction,
  $hiddeninputs,
  $gradequestioncontent 
)

Render grading page.

Parameters
object$questioninfoInformation of a question.
moodle_url$listquestionsurlUrl of the page that list all questions.
quiz_grading_settings_form$filterformQuestion filter form.
object$paginginfoPagination information.
object$pagingbarPagination bar information.
moodle_url$formactionForm submit url.
array$hiddeninputsList of hidden input fields.
string$gradequestioncontentHTML string of question content.
Return values
stringThe HTML for the grading interface.
Exceptions
coding_exception
moodle_exception

◆ render_questions_table()

quiz_grading_renderer::render_questions_table (   $includeauto,
  $data,
  $header 
)

Render questions list table.

Parameters
bool$includeautoTrue to show automatically graded questions.
array$dataList of questions.
array$headerList of table headers.
Return values
stringThe HTML for the question table.
Exceptions
coding_exception

◆ render_quiz_no_grade_question_notification()

quiz_grading_renderer::render_quiz_no_grade_question_notification ( )

Render no question need to grade notification.

Exceptions
coding_exception

◆ render_quiz_no_question_notification()

quiz_grading_renderer::render_quiz_no_question_notification (   $quiz,
  $cm,
  $context 
)

Render no question notification.

Parameters
object$quizThe quiz settings.
object$cmThe course-module for this quiz.
object$contextThe quiz context.
Return values
stringThe HTML for the no questions message.

◆ should_display_main_logo()

renderer_base::should_display_main_logo (   $headinglevel = 1)
inherited

Whether we should display the main logo.

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: