enrol/upgrade.txt

   1 This files describes API changes in /enrol/* - plugins,
   2 information provided here is intended especially for developers.
   3
   4 === 3.4 ===
   5
   6 * render_course_enrolment_users_table method has been removed from the renderer. The enrolled users page is now
   7   combined with the participants page. /enrol/users.php no longer exists.
   8
   9 === 3.3 ===
  10
  11 * External function core_enrol_external::get_users_courses now return the user progress, start and the end course dates.
  12
  13 === 3.2 ===
  14
  15 * External function core_enrol_external::get_users_courses now return the category id as an additional optional field.
  16
  17 === 3.1 ===
  18
  19 * core_enrol_external::get_enrolled_users now supports two additional parameters for ordering: sortby and sortdirection.
  20 * Enrolment plugins UI have been consolidated. Plugins can implement use_standard_editing_ui() function
  21   and add edit_instance_form() and edit_instance_validation() methods instead of providing their own edit.php and form.
  22   They can then rely on the default implementation of get_action_icons and get_course_navigation. In future this will
  23   mean they can be called by webservices/user upload tools because they can validate their data.
  24
  25 === 3.0 ===
  26
  27 * Added new events enrol_instance_created, enrol_instance_updated and
  28   enrol_instance_deleted . Always trigger them when changing records in the
  29   DB table 'enrol'.
  30 * Constant CACHE_COURSE_CONTACTS_TTL was deleted.
  31 * 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.
  32
  33 === 2.9 ===
  34
  35 * External function core_enrol_external::get_users_courses now returns additional optional fields:
  36    - summary: Course summary.
  37    - summaryformat: Course summary format.
  38    - format: Course format.
  39    - showgrades: True if grades are shown, otherwise false.
  40    - lang: Forced course language.
  41    - enablecompletion: Control or not via completion and activity settings.
  42
  43 === 2.8 ===
  44
  45 * enrol_plugin::instance_deleteable() is deprecated and has been replaced by enrol_plugin::can_delete_instance()
  46 * enrol_plugin::can_hide_show_instance() is a new function to control who can hide/show enrolment instances.
  47   Returns true by default but plugins must implement their own logic.
  48
  49 === 2.6 ===
  50
  51 * Enrolment plugin which supports self enrolment should implement can_self_enrol()
  52 * Enrolment plugin should implement get_enrol_info() to expose instance information
  53   with webservice or external interface.
  54 * Webservice core_enrol_get_enrolled_users_with_capability was incorrectly specifing
  55   float as the return type for user id. int is the actual returned type and is now
  56   reported as such.
  57
  58 === 2.5 ===
  59
  60 * plugins may use general enrol/editenrolment.php page to let users edit
  61   enrolments manually
  62 * new support for grade recovery in enrol_plugin::enrol_user() method
  63
  64 === 2.4 ===
  65
  66 required changes in code:
  67 * use role_get_name() or role_fix_names() if you need any role names, using role.name
  68   directly from database is not correct any more
  69 * new restore support: ENROL_RESTORE_EXACT, ENROL_RESTORE_NOUSERS
  70   and ENROL_RESTORE_CLASS were removed, implement new restore_* plugin methods instead
  71
  72 other changes and new features:
  73 * course enrolment manager now works with disabled plugins too
  74 * new support for protected group membership linked to enrol instance
  75 * new support for expiry notifications - see enrol_plugin::send_expiry_notifications() method
  76
  77
  78 === 2.2 ===
  79
  80 required changes in code:
  81 * load_temp_role() is deprecated, use load_temp_course_role() instead, temp role not loaded
  82 * remove_temp_role() is deprecated, use remove_temp_course_roles() instead
  83 * 'user_unenrol_modified' event was renamed to 'user_enrol_modified'
  84
  85
  86 === 2.0 ===
  87
  88 required changes in code:
  89 * enrolment plugins need to be rewritten to use new API - see inline phpdocs and official plugins