Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
core_reportbuilder

Directories

directory local
  
 
directory reportbuilder
  
 

Namespaces

namespace  core_cohort\reportbuilder\audience
  
 
namespace  core_reportbuilder
  
 
namespace  core_reportbuilder\event
  
 
namespace  core_reportbuilder\external
  
 
namespace  core_reportbuilder\external\audiences
  
 
namespace  core_reportbuilder\external\columns
  
 
namespace  core_reportbuilder\external\columns\sort
  
 
namespace  core_reportbuilder\external\conditions
  
 
namespace  core_reportbuilder\external\filters
  
 
namespace  core_reportbuilder\external\reports
  
 
namespace  core_reportbuilder\external\schedules
  
 
namespace  core_reportbuilder\external\systemreports
  
 
namespace  core_reportbuilder\form
  
 
namespace  core_reportbuilder\local\aggregation
  
 
namespace  core_reportbuilder\local\audiences
  
 
namespace  core_reportbuilder\local\entities
  
 
namespace  core_reportbuilder\local\filters
  
 
namespace  core_reportbuilder\local\helpers
  
 
namespace  core_reportbuilder\local\models
  
 
namespace  core_reportbuilder\local\report
  
 
namespace  core_reportbuilder\local\systemreports
  
 
namespace  core_reportbuilder\output
  
 
namespace  core_reportbuilder\output\dynamictabs
  
 
namespace  core_reportbuilder\privacy
  
 
namespace  core_reportbuilder\reportbuilder\audience
  
 
namespace  core_reportbuilder\table
  
 
namespace  core_reportbuilder\task
  
 

Classes

class  behat_core_reportbuilder_generator
 Behat data generator for Report builder. More...
 
class  behat_reportbuilder
 Behat step definitions for Report builder. More...
 
class  core_cohort\reportbuilder\audience\cohortmember
 The backend class for Cohort member audience type. More...
 
class  core_reportbuilder\datasource
 Class datasource. More...
 
class  core_reportbuilder\event\audience_created
 Report builder custom report audience created event class. More...
 
class  core_reportbuilder\event\audience_deleted
 Report builder custom report audience deleted event class. More...
 
class  core_reportbuilder\event\audience_updated
 Report builder custom report audience created event class. More...
 
class  core_reportbuilder\event\schedule_created
 Report builder custom report schedule created event class. More...
 
class  core_reportbuilder\event\schedule_deleted
 Report builder custom report schedule created event class. More...
 
class  core_reportbuilder\event\schedule_updated
 Report builder custom report schedule updated event class. More...
 
class  core_reportbuilder\external\audiences\delete
 External method for deleting a report audience. More...
 
class  core_reportbuilder\external\columns\add
 External method for adding report columns. More...
 
class  core_reportbuilder\external\columns\delete
 External method for deleting report columns. More...
 
class  core_reportbuilder\external\columns\reorder
 External method for re-ordering report columns. More...
 
class  core_reportbuilder\external\columns\sort\get
 External method for retrieving report column sorting. More...
 
class  core_reportbuilder\external\columns\sort\reorder
 External method for re-ordering report column sorting. More...
 
class  core_reportbuilder\external\columns\sort\toggle
 External method for toggling report column sorting. More...
 
class  core_reportbuilder\external\conditions\add
 External method for adding report conditions. More...
 
class  core_reportbuilder\external\conditions\delete
 External method for deleting report conditions. More...
 
class  core_reportbuilder\external\conditions\reorder
 External method for re-ordering report conditions. More...
 
class  core_reportbuilder\external\conditions\reset
 External method for resetting report conditions. More...
 
class  core_reportbuilder\external\custom_report_audience_cards_exporter
 Custom report audience cards exporter class. More...
 
class  core_reportbuilder\external\custom_report_card_view_exporter
 Custom report card view exporter class. More...
 
class  core_reportbuilder\external\custom_report_column_cards_exporter
 Custom report column cards exporter class. More...
 
class  core_reportbuilder\external\custom_report_columns_sorting_exporter
 Custom report columns sorting exporter class. More...
 
class  core_reportbuilder\external\custom_report_conditions_exporter
 Custom report conditions exporter class. More...
 
class  core_reportbuilder\external\custom_report_data_exporter
 Custom report data exporter class. More...
 
class  core_reportbuilder\external\custom_report_details_exporter
 Custom report details exporter class. More...
 
class  core_reportbuilder\external\custom_report_exporter
 Custom report exporter class. More...
 
class  core_reportbuilder\external\custom_report_filters_exporter
 Custom report filters exporter class. More...
 
class  core_reportbuilder\external\custom_report_menu_cards_exporter
 Custom report menu cards exporter abstract class. More...
 
class  core_reportbuilder\external\filters\add
 External method for adding report filters. More...
 
class  core_reportbuilder\external\filters\delete
 External method for deleting report filters. More...
 
class  core_reportbuilder\external\filters\reorder
 External method for re-ordering report filters. More...
 
class  core_reportbuilder\external\filters\reset
 External method for resetting report filters. More...
 
class  core_reportbuilder\external\filters\set
 External method for setting report filter values. More...
 
class  core_reportbuilder\external\reports\delete
 External method for deleting reports. More...
 
class  core_reportbuilder\external\reports\get
 External method for getting a custom report. More...
 
class  core_reportbuilder\external\reports\listing
 External method for listing users' custom reports. More...
 
class  core_reportbuilder\external\reports\retrieve
 External method for retrieving custom report content. More...
 
class  core_reportbuilder\external\reports\view
 External method to record the viewing of a report. More...
 
class  core_reportbuilder\external\schedules\delete
 External method for deleting report schedules. More...
 
class  core_reportbuilder\external\schedules\send
 External method for sending report schedules. More...
 
class  core_reportbuilder\external\schedules\toggle
 External method for toggling report schedules. More...
 
class  core_reportbuilder\external\system_report_data_exporter
 System report data exporter class. More...
 
class  core_reportbuilder\external\system_report_exporter
 Report exporter class. More...
 
class  core_reportbuilder\external\systemreports\can_view
 External method for validating access to a system report. More...
 
class  core_reportbuilder\external\systemreports\retrieve
 External method for retrieving system report content. More...
 
class  core_reportbuilder\form\audience
 Dynamic audience form. More...
 
class  core_reportbuilder\form\card_view
 Card view dynamic form. More...
 
class  core_reportbuilder\form\condition
 Dynamic condition form. More...
 
class  core_reportbuilder\form\filter
 Dynamic filter form. More...
 
class  core_reportbuilder\form\report
 Report details form. More...
 
class  core_reportbuilder\form\schedule
 Schedule form. More...
 
class  core_reportbuilder\local\aggregation\avg
 Column average aggregation type. More...
 
class  core_reportbuilder\local\aggregation\base
 Base class for column aggregation types. More...
 
class  core_reportbuilder\local\aggregation\count
 Column count aggregation type. More...
 
class  core_reportbuilder\local\aggregation\countdistinct
 Column count distinct aggregation type. More...
 
class  core_reportbuilder\local\aggregation\groupconcat
 Column group concatenation aggregation type. More...
 
class  core_reportbuilder\local\aggregation\groupconcatdistinct
 Column group concatenation distinct aggregation type. More...
 
class  core_reportbuilder\local\aggregation\max
 Column max aggregation type. More...
 
class  core_reportbuilder\local\aggregation\min
 Column min aggregation type. More...
 
class  core_reportbuilder\local\aggregation\percent
 Column percent aggregation type. More...
 
class  core_reportbuilder\local\aggregation\sum
 Column sum aggregation type. More...
 
class  core_reportbuilder\local\entities\base
 Base class for all report entities. More...
 
class  core_reportbuilder\local\entities\course
 Course entity class implementation. More...
 
class  core_reportbuilder\local\entities\user
 User entity class implementation. More...
 
class  core_reportbuilder\local\filters\autocomplete
 Autocomplete report filter. More...
 
class  core_reportbuilder\local\filters\base
 Base class for all report filters. More...
 
class  core_reportbuilder\local\filters\boolean_select
 Boolean report filter. More...
 
class  core_reportbuilder\local\filters\category
 Course category report filter. More...
 
class  core_reportbuilder\local\filters\course_selector
 Course selector filter class implementation. More...
 
class  core_reportbuilder\local\filters\date
 Date report filter. More...
 
class  core_reportbuilder\local\filters\duration
 Duration report filter. More...
 
class  core_reportbuilder\local\filters\number
 Number report filter. More...
 
class  core_reportbuilder\local\filters\select
 Select report filter. More...
 
class  core_reportbuilder\local\filters\tags
 Class containing logic for the tags filter. More...
 
class  core_reportbuilder\local\filters\text
 Text report filter. More...
 
class  core_reportbuilder\local\filters\user
 User report filter. More...
 
class  core_reportbuilder\local\helpers\aggregation
 Helper class for column aggregation related methods. More...
 
class  core_reportbuilder\local\helpers\custom_fields
 Helper class for course custom fields. More...
 
class  core_reportbuilder\local\helpers\database
 Helper functions for DB manipulations. More...
 
class  core_reportbuilder\local\helpers\format
 Class containing helper methods for formatting column data via callbacks. More...
 
class  core_reportbuilder\local\helpers\schedule
 Helper class for report schedule related methods. More...
 
class  core_reportbuilder\local\helpers\user_filter_manager
 This class handles the setting and retrieving of a users' filter values for given reports. More...
 
class  core_reportbuilder\local\helpers\user_profile_fields
 Helper class for user profile fields. More...
 
class  core_reportbuilder\local\models\audience
 Persistent class to represent a report audience. More...
 
class  core_reportbuilder\local\models\column
 Persistent class to represent a report column. More...
 
class  core_reportbuilder\local\models\filter
 Persistent class to represent a report filter/condition. More...
 
class  core_reportbuilder\local\models\report
 Persistent class to represent a report. More...
 
class  core_reportbuilder\local\models\schedule
 Persistent class to represent a report schedule. More...
 
class  core_reportbuilder\local\report\action
 Class to represent a report action. More...
 
class  core_reportbuilder\local\report\base
 Base class for all reports. More...
 
class  core_reportbuilder\local\report\column
 Class to represent a report column. More...
 
class  core_reportbuilder\local\report\filter
 Class to represent a report filter. More...
 
class  core_reportbuilder\local\systemreports\report_access_list
 Report access list. More...
 
class  core_reportbuilder\local\systemreports\report_schedules
 Report schedules list. More...
 
class  core_reportbuilder\local\systemreports\reports_list
 Reports list. More...
 
class  core_reportbuilder\manager
 Report management class. More...
 
class  core_reportbuilder\output\audience_heading_editable
 Audience heading editable component. More...
 
class  core_reportbuilder\output\column_aggregation_editable
 Column aggregation editable component. More...
 
class  core_reportbuilder\output\column_heading_editable
 Column heading editable component. More...
 
class  core_reportbuilder\output\custom_report
 Custom report output class. More...
 
class  core_reportbuilder\output\dynamictabs\access
 Access dynamic tab. More...
 
class  core_reportbuilder\output\dynamictabs\audience
 Audience dynamic tab. More...
 
class  core_reportbuilder\output\dynamictabs\editor
 Editor dynamic tab. More...
 
class  core_reportbuilder\output\dynamictabs\schedules
 Schedules dynamic tab. More...
 
class  core_reportbuilder\output\filter_heading_editable
 Filter heading editable component. More...
 
class  core_reportbuilder\output\renderer
 Report renderer class. More...
 
class  core_reportbuilder\output\report_name_editable
 Report name editable component. More...
 
class  core_reportbuilder\output\schedule_name_editable
 Schedule name editable component. More...
 
class  core_reportbuilder\output\system_report
 System report output class. More...
 
class  core_reportbuilder\permission
 Report permission class. More...
 
class  core_reportbuilder\privacy\provider
 Privacy Subsystem for core_reportbuilder. More...
 
class  core_reportbuilder\report_access_exception
 User cannot access report exception. More...
 
class  core_reportbuilder\reportbuilder\audience\admins
 Administrators audience type. More...
 
class  core_reportbuilder\reportbuilder\audience\allusers
 The backend class for All users audience type. More...
 
class  core_reportbuilder\reportbuilder\audience\manual
 The backend class for Manually added users audience type. More...
 
class  core_reportbuilder\reportbuilder\audience\systemrole
 The backend class for Has system role audience type. More...
 
class  core_reportbuilder\source_invalid_exception
 Invalid report source exception. More...
 
class  core_reportbuilder\source_unavailable_exception
 Unavailable report source exception. More...
 
class  core_reportbuilder\system_report
 Base class for system reports. More...
 
class  core_reportbuilder\system_report_factory
 Factory class for creating system report instances. More...
 
class  core_reportbuilder\table\base_report_table
 Base report dynamic table class. More...
 
class  core_reportbuilder\table\custom_report_table
 Custom report dynamic table class. More...
 
class  core_reportbuilder\table\custom_report_table_filterset
 Custom report dynamic table filterset class. More...
 
class  core_reportbuilder\table\custom_report_table_view
 Custom report view dynamic table class. More...
 
class  core_reportbuilder\table\custom_report_table_view_filterset
 Custom report dynamic table filterset class. More...
 
class  core_reportbuilder\table\system_report_table
 System report dynamic table class. More...
 
class  core_reportbuilder\table\system_report_table_filterset
 System report dynamic table filterset class. More...
 
class  core_reportbuilder\task\send_schedule
 Ad-hoc task for sending a single report schedule. More...
 
class  core_reportbuilder\task\send_schedules
 Scheduled task for sending queued report schedules. More...
 
class  core_reportbuilder_generator
 Report builder test generator. More...
 
class  core_reportbuilder_testcase
 Helper base class for reportbuilder unit tests. More...
 

Functions

 core_reportbuilder_inplace_editable (string $itemtype, int $itemid, string $newvalue)
 Plugin inplace editable implementation.
 
 core_reportbuilder_output_fragment_audience_form (array $params)
 Return the audience form fragment.
 
 core_reportbuilder_output_fragment_filters_form (array $params)
 Return the filters form fragment.
 

Variables

global core_reportbuilder\form::$CFG
 
global core_reportbuilder\local\entities::$CFG
 
global core_reportbuilder\local\helpers::$CFG
 
 $settings
 

Detailed Description

Function Documentation

◆ core_reportbuilder_inplace_editable()

core_reportbuilder_inplace_editable ( string $itemtype,
int $itemid,
string $newvalue )

Plugin inplace editable implementation.

Parameters
string$itemtype
int$itemid
string$newvalue
Return values
inplace_editable|null

◆ core_reportbuilder_output_fragment_audience_form()

core_reportbuilder_output_fragment_audience_form ( array $params)

Return the audience form fragment.

Parameters
array$params
Return values
string

◆ core_reportbuilder_output_fragment_filters_form()

core_reportbuilder_output_fragment_filters_form ( array $params)

Return the filters form fragment.

Parameters
array$params
Return values
string

Variable Documentation

◆ $settings

$settings
Initial value:
= new admin_settingpage('reportbuildersettings', get_string('customreportssettings', 'core_reportbuilder'),
'moodle/site:config', empty($CFG->enablecustomreports))
Used to group a number of admin_setting objects into a page and add them to the admin tree.
Definition adminlib.php:1451