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