 |
Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
|
|
Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
|
Defines the renderer for the quiz_grading module. More...
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. | |
| 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, $gradestring, $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 ($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_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. | |
Defines the renderer for the quiz_grading module.
|
inherited |
Magic method used to pass calls otherwise meant for the standard renderer to it to ensure we don't go causing unnecessary grief.
| string | $method | |
| array | $arguments |
| mixed |
|
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()
| component_action | $action | |
| string | $id |
| string | id of element, either original submitted or random new if not supplied |
|
inherited |
Return the site's compact logo URL, if any.
| int | $maxwidth | The maximum width, or null when the maximum width does not matter. |
| int | $maxheight | The maximum height, or null when the maximum height does not matter. |
| moodle_url|false |
|
inherited |
Return the site's logo URL, if any.
| int | $maxwidth | The maximum width, or null when the maximum width does not matter. |
| int | $maxheight | The maximum height, or null when the maximum height does not matter. |
| moodle_url|false |
|
protectedinherited |
Return an instance of the mustache class.
| Mustache_Engine |
|
inherited |
Returns true is output has already started, and false if not.
| boolean | true if the header has been printed. |
|
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')
| string | $imagename | the pathname of the image |
| string | $component | full plugin name (aka component) or 'theme' |
| moodle_url |
|
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.
| string | $imagename | the name of the icon. |
| string | $component | specification of one plugin like in get_string() |
| moodle_url |
|
staticinherited |
Given an array or space-separated list of classes, prepares and returns the HTML class attribute value.
| mixed | $classes | Space-separated string or array of classes |
| string | HTML class attribute value |
|
inherited |
Renders the provided widget and returns the HTML to display it.
| renderable | $widget | instance with renderable interface |
| string |
Reimplemented from renderer_base.
Reimplemented in core_courseformat\output\section_renderer, and tool_policy\output\renderer.
| quiz_grading_renderer::render_display_index_heading | ( | $linktext, | |
| $listquestionurl ) |
Render index display.
| string | $linktext | The text of the link. |
| moodle_url | $listquestionurl | Url of the page that list all questions. |
| string | The HTML for the display heading. |
| coding_exception |
|
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
| array | stdClass | $context | Context containing data for the template. |
| string|boolean |
| quiz_grading_renderer::render_grade_link | ( | $counts, | |
| $type, | |||
| $gradestring, | |||
| $gradequestionurl ) |
Render grade link for question.
| stdClass | $counts | |
| string | $type | Type of grade. |
| string | $gradestring | Lang string. |
| moodle_url | $gradequestionurl | Url to grade question. |
| string | The HTML for the question grade link. |
| coding_exception |
| quiz_grading_renderer::render_grade_question | ( | $questionusage, | |
| $slot, | |||
| $displayoptions, | |||
| $questionnumber, | |||
| $heading ) |
Render grade question content.
| question_usage_by_activity | $questionusage | The question usage that need to grade. |
| int | $slot | the number used to identify this question within this usage. |
| question_display_options | $displayoptions | the display options to use. |
| int | $questionnumber | the number of the question to check. |
| string | $heading | the question heading text. |
| string | The HTML for the question display. |
| quiz_grading_renderer::render_grading_interface | ( | $questioninfo, | |
| $listquestionsurl, | |||
| $filterform, | |||
| $paginginfo, | |||
| $pagingbar, | |||
| $formaction, | |||
| $hiddeninputs, | |||
| $gradequestioncontent ) |
Render grading page.
| stdClass | $questioninfo | Information of a question. |
| moodle_url | $listquestionsurl | Url of the page that list all questions. |
| quiz_grading_settings_form | $filterform | Question filter form. |
| stdClass | $paginginfo | Pagination information. |
| stdClass | $pagingbar | Pagination bar information. |
| moodle_url | $formaction | Form submit url. |
| array | $hiddeninputs | List of hidden input fields. |
| string | $gradequestioncontent | HTML string of question content. |
| string | The HTML for the grading interface. |
| coding_exception | |
| moodle_exception |
| quiz_grading_renderer::render_paging_bar | ( | object | $pagingbar | ) |
Render paging bar.
| object | $pagingbar | Pagination bar information. |
| string | The HTML for the question display. |
| quiz_grading_renderer::render_questions_table | ( | $includeauto, | |
| $data, | |||
| $header ) |
Render questions list table.
| bool | $includeauto | True to show automatically graded questions. |
| array | $data | List of questions. |
| array | $header | List of table headers. |
| string | The HTML for the question table. |
| coding_exception |
| quiz_grading_renderer::render_quiz_no_grade_question_notification | ( | ) |
Render no question need to grade notification.
| coding_exception |
| quiz_grading_renderer::render_quiz_no_question_notification | ( | $quiz, | |
| $cm, | |||
| $context ) |
Render no question notification.
| stdClass | $quiz | The quiz settings. |
| stdClass | $cm | The course-module for this quiz. |
| stdClass | $context | The quiz context. |
| string | The HTML for the no questions message. |
|
inherited |
Whether we should display the main logo.
| int | $headinglevel | The heading level we want to check against. |
| bool |
|
inherited |
Whether we should display the logo in the navbar.
We will when there are no main logos, and we have compact logo.
| bool |
|
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
1.11.0