mod_resource\output\courseformat\activitybadge Class Reference

Inheritance diagram for mod_resource\output\courseformat\activitybadge:

Public Member Functions
	export_for_template (renderer_base $output)
	Function to export the renderer data in a format that is suitable for a mustache template.
	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.

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() [1/2]

core\output\templatable::export_for_template ( renderer_base $output )

inherited

Function to export the renderer data in a format that is suitable for a mustache template.

This means:

1. No complex types - only stdClass, array, int, string, float, bool
2. Any additional info that is required for the template is pre-calculated (e.g. capability checks).

Parameters

renderer_base

$output

Used to do a final render of any components that need to be rendered for export.

Return values

stdClass|array

Implemented in core\output\action_menu, core\output\actions\component_action, core\output\activity_header, core\output\checkbox_toggleall, core\output\choicelist, core\output\chooser, core\output\chooser_item, core\output\chooser_section, core\output\comboboxsearch, core\output\context_header, core\output\custom_menu_item, core\output\dynamic_tabs, core\output\help_icon, core\output\initials_bar, core\output\paging_bar, core\output\pix_icon, core\output\pix_icon_font, core\output\progress_bar, core\output\select_menu, core\output\single_select, core\output\tabobject, core\output\tabtree, core\output\task_indicator, core\output\url_select, core_calendar\output\humandate, core_calendar\output\humantimeperiod, core_course\output\actionbar\group_selector_button, core_course\output\actionbar\group_selector_dropdown_form, core_course\output\actionbar\initials_dropdown_form, core_course\output\actionbar\user_selector_button, core_course\output\activity_completion, core_course\output\activity_dates, core_course\output\activity_icon, core_course\output\activitychooserbutton, core_course\output\completion_action_bar, core_courseformat\output\local\content\basecontrolmenu, core_courseformat\output\local\content\cm\controlmenu, core_courseformat\output\local\content\cm, core_courseformat\output\local\content\section, core_courseformat\output\local\overview\activityname, core_courseformat\output\local\overview\overviewtable, core_grades\output\penalty_indicator, core_reportbuilder\output\custom_report, core_reportbuilder\output\dynamictabs\access, core_reportbuilder\output\dynamictabs\audience, core_reportbuilder\output\dynamictabs\editor, core_reportbuilder\output\dynamictabs\schedules, core_reportbuilder\output\report_action, and core_reportbuilder\output\system_report.

export_for_template() [2/2]

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

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\choicelist, core\output\comboboxsearch, core_course\output\actionbar\group_selector_button, core_course\output\actionbar\group_selector_dropdown_form, core_course\output\actionbar\user_selector_button, core_courseformat\output\local\overview\activityname, and core_courseformat\output\local\overview\overviewtable.

update_content()

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

protected

This method will be called before exporting the template.

Reimplemented from core_courseformat\output\activitybadge.

Member Data Documentation

$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']].

STYLES

array const core_courseformat\output\activitybadge::STYLES

inherited

Initial value:

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

Badge defined styles.

---

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

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