 |
Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
|
|
Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
|
Workshop module renderer class. 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. | |
| initials_bars (workshop $workshop, moodle_url $url) | |
| Render the initials bars for workshop. | |
| perpage_selector ($current=10) | |
| Renders a perpage selector for workshop listings. | |
| 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_action_buttons (workshop $workshop, workshop_user_plan $userplan) | |
| Generates the action buttons. | |
| render_allocation_menu (\mod_workshop\output\actionbar $actionbar) | |
| Renders the tertiary nav for the allocation pages. | |
| 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. | |
| view_page (workshop $workshop, workshop_user_plan $userplan, string $currentphasetitle, int $page, string $sortby, string $sorthow) | |
| Generates the view page. | |
| view_submissions_report (workshop $workshop, workshop_user_plan $userplan, int $page, string $sortby, string $sorthow) | |
| Generates the submission report. | |
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. | |
| helper_grading_report_assessment ($assessment, $shownames, array $userinfo, $separator) | |
| helper_grading_report_grade ($grade, $over=null) | |
| Formats the aggreagated grades. | |
| helper_grading_report_participant (stdclass $participant, array $userinfo) | |
| helper_grading_report_submission (stdclass $participant) | |
| helper_sortable_heading ($text, $sortid=null, $sortby=null, $sorthow=null) | |
| Renders a text with icons to sort by the given column. | |
| helper_submission_attachments ($submissionid, $format='html') | |
| Renders a list of files attached to the submission. | |
| helper_user_plan_tasks (array $tasks) | |
| Renders the tasks for the single phase in the user plan. | |
| overall_feedback (workshop_assessment $assessment) | |
| Renders the overall feedback for the author of the submission. | |
| render_workshop_allocation_result (workshop_allocation_result $result) | |
| Renders the result of the submissions allocation process. | |
| render_workshop_assessment (workshop_assessment $assessment) | |
| Renders the full assessment. | |
| render_workshop_example_assessment (workshop_example_assessment $assessment) | |
| Renders the assessment of an example submission. | |
| render_workshop_example_reference_assessment (workshop_example_reference_assessment $assessment) | |
| Renders the reference assessment of an example submission. | |
| render_workshop_example_submission (workshop_example_submission $example) | |
| Renders full workshop example submission. | |
| render_workshop_example_submission_summary (workshop_example_submission_summary $summary) | |
| Renders short summary of the example submission. | |
| render_workshop_feedback_author (workshop_feedback_author $feedback) | |
| Renders the feedback for the author of the submission. | |
| render_workshop_feedback_reviewer (workshop_feedback_reviewer $feedback) | |
| Renders the feedback for the reviewer of the submission. | |
| render_workshop_final_grades (workshop_final_grades $grades) | |
| Renders the user's final grades. | |
| render_workshop_grading_report (workshop_grading_report $gradingreport) | |
| Renders the workshop grading report. | |
| render_workshop_message (workshop_message $message) | |
| Renders workshop message. | |
| render_workshop_submission (workshop_submission $submission) | |
| Renders full workshop submission. | |
| render_workshop_submission_summary (workshop_submission_summary $summary) | |
| Renders short summary of the submission. | |
| render_workshop_user_plan (workshop_user_plan $plan) | |
| Renders the user plannner tool. | |
Static Protected Member Functions | |
| static | array_nth (array $a, $n) |
| Helper function returning the n-th item of the array. | |
| static | fullname_format () |
| Tries to guess the fullname format set at the site. | |
| static | moodleform (moodleform $mform) |
| Helper method dealing with the fact we can not just fetch the output of moodleforms. | |
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. | |
Workshop module renderer class.
|
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 |
|
staticprotected |
Helper function returning the n-th item of the array.
| array | $a | |
| int | $n | from 0 to m, where m is th number of items in the array |
| mixed | the $n-th element of $a |
|
staticprotected |
Tries to guess the fullname format set at the site.
| string | fl|lf |
|
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 |
| stdClass | null | $assessment | |
| bool | $shownames | |
| string | $separator | between the grade and the reviewer/author |
| string |
|
protected |
| stdClass | $participant | |
| array | $userinfo |
| string |
|
protected |
| stdClass | $participant |
| string |
|
protected |
Renders a text with icons to sort by the given column.
This is intended for table headings.
| string | $text | The heading text |
| string | $sortid | The column id used for sorting |
| string | $sortby | Currently sorted by (column id) |
| string | $sorthow | Currently sorted how (ASC|DESC) |
| string |
|
protected |
Renders a list of files attached to the submission.
If format==html, then format a html string. If format==text, then format a text-only string. Otherwise, returns html for non-images and html to display the image inline.
| int | $submissionid | submission identifier |
| string | format the format of the returned string - html|text |
| string | formatted text to be echoed |
|
protected |
Renders the tasks for the single phase in the user plan.
| stdClass | $tasks |
| string | html code |
|
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 |
| mod_workshop_renderer::initials_bars | ( | workshop | $workshop, |
| moodle_url | $url ) |
Render the initials bars for workshop.
| workshop | $workshop | the current workshop of initial bars. |
| moodle_url | $url | base URL object. |
| string | HTML. |
|
staticprotected |
Helper method dealing with the fact we can not just fetch the output of moodleforms.
| moodleform | $mform |
| string | HTML |
|
protected |
Renders the overall feedback for the author of the submission.
| workshop_assessment | $assessment |
| string | HTML |
| mod_workshop_renderer::perpage_selector | ( | $current = 10 | ) |
Renders a perpage selector for workshop listings.
The scripts using this have to define the $PAGE->url prior to calling this and deal with eventually submitted value themselves.
| int | $current | current value of the perpage parameter |
| 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 core_courseformat\output\section_renderer, and tool_policy\output\renderer.
| mod_workshop_renderer::render_action_buttons | ( | workshop | $workshop, |
| workshop_user_plan | $userplan ) |
Generates the action buttons.
| workshop | $workshop | The current workshop. |
| workshop_user_plan | $userplan | An individual workshop plan for the user. |
| string | HTML to display. |
| mod_workshop_renderer::render_allocation_menu | ( | \mod_workshop\output\actionbar | $actionbar | ) |
Renders the tertiary nav for the allocation pages.
| mod_workshop\output\actionbar | $actionbar |
| bool|string | the rendered output |
|
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 |
|
protected |
Renders the result of the submissions allocation process.
| workshop_allocation_result | $result | as returned by the allocator's init() method |
| string | HTML to be echoed |
|
protected |
|
protected |
Renders the assessment of an example submission.
| workshop_example_assessment | $assessment |
| string | HTML |
|
protected |
Renders the reference assessment of an example submission.
| workshop_example_reference_assessment | $assessment |
| string | HTML |
|
protected |
Renders full workshop example submission.
| workshop_example_submission | $example |
| string | HTML |
|
protected |
Renders short summary of the example submission.
| workshop_example_submission_summary | $summary |
| string | text to be echo'ed |
|
protected |
Renders the feedback for the author of the submission.
| workshop_feedback_author | $feedback |
| string | HTML |
|
protected |
Renders the feedback for the reviewer of the submission.
| workshop_feedback_reviewer | $feedback |
| string | HTML |
|
protected |
Renders the user's final grades.
| workshop_final_grades | $grades | with the info about grades in the gradebook |
| string | HTML |
|
protected |
Renders the workshop grading report.
| workshop_grading_report | $gradingreport |
| string | html code |
|
protected |
Renders workshop message.
| workshop_message | $message | to display |
| string | html code |
|
protected |
Renders full workshop submission.
| workshop_submission | $submission |
| string | HTML |
|
protected |
Renders short summary of the submission.
| workshop_submission_summary | $summary |
| string | text to be echo'ed |
|
protected |
Renders the user plannner tool.
| workshop_user_plan | $plan | prepared for the user |
| string | html code to be displayed |
|
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 |
| mod_workshop_renderer::view_page | ( | workshop | $workshop, |
| workshop_user_plan | $userplan, | ||
| string | $currentphasetitle, | ||
| int | $page, | ||
| string | $sortby, | ||
| string | $sorthow ) |
Generates the view page.
| workshop | $workshop | The current workshop. |
| workshop_user_plan | $userplan | An individual workshop plan for the user. |
| string | $currentphasetitle | The current phase title. |
| int | $page | The current page (for the pagination). |
| string | $sortby | Lastname|firstname|submissiontitle|submissiongrade|gradinggrade. |
| string | $sorthow | ASC|DESC. |
| string | HTML to display. |
| mod_workshop_renderer::view_submissions_report | ( | workshop | $workshop, |
| workshop_user_plan | $userplan, | ||
| int | $page, | ||
| string | $sortby, | ||
| string | $sorthow ) |
Generates the submission report.
| workshop | $workshop | The current workshop. |
| workshop_user_plan | $userplan | An individual workshop plan for the user. |
| int | $page | The current page (for the pagination). |
| string | $sortby | Lastname|firstname|submissiontitle|submissiongrade|gradinggrade. |
| string | $sorthow | ASC|DESC. |
| string | HTML to display. |
|
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