calendar/upgrade.txt

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