Merge branch 'MDL-48970_2.8' of https://github.com/andrewhancox/moodle into MOODLE_28...
[moodle.git] / auth / upgrade.txt
blob5308808806b373cc0b0e8a0ab1e0cb6c784d7421
1 This files describes API changes in /auth/* - plugins,
2 information provided here is intended especially for developers.
4 === 2.8 ===
6 * \core\session\manager::session_exists() now verifies the session is active
7   instead of only checking the session data is present in low level session handler
9 * MNet is no longer sending logs between the client and parent sites. auth_plugin_mnet::refresh_log() is now deprecated. There is
10   no alternative. Please don't use this function.
12 === 2.7 ===
14 * If you are returning a url in method change_password_url() from config, please make sure it is set before trying to use it.
16 === 2.6 ===
18 * can_be_manually_set() - This function was introduced in the base class and returns false by default. If overriden by
19   an authentication plugin to return true, the authentication plugin will be able to be manually set for users. For example,
20   when bulk uploading users you will be able to select it as the authentication method they use.
22 === 2.4 ===
24 required changes in code:
25 * use role_get_name() or role_fix_names() if you need any role names, using role.name
26   directly from database is not correct any more
28 optional - no changes needed:
29 * add support for custom user signup form - see auth_plugin_base::signup_form() function
31 === 2.2 ===
33 required changes in code:
34 * the correct sequence to set up global $USER is:
35     $user = get_complete_user_data('username', $username); // or $user = authenticate_user_login()
36     enrol_check_plugins($user);
37     session_set_user($user);