mod_forum\output\courseformat\activitybadge Class Reference

Activity badge forum class, used for rendering unread messages. More...

Inheritance diagram for mod_forum\output\courseformat\activitybadge:

Public Member Functions
	export_for_template (renderer_base $output)
	Export this data so it can be used as the context for a mustache template.
	get_template_name (\renderer_base $renderer)
	Get the name of the template to use for this templatable.

Static Public Member Functions
static	create_instance (cm_info $cminfo)
	Creates an instance of activityclass for the given course module, in case it implements it.

Public Attributes
array const	STYLES
	Badge defined styles.

Protected Member Functions
	update_content ()
	This method will be called before exporting the template.

Protected Attributes
cm_info	$cminfo = null
	The course module information.
string	$content = null
	The content to be displayed in the activity badge.
string	$elementid = null
	An optional element id in case the module wants to add some code for the activity badge (events, CSS...).
array	$extraattributes = []
	An optional array of extra HTML attributes to add to the badge element (for example, data attributes).
string	$style = self::STYLES['none']
	The style for the activity badge.
moodle_url	$url = null
	An optional URL to redirect the user when the activity badge is clicked.

Detailed Description

Activity badge forum class, used for rendering unread messages.

Copyright

2023 Sara Arjona sara@.nosp@m.mood.nosp@m.le.co.nosp@m.m

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

create_instance()

static core_courseformat\output\activitybadge::create_instance ( cm_info $cminfo )

staticfinalinherited

Creates an instance of activityclass for the given course module, in case it implements it.

Parameters

cm_info

$cminfo

Return values

self|null

An instance of activityclass for the given module or null if the module doesn't implement it.

export_for_template()

core_courseformat\output\activitybadge::export_for_template ( renderer_base $output )

finalinherited

Export this data so it can be used as the context for a mustache template.

Parameters

renderer_base

$output

typically, the renderer that's calling this function

Return values

stdClass

data context for a mustache template

Implements templatable.

get_template_name()

core\output\named_templatable::get_template_name ( \renderer_base $renderer )

inherited

Get the name of the template to use for this templatable.

Parameters

renderer_base

$renderer

The renderer requesting the template name

Return values

string

Implemented in core\output\local\dropdown\dialog, core\output\local\dropdown\status, core\output\sticky_footer, core_courseformat\output\local\content\cm\title, and qbank_viewquestionname\output\questionname.

update_content()

mod_forum\output\courseformat\activitybadge::update_content ( )

protected

This method will be called before exporting the template.

Reimplemented from core_courseformat\output\activitybadge.

Member Data Documentation

$content

string core_courseformat\output\activitybadge::$content = null

protectedinherited

The content to be displayed in the activity badge.

$extraattributes

array core_courseformat\output\activitybadge::$extraattributes = []

protectedinherited

An optional array of extra HTML attributes to add to the badge element (for example, data attributes).

The format for this array is [['name' => 'attr1', 'value' => 'attrval1'], ['name' => 'attr2', 'value' => 'attrval2']].

$style

string core_courseformat\output\activitybadge::$style = self::STYLES['none']

protectedinherited

The style for the activity badge.

$url

moodle_url core_courseformat\output\activitybadge::$url = null

protectedinherited

An optional URL to redirect the user when the activity badge is clicked.

STYLES

array const core_courseformat\output\activitybadge::STYLES

inherited

Initial value:

= [
        'none' => 'badge-none',
        'dark' => 'badge-dark',
        'danger' => 'badge-danger',
        'warning' => 'badge-warning',
        'info' => 'badge-info',
    ]

Badge defined styles.

---

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

• mod/forum/classes/output/courseformat/activitybadge.php