Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
|
Public Member Functions | |
add_attributes (array $attributes) | |
Add report attributes (data-, class, etc.) that will be included in HTML when report is displayed. | |
add_base_condition_simple (string $fieldname, $fieldvalue) | |
Define simple "field = value" clause to apply to the report query. | |
add_base_condition_sql (string $where, array $params=[]) | |
Define more complex clause that will always be applied to the report query. | |
add_default_columns () | |
Add default datasource columns to the report. | |
add_default_conditions () | |
Add default datasource conditions to the report. | |
add_default_filters () | |
Add default datasource filters to the report. | |
get_active_columns () | |
Return all configured report columns. | |
get_active_columns_by_alias () | |
Return all active report columns, keyed by their alias (only active columns in a report would have a valid alias/index) | |
get_active_conditions () | |
Return all configured report conditions. | |
get_active_filters () | |
Return all configured report filters. | |
get_applied_filter_count () | |
Return the number of filter instances that are being applied based on the report's filter values (i.e. | |
get_attributes () | |
Returns the report HTML attributes. | |
get_base_condition () | |
Return base select/params for the report query. | |
get_column (string $uniqueidentifier) | |
Return report column by unique identifier. | |
get_columns () | |
Return all available report columns. | |
get_condition (string $uniqueidentifier) | |
Return report condition by unique identifier. | |
get_condition_instances () | |
Return all active report condition instances. | |
get_condition_values () | |
Get the condition values of the report. | |
get_conditions () | |
Return all available report conditions. | |
get_context () | |
Returns the report context. | |
get_default_column_sorting () | |
Return the default sorting that will be added to the report once it is created. | |
get_default_columns () | |
Return the columns that will be added to the report once is created. | |
get_default_condition_values () | |
Return the default condition values that will be added to the report once is created. | |
get_default_conditions () | |
Return the conditions that will be added to the report once is created. | |
get_default_filters () | |
Return the filters that will be added to the report once is created. | |
get_default_per_page () | |
Default 'per page' size. | |
get_downloadfilename () | |
Return the downloadable report filename. | |
get_entity_title (string $name) | |
Returns title of given report entity. | |
get_filter (string $uniqueidentifier) | |
Return report filter by unique identifier. | |
get_filter_instances () | |
Return all active report filter instances. | |
get_filter_values () | |
Get the filter values of the report. | |
get_filters () | |
Return all available report filters. | |
get_joins () | |
Return report JOIN clauses. | |
get_main_table () | |
Get the main table name. | |
get_main_table_alias () | |
Get the alias for the main table. | |
get_report_persistent () | |
Returns persistent class used when initialising this report. | |
get_settings_values () | |
Get the settings values of the report. | |
is_downloadable () | |
Get if the report can be downloaded. | |
set_condition_values (array $values) | |
Set the condition values of the report. | |
set_default_per_page (int $defaultperpage) | |
Set the default 'per page' size. | |
set_downloadable (bool $downloadable, ?string $downloadfilename=null) | |
Set if the report can be downloaded. | |
set_filter_values (array $values) | |
Set the filter values of the report. | |
set_main_table (string $tablename, string $tablealias='') | |
Set the main table and alias for the SQL query. | |
set_settings_values (array $values) | |
Set the settings values of the report. | |
Static Public Member Functions | |
static | get_name () |
Return user friendly name of the report. | |
static | is_available () |
Get the report availability. | |
static | report_elements_modified (int $reportid) |
Indicate that report elements have been modified, e.g. | |
Public Attributes | |
int const | DEFAULT_PAGESIZE = 30 |
Default paging limit. | |
int const | TYPE_CUSTOM_REPORT = 0 |
Custom report type value. | |
int const | TYPE_SYSTEM_REPORT = 1 |
System report type value. | |
Protected Member Functions | |
add_all_from_entities () | |
Adds all columns/filters/conditions from all the entities added to the report at once. | |
add_all_from_entity (string $entityname) | |
Adds all columns/filters/conditions from the given entity to the report at once. | |
add_column (column $column) | |
Adds a column to the report. | |
add_column_from_entity (string $uniqueidentifier) | |
Add given column to the report from an entity. | |
add_columns_from_entities (array $columns) | |
Add given columns to the report from one or more entities. | |
add_columns_from_entity (string $entityname, array $include=[], array $exclude=[]) | |
Add columns from the given entity name to be available to use in a custom report. | |
add_condition (filter $condition) | |
Adds a condition to the report. | |
add_condition_from_entity (string $uniqueidentifier) | |
Add given condition to the report from an entity. | |
add_conditions_from_entities (array $conditions) | |
Add given conditions to the report from one or more entities. | |
add_conditions_from_entity (string $entityname, array $include=[], array $exclude=[]) | |
Add conditions from the given entity name to be available to use in a custom report. | |
add_entity (entity_base $entity) | |
Adds given entity, along with it's columns and filters, to the report. | |
add_filter (filter $filter) | |
Adds a filter to the report. | |
add_filter_from_entity (string $uniqueidentifier) | |
Add given filter to the report from an entity. | |
add_filters_from_entities (array $filters) | |
Add given filters to the report from one or more entities. | |
add_filters_from_entity (string $entityname, array $include=[], array $exclude=[]) | |
Add filters from the given entity name to be available to use in a custom report. | |
add_join (string $join, array $params=[], bool $validateparams=true) | |
Adds report JOIN clause that is always added. | |
annotate_entity (string $name, lang_string $title) | |
Define a new entity for the report. | |
get_entities () | |
Returns the list of all the entities added to the report. | |
get_entity (string $name) | |
Returns the entity added to the report from the given entity name. | |
initialise () | |
Initialise report. | |
validate () | |
Perform some basic validation about expected class properties. | |
|
finalprotected |
Adds all columns/filters/conditions from the given entity to the report at once.
string | $entityname |
|
inherited |
Add report attributes (data-, class, etc.) that will be included in HTML when report is displayed.
array | $attributes |
self |
|
finalinherited |
Define simple "field = value" clause to apply to the report query.
string | $fieldname | |
mixed | $fieldvalue |
|
finalinherited |
Define more complex clause that will always be applied to the report query.
string | $where | |
array | $params | Note that the param names should be generated by { |
|
finalprotectedinherited |
Adds a column to the report.
column | $column |
column |
coding_exception |
|
finalprotectedinherited |
Add given column to the report from an entity.
The entity must have already been added to the report before calling this method
string | $uniqueidentifier |
column |
|
finalprotectedinherited |
Add given columns to the report from one or more entities.
Each entity must have already been added to the report before calling this method
string[] | $columns | Unique identifier of each entity column |
|
finalprotected |
Add columns from the given entity name to be available to use in a custom report.
string | $entityname | |
array | $include | Include only these columns, if omitted then include all |
array | $exclude | Exclude these columns, if omitted then exclude none |
coding_exception | If both $include and $exclude are non-empty |
|
finalprotectedinherited |
Adds a condition to the report.
filter | $condition |
filter |
coding_exception |
|
finalprotectedinherited |
Add given condition to the report from an entity.
The entity must have already been added to the report before calling this method
string | $uniqueidentifier |
filter |
|
finalprotectedinherited |
Add given conditions to the report from one or more entities.
Each entity must have already been added to the report before calling this method
string[] | $conditions | Unique identifier of each entity condition |
|
finalprotected |
Add conditions from the given entity name to be available to use in a custom report.
string | $entityname | |
array | $include | Include only these conditions, if omitted then include all |
array | $exclude | Exclude these conditions, if omitted then exclude none |
coding_exception | If both $include and $exclude are non-empty |
core_reportbuilder\datasource::add_default_columns | ( | ) |
Add default datasource columns to the report.
This method is optional and can be called when the report is created to add the default columns defined in the selected datasource.
core_reportbuilder\datasource::add_default_conditions | ( | ) |
Add default datasource conditions to the report.
This method is optional and can be called when the report is created to add the default conditions defined in the selected datasource.
core_reportbuilder\datasource::add_default_filters | ( | ) |
Add default datasource filters to the report.
This method is optional and can be called when the report is created to add the default filters defined in the selected datasource.
|
finalprotectedinherited |
Adds given entity, along with it's columns and filters, to the report.
entity_base | $entity |
|
finalprotectedinherited |
Adds a filter to the report.
filter | $filter |
filter |
coding_exception |
|
finalprotectedinherited |
Add given filter to the report from an entity.
The entity must have already been added to the report before calling this method
string | $uniqueidentifier |
filter |
|
finalprotectedinherited |
Add given filters to the report from one or more entities.
Each entity must have already been added to the report before calling this method
string[] | $filters | Unique identifier of each entity filter |
|
finalprotected |
Add filters from the given entity name to be available to use in a custom report.
string | $entityname | |
array | $include | Include only these filters, if omitted then include all |
array | $exclude | Exclude these filters, if omitted then exclude none |
coding_exception | If both $include and $exclude are non-empty |
|
protectedinherited |
Adds report JOIN clause that is always added.
string | $join | |
array | $params | |
bool | $validateparams | Some queries might add non-standard params and validation could fail |
|
finalprotectedinherited |
Define a new entity for the report.
string | $name | |
lang_string | $title |
coding_exception |
core_reportbuilder\datasource::get_active_columns | ( | ) |
Return all configured report columns.
column[] |
Reimplemented from core_reportbuilder\local\report\base.
|
finalinherited |
Return all active report columns, keyed by their alias (only active columns in a report would have a valid alias/index)
column[] |
core_reportbuilder\datasource::get_active_conditions | ( | ) |
Return all configured report conditions.
filter[] |
Reimplemented from core_reportbuilder\local\report\base.
core_reportbuilder\datasource::get_active_filters | ( | ) |
Return all configured report filters.
filter[] |
Reimplemented from core_reportbuilder\local\report\base.
|
finalinherited |
Return the number of filter instances that are being applied based on the report's filter values (i.e.
user has configured them from their initial "Any value" state)
int |
|
inherited |
Returns the report HTML attributes.
array |
|
finalinherited |
Return base select/params for the report query.
array | [string $select, array $params] |
|
finalinherited |
Return report column by unique identifier.
string | $uniqueidentifier |
column|null |
|
finalinherited |
Return all available report columns.
column[] |
|
finalinherited |
Return report condition by unique identifier.
string | $uniqueidentifier |
filter|null |
|
finalinherited |
Return all active report condition instances.
filter_base[] |
|
finalinherited |
Get the condition values of the report.
array |
|
finalinherited |
Return all available report conditions.
filter[] |
|
inherited |
Returns the report context.
context |
core_reportbuilder\datasource::get_default_column_sorting | ( | ) |
Return the default sorting that will be added to the report once it is created.
int[] | array [column identifier => SORT_ASC/SORT_DESC] |
Reimplemented in core_badges\reportbuilder\datasource\badges, core_badges\reportbuilder\datasource\users, core_cohort\reportbuilder\datasource\cohorts, core_course\reportbuilder\datasource\courses, and core_user\reportbuilder\datasource\users.
|
abstract |
Return the columns that will be added to the report once is created.
string[] |
Reimplemented in core_admin\reportbuilder\datasource\task_logs, core_badges\reportbuilder\datasource\badges, core_badges\reportbuilder\datasource\users, core_blog\reportbuilder\datasource\blogs, core_cohort\reportbuilder\datasource\cohorts, core_comment\reportbuilder\datasource\comments, core_course\reportbuilder\datasource\courses, core_course\reportbuilder\datasource\participants, core_files\reportbuilder\datasource\files, core_group\reportbuilder\datasource\groups, core_notes\reportbuilder\datasource\notes, core_tag\reportbuilder\datasource\tags, and core_user\reportbuilder\datasource\users.
core_reportbuilder\datasource::get_default_condition_values | ( | ) |
Return the default condition values that will be added to the report once is created.
For any of the default conditions returned by the method {
array |
Reimplemented in core_admin\reportbuilder\datasource\task_logs, core_files\reportbuilder\datasource\files, and core_user\reportbuilder\datasource\users.
|
abstract |
Return the conditions that will be added to the report once is created.
string[] |
Reimplemented in core_admin\reportbuilder\datasource\task_logs, core_badges\reportbuilder\datasource\badges, core_badges\reportbuilder\datasource\users, core_blog\reportbuilder\datasource\blogs, core_cohort\reportbuilder\datasource\cohorts, core_comment\reportbuilder\datasource\comments, core_course\reportbuilder\datasource\courses, core_course\reportbuilder\datasource\participants, core_files\reportbuilder\datasource\files, core_group\reportbuilder\datasource\groups, core_notes\reportbuilder\datasource\notes, core_tag\reportbuilder\datasource\tags, and core_user\reportbuilder\datasource\users.
|
abstract |
Return the filters that will be added to the report once is created.
string[] |
Reimplemented in core_admin\reportbuilder\datasource\task_logs, core_badges\reportbuilder\datasource\badges, core_badges\reportbuilder\datasource\users, core_blog\reportbuilder\datasource\blogs, core_cohort\reportbuilder\datasource\cohorts, core_comment\reportbuilder\datasource\comments, core_course\reportbuilder\datasource\courses, core_course\reportbuilder\datasource\participants, core_files\reportbuilder\datasource\files, core_group\reportbuilder\datasource\groups, core_notes\reportbuilder\datasource\notes, core_tag\reportbuilder\datasource\tags, and core_user\reportbuilder\datasource\users.
|
inherited |
Default 'per page' size.
int |
|
finalinherited |
Return the downloadable report filename.
string |
|
finalprotectedinherited |
Returns the list of all the entities added to the report.
entity_base[] |
|
finalprotectedinherited |
Returns the entity added to the report from the given entity name.
string | $name |
entity_base |
coding_exception |
|
finalinherited |
Returns title of given report entity.
string | $name |
lang_string |
coding_exception |
|
finalinherited |
Return report filter by unique identifier.
string | $uniqueidentifier |
filter|null |
|
finalinherited |
Return all active report filter instances.
filter_base[] |
|
finalinherited |
Get the filter values of the report.
array |
|
finalinherited |
Return all available report filters.
filter[] |
|
inherited |
Return report JOIN clauses.
array |
|
finalinherited |
Get the main table name.
string |
|
finalinherited |
Get the alias for the main table.
string |
|
staticabstractinherited |
Return user friendly name of the report.
string |
Reimplemented in core_admin\reportbuilder\datasource\task_logs, core_admin\reportbuilder\local\systemreports\task_logs, core_badges\reportbuilder\datasource\badges, core_badges\reportbuilder\datasource\users, core_blog\reportbuilder\datasource\blogs, core_cohort\reportbuilder\datasource\cohorts, core_comment\reportbuilder\datasource\comments, core_course\reportbuilder\datasource\courses, core_course\reportbuilder\datasource\participants, core_files\reportbuilder\datasource\files, core_group\reportbuilder\datasource\groups, core_notes\reportbuilder\datasource\notes, core_reportbuilder\system_report, core_tag\reportbuilder\datasource\tags, and core_user\reportbuilder\datasource\users.
|
finalinherited |
Returns persistent class used when initialising this report.
report |
|
finalinherited |
Get the settings values of the report.
array |
|
abstractprotectedinherited |
Initialise report.
Specify which columns, filters, etc should be present
To set the base query use:
Reimplemented in core_admin\reportbuilder\datasource\task_logs, core_admin\reportbuilder\local\systemreports\task_logs, core_badges\reportbuilder\datasource\badges, core_badges\reportbuilder\datasource\users, core_blog\reportbuilder\datasource\blogs, core_cohort\reportbuilder\datasource\cohorts, core_cohort\reportbuilder\local\systemreports\cohorts, core_comment\reportbuilder\datasource\comments, core_comment\reportbuilder\local\systemreports\comments, core_course\reportbuilder\datasource\courses, core_course\reportbuilder\datasource\participants, core_files\reportbuilder\datasource\files, core_group\reportbuilder\datasource\groups, core_notes\reportbuilder\datasource\notes, core_reportbuilder\local\systemreports\report_access_list, core_reportbuilder\local\systemreports\report_schedules, core_reportbuilder\local\systemreports\reports_list, core_tag\reportbuilder\datasource\tags, core_user\reportbuilder\datasource\users, gradereport_summary\local\systemreports\summary, and report_configlog\reportbuilder\local\systemreports\config_changes.
|
staticinherited |
Get the report availability.
Sub-classes should override this method to declare themselves unavailable, for example if they require classes that aren't present due to missing plugin
bool |
|
finalinherited |
Get if the report can be downloaded.
bool |
|
staticfinal |
Indicate that report elements have been modified, e.g.
columns/filters/conditions have been added, removed or updated
int | $reportid |
|
finalinherited |
Set the condition values of the report.
array | $values |
bool |
|
inherited |
Set the default 'per page' size.
int | $defaultperpage |
|
finalinherited |
Set if the report can be downloaded.
bool | $downloadable | |
string | null | $downloadfilename | If downloadable, then the name of the file (defaults to the name of the current report) |
|
finalinherited |
Set the filter values of the report.
array | $values |
bool |
|
finalinherited |
Set the main table and alias for the SQL query.
string | $tablename | |
string | $tablealias |
|
finalinherited |
Set the settings values of the report.
array | $values |
bool |
|
protectedinherited |
Perform some basic validation about expected class properties.
coding_exception |
Reimplemented in core_reportbuilder\system_report.