enrol/upgrade.txt

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