calendar/upgrade.txt

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