calendar/upgrade.txt

   1 This files describes API changes in /calendar/* ,
   2 information provided here is intended especially for developers.
   3
   4 === 3.8 ===
   5 * The following functions have been finally deprecated and can not be used anymore:
   6   * calendar_wday_name()
   7   * calendar_get_block_upcoming()
   8   * calendar_print_month_selector()
   9   * calendar_cron()
  10   * calendar_get_mini()
  11   * calendar_get_upcoming()
  12 * Added core_calendar_external::get_timestamps(), which allows an array containing an arbitrary number of arrays of
  13   date/time data to be converted and returned as timestamps, along with an optional key.
  14
  15 === 3.6 ===
  16 * calendar_get_default_courses() function now has optional $userid parameter.
  17 * calendar_set_filters() function now has optional $user parameter.
  18 * The core_calendar\local\event\container class now provides two new helper methods for getting and setting the requesting user:
  19   set_requesting_user() and get_requesting_user().
  20 * The following functions have been finally deprecated and can not be used anymore:
  21   * calendar_preferences_button()
  22 * added core_calendar_get_valid_event_timestart_range callback for course events when the update_event_start_day function is used
  23   in the local api.
  24
  25 === 3.5 ===
  26 * core_calendar_external::get_calendar_events now returns the categoryid for category events.
  27
  28 === 3.4 ===
  29 * calendar_get_mini, and calendar_get_upcoming have been deprecated. Please update to use the new exporters and renderers.
  30 * added core_calendar_get_valid_event_timestart_range and core_calendar_event_timestart_updated callbacks for module events
  31   when the update_event_start_day function is used in the local api.
  32
  33 === 3.3 ===
  34 * calendar_event_hook() has been removed. Developers should be using the Moodle events system to achieve this behaviour,
  35   rather than using a hacky calendar specific implementation.
  36 * calendar_wday_name() is deprecated and no longer used in core.
  37 * calendar_get_block_upcoming() is deprecated, please use block_calendar_upcoming::get_upcoming_content() instead.
  38 * calendar_print_month_selector() is deprecated and no longer used in core.
  39 * calendar_cron() is deprecated and should not be used. Please use the core\task\calendar_cron_task instead.
  40
  41 === 3.2 ===
  42 * calendar_preferences_button() is now deprecated. Calendar preferences have been moved to the user preferences page.
  43
  44 === 2.9 ===
  45 default values changes in code:
  46 * core_calendar_external::get_calendar_events_parameters() 'timeend' default option changed; now, by default,
  47   all events are returned, not only the past ones.
  48 * calendar types need to be updated to be compatible with standard PHP date/time code
  49
  50 === 2.5 ===
  51 required changes in code:
  52 * calendar_add_icalendar_event() now requires a valid subscriptionid
  53 * calendar_process_subscription_row() throws exception for invalid subscriptionid
  54 * calendar_update_subscription_events() now throws a dml_exception instead of moodle_exception for bad subscriptions
  55 * calendar_get_mini() function now has optional $placement and $courseid paramaters.
  56
  57 optional - no changes needed:
  58 * calendar_update_subscription() should now be used to update Ical subscriptions.
  59
  60 === 2.4 ===
  61
  62 required changes in code:
  63
  64 * calendar_get_popup() function now just returns id, instead of the string "id=$id"