enrol/upgrade.txt

   1 This files describes API changes in /enrol/* - plugins,
   2 information provided here is intended especially for developers.
   3
   4 === 3.7 ===
   5
   6 * Functions get_potential_users() and search_other_users() now return more information to avoid extra count query:
   7   - users: List of user objects returned by the query.
   8   - moreusers: True if there are still more users, otherwise is False.
   9   - totalusers: Number users matching the search. (This element only exists if the function is called with $returnexactcount param set to true).
  10 * enrolledusercount is now optional in the return value of get_users_courses() for performance reasons. This is controlled with the new
  11   optional returnusercount parameter (default true).
  12 * External function core_enrol_external::get_users_courses now returns a new field "completionusertracked" that indicates if the
  13   given user is being tracked for completion.
  14
  15 === 3.6 ===
  16
  17 * External function core_enrol_external::get_users_courses now return more information to avoid multiple queries to build the
  18   user dashboard:
  19   - displayname: Course display name for lists.
  20   - marker: Course section active marker.
  21   - completed: Whether the given user completed the course or not.
  22   - lastaccess: Last time the user accessed the course.
  23   - overviewfiles: Course overview files.
  24   - completionhascriteria: Whether completion criteria is set for the course.
  25   - isfavourite: Whether the user marked the course as favourite.
  26   - hidden: Whether the user hide the course from the dashboard.
  27 * External functions core_enrol_external::get_enrolled_users and core_enrol_external::get_enrolled_users_with_capability now return
  28   the last access time for the users in the given course.
  29
  30 === 3.5 ===
  31
  32 * Default sorting in enrol_get_my_courses(), enrol_get_all_users_courses() and enrol_get_users_courses() now respects
  33   the site setting "navsortmycoursessort" and should be consistently used when displaying the courses in the UI.
  34
  35 === 3.4 ===
  36
  37 * render_course_enrolment_users_table method has been removed from the renderer. The enrolled users page is now
  38   combined with the participants page. /enrol/users.php no longer exists.
  39
  40 === 3.3 ===
  41
  42 * External function core_enrol_external::get_users_courses now return the user progress, start and the end course dates.
  43
  44 === 3.2 ===
  45
  46 * External function core_enrol_external::get_users_courses now return the category id as an additional optional field.
  47
  48 === 3.1 ===
  49
  50 * core_enrol_external::get_enrolled_users now supports two additional parameters for ordering: sortby and sortdirection.
  51 * Enrolment plugins UI have been consolidated. Plugins can implement use_standard_editing_ui() function
  52   and add edit_instance_form() and edit_instance_validation() methods instead of providing their own edit.php and form.
  53   They can then rely on the default implementation of get_action_icons and get_course_navigation. In future this will
  54   mean they can be called by webservices/user upload tools because they can validate their data.
  55
  56 === 3.0 ===
  57
  58 * Added new events enrol_instance_created, enrol_instance_updated and
  59   enrol_instance_deleted . Always trigger them when changing records in the
  60   DB table 'enrol'.
  61 * Constant CACHE_COURSE_CONTACTS_TTL was deleted.
  62 * External function core_enrol_external::get_enrolled_users now returns only the viewable participants if the course has groups enabled and no groupid is passed.
  63
  64 === 2.9 ===
  65
  66 * External function core_enrol_external::get_users_courses now returns additional optional fields:
  67    - summary: Course summary.
  68    - summaryformat: Course summary format.
  69    - format: Course format.
  70    - showgrades: True if grades are shown, otherwise false.
  71    - lang: Forced course language.
  72    - enablecompletion: Control or not via completion and activity settings.
  73
  74 === 2.8 ===
  75
  76 * enrol_plugin::instance_deleteable() is deprecated and has been replaced by enrol_plugin::can_delete_instance()
  77 * enrol_plugin::can_hide_show_instance() is a new function to control who can hide/show enrolment instances.
  78   Returns true by default but plugins must implement their own logic.
  79
  80 === 2.6 ===
  81
  82 * Enrolment plugin which supports self enrolment should implement can_self_enrol()
  83 * Enrolment plugin should implement get_enrol_info() to expose instance information
  84   with webservice or external interface.
  85 * Webservice core_enrol_get_enrolled_users_with_capability was incorrectly specifing
  86   float as the return type for user id. int is the actual returned type and is now
  87   reported as such.
  88
  89 === 2.5 ===
  90
  91 * plugins may use general enrol/editenrolment.php page to let users edit
  92   enrolments manually
  93 * new support for grade recovery in enrol_plugin::enrol_user() method
  94
  95 === 2.4 ===
  96
  97 required changes in code:
  98 * use role_get_name() or role_fix_names() if you need any role names, using role.name
  99   directly from database is not correct any more
 100 * new restore support: ENROL_RESTORE_EXACT, ENROL_RESTORE_NOUSERS
 101   and ENROL_RESTORE_CLASS were removed, implement new restore_* plugin methods instead
 102
 103 other changes and new features:
 104 * course enrolment manager now works with disabled plugins too
 105 * new support for protected group membership linked to enrol instance
 106 * new support for expiry notifications - see enrol_plugin::send_expiry_notifications() method
 107
 108
 109 === 2.2 ===
 110
 111 required changes in code:
 112 * load_temp_role() is deprecated, use load_temp_course_role() instead, temp role not loaded
 113 * remove_temp_role() is deprecated, use remove_temp_course_roles() instead
 114 * 'user_unenrol_modified' event was renamed to 'user_enrol_modified'
 115
 116
 117 === 2.0 ===
 118
 119 required changes in code:
 120 * enrolment plugins need to be rewritten to use new API - see inline phpdocs and official plugins