Standard HTML output renderer for badges. More...

Inheritance diagram for core_badges_renderer:

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)

	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.

Detailed Description

Standard HTML output renderer for badges.

Member Function Documentation

◆ __call()

plugin_renderer_base::__call	(		$method,
			$arguments )

inherited

Magic method used to pass calls otherwise meant for the standard renderer to it to ensure we don't go causing unnecessary grief.

Parameters

string	$method
array	$arguments

Return values

mixed

◆ add_action_handler()

renderer_base::add_action_handler	(	component_action	$action,
			$id = null )

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()

Parameters

component_action	$action
string	$id

Return values

string id of element, either original submitted or random new if not supplied

◆ definition_list()

core_badges_renderer::definition_list	(	array	$items,
		array	$attributes = array() )

protected

Renders a definition list.

Parameters

array	$items	the list of items to define
	array

◆ get_compact_logo_url()

renderer_base::get_compact_logo_url	(		$maxwidth = 300,
			$maxheight = 300 )

inherited

Return the site's compact logo URL, if any.

Parameters

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.

Return values

moodle_url|false

◆ get_logo_url()

renderer_base::get_logo_url	(		$maxwidth = null,
			$maxheight = 200 )

inherited

Return the site's logo URL, if any.

Parameters

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.

Return values

moodle_url|false

◆ get_mustache()

renderer_base::get_mustache ( )

protectedinherited

Return an instance of the mustache class.

Since: 2.9

Return values

Mustache_Engine

◆ has_started()

renderer_base::has_started ( )

inherited

Returns true is output has already started, and false if not.

Return values

boolean true if the header has been printed.

◆ helper_fullname_format()

core_badges_renderer::helper_fullname_format ( )

protected

Tries to guess the fullname format set at the site.

Return values

string fl|lf

◆ helper_search_form()

core_badges_renderer::helper_search_form ( $search )

protected

Renders a search form.

Parameters

string $search Search string

Return values

string HTML

◆ helper_sortable_heading()

core_badges_renderer::helper_sortable_heading	(	$text,
		$sortid = null,
		$sortby = null,
		$sorthow = null )

protected

Renders a text with icons to sort by the given column.

This is intended for table headings.

Parameters

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)

Return values

string

◆ image_url()

renderer_base::image_url	(		$imagename,
			$component = 'moodle' )

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')

Parameters

string	$imagename	the pathname of the image
string	$component	full plugin name (aka component) or 'theme'

Return values

moodle_url

◆ pix_url()

renderer_base::pix_url	(		$imagename,
			$component = 'moodle' )

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.

Deprecated: since Moodle 3.3

Parameters

string	$imagename	the name of the icon.
string	$component	specification of one plugin like in get_string()

Return values

moodle_url

◆ prepare_classes()

static renderer_base::prepare_classes ( $classes )

staticinherited

Given an array or space-separated list of classes, prepares and returns the HTML class attribute value.

Parameters

mixed $classes Space-separated string or array of classes

Return values

string HTML class attribute value

◆ print_badge_alignments()

core_badges_renderer::print_badge_alignments ( badge $badge )

protected

Print list badge alignments.

Parameters

badge $badge Badge objects.

Return values

string\$output List alignments to output.

◆ print_badge_criteria()

core_badges_renderer::print_badge_criteria	(	badge	$badge,
			$short = '' )

Returns information about badge criteria in a list form.

Parameters

badge	$badge	Badge objects
string	$short	Indicates whether to print full info about this badge

Return values

string\$output HTML string to output

◆ print_badge_endorsement()

core_badges_renderer::print_badge_endorsement ( badge $badge )

protected

Outputs list en badges.

Parameters

badge $badge Badge object.

Return values

string\$output content endorsement to output.

◆ print_badge_related()

core_badges_renderer::print_badge_related ( badge $badge )

protected

Print list badges related.

Parameters

badge $badge Badge objects.

Return values

string\$output List related badges to output.

◆ print_badge_status_box()

core_badges_renderer::print_badge_status_box ( badge $badge )

Prints badge status box.

Parameters

badge $badge

Return values

Either the status box html as a string or null

◆ print_badge_tabs()

core_badges_renderer::print_badge_tabs	(	$badgeid,
		$context,
		$current = 'overview' )

Prints tabs for badge editing.

Deprecated: since Moodle 4.0

Todo: MDL-73426 Final deprecation.

Parameters

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

Return values

string

◆ print_criteria_actions()

core_badges_renderer::print_criteria_actions ( badge $badge )

Prints criteria actions for badge editing.

Parameters

badge $badge

Return values

string

◆ render()

plugin_renderer_base::render ( renderable $widget )

inherited

Renders the provided widget and returns the HTML to display it.

Parameters

renderable $widget instance with renderable interface

Return values

string

Reimplemented from renderer_base.

Reimplemented in core_courseformat\output\section_renderer, and tool_policy\output\renderer.

◆ render_badge_alignments()

core_badges_renderer::render_badge_alignments ( \core_badges\output\badge_alignments $alignments )

protected

Renders a table with alignment.

Parameters

core_badges\output\badge_alignments $alignments List alignments.

Return values

string List alignment to output.

◆ render_badge_collection()

core_badges_renderer::render_badge_collection ( \core_badges\output\badge_collection $badges )

protected

Render a collection of badges.

Parameters

core_badges\output\badge_collection $badges

Return values

string

◆ render_badge_management()

core_badges_renderer::render_badge_management ( \core_badges\output\badge_management $badges )

protected

Render a table of badges.

Parameters

core_badges\output\badge_management $badges

Return values

string

◆ render_badge_recipients()

core_badges_renderer::render_badge_recipients ( \core_badges\output\badge_recipients $recipients )

protected

Renders a table with users who have earned the badge.

Based on stamps collection plugin.

Parameters

core_badges\output\badge_recipients $recipients

Return values

string

◆ render_badge_related()

core_badges_renderer::render_badge_related ( \core_badges\output\badge_related $related )

protected

Renders a table for related badges.

Parameters

core_badges\output\badge_related $related list related badges.

Return values

string list related badges to output.

◆ render_badge_user_collection()

core_badges_renderer::render_badge_user_collection ( \core_badges\output\badge_user_collection $badges )

protected

Render a collection of user badges.

Parameters

core_badges\output\badge_user_collection $badges

Return values

string

◆ render_badgeclass()

core_badges_renderer::render_badgeclass ( \core_badges\output\badgeclass $badge )

protected

Render an issued badge.

Parameters

core_badges\output\badgeclass $badge

Return values

string

◆ render_external_backpacks_page()

core_badges_renderer::render_external_backpacks_page ( \core_badges\output\external_backpacks_page $page )

Defer to template.

Parameters

core_badges\output\external_backpacks_page $page

Return values

bool|string

◆ render_external_badge()

core_badges_renderer::render_external_badge ( \core_badges\output\external_badge $ibadge )

protected

Render an external badge.

Parameters

core_badges\output\external_badge $ibadge

Return values

string

◆ render_from_template()

renderer_base::render_from_template	(		$templatename,
			$context )

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

Since: 2.9

Parameters

array | stdClass $context Context containing data for the template.

Return values

string|boolean

◆ render_issued_badge()

core_badges_renderer::render_issued_badge ( \core_badges\output\issued_badge $ibadge )

protected

Render an issued badge.

Parameters

core_badges\output\issued_badge $ibadge

Return values

string

◆ render_tertiary_navigation()

core_badges_renderer::render_tertiary_navigation ( \core_badges\output\base_action_bar $actionbar )

Render the tertiary navigation for the page.

Parameters

core_badges\output\base_action_bar $actionbar

Return values

bool|string

◆ render_test_backpack_result()

core_badges_renderer::render_test_backpack_result ( int $backpackid )

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.

Parameters

int $backpackid The backpack identifier.

Return values

string A message with the validation result.

◆ should_display_main_logo()

renderer_base::should_display_main_logo ( $headinglevel = 1 )

inherited

Whether we should display the main logo.

Deprecated: since Moodle 4.0

Todo: final deprecation. To be removed in Moodle 4.4 MDL-73165.

Parameters

int $headinglevel The heading level we want to check against.

Return values

bool

◆ should_display_navbar_logo()

renderer_base::should_display_navbar_logo ( )

inherited

Whether we should display the logo in the navbar.

We will when there are no main logos, and we have compact logo.

Return values

bool

Member Data Documentation

◆ $output

renderer_base core_renderer plugin_renderer_base::$output

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

The documentation for this class was generated from the following file:

badges/renderer.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ __call()

◆ add_action_handler()

◆ definition_list()

◆ get_compact_logo_url()

◆ get_logo_url()

◆ get_mustache()

◆ has_started()

◆ helper_fullname_format()

◆ helper_search_form()

◆ helper_sortable_heading()

◆ image_url()

◆ pix_url()

◆ prepare_classes()

◆ print_badge_alignments()

◆ print_badge_criteria()

◆ print_badge_endorsement()

◆ print_badge_related()

◆ print_badge_status_box()

◆ print_badge_tabs()

◆ print_criteria_actions()

◆ render()

◆ render_badge_alignments()

◆ render_badge_collection()

◆ render_badge_management()

◆ render_badge_recipients()

◆ render_badge_related()

◆ render_badge_user_collection()

◆ render_badgeclass()

◆ render_external_backpacks_page()

◆ render_external_badge()

◆ render_from_template()

◆ render_issued_badge()

◆ render_tertiary_navigation()

◆ render_test_backpack_result()

◆ should_display_main_logo()

◆ should_display_navbar_logo()

Member Data Documentation

◆ $output