Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/badges/ -> renderer.php (source)

[Source view]

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 401 and 403]

Renderer for use with the badges output

Author: Yuliya Bozhko <yuliya.bozhko@totaralms.com>
Copyright: 2012 onwards Totara Learning Solutions Ltd {@link http://www.totaralms.com/}
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 1153 lines (52 kb)
Included or required:0 times
Referenced: 2 times
Includes or requires: 0 files

Defines 1 class

core_badges_renderer:: (27 methods):
  print_badges_list()
  recipients_selection_form()
  print_badge_overview()
  print_badge_table_actions()
  render_issued_badge()
  render_badgeclass()
  render_external_badge()
  render_badge_user_collection()
  render_badge_collection()
  render_badge_management()
  print_badge_tabs()
  print_badge_status_box()
  print_badge_criteria()
  print_criteria_actions()
  render_badge_recipients()
  helper_sortable_heading()
  helper_fullname_format()
  helper_search_form()
  definition_list()
  print_badge_endorsement()
  print_badge_related()
  print_badge_alignments()
  render_badge_related()
  render_badge_alignments()
  render_external_backpacks_page()
  render_test_backpack_result()
  render_tertiary_navigation()


Class: core_badges_renderer  - X-Ref

Standard HTML output renderer for badges

print_badges_list($badges, $userid, $profile = false, $external = false)   X-Ref
No description

recipients_selection_form(user_selector_base $existinguc, user_selector_base $potentialuc)   X-Ref
No description

print_badge_overview($badge, $context)   X-Ref
No description

print_badge_table_actions($badge, $context)   X-Ref
No description

render_issued_badge(\core_badges\output\issued_badge $ibadge)   X-Ref
Render an issued badge.

param: \core_badges\output\issued_badge $ibadge
return: string

render_badgeclass(\core_badges\output\badgeclass $badge)   X-Ref
Render an issued badge.

param: \core_badges\output\badgeclass $badge
return: string

render_external_badge(\core_badges\output\external_badge $ibadge)   X-Ref
Render an external badge.

param: \core_badges\output\external_badge $ibadge
return: string

render_badge_user_collection(\core_badges\output\badge_user_collection $badges)   X-Ref
Render a collection of user badges.

param: \core_badges\output\badge_user_collection $badges
return: string

render_badge_collection(\core_badges\output\badge_collection $badges)   X-Ref
Render a collection of badges.

param: \core_badges\output\badge_collection $badges
return: string

render_badge_management(\core_badges\output\badge_management $badges)   X-Ref
Render a table of badges.

param: \core_badges\output\badge_management $badges
return: string

print_badge_tabs($badgeid, $context, $current = 'overview')   X-Ref
Prints tabs for badge editing.

param: integer $badgeid The badgeid to edit.
param: context $context The current context.
param: string $current The currently selected tab.
return: string

print_badge_status_box(badge $badge)   X-Ref
Prints badge status box.

param: badge $badge
return: Either the status box html as a string or null

print_badge_criteria(badge $badge, $short = '')   X-Ref
Returns information about badge criteria in a list form.

param: badge $badge Badge objects
param: string $short Indicates whether to print full info about this badge
return: string $output HTML string to output

print_criteria_actions(badge $badge)   X-Ref
Prints criteria actions for badge editing.

param: badge $badge
return: string

render_badge_recipients(\core_badges\output\badge_recipients $recipients)   X-Ref
Renders a table with users who have earned the badge.
Based on stamps collection plugin.

param: \core_badges\output\badge_recipients $recipients
return: string

helper_sortable_heading($text, $sortid = null, $sortby = null, $sorthow = null)   X-Ref
Renders a text with icons to sort by the given column

This is intended for table headings.

param: string $text    The heading text
param: string $sortid  The column id used for sorting
param: string $sortby  Currently sorted by (column id)
param: string $sorthow Currently sorted how (ASC|DESC)
return: string

helper_fullname_format()   X-Ref
Tries to guess the fullname format set at the site

return: string fl|lf

helper_search_form($search)   X-Ref
Renders a search form

param: string $search Search string
return: string HTML

definition_list(array $items, array $attributes = array()   X-Ref
Renders a definition list

param: array $items the list of items to define
param: array

print_badge_endorsement(badge $badge)   X-Ref
Outputs list en badges.

param: badge $badge Badge object.
return: string $output content endorsement to output.

print_badge_related(badge $badge)   X-Ref
Print list badges related.

param: badge $badge Badge objects.
return: string $output List related badges to output.

print_badge_alignments(badge $badge)   X-Ref
Print list badge alignments.

param: badge $badge Badge objects.
return: string $output List alignments to output.

render_badge_related(\core_badges\output\badge_related $related)   X-Ref
Renders a table for related badges.

param: \core_badges\output\badge_related $related list related badges.
return: string list related badges to output.

render_badge_alignments(\core_badges\output\badge_alignments $alignments)   X-Ref
Renders a table with alignment.

param: core_badges\output\badge_alignments $alignments List alignments.
return: string List alignment to output.

render_external_backpacks_page(\core_badges\output\external_backpacks_page $page)   X-Ref
Defer to template.

param: \core_badges\output\external_backpacks_page $page
return: bool|string

render_test_backpack_result(int $backpackid)   X-Ref
Get the result of a backpack validation with its settings. It returns:
- A informative message if the backpack version is different from OBv2.
- A warning with the error if it's not possible to connect to this backpack.
- A successful message if the connection has worked.

param: int    $backpackid The backpack identifier.
return: string A message with the validation result.

render_tertiary_navigation(\core_badges\output\base_action_bar $actionbar)   X-Ref
Render the tertiary navigation for the page.

param: \core_badges\output\base_action_bar $actionbar
return: bool|string