core\output\dynamic_tabs\base Class Reference

Inheritance diagram for core\output\dynamic_tabs\base:

Public Member Functions
	__construct (array $data)
	tab constructor.
	add_data (array $data)
	Add custom data to the tab data attributes.
	export_for_template (renderer_base $output)
	Function to export the renderer data in a format that is suitable for a mustache template.
	get_data ()
	Return tab data attributes.
	get_tab_id ()
	HTML "id" attribute that should be used for this tab, by default the last part of class name.
	get_tab_label ()
	The label to be displayed on the tab.
	get_template ()
	Template to use to display tab contents.
	is_available ()
	Check permission of the current user to access this tab.
	require_access ()
	Check that tab is accessible, throw exception otherwise - used from WS requesting tab contents.

Protected Attributes
array	$data

Constructor & Destructor Documentation

__construct()

core\output\dynamic_tabs\base::__construct ( array $data )

final

tab constructor.

Parameters

array

$data

Member Function Documentation

add_data()

core\output\dynamic_tabs\base::add_data

(

array

$data

)

Add custom data to the tab data attributes.

Parameters

array

$data

export_for_template()

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.

get_data()

core\output\dynamic_tabs\base::get_data

(

)

Return tab data attributes.

Return values

array

get_tab_id()

core\output\dynamic_tabs\base::get_tab_id

(

)

HTML "id" attribute that should be used for this tab, by default the last part of class name.

Return values

string

get_tab_label()

core\output\dynamic_tabs\base::get_tab_label ( )

abstract

The label to be displayed on the tab.

Return values

string

Reimplemented in core_reportbuilder\output\dynamictabs\access, core_reportbuilder\output\dynamictabs\audience, core_reportbuilder\output\dynamictabs\editor, core_reportbuilder\output\dynamictabs\schedules, tool_componentlibrary\local\examples\dynamictabs\tab1, and tool_componentlibrary\local\examples\dynamictabs\tab2.

get_template()

core\output\dynamic_tabs\base::get_template ( )

abstract

Template to use to display tab contents.

Return values

string

Reimplemented in core_reportbuilder\output\dynamictabs\access, core_reportbuilder\output\dynamictabs\audience, core_reportbuilder\output\dynamictabs\editor, core_reportbuilder\output\dynamictabs\schedules, tool_componentlibrary\local\examples\dynamictabs\tab1, and tool_componentlibrary\local\examples\dynamictabs\tab2.

is_available()

core\output\dynamic_tabs\base::is_available ( )

abstract

Check permission of the current user to access this tab.

Return values

bool

Reimplemented in core_reportbuilder\output\dynamictabs\access, core_reportbuilder\output\dynamictabs\audience, core_reportbuilder\output\dynamictabs\editor, core_reportbuilder\output\dynamictabs\schedules, tool_componentlibrary\local\examples\dynamictabs\tab1, and tool_componentlibrary\local\examples\dynamictabs\tab2.

require_access()

core\output\dynamic_tabs\base::require_access ( )

final

Check that tab is accessible, throw exception otherwise - used from WS requesting tab contents.

Exceptions

moodle_exception

---

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

• lib/classes/output/dynamic_tabs/base.php