From c9e1d37e20f70ec4166a39513db379b4ff967b50 Mon Sep 17 00:00:00 2001 From: Sara Arjona Date: Thu, 31 Jul 2025 16:07:17 +0200 Subject: [PATCH] NOBUG: Add upgrade notes --- UPGRADING.md | 26 ++++++++++++++++++++++++++ public/course/format/UPGRADING.md | 12 ++++++++++++ public/lib/UPGRADING.md | 14 ++++++++++++++ 3 files changed, 52 insertions(+) diff --git a/UPGRADING.md b/UPGRADING.md index 616d7012cc1..4a2926d0f73 100644 --- a/UPGRADING.md +++ b/UPGRADING.md @@ -26,6 +26,9 @@ The format of this change log follows the advice given at [Keep a CHANGELOG](htt - Added support for configurable `aspectRatio` in charts rendered using Chart.js. This enables developers to control chart sizing more precisely via the `chart_base` API and the frontend renderer. For more information see [MDL-85158](https://tracker.moodle.org/browse/MDL-85158) +- Output classes can now implement the core\output\externable interface. This allows these classes to define methods for exporting their data in a format suitable for use in web services. + + For more information see [MDL-85509](https://tracker.moodle.org/browse/MDL-85509) #### Changed @@ -38,9 +41,20 @@ The format of this change log follows the advice given at [Keep a CHANGELOG](htt - The `\core\attribute\deprecated` attribute constructor `$replacement` parameter now defaults to null, and can be omitted For more information see [MDL-84531](https://tracker.moodle.org/browse/MDL-84531) +- Added a new `\core\deprecation::emit_deprecation()` method which should be used in places where a deprecation is known to occur. This method will throw debugging if no deprecation notice was found, for example: + ```php + public function deprecated_method(): void { + \core\deprecation::emit_deprecation([self::class, __FUNCTION__]); + } + ``` + + For more information see [MDL-85897](https://tracker.moodle.org/browse/MDL-85897) #### Deprecated +- The following function has been deprecated and should no longer be used: `file_encode_url`. Please consider using the `core\url` factory methods instead. + + For more information see [MDL-31071](https://tracker.moodle.org/browse/MDL-31071) - The following `core/checkbox-toggleall` templates have been deprecated: - `core/checkbox-toggleall-master-button` - This is replaced with `core/checkbox-toggleall-toggler-button` @@ -158,6 +172,18 @@ The format of this change log follows the advice given at [Keep a CHANGELOG](htt - A new interface, `main_activity_interface`, is now available. Course format plugins should implement it if they intend to display only a single activity in the course page. For more information see [MDL-85433](https://tracker.moodle.org/browse/MDL-85433) +- The core_courseformat\local\overview\overviewfactory now includes a new method, activity_has_overview_integration, which determines if a module supports overview integration. + + For more information see [MDL-85509](https://tracker.moodle.org/browse/MDL-85509) +- New needs_filtering_by_groups() and get_groups_for_filtering() had been created in activityoverviewbase class for a better management of groups filtering in Activities overview page by activities. needs_filtering_by_groups() returns whether the user needs to filter by groups in the current module, and get_groups_for_filtering() returns which is the filter the user should use with groups API. + + For more information see [MDL-85852](https://tracker.moodle.org/browse/MDL-85852) +- A new has_error() function has been created in activityoverviewbase class to raise when a user is trying to check information about a module set as SEPARATE_GROUPS but the user is not in any group. + + For more information see [MDL-85852](https://tracker.moodle.org/browse/MDL-85852) +- New optional $nogroupserror parameter has been added to activityname class constructor. A set_nogroupserror() setter to change the value after the constructor has been also added. + + For more information see [MDL-85852](https://tracker.moodle.org/browse/MDL-85852) #### Changed diff --git a/public/course/format/UPGRADING.md b/public/course/format/UPGRADING.md index 263d1773604..d13d710024d 100644 --- a/public/course/format/UPGRADING.md +++ b/public/course/format/UPGRADING.md @@ -10,6 +10,18 @@ - A new interface, `main_activity_interface`, is now available. Course format plugins should implement it if they intend to display only a single activity in the course page. For more information see [MDL-85433](https://tracker.moodle.org/browse/MDL-85433) +- The core_courseformat\local\overview\overviewfactory now includes a new method, activity_has_overview_integration, which determines if a module supports overview integration. + + For more information see [MDL-85509](https://tracker.moodle.org/browse/MDL-85509) +- New needs_filtering_by_groups() and get_groups_for_filtering() had been created in activityoverviewbase class for a better management of groups filtering in Activities overview page by activities. needs_filtering_by_groups() returns whether the user needs to filter by groups in the current module, and get_groups_for_filtering() returns which is the filter the user should use with groups API. + + For more information see [MDL-85852](https://tracker.moodle.org/browse/MDL-85852) +- A new has_error() function has been created in activityoverviewbase class to raise when a user is trying to check information about a module set as SEPARATE_GROUPS but the user is not in any group. + + For more information see [MDL-85852](https://tracker.moodle.org/browse/MDL-85852) +- New optional $nogroupserror parameter has been added to activityname class constructor. A set_nogroupserror() setter to change the value after the constructor has been also added. + + For more information see [MDL-85852](https://tracker.moodle.org/browse/MDL-85852) ### Changed diff --git a/public/lib/UPGRADING.md b/public/lib/UPGRADING.md index 5dd38c67e12..83e11271d2c 100644 --- a/public/lib/UPGRADING.md +++ b/public/lib/UPGRADING.md @@ -18,6 +18,9 @@ - Added support for configurable `aspectRatio` in charts rendered using Chart.js. This enables developers to control chart sizing more precisely via the `chart_base` API and the frontend renderer. For more information see [MDL-85158](https://tracker.moodle.org/browse/MDL-85158) +- Output classes can now implement the core\output\externable interface. This allows these classes to define methods for exporting their data in a format suitable for use in web services. + + For more information see [MDL-85509](https://tracker.moodle.org/browse/MDL-85509) ### Changed @@ -30,9 +33,20 @@ - The `\core\attribute\deprecated` attribute constructor `$replacement` parameter now defaults to null, and can be omitted For more information see [MDL-84531](https://tracker.moodle.org/browse/MDL-84531) +- Added a new `\core\deprecation::emit_deprecation()` method which should be used in places where a deprecation is known to occur. This method will throw debugging if no deprecation notice was found, for example: + ```php + public function deprecated_method(): void { + \core\deprecation::emit_deprecation([self::class, __FUNCTION__]); + } + ``` + + For more information see [MDL-85897](https://tracker.moodle.org/browse/MDL-85897) ### Deprecated +- The following function has been deprecated and should no longer be used: `file_encode_url`. Please consider using the `core\url` factory methods instead. + + For more information see [MDL-31071](https://tracker.moodle.org/browse/MDL-31071) - The following `core/checkbox-toggleall` templates have been deprecated: - `core/checkbox-toggleall-master-button` - This is replaced with `core/checkbox-toggleall-toggler-button`