calendar/upgrade.txt

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