enrol/upgrade.txt

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