Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
core_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
 
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_data_exporter
 
class  core_reportbuilder\external\system_report_exporter
 
class  core_reportbuilder\external\systemreports\can_view
 
class  core_reportbuilder\external\systemreports\retrieve
 
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\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\cohort
 
class  core_reportbuilder\local\filters\course_selector
 
class  core_reportbuilder\local\filters\date
 
class  core_reportbuilder\local\filters\duration
 
class  core_reportbuilder\local\filters\filesize
 
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\audience
 
class  core_reportbuilder\local\helpers\custom_fields
 
class  core_reportbuilder\local\helpers\database
 
class  core_reportbuilder\local\helpers\format
 
class  core_reportbuilder\local\helpers\report
 
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_get_tagged_reports (core_tag_tag $tag, bool $exclusivemode=false, ?int $fromcontextid=0, ?int $contextid=0, bool $recurse=true, int $page=0,)
 Callback to return tagged reports.
 
 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_get_tagged_reports()

core_reportbuilder_get_tagged_reports ( core_tag_tag $tag,
bool $exclusivemode = false,
?int $fromcontextid = 0,
?int $contextid = 0,
bool $recurse = true,
int $page = 0 )

Callback to return tagged reports.

Parameters
core_tag_tag$tag
bool$exclusivemode
int | null$fromcontextid
int | null$contextid
bool$recurse
int$page
Return values
tagindex

◆ 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