Skip to content

Commit c9e1d37

Browse files
committed
NOBUG: Add upgrade notes
1 parent 34a4cd0 commit c9e1d37

File tree

3 files changed

+52
-0
lines changed

3 files changed

+52
-0
lines changed

UPGRADING.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ The format of this change log follows the advice given at [Keep a CHANGELOG](htt
2626
- 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.
2727

2828
For more information see [MDL-85158](https://tracker.moodle.org/browse/MDL-85158)
29+
- 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.
30+
31+
For more information see [MDL-85509](https://tracker.moodle.org/browse/MDL-85509)
2932

3033
#### Changed
3134

@@ -38,9 +41,20 @@ The format of this change log follows the advice given at [Keep a CHANGELOG](htt
3841
- The `\core\attribute\deprecated` attribute constructor `$replacement` parameter now defaults to null, and can be omitted
3942

4043
For more information see [MDL-84531](https://tracker.moodle.org/browse/MDL-84531)
44+
- 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:
45+
```php
46+
public function deprecated_method(): void {
47+
\core\deprecation::emit_deprecation([self::class, __FUNCTION__]);
48+
}
49+
```
50+
51+
For more information see [MDL-85897](https://tracker.moodle.org/browse/MDL-85897)
4152

4253
#### Deprecated
4354

55+
- The following function has been deprecated and should no longer be used: `file_encode_url`. Please consider using the `core\url` factory methods instead.
56+
57+
For more information see [MDL-31071](https://tracker.moodle.org/browse/MDL-31071)
4458
- The following `core/checkbox-toggleall` templates have been deprecated:
4559

4660
- `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
158172
- 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.
159173

160174
For more information see [MDL-85433](https://tracker.moodle.org/browse/MDL-85433)
175+
- The core_courseformat\local\overview\overviewfactory now includes a new method, activity_has_overview_integration, which determines if a module supports overview integration.
176+
177+
For more information see [MDL-85509](https://tracker.moodle.org/browse/MDL-85509)
178+
- 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.
179+
180+
For more information see [MDL-85852](https://tracker.moodle.org/browse/MDL-85852)
181+
- 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.
182+
183+
For more information see [MDL-85852](https://tracker.moodle.org/browse/MDL-85852)
184+
- 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.
185+
186+
For more information see [MDL-85852](https://tracker.moodle.org/browse/MDL-85852)
161187

162188
#### Changed
163189

public/course/format/UPGRADING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,18 @@
1010
- 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.
1111

1212
For more information see [MDL-85433](https://tracker.moodle.org/browse/MDL-85433)
13+
- The core_courseformat\local\overview\overviewfactory now includes a new method, activity_has_overview_integration, which determines if a module supports overview integration.
14+
15+
For more information see [MDL-85509](https://tracker.moodle.org/browse/MDL-85509)
16+
- 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.
17+
18+
For more information see [MDL-85852](https://tracker.moodle.org/browse/MDL-85852)
19+
- 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.
20+
21+
For more information see [MDL-85852](https://tracker.moodle.org/browse/MDL-85852)
22+
- 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.
23+
24+
For more information see [MDL-85852](https://tracker.moodle.org/browse/MDL-85852)
1325

1426
### Changed
1527

public/lib/UPGRADING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@
1818
- 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.
1919

2020
For more information see [MDL-85158](https://tracker.moodle.org/browse/MDL-85158)
21+
- 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.
22+
23+
For more information see [MDL-85509](https://tracker.moodle.org/browse/MDL-85509)
2124

2225
### Changed
2326

@@ -30,9 +33,20 @@
3033
- The `\core\attribute\deprecated` attribute constructor `$replacement` parameter now defaults to null, and can be omitted
3134

3235
For more information see [MDL-84531](https://tracker.moodle.org/browse/MDL-84531)
36+
- 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:
37+
```php
38+
public function deprecated_method(): void {
39+
\core\deprecation::emit_deprecation([self::class, __FUNCTION__]);
40+
}
41+
```
42+
43+
For more information see [MDL-85897](https://tracker.moodle.org/browse/MDL-85897)
3344

3445
### Deprecated
3546

47+
- The following function has been deprecated and should no longer be used: `file_encode_url`. Please consider using the `core\url` factory methods instead.
48+
49+
For more information see [MDL-31071](https://tracker.moodle.org/browse/MDL-31071)
3650
- The following `core/checkbox-toggleall` templates have been deprecated:
3751

3852
- `core/checkbox-toggleall-master-button` - This is replaced with `core/checkbox-toggleall-toggler-button`

0 commit comments

Comments
 (0)