upgrade.txt 4.98 KB
Newer Older
1
2
3
This files describes API changes in /calendar/* ,
information provided here is intended especially for developers.

4
5
6
7
=== 4.1 ===
* New method `calendar_format_event_location` which will format the location property of an event, converting any
  links into suitable markup

8
9
10
11
=== 4.0 ===
* The following external functions now accepts an optional parameter 'searchvalue' to search the events:
  - core_calendar_external::get_calendar_action_events_by_timesort
  - core_calendar_external::get_calendar_action_events_by_courses
12
  - core_calendar_external::get_calendar_action_events_by_course
13
* Added core_calendar_delete_subscription, which allows to delete the calendar subscription.
14
* Updated calendar_can_manage_user_event() function to check permissions to user events.
15
16
17
* The following functions have been deprecated because they were no longer used:
  - calendar_process_subscription_row()
  - calendar_import_icalendar_events()
18
19
* The following has been removed after being deprecated in 3.8
  * CALENDAR_EVENT_GLOBAL
20
21
22
23
24
* The following have been deprecated because the three-month pseudo block has been removed:
  - fake_block_threemonths() renderer method.
  - calendar_threemonth.js.
  - calendar_threemonth and threemonth_month templates.
  - Behat step definitions i_hover_over_day_of_this_month_in_calendar and i_click_day_of_this_month_in_calendar.
25

26
=== 3.10 ===
27
28
29
* The core_calendar\local\event\value_objects\times_interface class now has new method get_usermidnight_time() which
  returns the user midnight time for a given event.

30
31
32
33
=== 3.9 ===
* Plugins can now create their own calendar events, both standard and action ones. To do it they need to specify
  $event->component when creating an event. Component events can not be edited or deleted manually.
  See https://docs.moodle.org/dev/Calendar_API#Component_events
34
35
36
* The following functions have been deprecated because they were no longer used:
  - calendar_add_event_metadata()
  - core_calendar_renderer::event()
37

38
39
40
41
42
43
=== 3.8 ===
* The following functions have been finally deprecated and can not be used anymore:
  * calendar_wday_name()
  * calendar_get_block_upcoming()
  * calendar_print_month_selector()
  * calendar_cron()
44
45
  * calendar_get_mini()
  * calendar_get_upcoming()
46
47
* Added core_calendar_external::get_timestamps(), which allows an array containing an arbitrary number of arrays of
  date/time data to be converted and returned as timestamps, along with an optional key.
48

49
50
=== 3.6 ===
* calendar_get_default_courses() function now has optional $userid parameter.
51
* calendar_set_filters() function now has optional $user parameter.
52
53
* The core_calendar\local\event\container class now provides two new helper methods for getting and setting the requesting user:
  set_requesting_user() and get_requesting_user().
54
55
* The following functions have been finally deprecated and can not be used anymore:
  * calendar_preferences_button()
56
57
* added core_calendar_get_valid_event_timestart_range callback for course events when the update_event_start_day function is used
  in the local api.
58

59
60
61
=== 3.5 ===
* core_calendar_external::get_calendar_events now returns the categoryid for category events.

62
=== 3.4 ===
63
* calendar_get_mini, and calendar_get_upcoming have been deprecated. Please update to use the new exporters and renderers.
64
* added core_calendar_get_valid_event_timestart_range and core_calendar_event_timestart_updated callbacks for module events
65
  when the update_event_start_day function is used in the local api.
66

67
68
69
=== 3.3 ===
* calendar_event_hook() has been removed. Developers should be using the Moodle events system to achieve this behaviour,
  rather than using a hacky calendar specific implementation.
70
71
72
73
* calendar_wday_name() is deprecated and no longer used in core.
* calendar_get_block_upcoming() is deprecated, please use block_calendar_upcoming::get_upcoming_content() instead.
* calendar_print_month_selector() is deprecated and no longer used in core.
* calendar_cron() is deprecated and should not be used. Please use the core\task\calendar_cron_task instead.
74

75
=== 3.2 ===
76
* calendar_preferences_button() is now deprecated. Calendar preferences have been moved to the user preferences page.
77

78
79
80
81
=== 2.9 ===
default values changes in code:
* core_calendar_external::get_calendar_events_parameters() 'timeend' default option changed; now, by default,
  all events are returned, not only the past ones.
82
* calendar types need to be updated to be compatible with standard PHP date/time code
83

84
85
86
87
88
=== 2.5 ===
required changes in code:
* calendar_add_icalendar_event() now requires a valid subscriptionid
* calendar_process_subscription_row() throws exception for invalid subscriptionid
* calendar_update_subscription_events() now throws a dml_exception instead of moodle_exception for bad subscriptions
89
* calendar_get_mini() function now has optional $placement and $courseid paramaters.
90

91
92
93
optional - no changes needed:
* calendar_update_subscription() should now be used to update Ical subscriptions.

94
95
96
97
98
=== 2.4 ===

required changes in code:

* calendar_get_popup() function now just returns id, instead of the string "id=$id"