Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
- Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
- PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.
/reportbuilder/classes/ -> datasource.php (source)
Differences Between: [Versions 400 and 403] [Versions 401 and 403] [Versions 402 and 403]
(no description)
| File Size: | 411 lines (16 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
datasource:: (14 methods):
add_columns_from_entity()
add_default_columns()
get_default_column_sorting()
get_active_columns()
add_filters_from_entity()
add_default_filters()
get_active_filters()
add_conditions_from_entity()
add_default_conditions()
get_default_condition_values()
get_active_conditions()
add_all_from_entity()
add_all_from_entities()
report_elements_modified()
Class: datasource - X-Ref
Class datasource| add_columns_from_entity(string $entityname, array $include = [], array $exclude = []) X-Ref |
| Add columns from the given entity name to be available to use in a custom report param: string $entityname param: array $include Include only these columns, if omitted then include all param: array $exclude Exclude these columns, if omitted then exclude none |
| add_default_columns() X-Ref |
| Add default datasource columns to the report Uses column data returned by the source {@see get_default_columns} and {@see get_default_column_sorting} methods |
| get_default_column_sorting() X-Ref |
| Return the default column sorting that will be set for the report upon creation, by {@see add_default_columns} When overriding this method in child classes, column identifiers specified must refer to default columns returned from the {@see get_default_columns} method return: int[] array [column identifier => SORT_ASC/SORT_DESC] |
| get_active_columns() X-Ref |
| Override parent method, returning only those columns specifically added to the custom report (rather than all that are available) return: column[] |
| add_filters_from_entity(string $entityname, array $include = [], array $exclude = []) X-Ref |
| Add filters from the given entity name to be available to use in a custom report param: string $entityname param: array $include Include only these filters, if omitted then include all param: array $exclude Exclude these filters, if omitted then exclude none |
| add_default_filters() X-Ref |
| 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. |
| get_active_filters() X-Ref |
| Override parent method, returning only those filters specifically added to the custom report (rather than all that are available) return: filter[] |
| add_conditions_from_entity(string $entityname, array $include = [], array $exclude = []) X-Ref |
| Add conditions from the given entity name to be available to use in a custom report param: string $entityname param: array $include Include only these conditions, if omitted then include all param: array $exclude Exclude these conditions, if omitted then exclude none |
| add_default_conditions() X-Ref |
| 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. |
| get_default_condition_values() X-Ref |
| 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 {@see get_default_conditions} is possible to set the initial values. return: array |
| get_active_conditions() X-Ref |
| Override parent method, returning only those conditions specifically added to the custom report (rather than all that are available) return: filter[] |
| add_all_from_entity(string $entityname) X-Ref |
| Adds all columns/filters/conditions from the given entity to the report at once param: string $entityname |
| add_all_from_entities() X-Ref |
| Adds all columns/filters/conditions from all the entities added to the report at once |
| report_elements_modified(int $reportid) X-Ref |
| Indicate that report elements have been modified, e.g. columns/filters/conditions have been added, removed or updated param: int $reportid |
