upgrade.txt 2.73 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.

4
5
6
7
8
=== 3.0 ===

* Added new events enrol_instance_created, enrol_instance_updated and
  enrol_instance_deleted . Always trigger them when changing records in the
  DB table 'enrol'.
9
* Constant CACHE_COURSE_CONTACTS_TTL was deleted.
10
* 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.
11

12
13
14
15
16
17
18
19
20
21
=== 2.9 ===

* External function core_enrol_external::get_users_courses now returns additional optional fields:
   - summary: Course summary.
   - summaryformat: Course summary format.
   - format: Course format.
   - showgrades: True if grades are shown, otherwise false.
   - lang: Forced course language.
   - enablecompletion: Control or not via completion and activity settings.

Dan Poltawski's avatar
Dan Poltawski committed
22
23
24
=== 2.8 ===

* enrol_plugin::instance_deleteable() is deprecated and has been replaced by enrol_plugin::can_delete_instance()
25
26
* 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
27

28
29
30
31
32
=== 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.
33
34
35
* 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.
36

37
38
39
40
=== 2.5 ===

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

43
44
45
46
47
=== 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
48
49
* new restore support: ENROL_RESTORE_EXACT, ENROL_RESTORE_NOUSERS
  and ENROL_RESTORE_CLASS were removed, implement new restore_* plugin methods instead
50

51
other changes and new features:
52
* course enrolment manager now works with disabled plugins too
53
54
* new support for protected group membership linked to enrol instance
* new support for expiry notifications - see enrol_plugin::send_expiry_notifications() method
55

56

Petr Skoda's avatar
Petr Skoda committed
57
58
59
60
61
=== 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
62
* 'user_unenrol_modified' event was renamed to 'user_enrol_modified'
63
64
65
66
67


=== 2.0 ===

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