Moodle APIs 4.1
Moodle 4.1.9+ (Build: 20240402)
Directories | Files | Namespaces | Classes | Functions | Variables
core_reportbuilder

Directories

directory local
  
 
directory reportbuilder
  
 

Files

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

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\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
 
class  behat_reportbuilder
 
class  core_cohort\reportbuilder\audience\cohortmember
 
class  core_reportbuilder\datasource
 
class  core_reportbuilder\event\audience_created
 
class  core_reportbuilder\event\audience_deleted
 
class  core_reportbuilder\event\audience_updated
 
class  core_reportbuilder\event\schedule_created
 
class  core_reportbuilder\event\schedule_deleted
 
class  core_reportbuilder\event\schedule_updated
 
class  core_reportbuilder\external\audiences\delete
 
class  core_reportbuilder\external\columns\add
 
class  core_reportbuilder\external\columns\delete
 
class  core_reportbuilder\external\columns\reorder
 
class  core_reportbuilder\external\columns\sort\get
 
class  core_reportbuilder\external\columns\sort\reorder
 
class  core_reportbuilder\external\columns\sort\toggle
 
class  core_reportbuilder\external\conditions\add
 
class  core_reportbuilder\external\conditions\delete
 
class  core_reportbuilder\external\conditions\reorder
 
class  core_reportbuilder\external\conditions\reset
 
class  core_reportbuilder\external\custom_report_audience_cards_exporter
 
class  core_reportbuilder\external\custom_report_card_view_exporter
 
class  core_reportbuilder\external\custom_report_column_cards_exporter
 
class  core_reportbuilder\external\custom_report_columns_sorting_exporter
 
class  core_reportbuilder\external\custom_report_conditions_exporter
 
class  core_reportbuilder\external\custom_report_data_exporter
 
class  core_reportbuilder\external\custom_report_details_exporter
 
class  core_reportbuilder\external\custom_report_exporter
 
class  core_reportbuilder\external\custom_report_filters_exporter
 
class  core_reportbuilder\external\custom_report_menu_cards_exporter
 
class  core_reportbuilder\external\filters\add
 
class  core_reportbuilder\external\filters\delete
 
class  core_reportbuilder\external\filters\reorder
 
class  core_reportbuilder\external\filters\reset
 
class  core_reportbuilder\external\filters\set
 
class  core_reportbuilder\external\reports\delete
 
class  core_reportbuilder\external\reports\get
 
class  core_reportbuilder\external\reports\listing
 
class  core_reportbuilder\external\reports\retrieve
 
class  core_reportbuilder\external\reports\view
 
class  core_reportbuilder\external\schedules\delete
 
class  core_reportbuilder\external\schedules\send
 
class  core_reportbuilder\external\schedules\toggle
 
class  core_reportbuilder\external\system_report_exporter
 
class  core_reportbuilder\form\audience
 
class  core_reportbuilder\form\card_view
 
class  core_reportbuilder\form\condition
 
class  core_reportbuilder\form\filter
 
class  core_reportbuilder\form\report
 
class  core_reportbuilder\form\schedule
 
class  core_reportbuilder\local\aggregation\avg
 
class  core_reportbuilder\local\aggregation\base
 
class  core_reportbuilder\local\aggregation\count
 
class  core_reportbuilder\local\aggregation\countdistinct
 
class  core_reportbuilder\local\aggregation\groupconcat
 
class  core_reportbuilder\local\aggregation\groupconcatdistinct
 
class  core_reportbuilder\local\aggregation\max
 
class  core_reportbuilder\local\aggregation\min
 
class  core_reportbuilder\local\aggregation\percent
 
class  core_reportbuilder\local\aggregation\sum
 
class  core_reportbuilder\local\audiences\base
 
class  core_reportbuilder\local\entities\base
 
class  core_reportbuilder\local\entities\course
 
class  core_reportbuilder\local\entities\user
 
class  core_reportbuilder\local\filters\autocomplete
 
class  core_reportbuilder\local\filters\base
 
class  core_reportbuilder\local\filters\boolean_select
 
class  core_reportbuilder\local\filters\category
 
class  core_reportbuilder\local\filters\course_selector
 
class  core_reportbuilder\local\filters\date
 
class  core_reportbuilder\local\filters\duration
 
class  core_reportbuilder\local\filters\number
 
class  core_reportbuilder\local\filters\select
 
class  core_reportbuilder\local\filters\tags
 
class  core_reportbuilder\local\filters\text
 
class  core_reportbuilder\local\filters\user
 
class  core_reportbuilder\local\helpers\aggregation
 
class  core_reportbuilder\local\helpers\custom_fields
 
class  core_reportbuilder\local\helpers\database
 
class  core_reportbuilder\local\helpers\format
 
class  core_reportbuilder\local\helpers\schedule
 
class  core_reportbuilder\local\helpers\user_filter_manager
 
class  core_reportbuilder\local\helpers\user_profile_fields
 
class  core_reportbuilder\local\models\audience
 
class  core_reportbuilder\local\models\column
 
class  core_reportbuilder\local\models\filter
 
class  core_reportbuilder\local\models\report
 
class  core_reportbuilder\local\models\schedule
 
class  core_reportbuilder\local\report\action
 
class  core_reportbuilder\local\report\base
 
class  core_reportbuilder\local\report\column
 
class  core_reportbuilder\local\report\filter
 
class  core_reportbuilder\local\systemreports\report_access_list
 
class  core_reportbuilder\local\systemreports\report_schedules
 
class  core_reportbuilder\local\systemreports\reports_list
 
class  core_reportbuilder\manager
 
class  core_reportbuilder\output\audience_heading_editable
 
class  core_reportbuilder\output\column_aggregation_editable
 
class  core_reportbuilder\output\column_heading_editable
 
class  core_reportbuilder\output\custom_report
 
class  core_reportbuilder\output\dynamictabs\access
 
class  core_reportbuilder\output\dynamictabs\audience
 
class  core_reportbuilder\output\dynamictabs\editor
 
class  core_reportbuilder\output\dynamictabs\schedules
 
class  core_reportbuilder\output\filter_heading_editable
 
class  core_reportbuilder\output\renderer
 
class  core_reportbuilder\output\report_name_editable
 
class  core_reportbuilder\output\schedule_name_editable
 
class  core_reportbuilder\output\system_report
 
class  core_reportbuilder\permission
 
class  core_reportbuilder\privacy\provider
 
class  core_reportbuilder\report_access_exception
 
class  core_reportbuilder\reportbuilder\audience\admins
 
class  core_reportbuilder\reportbuilder\audience\allusers
 
class  core_reportbuilder\reportbuilder\audience\manual
 
class  core_reportbuilder\reportbuilder\audience\systemrole
 
class  core_reportbuilder\source_invalid_exception
 
class  core_reportbuilder\source_unavailable_exception
 
class  core_reportbuilder\system_report
 
class  core_reportbuilder\system_report_factory
 
class  core_reportbuilder\table\base_report_table
 
class  core_reportbuilder\table\custom_report_table
 
class  core_reportbuilder\table\custom_report_table_filterset
 
class  core_reportbuilder\table\custom_report_table_view
 
class  core_reportbuilder\table\custom_report_table_view_filterset
 
class  core_reportbuilder\table\system_report_table
 
class  core_reportbuilder\table\system_report_table_filterset
 
class  core_reportbuilder\task\send_schedule
 
class  core_reportbuilder\task\send_schedules
 
class  core_reportbuilder_generator
 
class  core_reportbuilder_testcase
 

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\external\audiences::$CFG
 
global core_reportbuilder\external\columns::$CFG
 
global core_reportbuilder\external\columns\sort::$CFG
 
global core_reportbuilder\external\conditions::$CFG
 
global core_reportbuilder\external\filters::$CFG
 
global core_reportbuilder\external\reports::$CFG
 
global core_reportbuilder\external\schedules::$CFG
 
global core_reportbuilder\form::$CFG
 
global core_reportbuilder\local\entities::$CFG
 
global core_reportbuilder\local\helpers::$CFG
 
global core_reportbuilder\output::$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:1446