core_grades\output\general_action_bar Class Reference

Inheritance diagram for core_grades\output\general_action_bar:

Public Member Functions
	__construct (\context $context, moodle_url $activeurl, string $activetype, string $activeplugin)
	The class constructor.
	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 the data for the mustache template.
	get_template ()
	Returns the template for the action bar.

Protected Attributes
string	$activeplugin
	$activeplugin The plugin of the current gradebook page (grader, fullview, ...).
string	$activetype
	The type of the current gradebook page (report, settings, import, export, scales, outcomes, letters).
moodle_url	$activeurl
	$activeurl The URL that should be set as active in the URL selector element.
context	$context
	$context The context object.

Constructor & Destructor Documentation

__construct()

core_grades\output\general_action_bar::__construct	(	\context	$context,
		moodle_url	$activeurl,
		string	$activetype,
		string	$activeplugin )

The class constructor.

Parameters

context	$context	The context object.
moodle_url	$activeurl	The URL that should be set as active in the URL selector element.
string	$activetype	The type of the current gradebook page (report, settings, import, export, scales, outcomes, letters).
string	$activeplugin	The plugin of the current gradebook page (grader, fullview, ...).

Member Function Documentation

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_grades\output\general_action_bar::export_for_template

(

\renderer_base

$output

)

Export the data for the mustache template.

Parameters

renderer_base

$output

renderer to be used to render the action bar elements.

Return values

array

get_template()

core_grades\output\general_action_bar::get_template

(

)

Returns the template for the action bar.

Return values

string

Reimplemented from core_grades\output\action_bar.

Member Data Documentation

$activetype

string core_grades\output\general_action_bar::$activetype

protected

The type of the current gradebook page (report, settings, import, export, scales, outcomes, letters).

$activetype

---

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

• grade/classes/output/general_action_bar.php