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