Moodle PHP Documentation 5.1
Moodle 5.1dev (Build: 20250706) (a6b17d8f6bd)
core\output\templatable Interface Reference
Inheritance diagram for core\output\templatable:
core\output\action_menu core\output\actions\component_action core\output\activity_header core\output\checkbox_toggleall core\output\chooser core\output\chooser_item core\output\chooser_section core\output\context_header core\output\custom_menu_item core\output\datafilter core\output\dynamic_tabs core\output\dynamic_tabs\base core\output\help_icon core\output\initials_bar core\output\inplace_editable core\output\language_menu core\output\named_templatable core\output\notification 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\task_indicator core\output\url_select core_calendar\output\humandate core_calendar\output\humantimeperiod core_course\output\actionbar\initials_dropdown_form core_course\output\activity_completion core_course\output\activity_dates core_course\output\activity_icon core_course\output\activity_navigation core_course\output\activitychooserbutton core_course\output\completion_action_bar core_course\output\recommendations\activity_list core_grades\output\action_bar core_grades\output\penalty_indicator core_reportbuilder\output\custom_report core_reportbuilder\output\report_action core_reportbuilder\output\system_report

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.
 

Detailed Description

Since
2.9

Member Function Documentation

◆ export_for_template()

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

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$outputUsed 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.


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