Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
report_insights\output\insight Class Reference

Single insight view page. More...

Inheritance diagram for report_insights\output\insight:
renderable templatable

Public Member Functions

 __construct (\core_analytics\prediction $prediction, core_analytics\model $model, $includedetailsaction=false, context $context)
 Constructor. More...
 
 export_for_template (\renderer_base $output)
 Exports the data. More...
 
 export_for_template (renderer_base $output)
 Function to export the renderer data in a format that is suitable for a mustache template. More...
 
 get_model ()
 Model getter. More...
 

Static Public Member Functions

static get_calculation_display (\core_analytics\calculable $calculable, $value, $output, $subtype=false)
 Returns display info for the calculated value outcome. More...
 

Protected Attributes

context $context
 
bool $includedetailsaction = false
 
core_analytics model $model
 
core_analytics prediction $prediction
 

Detailed Description

Single insight view page.

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

Constructor & Destructor Documentation

◆ __construct()

report_insights\output\insight::__construct ( \core_analytics\prediction  $prediction,
core_analytics\model  $model,
  $includedetailsaction = false,
context  $context 
)

Constructor.

Parameters
core_analytics::prediction$prediction
core_analytics::model$model
bool$includedetailsaction
context$context
Return values
void

Member Function Documentation

◆ export_for_template() [1/2]

report_insights\output\insight::export_for_template ( \renderer_base  $output)

Exports the data.

Parameters
renderer_base$output
Return values
stdClass

◆ export_for_template() [2/2]

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$outputUsed to do a final render of any components that need to be rendered for export.
Return values
stdClass|array

Implemented in 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\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_evidence_list_page, tool_policy\output\acceptances, 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_templatelibrary\output\list_templates_page, core_auth\output\digital_minor_page, core_auth\output\login, core_auth\output\verify_age_location_page, 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_search_forums\output\search_form, block_starredcourses\output\main, block_timeline\output\main, core_contentbank\output\bankcontent, core_contentbank\output\viewcontent, enrol_lti\output\registration, core_group\output\group_details, core_group\output\index_page, core_h5p\output\libraries, core\output\checkbox_toggleall, core\output\chooser, core\output\chooser_item, core\output\chooser_section, MoodleQuickForm_advcheckbox, MoodleQuickForm_autocomplete, MoodleQuickForm_checkbox, MoodleQuickForm_date_selector, MoodleQuickForm_date_time_selector, MoodleQuickForm_editor, MoodleQuickForm_filemanager, MoodleQuickForm_filepicker, MoodleQuickForm_grading, MoodleQuickForm_group, MoodleQuickForm_passwordunmask, MoodleQuickForm_recaptcha, MoodleQuickForm_select, MoodleQuickForm_selectgroups, MoodleQuickForm_selectwithlink, MoodleQuickForm_static, MoodleQuickForm_submit, MoodleQuickForm_tags, MoodleQuickForm_textarea, MoodleQuickForm_url, MoodleQuickForm_warning, component_action, help_icon, pix_icon_font, pix_icon, single_select, url_select, paging_bar, initials_bar, custom_menu_item, tabobject, tabtree, action_menu, progress_bar, login_signup_form, mod_assign\output\grading_app, assign_attempt_history_chooser, booktool_print\output\print_book_chapter_page, booktool_print\output\print_book_page, mod_feedback\output\summary, mod_forum\output\big_search_form, mod_forum\output\quick_search_form, mod_h5pactivity\output\attempt, mod_h5pactivity\output\reportattempts, mod_h5pactivity\output\reportlink, mod_h5pactivity\output\reportresults, mod_h5pactivity\output\result, mod_h5pactivity\output\result\longfillin, mod_h5pactivity\output\result\other, mod_lti\output\external_registration_return_page, mod_lti\output\repost_crosssite_page, mod_lti\output\tool_configure_page, MoodleQuickForm_wikieditor, core_privacy\output\exported_html_page, core_privacy\output\exported_navigation_page, report_competency\output\report, report_competency\output\user_course_navigation, core_tag\output\tag, core_tag\output\tagcloud, core_tag\output\tagfeed, core_tag\output\tagindex, core_tag\output\taglist, core_user\output\participants_filter, core_user\output\status_field, core_user\output\unified_filter, and forumreport_summary\output\filters.

◆ get_calculation_display()

static report_insights\output\insight::get_calculation_display ( \core_analytics\calculable  $calculable,
  $value,
  $output,
  $subtype = false 
)
static

Returns display info for the calculated value outcome.

Parameters
core_analytics::calculable$calculable
float$value
renderer_base$output
string | false$subtype
Return values
arrayThe style as 'success', 'info', 'warning' or 'danger' and pix_icon

◆ get_model()

report_insights\output\insight::get_model ( )

Model getter.

Return values
core_analytics::model

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