moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-08 02:16:41 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

NOBUG: Add upgrade notes

Browse source
This commit is contained in:
Huong Nguyen 2024-10-04 21:03:11 +07:00
parent 166408a13a
commit 3a6640c461
No known key found for this signature in database
GPG key ID: 40D88AB693A3E72A
47 changed files with 834 additions and 738 deletions
Download patch file Download diff file Expand all files Collapse all files

46
reportbuilder/UPGRADING.md
View file

@ -1,6 +1,6 @@
# core_reportbuilder (subsystem) Upgrade notes
## 4.5rc1
## 4.5rc2
### Added
@ -15,13 +15,17 @@
- `core_reportbuilder_retrieve_report`
For more information see [MDL-81433](https://tracker.moodle.org/browse/MDL-81433)
- Added a new database helper method `sql_replace_parameters` to help ensure uniqueness of parameters within a SQL expression
- Added a new database helper method `sql_replace_parameters` to help ensure uniqueness of parameters within a SQL expression.
For more information see [MDL-81434](https://tracker.moodle.org/browse/MDL-81434)
- New format helper `format_time` method, for use in column callbacks that represent a duration of time (e.g. "3 days 4 hours")
- A new static method, `\core_reportbuilder\local\helpers\format::format_time()`, has been added for use in column callbacks that represent a duration of time (for example "3 days 4 hours").
For more information see [MDL-82466](https://tracker.moodle.org/browse/MDL-82466)
- Methods `add_columns_from_entity()`, `add_filters_from_entity()` and `report_element_search()` have been moved from `\core_reportbuilder\datasource` class to `\core_reportbuilder\base` class in order to be available also for system reports
- The following methods have been moved from `\core_reportbuilder\datasource` class to its parent class `\core_reportbuilder\base` to make them available for use in system reports:
- `add_columns_from_entity()`
- `add_filters_from_entity()`
- `report_element_search()`
For more information see [MDL-82529](https://tracker.moodle.org/browse/MDL-82529)
@ -34,36 +38,38 @@
- `number`
For more information see [MDL-81168](https://tracker.moodle.org/browse/MDL-81168)
- The base datasource `add_all_from_entities` method accepts a new optional parameter to specify which entities to add elements from
- The base datasource `\core_reportbuilder\datasource::add_all_from_entities()` method accepts a new optional `array $entitynames` parameter to specify which entities to add elements from.
For more information see [MDL-81330](https://tracker.moodle.org/browse/MDL-81330)
- All time related code has been updated to the PSR-20 Clock interface, as such the following methods no longer accept a `$timenow` parameter (instead please use `\core\clock` dependency injection):
- All time-related code has been updated to the PSR-20 Clock interface, as such the following methods no longer accept a `$timenow` parameter (instead please use `\core\clock` dependency injection):
- `core_reportbuilder_generator::create_schedule`
- `core_reportbuilder\local\helpers\schedule::[create_schedule|calculate_next_send_time]`
- `core_reportbuilder\local\helpers\schedule::create_schedule()`
- `core_reportbuilder\local\helpers\schedule::calculate_next_send_time()`
For more information see [MDL-82041](https://tracker.moodle.org/browse/MDL-82041)
- The following classes have been moved to use the new exception API as a L2 namespace:
| Old class | New class |
|-----------|-----------|
| `\core_reportbuilder\report_access_exception` | `\core_reportbuilder\exception\report_access_exception` |
| `\core_reportbuilder\source_invalid_exception` | `\core_reportbuilder\exception\source_invalid_exception` |
| `\core_reportbuilder\source_unavailable_exception` | `\core_reportbuilder\exception\source_unavailable_exception` |
| Old class | New class |
| ----------- | ----------- |
| `\core_reportbuilder\report_access_exception` | `\core_reportbuilder\exception\report_access_exception` |
| `\core_reportbuilder\source_invalid_exception` | `\core_reportbuilder\exception\source_invalid_exception` |
| `\core_reportbuilder\source_unavailable_exception` | `\core_reportbuilder\exception\source_unavailable_exception` |
For more information see [MDL-82133](https://tracker.moodle.org/browse/MDL-82133)
### Removed
- Support for the following entity classes, renamed since 4.1, has now been removed completely:
- Support for the following entity classes, renamed since 4.1, have now been removed completely:
- `core_admin\local\entities\task_log`
- `core_cohort\local\entities\cohort`
- `core_cohort\local\entities\cohort_member`
- `core_course\local\entities\course_category`
- `report_configlog\local\entities\config_change`
- `\core_admin\local\entities\task_log`
- `\core_cohort\local\entities\cohort`
- `\core_cohort\local\entities\cohort_member`
- `\core_course\local\entities\course_category`
- `\report_configlog\local\entities\config_change`
For more information see [MDL-74583](https://tracker.moodle.org/browse/MDL-74583)
- The following previously deprecated local helper methods have been removed and can no longer be used:
- `audience::get_all_audiences_menu_types`
- `report::get_available_columns`
- `\core_reportbuilder\local\helpers\audience::get_all_audiences_menu_types()`
- `\core_reportbuilder\local\helpers\report::get_available_columns()`
For more information see [MDL-76690](https://tracker.moodle.org/browse/MDL-76690)