calendar/upgrade.txt

   1 === 4.5 Onwards ===
   2
   3 This file has been replaced by UPGRADING.md. See MDL-81125 for further information.
   4
   5 ===
   6 This files describes API changes in /calendar/* ,
   7 information provided here is intended especially for developers.
   8
   9 === 4.4 ===
  10 * The following previously deprecated methods have been removed and can no longer be used:
  11   - `calendar_process_subscription_row`
  12   - `calendar_import_icalendar_events`
  13   - `fake_block_threemonths`
  14   - `i_click_day_of_this_month_in_calendar`
  15   - `i_hover_over_today_in_the_calendar`
  16 * The following previously deprecated files have been removed and can no longer be used:
  17   - `calendar_threemonth.js`
  18   - `calendar_threemonth.mustache`
  19   - `threemonth_month.mustache`
  20 * The following have been deprecated:
  21   - Behat step definition `i_hover_over_today_in_the_calendar`
  22 * The event_exporter_base class now returns a field called "branded" indicating whether the module is branded or not.
  23   All the external functions using the exporter will now return the new field:
  24   - core_calendar_get_action_events_by_course
  25   - core_calendar_get_action_events_by_courses
  26   - core_calendar_get_action_events_by_timesort
  27   - core_calendar_get_calendar_day_view
  28   - core_calendar_get_calendar_event_by_id
  29   - core_calendar_get_calendar_monthly_view
  30   - core_calendar_get_calendar_upcoming_view
  31   - core_calendar_submit_create_update_form
  32   - core_calendar_update_event_start_day
  33
  34 === 4.3 ===
  35 * The `navigation` property has been removed from `\core_calendar\external\day_exporter` as it is not being used by any of the
  36   calendar templates.
  37 * The following functions have been deprecated and should no longer be used:
  38   - calendar_top_controls()
  39   - calendar_get_link_previous()
  40   - calendar_get_link_next()
  41
  42 === 4.1 ===
  43 * New method `calendar_format_event_location` which will format the location property of an event, converting any
  44   links into suitable markup
  45
  46 === 4.0 ===
  47 * The following external functions now accepts an optional parameter 'searchvalue' to search the events:
  48   - core_calendar_external::get_calendar_action_events_by_timesort
  49   - core_calendar_external::get_calendar_action_events_by_courses
  50   - core_calendar_external::get_calendar_action_events_by_course
  51 * Added core_calendar_delete_subscription, which allows to delete the calendar subscription.
  52 * Updated calendar_can_manage_user_event() function to check permissions to user events.
  53 * The following functions have been deprecated because they were no longer used:
  54   - calendar_process_subscription_row()
  55   - calendar_import_icalendar_events()
  56 * The following has been removed after being deprecated in 3.8
  57   * CALENDAR_EVENT_GLOBAL
  58 * The following have been deprecated because the three-month pseudo block has been removed:
  59   - fake_block_threemonths() renderer method.
  60   - calendar_threemonth.js.
  61   - calendar_threemonth and threemonth_month templates.
  62   - Behat step definitions i_hover_over_day_of_this_month_in_calendar and i_click_day_of_this_month_in_calendar.
  63
  64 === 3.10 ===
  65 * The core_calendar\local\event\value_objects\times_interface class now has new method get_usermidnight_time() which
  66   returns the user midnight time for a given event.
  67
  68 === 3.9 ===
  69 * Plugins can now create their own calendar events, both standard and action ones. To do it they need to specify
  70   $event->component when creating an event. Component events can not be edited or deleted manually.
  71   See https://moodledev.io/docs/apis/core/calendar#component-events
  72 * The following functions have been deprecated because they were no longer used:
  73   - calendar_add_event_metadata()
  74   - core_calendar_renderer::event()
  75
  76 === 3.8 ===
  77 * The following functions have been finally deprecated and can not be used anymore:
  78   * calendar_wday_name()
  79   * calendar_get_block_upcoming()
  80   * calendar_print_month_selector()
  81   * calendar_cron()
  82   * calendar_get_mini()
  83   * calendar_get_upcoming()
  84 * Added core_calendar_external::get_timestamps(), which allows an array containing an arbitrary number of arrays of
  85   date/time data to be converted and returned as timestamps, along with an optional key.
  86
  87 === 3.6 ===
  88 * calendar_get_default_courses() function now has optional $userid parameter.
  89 * calendar_set_filters() function now has optional $user parameter.
  90 * The core_calendar\local\event\container class now provides two new helper methods for getting and setting the requesting user:
  91   set_requesting_user() and get_requesting_user().
  92 * The following functions have been finally deprecated and can not be used anymore:
  93   * calendar_preferences_button()
  94 * added core_calendar_get_valid_event_timestart_range callback for course events when the update_event_start_day function is used
  95   in the local api.
  96
  97 === 3.5 ===
  98 * core_calendar_external::get_calendar_events now returns the categoryid for category events.
  99
 100 === 3.4 ===
 101 * calendar_get_mini, and calendar_get_upcoming have been deprecated. Please update to use the new exporters and renderers.
 102 * added core_calendar_get_valid_event_timestart_range and core_calendar_event_timestart_updated callbacks for module events
 103   when the update_event_start_day function is used in the local api.
 104
 105 === 3.3 ===
 106 * calendar_event_hook() has been removed. Developers should be using the Moodle events system to achieve this behaviour,
 107   rather than using a hacky calendar specific implementation.
 108 * calendar_wday_name() is deprecated and no longer used in core.
 109 * calendar_get_block_upcoming() is deprecated, please use block_calendar_upcoming::get_upcoming_content() instead.
 110 * calendar_print_month_selector() is deprecated and no longer used in core.
 111 * calendar_cron() is deprecated and should not be used. Please use the core\task\calendar_cron_task instead.
 112
 113 === 3.2 ===
 114 * calendar_preferences_button() is now deprecated. Calendar preferences have been moved to the user preferences page.
 115
 116 === 2.9 ===
 117 default values changes in code:
 118 * core_calendar_external::get_calendar_events_parameters() 'timeend' default option changed; now, by default,
 119   all events are returned, not only the past ones.
 120 * calendar types need to be updated to be compatible with standard PHP date/time code
 121
 122 === 2.5 ===
 123 required changes in code:
 124 * calendar_add_icalendar_event() now requires a valid subscriptionid
 125 * calendar_process_subscription_row() throws exception for invalid subscriptionid
 126 * calendar_update_subscription_events() now throws a dml_exception instead of moodle_exception for bad subscriptions
 127 * calendar_get_mini() function now has optional $placement and $courseid paramaters.
 128
 129 optional - no changes needed:
 130 * calendar_update_subscription() should now be used to update Ical subscriptions.
 131
 132 === 2.4 ===
 133
 134 required changes in code:
 135
 136 * calendar_get_popup() function now just returns id, instead of the string "id=$id"