 |
Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
|
|
Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
|
Standard HTML output renderer for badges. 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. | |
| print_badge_criteria (badge $badge, $short='') | |
| Returns information about badge criteria in a list form. | |
| print_badge_overview ($badge, $context) | |
| print_badge_status_box (badge $badge) | |
| Prints badge status box. | |
| print_badge_table_actions ($badge, $context) | |
| Prints action icons for the badge. | |
| print_badge_tabs ($badgeid, $context, $current='overview') | |
| Prints tabs for badge editing. | |
| print_badges_list ($badges, $userid, $profile=false, $external=false) | |
| print_criteria_actions (badge $badge) | |
| Prints criteria actions for badge editing. | |
| recipients_selection_form (user_selector_base $existinguc, user_selector_base $potentialuc) | |
| render (renderable $widget) | |
| Renders the provided widget and returns the HTML to display it. | |
| render_external_backpacks_page (\core_badges\output\external_backpacks_page $page) | |
| Defer to template. | |
| render_from_template ($templatename, $context) | |
| Renders a template by name with the given context. | |
| render_tertiary_navigation (\core_badges\output\base_action_bar $actionbar) | |
| Render the tertiary navigation for the page. | |
| render_test_backpack_result (int $backpackid) | |
| Get the result of a backpack validation with its settings. | |
| 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 | |
| definition_list (array $items, array $attributes=array()) | |
| Renders a definition list. | |
| get_mustache () | |
| Return an instance of the mustache class. | |
| helper_fullname_format () | |
| Tries to guess the fullname format set at the site. | |
| helper_search_form ($search) | |
| Renders a search form. | |
| helper_sortable_heading ($text, $sortid=null, $sortby=null, $sorthow=null) | |
| Renders a text with icons to sort by the given column. | |
| print_badge_alignments (badge $badge) | |
| Print list badge alignments. | |
| print_badge_endorsement (badge $badge) | |
| Outputs list en badges. | |
| print_badge_related (badge $badge) | |
| Print list badges related. | |
| render_badge_alignments (\core_badges\output\badge_alignments $alignments) | |
| Renders a table with alignment. | |
| render_badge_collection (\core_badges\output\badge_collection $badges) | |
| Render a collection of badges. | |
| render_badge_management (\core_badges\output\badge_management $badges) | |
| Render a table of badges. | |
| render_badge_recipients (\core_badges\output\badge_recipients $recipients) | |
| Renders a table with users who have earned the badge. | |
| render_badge_related (\core_badges\output\badge_related $related) | |
| Renders a table for related badges. | |
| render_badge_user_collection (\core_badges\output\badge_user_collection $badges) | |
| Render a collection of user badges. | |
| render_badgeclass (\core_badges\output\badgeclass $badge) | |
| Render an issued badge. | |
| render_external_badge (\core_badges\output\external_badge $ibadge) | |
| Render an external badge. | |
| render_issued_badge (\core_badges\output\issued_badge $ibadge) | |
| Render an issued badge. | |
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. | |
Standard HTML output renderer for badges.
|
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 |
|
protected |
Renders a definition list.
| array | $items | the list of items to define |
| array |
|
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 |
Tries to guess the fullname format set at the site.
| string | fl|lf |
|
protected |
Renders a search form.
| string | $search | Search string |
| string | HTML |
|
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 |
|
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 |
|
protected |
Print list badge alignments.
| badge | $badge | Badge objects. |
| string\$output | List alignments to output. |
| core_badges_renderer::print_badge_criteria | ( | badge | $badge, |
| $short = '' ) |
Returns information about badge criteria in a list form.
| badge | $badge | Badge objects |
| string | $short | Indicates whether to print full info about this badge |
| string\$output | HTML string to output |
|
protected |
Outputs list en badges.
| badge | $badge | Badge object. |
| string\$output | content endorsement to output. |
|
protected |
Print list badges related.
| badge | $badge | Badge objects. |
| string\$output | List related badges to output. |
| core_badges_renderer::print_badge_status_box | ( | badge | $badge | ) |
Prints badge status box.
| badge | $badge |
| Either | the status box html as a string or null |
| core_badges_renderer::print_badge_table_actions | ( | $badge, | |
| $context ) |
Prints action icons for the badge.
| core_badges\badge | $badge | |
| context | $context |
| string |
| core_badges_renderer::print_badge_tabs | ( | $badgeid, | |
| $context, | |||
| $current = 'overview' ) |
Prints tabs for badge editing.
| integer | $badgeid | The badgeid to edit. |
| context | $context | The current context. |
| string | $current | The currently selected tab. |
| string |
| core_badges_renderer::print_criteria_actions | ( | badge | $badge | ) |
Prints criteria actions for badge editing.
| badge | $badge |
| string |
|
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.
|
protected |
Renders a table with alignment.
| core_badges\output\badge_alignments | $alignments | List alignments. |
| string | List alignment to output. |
|
protected |
Render a collection of badges.
| core_badges\output\badge_collection | $badges |
| string |
|
protected |
Render a table of badges.
| core_badges\output\badge_management | $badges |
| string |
|
protected |
Renders a table with users who have earned the badge.
Based on stamps collection plugin.
| core_badges\output\badge_recipients | $recipients |
| string |
|
protected |
Renders a table for related badges.
| core_badges\output\badge_related | $related | list related badges. |
| string | list related badges to output. |
|
protected |
Render a collection of user badges.
| core_badges\output\badge_user_collection | $badges |
| string |
|
protected |
| core_badges_renderer::render_external_backpacks_page | ( | \core_badges\output\external_backpacks_page | $page | ) |
Defer to template.
| core_badges\output\external_backpacks_page | $page |
| bool|string |
|
protected |
|
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 |
| core_badges_renderer::render_tertiary_navigation | ( | \core_badges\output\base_action_bar | $actionbar | ) |
Render the tertiary navigation for the page.
| core_badges\output\base_action_bar | $actionbar |
| bool|string |
| core_badges_renderer::render_test_backpack_result | ( | int | $backpackid | ) |
Get the result of a backpack validation with its settings.
It returns:
| int | $backpackid | The backpack identifier. |
| string | A message with the validation result. |
|
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