6d3489e3b588cb1de7e75419f26dda0af5571b33
[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.
7 * The core_calendar\local\event\container class now provides two new helper methods for getting and setting the requesting user:
8   set_requesting_user() and get_requesting_user().
10 === 3.5 ===
11 * core_calendar_external::get_calendar_events now returns the categoryid for category events.
13 === 3.4 ===
14 * calendar_get_mini, and calendar_get_upcoming have been deprecated. Please update to use the new exporters and renderers.
15 * added core_calendar_get_valid_event_timestart_range and core_calendar_event_timestart_updated callbacks for module events
16   when the update_event_start_day function is used in the local api.
18 === 3.3 ===
19 * calendar_event_hook() has been removed. Developers should be using the Moodle events system to achieve this behaviour,
20   rather than using a hacky calendar specific implementation.
21 * calendar_wday_name() is deprecated and no longer used in core.
22 * calendar_get_block_upcoming() is deprecated, please use block_calendar_upcoming::get_upcoming_content() instead.
23 * calendar_print_month_selector() is deprecated and no longer used in core.
24 * calendar_cron() is deprecated and should not be used. Please use the core\task\calendar_cron_task instead.
26 === 3.2 ===
27 * calendar_preferences_button() is now deprecated. Calendar preferences have been moved to the user preferences page.
29 === 2.9 ===
30 default values changes in code:
31 * core_calendar_external::get_calendar_events_parameters() 'timeend' default option changed; now, by default,
32   all events are returned, not only the past ones.
33 * calendar types need to be updated to be compatible with standard PHP date/time code
35 === 2.5 ===
36 required changes in code:
37 * calendar_add_icalendar_event() now requires a valid subscriptionid
38 * calendar_process_subscription_row() throws exception for invalid subscriptionid
39 * calendar_update_subscription_events() now throws a dml_exception instead of moodle_exception for bad subscriptions
40 * calendar_get_mini() function now has optional $placement and $courseid paramaters.
42 optional - no changes needed:
43 * calendar_update_subscription() should now be used to update Ical subscriptions.
45 === 2.4 ===
47 required changes in code:
49 * calendar_get_popup() function now just returns id, instead of the string "id=$id"