enrol/upgrade.txt

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