Moodle APIs  3.8
Moodle 3.8.6 (Build: 20201109)
Public Member Functions | List of all members
templatable Interface Reference
Inheritance diagram for templatable:
action_menu assign_attempt_history_chooser block_lp\output\competencies_to_review_page block_lp\output\plans_to_review_page block_lp\output\summary block_myoverview\output\main block_myprofile\output\myprofile block_recentlyaccessedcourses\output\main block_recentlyaccesseditems\output\main block_rss_client\output\block block_rss_client\output\channel_image block_rss_client\output\feed block_rss_client\output\footer block_rss_client\output\item block_search_forums\output\search_form block_starredcourses\output\main block_timeline\output\main booktool_print\output\print_book_chapter_page booktool_print\output\print_book_page component_action core\output\checkbox_toggleall core\output\chooser core\output\chooser_item core\output\chooser_section core\output\inplace_editable core\output\notification core_auth\output\digital_minor_page core_auth\output\login core_auth\output\verify_age_location_page core_course\output\activity_navigation core_customfield\output\field_data core_customfield\output\management core_group\output\group_details core_group\output\index_page core_message\output\messagearea\contact core_message\output\messagearea\contacts core_message\output\messagearea\message core_message\output\messagearea\message_area core_message\output\messagearea\messages core_message\output\messagearea\profile core_message\output\messagearea\user_search_results core_message\output\preferences\notification_list core_message\output\preferences\notification_list_component core_message\output\preferences\notification_list_processor core_message\output\preferences\processor core_message\output\processor core_privacy\output\exported_html_page core_privacy\output\exported_navigation_page core_search\document core_tag\output\tag core_tag\output\tagcloud core_tag\output\tagfeed core_tag\output\tagindex core_tag\output\taglist core_user\output\status_field core_user\output\unified_filter custom_menu_item enrol_lti\output\registration forumreport_summary\output\filters help_icon initials_bar login_signup_form message_email\output\email_digest message_popup\output\popup_notification mod_assign\output\grading_app mod_feedback\output\summary mod_forum\output\big_search_form mod_forum\output\forum_post mod_forum\output\quick_search_form mod_lti\output\external_registration_return_page mod_lti\output\tool_configure_page MoodleQuickForm_advcheckbox MoodleQuickForm_button MoodleQuickForm_checkbox MoodleQuickForm_editor MoodleQuickForm_filemanager MoodleQuickForm_filepicker MoodleQuickForm_grading MoodleQuickForm_group MoodleQuickForm_password MoodleQuickForm_radio MoodleQuickForm_recaptcha MoodleQuickForm_select MoodleQuickForm_selectgroups MoodleQuickForm_selectwithlink MoodleQuickForm_static MoodleQuickForm_submit MoodleQuickForm_text MoodleQuickForm_textarea MoodleQuickForm_url MoodleQuickForm_warning paging_bar pix_icon pix_icon_font progress_bar report_competency\output\report report_competency\output\user_course_navigation report_insights\output\insight report_insights\output\insights_list single_select tabobject tool_analytics\output\insights_report tool_analytics\output\invalid_analysables tool_analytics\output\models_list tool_analytics\output\restorable_models tool_customlang\output\translator tool_dataprivacy\output\categories tool_dataprivacy\output\data_deletion_page tool_dataprivacy\output\data_registry_compliance_page tool_dataprivacy\output\data_registry_page tool_dataprivacy\output\data_requests_page tool_dataprivacy\output\defaults_page tool_dataprivacy\output\my_data_requests_page tool_dataprivacy\output\purposes tool_dataprivacy\output\request_filter tool_dataprivacy\output\summary_page tool_langimport\output\langimport_page tool_lp\output\competency_plan_navigation tool_lp\output\competency_summary tool_lp\output\course_competencies_page tool_lp\output\manage_competencies_page tool_lp\output\manage_competency_frameworks_page tool_lp\output\manage_templates_page tool_lp\output\module_navigation tool_lp\output\plan_page tool_lp\output\plans_page tool_lp\output\related_competencies tool_lp\output\template_competencies_page tool_lp\output\user_competency_course_navigation tool_lp\output\user_competency_summary tool_lp\output\user_competency_summary_in_course tool_lp\output\user_competency_summary_in_plan tool_lp\output\user_evidence_list_page tool_lp\output\user_evidence_page tool_lpmigrate\output\migrate_framework_results tool_policy\output\acceptances tool_policy\output\acceptances_filter tool_policy\output\guestconsent tool_policy\output\page_agreedocs tool_policy\output\page_managedocs_list tool_policy\output\page_nopermission tool_policy\output\page_viewalldoc tool_policy\output\page_viewdoc tool_policy\output\user_agreement tool_templatelibrary\output\list_templates_page url_select

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. More...
 

Member Function Documentation

◆ export_for_template()

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 forumreport_summary\output\filters, core_user\output\unified_filter, core_user\output\status_field, core_tag\output\taglist, core_tag\output\tagindex, core_tag\output\tagfeed, core_tag\output\tagcloud, core_tag\output\tag, report_competency\output\user_course_navigation, report_competency\output\report, core_privacy\output\exported_navigation_page, core_privacy\output\exported_html_page, MoodleQuickForm_wikieditor, mod_lti\output\tool_configure_page, mod_lti\output\external_registration_return_page, mod_forum\output\quick_search_form, mod_forum\output\big_search_form, mod_feedback\output\summary, booktool_print\output\print_book_page, booktool_print\output\print_book_chapter_page, assign_attempt_history_chooser, mod_assign\output\grading_app, login_signup_form, progress_bar, action_menu, tabtree, tabobject, custom_menu_item, initials_bar, paging_bar, url_select, single_select, pix_icon, pix_icon_font, help_icon, component_action, MoodleQuickForm_warning, MoodleQuickForm_url, MoodleQuickForm_textarea, MoodleQuickForm_tags, MoodleQuickForm_submit, MoodleQuickForm_static, MoodleQuickForm_selectwithlink, MoodleQuickForm_selectgroups, MoodleQuickForm_select, MoodleQuickForm_recaptcha, MoodleQuickForm_passwordunmask, MoodleQuickForm_group, MoodleQuickForm_grading, MoodleQuickForm_filepicker, MoodleQuickForm_filemanager, MoodleQuickForm_editor, MoodleQuickForm_date_time_selector, MoodleQuickForm_date_selector, MoodleQuickForm_checkbox, MoodleQuickForm_autocomplete, MoodleQuickForm_advcheckbox, core\output\chooser_section, core\output\chooser_item, core\output\chooser, core\output\checkbox_toggleall, core_group\output\index_page, core_group\output\group_details, enrol_lti\output\registration, core_course\output\modchooser, block_timeline\output\main, block_starredcourses\output\main, block_search_forums\output\search_form, block_recentlyaccesseditems\output\main, block_recentlyaccessedcourses\output\main, block_myprofile\output\myprofile, block_myoverview\output\main, block_lp\output\summary, block_lp\output\plans_to_review_page, block_lp\output\competencies_to_review_page, core_auth\output\verify_age_location_page, core_auth\output\login, core_auth\output\digital_minor_page, tool_templatelibrary\output\list_templates_page, tool_policy\output\page_viewdoc, tool_policy\output\page_viewalldoc, tool_policy\output\page_nopermission, tool_policy\output\page_managedocs_list, tool_policy\output\page_agreedocs, tool_policy\output\guestconsent, tool_policy\output\acceptances, tool_lp\output\user_evidence_list_page, tool_lp\output\user_competency_summary_in_course, tool_lp\output\user_competency_summary, tool_lp\output\user_competency_course_navigation, tool_lp\output\template_competencies_page, tool_lp\output\related_competencies, tool_lp\output\plans_page, tool_lp\output\module_navigation, tool_lp\output\manage_templates_page, tool_lp\output\manage_competency_frameworks_page, tool_lp\output\manage_competencies_page, tool_lp\output\course_competencies_page, tool_lp\output\competency_summary, tool_lp\output\competency_plan_navigation, tool_langimport\output\langimport_page, tool_dataprivacy\output\summary_page, tool_dataprivacy\output\request_filter, tool_dataprivacy\output\purposes, tool_dataprivacy\output\my_data_requests_page, tool_dataprivacy\output\defaults_page, tool_dataprivacy\output\data_requests_page, tool_dataprivacy\output\data_registry_page, tool_dataprivacy\output\data_registry_compliance_page, tool_dataprivacy\output\data_deletion_page, tool_dataprivacy\output\categories, and tool_customlang\output\translator.


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