Merge branch 'MDL-74600' of https://github.com/paulholden/moodle
[moodle.git] / reportbuilder / upgrade.txt
blobc0643acf9c37950c406c0caebf76d576314bf380
1 This file describes API changes in /reportbuilder/*
2 Information provided here is intended especially for developers.
4 === 4.1 ===
5 * 'set_default_per_page' and 'get_default_per_page' methods have been added to \local\report\base class
6   to manage the default displayed rows per page.
7 * Added two new methods in the datasource class:
8     - add_all_from_entity() to add all columns/filters/conditions from the given entity to the report at once
9     - add_all_from_entities() to add all columns/filters/conditions from all the entities added to the report at once
10 * New database helper methods for generating multiple unique values: `generate_aliases` and `generate_param_names`
11 * The base aggregation `format_value` method has a `$columntype` argument in order to preserve type during aggregation. When
12   defining column callbacks, strict typing will now be preserved in your callback methods when the column is being aggregated
13 * The method `get_joins()` in the base entity class is now public, allowing for easier joins within reports
14 * The following local helper methods have been deprecated, their implementation moved to exporters:
15   - `audience::get_all_audiences_menu_types` -> `custom_report_audience_cards_exporter`
16   - `report::get_available_columns` -> `custom_report_column_cards_exporter`