upgrade.txt 1.97 KB
Newer Older
Petr Skoda's avatar
Petr Skoda committed
1
2
3
This files describes API changes in /enrol/* - plugins,
information provided here is intended especially for developers.

Dan Poltawski's avatar
Dan Poltawski committed
4
5
6
=== 2.8 ===

* enrol_plugin::instance_deleteable() is deprecated and has been replaced by enrol_plugin::can_delete_instance()
7
8
* enrol_plugin::can_hide_show_instance() is a new function to control who can hide/show enrolment instances.
  Returns true by default but plugins must implement their own logic.
Dan Poltawski's avatar
Dan Poltawski committed
9

10
11
12
13
14
=== 2.6 ===

* Enrolment plugin which supports self enrolment should implement can_self_enrol()
* Enrolment plugin should implement get_enrol_info() to expose instance information
  with webservice or external interface.
15
16
17
* Webservice core_enrol_get_enrolled_users_with_capability was incorrectly specifing
  float as the return type for user id. int is the actual returned type and is now
  reported as such.
18

19
20
21
22
=== 2.5 ===

* plugins may use general enrol/editenrolment.php page to let users edit
  enrolments manually
23
* new support for grade recovery in enrol_plugin::enrol_user() method
24

25
26
27
28
29
=== 2.4 ===

required changes in code:
* use role_get_name() or role_fix_names() if you need any role names, using role.name
  directly from database is not correct any more
30
31
* new restore support: ENROL_RESTORE_EXACT, ENROL_RESTORE_NOUSERS
  and ENROL_RESTORE_CLASS were removed, implement new restore_* plugin methods instead
32

33
other changes and new features:
34
* course enrolment manager now works with disabled plugins too
35
36
* new support for protected group membership linked to enrol instance
* new support for expiry notifications - see enrol_plugin::send_expiry_notifications() method
37

38

Petr Skoda's avatar
Petr Skoda committed
39
40
41
42
43
=== 2.2 ===

required changes in code:
* load_temp_role() is deprecated, use load_temp_course_role() instead, temp role not loaded
* remove_temp_role() is deprecated, use remove_temp_course_roles() instead
44
* 'user_unenrol_modified' event was renamed to 'user_enrol_modified'
45
46
47
48
49


=== 2.0 ===

required changes in code:
50
* enrolment plugins need to be rewritten to use new API - see inline phpdocs and official plugins