calendar/upgrade.txt

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