enrol/upgrade.txt

   1 This files describes API changes in /enrol/* - plugins,
   2 information provided here is intended especially for developers.
   3
   4 === 2.6 ===
   5
   6 * Enrolment plugin which supports self enrolment should implement can_self_enrol()
   7 * Enrolment plugin should implement get_enrol_info() to expose instance information
   8   with webservice or external interface.
   9
  10 === 2.5 ===
  11
  12 * plugins may use general enrol/editenrolment.php page to let users edit
  13   enrolments manually
  14 * new support for grade recovery in enrol_plugin::enrol_user() method
  15
  16 === 2.4 ===
  17
  18 required changes in code:
  19 * use role_get_name() or role_fix_names() if you need any role names, using role.name
  20   directly from database is not correct any more
  21 * new restore support: ENROL_RESTORE_EXACT, ENROL_RESTORE_NOUSERS
  22   and ENROL_RESTORE_CLASS were removed, implement new restore_* plugin methods instead
  23
  24 other changes and new features:
  25 * course enrolment manager now works with disabled plugins too
  26 * new support for protected group membership linked to enrol instance
  27 * new support for expiry notifications - see enrol_plugin::send_expiry_notifications() method
  28
  29
  30 === 2.2 ===
  31
  32 required changes in code:
  33 * load_temp_role() is deprecated, use load_temp_course_role() instead, temp role not loaded
  34 * remove_temp_role() is deprecated, use remove_temp_course_roles() instead
  35 * 'user_unenrol_modified' event was renamed to 'user_enrol_modified'
  36
  37
  38 === 2.0 ===
  39
  40 required changes in code:
  41 * enrolment plugins need to be rewritten to use new API - see inline phpdocs and official plugins