| 1441 |
ariadna |
1 |
=== 4.5 Onwards ===
|
|
|
2 |
|
|
|
3 |
This file has been replaced by UPGRADING.md. See MDL-81125 for further information.
|
|
|
4 |
|
|
|
5 |
===
|
| 1 |
efrain |
6 |
This files describes API changes for code that uses the user API.
|
|
|
7 |
|
|
|
8 |
=== 4.4 ===
|
|
|
9 |
|
|
|
10 |
* The `profile_field_base` class now contains a `show_field_content` method to determine whether the field and
|
|
|
11 |
content should be shown to the user. Can be overridden in child classes as required
|
|
|
12 |
|
|
|
13 |
=== 4.3 ===
|
|
|
14 |
|
|
|
15 |
* Added new methods:
|
|
|
16 |
- `core_user::get_profile_picture` for retrieving user picture.
|
|
|
17 |
- `core_user::get_profile_url` for retrieving profile url.
|
|
|
18 |
- `core_user::get_fullname` for retrieving user full name.
|
|
|
19 |
* The `core_user/repository` Javascript module now exports new methods for manipulating user preferences:
|
|
|
20 |
- `[get|set]UserPreference`
|
|
|
21 |
- `[get|set]UserPreferences`
|
|
|
22 |
* The following user preference helpers have been deprecated, please use the `core_user/repository` module instead:
|
|
|
23 |
- `user_preference_allow_ajax_update`
|
|
|
24 |
- `M.util.set_user_preference`
|
|
|
25 |
- `lib/ajax/setuserpref.php`
|
|
|
26 |
* The external `core_user_set_user_preferences` method will now default the `userid` property of each preference to
|
|
|
27 |
that of the current user, if omitted
|
|
|
28 |
* The following previously deprecated methods have been removed and can no longer be used:
|
|
|
29 |
- `profile_display_fields`
|
|
|
30 |
- `profile_edit_category`
|
|
|
31 |
- `profile_edit_field`
|
|
|
32 |
- `user_get_participants`
|
|
|
33 |
- `user_get_participants_sql`
|
|
|
34 |
- `user_get_total_participants`
|
|
|
35 |
* The users_search_sql function parameter $searchanywhere has been change to $searchtype for different type of search. $searchtype is a int parameter and has three constant value:
|
|
|
36 |
USER_SEARCH_STARTS_WITH: 0, USER_SEARCH_CONTAINS: 1, USER_SEARCH_EXACT_MATCH: 2
|
|
|
37 |
users_search_sql('User Test 2', '', false) => users_search_sql('Test Street', '', USER_SEARCH_CONTAINS)
|
|
|
38 |
|
|
|
39 |
=== 4.2 ===
|
|
|
40 |
|
|
|
41 |
* Added get_internalfield_list() and get_internalfields() in the user_field_mapping class.
|
|
|
42 |
The get_internalfield_list() returns data in an array by grouping profile fields based on field categories,
|
|
|
43 |
used for internal field name dropdown in the user field mapping of Oauth2 services
|
|
|
44 |
The get_internalfields() converts the result from get_internalfield_list() into flat array,
|
|
|
45 |
used to save/update the profile data when a user uses OAuth2 services.
|
|
|
46 |
* Added get_profile_field_names() and get_profile_field_list() in the profile_field_base class.
|
|
|
47 |
The get_profile_field_names() returns the list of valid custom profile user fields.
|
|
|
48 |
The get_profile_field_list() returns the profile fields
|
|
|
49 |
in a format that can be used for choices in a group select menu.
|
|
|
50 |
* New method `core_user::is_current_user`, useful for components implementing permission callbacks for their preferences
|
|
|
51 |
* New `profile_get_user_field` method for returning profile field instance of given type
|
|
|
52 |
* The `profile_field_base::is_visible` method now accepts an optional `$context` argument
|
|
|
53 |
* External function core_user_external::add_user_private_files() now returns moodle_exception when the user quota is exceeded
|
|
|
54 |
* The `customfields` structure used for returning user profile fields information has been updated to:
|
|
|
55 |
* Return in the field `value` the value of the custom field (as stored in the database)
|
|
|
56 |
* Return in the field `displayvalue` the value of the custom field for display
|
|
|
57 |
External systems displaying user information should always use `displayvalue`.
|
|
|
58 |
* New method `user_update_device_public_key()`` and accompanying external function core_user_external::update_device_public_key to
|
|
|
59 |
update a user's app generated public key by device uuid and app id.
|
|
|
60 |
|
|
|
61 |
=== 4.1 ===
|
|
|
62 |
|
|
|
63 |
* Added a new method is_transform_supported() in the profile_field_base class.
|
|
|
64 |
The purpose is to allow the field to be transformed during the export process.
|
|
|
65 |
It has been implemented in the Date/Time data type (Applied in 4.1, 4.0.6).
|
|
|
66 |
|
|
|
67 |
* user_get_user_details_courses() now accepts an optional second parameter, an array of userfields that should be
|
|
|
68 |
returned. The values passed into the $userfields parameter must all be included in the return from
|
|
|
69 |
user_get_default_fields().
|
|
|
70 |
It also allows you to reduce how much of a user record is required by the method. The minimum user record fields are:
|
|
|
71 |
* id
|
|
|
72 |
* deleted
|
|
|
73 |
* all potential fullname fields
|
|
|
74 |
|
|
|
75 |
* Participant filter is moved to core as an API which can be used in different areas of core by implementing the API
|
|
|
76 |
and filterable objects. As a part of making the API mature as a core one, these are the js files moved from core
|
|
|
77 |
user to core library:
|
|
|
78 |
* user/amd/src/local/participantsfilter/filter.js → lib/amd/src/datafilter/filtertype.js
|
|
|
79 |
* user/amd/src/local/participantsfilter/filtertypes/country.js → lib/amd/src/datafilter/filtertypes/country.js
|
|
|
80 |
* user/amd/src/local/participantsfilter/filtertypes/courseid.js → lib/amd/src/datafilter/filtertypes/courseid.js
|
|
|
81 |
* user/amd/src/local/participantsfilter/filtertypes/keyword.js → lib/amd/src/datafilter/filtertypes/keyword.js
|
|
|
82 |
* user/amd/src/local/participantsfilter/selectors.js → lib/amd/src/datafilter/selectors.js
|
|
|
83 |
The following mustache have been moved from core user to core library:
|
|
|
84 |
* user/templates/local/participantsfilter/filterrow.mustache → lib/templates/datafilter/filter_row.mustache
|
|
|
85 |
* user/templates/local/participantsfilter/filtertype.mustache → lib/templates/datafilter/filter_type.mustache
|
|
|
86 |
* user/templates/local/participantsfilter/filtertypes.mustache → lib/templates/datafilter/filter_types.mustache
|
|
|
87 |
* user/templates/local/participantsfilter/autocomplete_layout.mustache → lib/templates/datafilter/autocomplete_layout.mustache
|
|
|
88 |
* user/templates/local/participantsfilter/autocomplete_selection.mustache → lib/templates/datafilter/autocomplete_selection.mustache
|
|
|
89 |
* user/templates/local/participantsfilter/autocomplete_selection_items.mustache → lib/templates/datafilter/autocomplete_selection_items.mustache
|
|
|
90 |
Class participant_filter now extends core filter api in core user.
|
|
|
91 |
|
|
|
92 |
* The unified_filter function has been finally deprecated and cannot be used anymore
|
|
|
93 |
* The class \core_user\output\unified_filter has been finally deprecated and removed
|
|
|
94 |
|
|
|
95 |
=== 4.0 ===
|
|
|
96 |
|
|
|
97 |
* External function core_user_external::update_users() will now fail on a per user basis. Previously if one user
|
|
|
98 |
update failed all users in the operation would fail.
|
|
|
99 |
* External function core_user_external::update_users() now returns an error code and message to why a user update
|
|
|
100 |
action failed.
|
|
|
101 |
* New method `core_user\fields::get_sql_fullname` for retrieving user fullname format in SQL statement
|
|
|
102 |
* The `profile_get_custom_field_data_by_shortname` method now accepts an optional parameter to determine whether
|
|
|
103 |
to use case-sensitive matching of the profile field shortname or not (default true)
|
|
|
104 |
|
|
|
105 |
=== 3.11 ===
|
|
|
106 |
|
|
|
107 |
* Added new core_user/form_user_selector JS module that can be used as the 'ajax' handler for the autocomplete form
|
|
|
108 |
element implementing the user selector.
|
|
|
109 |
* Added new external function core_user_external::search_identity(). The main purpose of this external function is to
|
|
|
110 |
provide data for asynchronous user selectors and similar widgets. It allows to search users matching the given query
|
|
|
111 |
in their name or other available identity fields.
|
|
|
112 |
|
|
|
113 |
=== 3.9 ===
|
|
|
114 |
|
|
|
115 |
* The unified filter has been replaced by the participants filter. The following have therefore been deprecated:
|
|
|
116 |
* Library functions:
|
|
|
117 |
* user_get_participants_sql
|
|
|
118 |
* user_get_total_participants
|
|
|
119 |
* user_get_participants
|
|
|
120 |
* Unified filter renderer (core_user_renderer::unified_filter)
|
|
|
121 |
* Unified filter renderable (\core_user\output\unified_filter)
|
|
|
122 |
* Unified filter JavaScript (core_user/unified_filter.js and core_user/unified_filter_datasource.js)
|
|
|
123 |
* Unified filter template (unified_filter.mustache)
|
|
|
124 |
|
|
|
125 |
=== 3.6 ===
|
|
|
126 |
|
|
|
127 |
* The following functions have been finally deprecated and can not be used anymore:
|
|
|
128 |
* useredit_update_picture()
|
|
|
129 |
* core_user_external::update_user_preferences() now allows to unset existing preferences values.
|
|
|
130 |
If the preference value field is not set, the preference will be unset.
|