 |
Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
|
|
Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
|
A custom renderer class that extends the plugin_renderer_base and is used by the assign 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. More... | |
| add_action_handler (component_action $action, $id=null) | |
| Adds a JS action for the element with the provided id. More... | |
| assign_files (context $context, $userid, $filearea, $component) | |
| Rendering assignment files. 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_assign_attempt_history (assign_attempt_history $history) | |
| Output the attempt history for this assignment. More... | |
| render_assign_attempt_history_chooser (assign_attempt_history_chooser $history) | |
| Output the attempt history chooser for this assignment. More... | |
| render_assign_course_index_summary (assign_course_index_summary $indexsummary) | |
| Render a course index summary. More... | |
| render_assign_feedback_plugin_feedback (assign_feedback_plugin_feedback $feedbackplugin) | |
| Render a feedback plugin feedback. More... | |
| render_assign_feedback_status (assign_feedback_status $status) | |
| Render a table containing all the current grades and feedback. More... | |
| render_assign_files (assign_files $tree) | |
| Rendering assignment files. More... | |
| render_assign_form (assign_form $form) | |
| Render the generic form. More... | |
| render_assign_grading_summary (assign_grading_summary $summary) | |
| Render a table containing the current status of the grading process. More... | |
| render_assign_grading_table (assign_grading_table $table) | |
| Render the grading table. More... | |
| render_assign_gradingmessage (assign_gradingmessage $result) | |
| Render a grading message notification. More... | |
| render_assign_header (assign_header $header) | |
| Render the header. More... | |
| render_assign_plugin_header (assign_plugin_header $header) | |
| Render the header for an individual plugin. More... | |
| render_assign_submission_plugin_submission (assign_submission_plugin_submission $submissionplugin) | |
| Render a submission plugin submission. More... | |
| render_assign_submission_status (assign_submission_status $status) | |
| Render a table containing the current status of the submission. More... | |
| render_assign_submission_status_compact (assign_submission_status_compact $status) | |
| Render a compact view of the current status of the submission. More... | |
| render_assign_submit_for_grading_page ($page) | |
| Render the submit for grading page. More... | |
| render_assign_user_summary (assign_user_summary $summary) | |
| Render the user summary. More... | |
| render_footer () | |
| Page is done - render the footer. More... | |
| render_from_template ($templatename, $context) | |
| Renders a template by name with the given context. More... | |
| render_grading_app (grading_app $app) | |
| Defer to template. 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 | |
| flexible_table (flexible_table $table, $rowsperpage, $displaylinks) | |
| Helper method dealing with the fact we can not just fetch the output of flexible_table. More... | |
| get_mustache () | |
| Return an instance of the mustache class. More... | |
| htmllize_tree (assign_files $tree, $dir) | |
| Internal function - creates htmls structure suitable for YUI tree. More... | |
| moodleform (moodleform $mform) | |
| Helper method dealing with the fact we can not just fetch the output of moodleforms. 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. | |
A custom renderer class that extends the plugin_renderer_base and is used by the assign 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 |
| mod_assign_renderer::assign_files | ( | context | $context, |
| $userid, | |||
| $filearea, | |||
| $component | |||
| ) |
Rendering assignment files.
| context | $context | |
| int | $userid | |
| string | $filearea | |
| string | $component |
| string |
|
protected |
Helper method dealing with the fact we can not just fetch the output of flexible_table.
| flexible_table | $table | The table to render |
| int | $rowsperpage | How many assignments to render in a page |
| bool | $displaylinks | - Whether to render links in the table (e.g. downloads would not enable this) |
| string | HTML |
|
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. |
|
protected |
Internal function - creates htmls structure suitable for YUI tree.
| assign_files | $tree | |
| array | $dir |
| string |
|
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 |
|
protected |
Helper method dealing with the fact we can not just fetch the output of moodleforms.
| moodleform | $mform |
| string | HTML |
|
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 tool_policy\output\renderer.
| mod_assign_renderer::render_assign_attempt_history | ( | assign_attempt_history | $history | ) |
Output the attempt history for this assignment.
| assign_attempt_history | $history |
| string |
| mod_assign_renderer::render_assign_attempt_history_chooser | ( | assign_attempt_history_chooser | $history | ) |
Output the attempt history chooser for this assignment.
| assign_attempt_history_chooser | $history |
| string |
| mod_assign_renderer::render_assign_course_index_summary | ( | assign_course_index_summary | $indexsummary | ) |
Render a course index summary.
| assign_course_index_summary | $indexsummary |
| string |
| mod_assign_renderer::render_assign_feedback_plugin_feedback | ( | assign_feedback_plugin_feedback | $feedbackplugin | ) |
Render a feedback plugin feedback.
| assign_feedback_plugin_feedback | $feedbackplugin |
| string |
| mod_assign_renderer::render_assign_feedback_status | ( | assign_feedback_status | $status | ) |
Render a table containing all the current grades and feedback.
| assign_feedback_status | $status |
| string |
| mod_assign_renderer::render_assign_files | ( | assign_files | $tree | ) |
| mod_assign_renderer::render_assign_form | ( | assign_form | $form | ) |
| mod_assign_renderer::render_assign_grading_summary | ( | assign_grading_summary | $summary | ) |
Render a table containing the current status of the grading process.
| assign_grading_summary | $summary |
| string |
| mod_assign_renderer::render_assign_grading_table | ( | assign_grading_table | $table | ) |
| mod_assign_renderer::render_assign_gradingmessage | ( | assign_gradingmessage | $result | ) |
Render a grading message notification.
| assign_gradingmessage | $result | The result to render |
| string |
| mod_assign_renderer::render_assign_header | ( | assign_header | $header | ) |
| mod_assign_renderer::render_assign_plugin_header | ( | assign_plugin_header | $header | ) |
Render the header for an individual plugin.
| assign_plugin_header | $header |
| string |
| mod_assign_renderer::render_assign_submission_plugin_submission | ( | assign_submission_plugin_submission | $submissionplugin | ) |
Render a submission plugin submission.
| assign_submission_plugin_submission | $submissionplugin |
| string |
| mod_assign_renderer::render_assign_submission_status | ( | assign_submission_status | $status | ) |
Render a table containing the current status of the submission.
| assign_submission_status | $status |
| string |
| mod_assign_renderer::render_assign_submission_status_compact | ( | assign_submission_status_compact | $status | ) |
Render a compact view of the current status of the submission.
| assign_submission_status_compact | $status |
| string |
| mod_assign_renderer::render_assign_submit_for_grading_page | ( | $page | ) |
Render the submit for grading page.
| assign_submit_for_grading_page | $page |
| string |
| mod_assign_renderer::render_assign_user_summary | ( | assign_user_summary | $summary | ) |
Render the user summary.
| assign_user_summary | $summary | The user summary to render |
| string |
| mod_assign_renderer::render_footer | ( | ) |
Page is done - render the footer.
| void |
|
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 |
| mod_assign_renderer::render_grading_app | ( | grading_app | $app | ) |
Defer to template.
| grading_app | $app | - All the data to render the grading app. |
|
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.9.3