Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
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.
 
 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 ()
 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_display_index_heading ($linktext, $listquestionurl)
 Render index display.
 
 render_from_template ($templatename, $context)
 Renders a template by name with the given context.
 
 render_grade_link ($counts, $type, $string, $component, $gradequestionurl)
 Render grade link for question.
 
 render_grade_question ($questionusage, $slot, $displayoptions, $questionnumber, $heading)
 Render grade question content.
 
 render_grading_interface ($questioninfo, $listquestionsurl, $filterform, $paginginfo, $pagingbar, $formaction, $hiddeninputs, $gradequestioncontent)
 Render grading page.
 
 render_paging_bar (object $pagingbar)
 Render paging bar.
 
 render_questions_table ($includeauto, $data, $header)
 Render questions list table.
 
 render_quiz_no_grade_question_notification ()
 Render no question need to grade notification.
 
 render_quiz_no_question_notification ($quiz, $cm, $context)
 Render no question notification.
 
 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_mustache ()
 Return an instance of the mustache class.
 

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

The renderer for the quiz_grading module.

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

Member Function Documentation

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

quiz_grading_renderer::render_grade_link ( $counts,
$type,
$string,
$component,
$gradequestionurl )

Render grade link for question.

Parameters
stdClass$counts
string$typeType of grade.
string$stringLang string.
string$componentLang string component.
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
stdClass$questioninfoInformation of a question.
moodle_url$listquestionsurlUrl of the page that list all questions.
quiz_grading_settings_form$filterformQuestion filter form.
stdClass$paginginfoPagination information.
stdClass$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_paging_bar()

quiz_grading_renderer::render_paging_bar ( object $pagingbar)

Render paging bar.

Parameters
object$pagingbarPagination bar information.
Return values
stringThe HTML for the question display.

◆ 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
stdClass$quizThe quiz settings.
stdClass$cmThe course-module for this quiz.
stdClass$contextThe quiz context.
Return values
stringThe HTML for the no questions message.

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