MDL-60065 calendar: Deprecate calendar_get_mini and friends
[moodle.git] / calendar / upgrade.txt
1 This files describes API changes in /calendar/* ,
2 information provided here is intended especially for developers.
4 === 3.4 ===
5 * calendar_get_mini has been deprecated. Please update to use the new
6   exporters and renderers.
8 === 3.3 ===
9 * calendar_event_hook() has been removed. Developers should be using the Moodle events system to achieve this behaviour,
10   rather than using a hacky calendar specific implementation.
11 * calendar_wday_name() is deprecated and no longer used in core.
12 * calendar_get_block_upcoming() is deprecated, please use block_calendar_upcoming::get_upcoming_content() instead.
13 * calendar_print_month_selector() is deprecated and no longer used in core.
14 * calendar_cron() is deprecated and should not be used. Please use the core\task\calendar_cron_task instead.
16 === 3.2 ===
17 * calendar_preferences_button() is now deprecated. Calendar preferences have been moved to the user preferences page.
19 === 2.9 ===
20 default values changes in code:
21 * core_calendar_external::get_calendar_events_parameters() 'timeend' default option changed; now, by default,
22   all events are returned, not only the past ones.
23 * calendar types need to be updated to be compatible with standard PHP date/time code
25 === 2.5 ===
26 required changes in code:
27 * calendar_add_icalendar_event() now requires a valid subscriptionid
28 * calendar_process_subscription_row() throws exception for invalid subscriptionid
29 * calendar_update_subscription_events() now throws a dml_exception instead of moodle_exception for bad subscriptions
30 * calendar_get_mini() function now has optional $placement and $courseid paramaters.
32 optional - no changes needed:
33 * calendar_update_subscription() should now be used to update Ical subscriptions.
35 === 2.4 ===
37 required changes in code:
39 * calendar_get_popup() function now just returns id, instead of the string "id=$id"