 |
Moodle PHP Documentation 4.1
Moodle 4.1.11 (Build: 20240610) (c8c84b4af18)
|
|
Moodle PHP Documentation 4.1
Moodle 4.1.11 (Build: 20240610) (c8c84b4af18)
|
Grading method plugin renderer. 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. | |
| 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. | |
Grading method plugin renderer.
|
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 |
| 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.
| int | $mode | guide display mode, one of gradingform_guide_controller\DISPLAY_* gradingform_guide_controller |
| string | $elementname | the name of the form element (in editor mode) or the prefix for div ids (in view mode) |
| array | $comment |
| string |
| 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.
| int | $mode | guide display mode, one of gradingform_guide_controller\DISPLAY_* gradingform_guide_controller() |
| array | $options | An array of options. showmarkspercriterionstudents (bool) If true adds the current score to the display |
| string | $elementname | the name of the form element (in editor mode) or the prefix for div ids (in view mode) |
| array | $criterion | criterion data |
| array | $value | (only in view mode) teacher's feedback on this criterion |
| array | $validationerrors | An array containing validation errors to be shown |
| array | $comments | Array of frequently used comments. |
| string |
| 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
| array | $criteria | data about the guide design |
| array | $comments | |
| array | $options | |
| int | $mode | guide display mode, one of gradingform_guide_controller\DISPLAY_* gradingform_guide_controller |
| string | $elementname | the name of the form element (in editor mode) or the prefix for div ids (in view mode) |
| array | $values | evaluation result |
| array | $validationerrors |
| string |
| 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.
| array | $scores |
| string |
| gradingform_guide_renderer::display_instance | ( | gradingform_guide_instance | $instance, |
| $idx, | |||
| $cangrade ) |
Displays one grading instance.
| gradingform_guide_instance | $instance | |
| int | $idx | unique number of instance on page |
| bool | $cangrade | whether current user has capability to grade in this context |
| gradingform_guide_renderer::display_instances | ( | $instances, | |
| $defaultcontent, | |||
| $cangrade ) |
Displays for the student the list of instances or default content if no instances found.
| array | $instances | array of objects of type gradingform_guide_instance |
| string | $defaultcontent | default string that would be displayed without advanced grading |
| bool | $cangrade | whether current user has capability to grade in this context |
| string |
| gradingform_guide_renderer::display_regrade_confirmation | ( | $elementname, | |
| $changelevel, | |||
| $value ) |
Displays a confirmation message after a regrade has occured.
| string | $elementname | |
| int | $changelevel | |
| int | $value | The regrade option that was used |
| string |
|
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 |
|
protected |
Help function to return CSS class names for element (first/last/even/odd) with leading space.
| int | $idx | index of this element in the row/column |
| int | $maxidx | maximum index of the element in the row/column |
| string |
|
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 |
|
protected |
Generates html template to view/edit the guide options.
Expression {NAME} is used in template for the form element name
| int | $mode | guide display mode, one of gradingform_guide_controller\DISPLAY_* gradingform_guide_controller |
| array | $options |
| string |
|
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.
| int | $mode | guide display mode, one of gradingform_guide_controller\DISPLAY_* gradingform_guide_controller |
| array | $options | An array of options provided to gradingform_guide_renderer::guide_edit_options() |
| 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 guide's criteria |
| string | $commentstr |
| string |
|
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.
|
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 |
|
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