on-demand release 4.0dev+
[moodle.git] / calendar / upgrade.txt
1 This files describes API changes in /calendar/* ,
2 information provided here is intended especially for developers.
4 === 4.0 ===
5 * The following external functions now accepts an optional parameter 'searchvalue' to search the events:
6   - core_calendar_external::get_calendar_action_events_by_timesort
7   - core_calendar_external::get_calendar_action_events_by_courses
9 === 3.10 ===
10 * The core_calendar\local\event\value_objects\times_interface class now has new method get_usermidnight_time() which
11   returns the user midnight time for a given event.
13 === 3.9 ===
14 * Plugins can now create their own calendar events, both standard and action ones. To do it they need to specify
15   $event->component when creating an event. Component events can not be edited or deleted manually.
16   See https://docs.moodle.org/dev/Calendar_API#Component_events
17 * The following functions have been deprecated because they were no longer used:
18   - calendar_add_event_metadata()
19   - core_calendar_renderer::event()
21 === 3.8 ===
22 * The following functions have been finally deprecated and can not be used anymore:
23   * calendar_wday_name()
24   * calendar_get_block_upcoming()
25   * calendar_print_month_selector()
26   * calendar_cron()
27   * calendar_get_mini()
28   * calendar_get_upcoming()
29 * Added core_calendar_external::get_timestamps(), which allows an array containing an arbitrary number of arrays of
30   date/time data to be converted and returned as timestamps, along with an optional key.
32 === 3.6 ===
33 * calendar_get_default_courses() function now has optional $userid parameter.
34 * calendar_set_filters() function now has optional $user parameter.
35 * The core_calendar\local\event\container class now provides two new helper methods for getting and setting the requesting user:
36   set_requesting_user() and get_requesting_user().
37 * The following functions have been finally deprecated and can not be used anymore:
38   * calendar_preferences_button()
39 * added core_calendar_get_valid_event_timestart_range callback for course events when the update_event_start_day function is used
40   in the local api.
42 === 3.5 ===
43 * core_calendar_external::get_calendar_events now returns the categoryid for category events.
45 === 3.4 ===
46 * calendar_get_mini, and calendar_get_upcoming have been deprecated. Please update to use the new exporters and renderers.
47 * added core_calendar_get_valid_event_timestart_range and core_calendar_event_timestart_updated callbacks for module events
48   when the update_event_start_day function is used in the local api.
50 === 3.3 ===
51 * calendar_event_hook() has been removed. Developers should be using the Moodle events system to achieve this behaviour,
52   rather than using a hacky calendar specific implementation.
53 * calendar_wday_name() is deprecated and no longer used in core.
54 * calendar_get_block_upcoming() is deprecated, please use block_calendar_upcoming::get_upcoming_content() instead.
55 * calendar_print_month_selector() is deprecated and no longer used in core.
56 * calendar_cron() is deprecated and should not be used. Please use the core\task\calendar_cron_task instead.
58 === 3.2 ===
59 * calendar_preferences_button() is now deprecated. Calendar preferences have been moved to the user preferences page.
61 === 2.9 ===
62 default values changes in code:
63 * core_calendar_external::get_calendar_events_parameters() 'timeend' default option changed; now, by default,
64   all events are returned, not only the past ones.
65 * calendar types need to be updated to be compatible with standard PHP date/time code
67 === 2.5 ===
68 required changes in code:
69 * calendar_add_icalendar_event() now requires a valid subscriptionid
70 * calendar_process_subscription_row() throws exception for invalid subscriptionid
71 * calendar_update_subscription_events() now throws a dml_exception instead of moodle_exception for bad subscriptions
72 * calendar_get_mini() function now has optional $placement and $courseid paramaters.
74 optional - no changes needed:
75 * calendar_update_subscription() should now be used to update Ical subscriptions.
77 === 2.4 ===
79 required changes in code:
81 * calendar_get_popup() function now just returns id, instead of the string "id=$id"