core\output\language_menu Class Reference

Class for creating the language menu. More...

Inheritance diagram for core\output\language_menu:

Public Member Functions
	__construct ($page)
	Language menu constructor.
	export_for_action_menu (\renderer_base $output)
	Export the data providing a structure for the core/action_menu template.
	export_for_single_select (\renderer_base $output)
	Export the data providing a structure for the core/single_select template.
	export_for_template (\renderer_base $output)
	Export the data.
	export_for_template (renderer_base $output)
	Function to export the renderer data in a format that is suitable for a mustache template.

Protected Member Functions
	show_language_menu ()
	Determine if the language menu should be shown.

Protected Attributes
string	$currentlang
	current language code
array	$langs
	localised list of installed translations
moodle_page	$page
	$page the moodle page that the languague menu belongs to

Detailed Description

Class for creating the language menu.

Copyright

2021 Adrian Greeve adria.nosp@m.n@mo.nosp@m.odle..nosp@m.com

License

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

Constructor & Destructor Documentation

__construct()

core\output\language_menu::__construct

(

$page

)

Language menu constructor.

Parameters

moodle_page

$page

the moodle page that the languague menu belongs to.

Member Function Documentation

export_for_action_menu()

core\output\language_menu::export_for_action_menu

(

\renderer_base

$output

)

Export the data providing a structure for the core/action_menu template.

Parameters

renderer_base

$output

Return values

stdClass

action_menu data export.

export_for_single_select()

core\output\language_menu::export_for_single_select

(

\renderer_base

$output

)

Export the data providing a structure for the core/single_select template.

Parameters

renderer_base

$output

Return values

stdClass

single_select data export.

export_for_template() [1/2]

core\output\language_menu::export_for_template

(

\renderer_base

$output

)

Export the data.

Parameters

renderer_base

$output

Return values

array

with the title for the menu and an array of items.

export_for_template() [2/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.

show_language_menu()

core\output\language_menu::show_language_menu ( )

protected

Determine if the language menu should be shown.

Return values

bool	true if the language menu should be shown.

---

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

• lib/classes/output/language_menu.php