MDL-62142 navigation: accessibility
[moodle.git] / lib / upgrade.txt
CommitLineData
690a55f6 1This files describes API changes in core libraries and APIs,
ee362526 2information provided here is intended especially for developers.
1cb5c7b3 3
b91ddd16
FM
4=== 3.7 ===
5
9df03b19 6* Nodes in the navigation api can have labels for each group. See set/get_collectionlabel().
b91ddd16
FM
7* The method core_user::is_real_user() now returns false for userid = 0 parameter
8
437ffc9f 9=== 3.6 ===
10
883f6555
AN
11* A new token-based version of pluginfile.php has been added which can be used for out-of-session file serving by
12 setting the `$includetoken` parameter to true on the `moodle_url::make_pluginfile_url()`, and
13 `moodle_url::make_file_url()` functions.
14* The following picture functions have been updated to support use of the new token-based file serving:
15 - print_group_picture
16 - get_group_picture_url
88d89512
AN
17* The `user_picture` class has a new public `$includetoken` property which can be set to make use of the new token-based
18 file serving.
9411beb3 19* Custom AJAX handlers for the form autocomplete fields can now optionally return string in their processResults()
2dd33840 20 callback. If a string is returned, it is displayed instead of the list of suggested items. This can be used, for
9411beb3 21 example, to inform the user that there are too many items matching the current search criteria.
f8d15c66 22* The form element 'htmleditor' has been deprecated. Please use the 'editor' element instead.
350d7b06 23* The print_textarea() function has been deprecated. Please use $OUTPUT->print_textarea() instead.
437ffc9f 24* The following functions have been finally deprecated and can not be used any more:
d8e87342
MG
25 - external_function_info()
26 - core_renderer::update_module_button()
627d9aa6
DM
27 - events_trigger()
28 - events_cron()
29 - events_dispatch()
30 - events_is_registered()
31 - events_load_def()
32 - events_pending_count()
33 - events_process_queued_handler()
34 - events_queue_handler()
35 - events_trigger_legacy()
36 - events_update_definition()
5ab88243
MG
37 - get_file_url()
38 - course_get_cm_rename_action()
39 - course_scale_used()
40 - site_scale_used()
41 - clam_message_admins()
42 - get_clam_error_code()
216b8947
MG
43 - get_records_csv()
44 - put_records_csv()
45 - print_log()
46 - print_mnet_log()
47 - print_log_csv()
48 - print_log_xls()
49 - print_log_ods()
50 - build_logs_array()
51 - get_logs_usercourse()
52 - get_logs_userday()
53 - get_logs()
54 - prevent_form_autofill_password()
f2cdf993 55 - prefixed_tablenode_transformations()
a50b8a43
DM
56 - core_media_renderer
57 - core_media
8d2432f5 58* Following api's have been removed in behat_config_manager, please use behat_config_util instead.
59 - get_features_with_tags()
60 - get_components_steps_definitions()
61 - get_config_file_contents()
62 - merge_behat_config()
63 - get_behat_profile()
64 - profile_guided_allocate()
65 - merge_config()
66 - clean_path()
67 - get_behat_tests_path()
5f2628c5
MG
68* Following behat steps have been removed from core:
69 - I set the field "<field_string>" to multiline
70 - I follow "<link_string>"" in the open menu
02fda279
VDF
71* The following behat steps have been deprecated, please do not use these step definitions any more:
72 - behat_navigation.php: i_navigate_to_node_in()
73 - theme/boost/tests/behat/behat_theme_boost_behat_navigation.php: i_navigate_to_node_in()
74 Use one of the following steps instead:
75 - I navigate to "PATH > ITEM" in current page administration
76 - I navigate to "PATH > ITEM" in site administration
77 - I navigate to course participants
78 - I navigate to "TAB1 > TAB2" in the course gradebook
02fda279
VDF
79 If some items are not available without Navigation block at all, one can use combination of:
80 - I add the "Navigation" block if not present
81 - I click on "LINK" "link" in the "Navigation" "block"
4f06a977
EL
82* The core\session\util class has been removed. This contained one function only used by the memcached class which has
83 been moved there instead (connection_string_to_memcache_servers).
512a1d31 84* Removed the lib/password_compat/lib/password.php file.
5454e72c
AG
85* The eventslib.php file has been deleted and its functions have been moved to deprecatedlib.php. The affected functions are:
86 - events_get_cached()
87 - events_uninstall()
88 - events_cleanup()
89 - events_dequeue()
90 - events_get_handlers()
f7115c2e
SR
91* coursecat::get() now has optional $user parameter.
92* coursecat::is_uservisible() now has optional $user parameter.
2dd33840 93* Removed the lib/form/submitlink.php element which was deprecated in 3.2.
afa3e0ff
DM
94* The user_selector classes do not support custom list of extra identity fields any more. They obey the configured user
95 policy and respect the privacy setting made by site administrators. The list of user identifiers should never be
96 hard-coded. Instead, the setting $CFG->showuseridentity should be always respected, which has always been the default
97 behaviour (MDL-59847).
cc4952e9
AG
98* The function message_send() in messagelib.php will now only take the object \core\message\message as a parameter.
99* The method message_sent::create_from_ids() parameter courseid is now required. A debugging
100 message was previously displayed, and the SITEID was used, when not provided.
101* The method \core\message\manager::send_message() now only takes the object \core\message\message as the first parameter.
df536ab1 102* Following functions have been deprecated, please use get_roles_used_in_context.
103 - get_roles_on_exact_context()
104 - get_roles_with_assignment_on_context()
7d7d3b17 105* New functions to support the merging of user draft areas from the interface; see MDL-45170 for details:
c353ad20
JP
106 - file_copy_file_to_file_area()
107 - file_merge_draft_areas()
108 - file_replace_file_area_in_text()
109 - extract_draft_file_urls_from_text()
442f12f8
MG
110* Class coursecat is now alias to autoloaded class core_course_category, course_in_list is an alias to
111 core_course_list_element, class coursecat_sortable_records is deprecated without replacement.
69781cda
JP
112* \core_user_external::create_users() and \core_user_external::update_users() can now accept more user profile fields so user
113 creation/update via web service can now be very similar to the edit profile page's functionality. The new fields that have been
114 added are:
115 - maildisplay
116 - interests
117 - url
118 - icq
119 - skype
120 - aim
121 - yahoo
122 - msn
123 - institution
124 - department
125 - phone1
126 - phone2
127 - address
1d049e08
JC
128* New function mark_user_dirty() must be called after changing data that gets cached in user sessions. Examples:
129 - Assigning roles to users.
130 - Unassigning roles from users.
bdc51136
DM
131 - Enrolling users into courses.
132 - Unenrolling users from courses.
5290d060
SA
133* New optional parameter $context for the groups_get_members_join() function and ability to filter users that are not members of
134any group. Besides, groups_get_members_ids_sql, get_enrolled_sql and get_enrolled_users now accepts -1 (USERSWITHOUTGROUP) for
135the groupid field.
1afbb97b
AO
136* Added $CFG->conversionattemptlimit setting to config.php allowing a maximum number of retries before giving up conversion
137 of a given document by the assignfeedback_editpdf\task\convert_submissions task. Default value: 3.
beeadbf7
MN
138* The following events have been deprecated and should not be used any more:
139 - message_contact_blocked
140 - message_contact_unblocked
141 The reason for this is because you can now block/unblock users without them necessarily being a contact. These events
142 have been replaced with message_user_blocked and message_user_unblocked respectively.
14de10c4
MN
143* The event message_deleted has been changed, it no longer records the value of the 'useridto' due to
144 the introduction of group messaging. Please, if you have any observers or are triggering this event
145 in your code you will have to make some changes!
5d7a9ea6
MN
146* The gradebook now supports the ability to accept files as feedback. This can be achieved by adding
147 'feedbackfiles' to the $grades parameter passed to grade_update().
148 For example -
149 $grades['feedbackfiles'] = [
150 'contextid' => 1,
151 'component' => 'mod_xyz',
152 'filearea' => 'mod_xyz_feedback',
153 'itemid' => 2
154 ];
155 These files will be then copied to the gradebook file area.
32791416
SA
156* Allow users to choose who can message them for privacy reasons, with a 'growing circle of contactability':
157 - Added $CFG->messagingallusers, for enabling messaging to all site users. Default value: 0.
158 When $CFG->messagingallusers = false users can choose being contacted by only contacts or contacts and users sharing a course with them.
159 In that case, the default user preference is MESSAGE_PRIVACY_COURSEMEMBER (users sharing a course).
160 When $CFG->messagingallusers = true users have a new option for the privacy messaging preferences: "Anyone on the site". In that case,
161 the default user preference is MESSAGE_PRIVACY_SITE (all site users).
162 - Added $CFG->keepmessagingallusersenabled setting to config.php to force enabling $CFG->messagingallusers during the upgrading process.
163 Default value: 0.
164 When $CFG->keepmessagingallusersenabled is set to true, $CFG->messagingallusers will be also set to true to enable messaging site users.
165 However, when it is empty, $CFG->messagingallusers will be disabled during the upgrading process, so the users will only be able to
166 message contacts and users sharing a course with them.
d5adb60f
MP
167* There has been interface and functional changes to admin_apply_default_settings() (/lib/adminlib.php). The function now takes two
168 additional optional parameters, $admindefaultsettings and $settingsoutput. It also has a return value $settingsoutput.
169 The function now does not need to be called twice to ensure all default settings are set. Instead the function calls itself recursively
170 until all settings have been set. The additional parameters are used recursively and shouldn't be need to be explicitly passed in when calling
171 the function from other parts of Moodle.
172 The return value: $settingsoutput is an array of setting names and the values that were set by the function.
160e77f9 173* Webservices no longer update the lastaccess time for a user in a course. Call core_course_view_course() manually if needed.
0616f045 174* A new field has been added to the context table. Please ensure that any contxt preloading uses get_preload_record_columns_sql or get_preload_record_columns to fetch the list of columns.
f7115c2e 175
521252d6
DM
176=== 3.5 ===
177
4f41ae27
DM
178* There is a new privacy API that every subsystem and plugin has to implement so that the site can become GDPR
179 compliant. Plugins use this API to report what information they store or process regarding users, and provide ability
180 to export and delete personal data. See https://docs.moodle.org/dev/Privacy_API for guidelines on how to implement the
181 privacy API in your plugin.
cd305dc2 182* The cron runner now sets up a fresh PAGE and OUTPUT between each task.
76f8b361
EL
183* The core_renderer methods notify_problem(), notify_success(), notify_message() and notify_redirect() that were
184 deprecated in Moodle 3.1 have been removed. Use \core\notification::add(), or \core\output\notification as required.
521252d6
DM
185* The maximum supported precision (the total number of digits) for XMLDB_TYPE_NUMBER ("number") fields raised from 20 to
186 38 digits. Additionally, the whole number part (precision minus scale) must not be longer than the maximum length of
187 integer fields (20 digits). Note that PHP floats commonly support precision of roughly 15 digits only (MDL-32113).
0e68db9e
EL
188* Event triggering and event handlers:
189 - The following events, deprecated since moodle 2.6, have been finally removed: groups_members_removed,
190 groups_groupings_groups_removed, groups_groups_deleted, groups_groupings_deleted.
56c9d666
JP
191* The following functions have been finally deprecated and can not be used any more:
192 - notify()
54a099e9
EL
193* XMLDB now validates the PATH attribute on every install.xml file. Both the XMLDB editor and installation will fail
194 when a problem is detected with it. Please ensure your plugins contain correct directory relative paths.
caae0820 195* Add recaptchalib_v2.php for support of reCAPTCHA v2.
1727c939
MG
196* Plugins can define class 'PLUGINNAME\privacy\local\sitepolicy\handler' if they implement an alternative mechanisms for
197 site policies managements and agreements. Administrators can define which component is to be used for handling site
198 policies and agreements. See https://docs.moodle.org/dev/Site_policy_handler
0bdc5785
DM
199* Scripts can define a constant NO_SITEPOLICY_CHECK and set it to true before requiring the main config.php file. It
200 will make the require_login() skipping the test for the user's policyagreed status. This is useful for plugins that
201 act as a site policy handler.
c2e97077
DM
202* There is a new is_fulltext_search_supported() DML function. The default implementation returns false. This function
203 is used by 'Simple search' global search engine to determine if the database full-text search capabilities can be used.
3cfbce12
JP
204* The following have been removed from the list of core subsystems:
205 - core_register
206 - core_publish
3127fe10
MG
207 Following this change, \core_register_renderer and \core_publish_renderer have been removed and their methods have been
208 moved to \core_admin_renderer and \core_course_renderer respectively.
521252d6 209
8cf36e9c 210=== 3.4 ===
521252d6 211
d3882ea4 212* oauth2_client::request method has an extra parameter to specify the accept header for the response (MDL-60733)
f83d212b
EL
213* The following functions, previously used (exclusively) by upgrade steps are not available
214 anymore because of the upgrade cleanup performed for this version. See MDL-57432 for more info:
215 - upgrade_mimetypes()
216 - upgrade_fix_missing_root_folders_draft()
217 - upgrade_minmaxgrade()
218 - upgrade_course_tags()
219
8cf36e9c
DM
220* Added new moodleform element 'filetypes' and new admin setting widget 'admin_setting_filetypes'. These new widgets
221 allow users to define a list of file types; either by typing them manually or selecting them from a list. The widgets
222 directly support the syntax used to feed the 'accepted_types' option of the filemanager and filepicker elements. File
223 types can be specified as extensions (.jpg or just jpg), mime types (text/plain) or groups (image).
e705e69e
TL
224* Removed accesslib private functions: load_course_context(), load_role_access_by_context(), dedupe_user_access() (MDL-49398).
225* Internal "accessdata" structure format has changed to improve ability to perform role definition caching (MDL-49398).
226* Role definitions are no longer cached in user session (MDL-49398).
0f398b50
JL
227* External function core_group_external::get_activity_allowed_groups now returns an additional field: canaccessallgroups.
228 It indicates whether the user will be able to access all the activity groups.
bef201c7 229* file_get_draft_area_info does not sum the root folder anymore when calculating the foldercount.
6c8e25fa
DM
230* The moodleform element classes can now optionally provide a public function validateSubmitValue(). This method can be
231 used to perform implicit validation of submitted values - without the need to explicitly add the validation rules to
232 every form. The method should accept a single parameter with the submitted value. It should return a string with the
233 eventual validation error, or an empty value if the validation passes.
3b1eba06 234* New user_picture attribute $includefullname to determine whether to include the user's full name with the user's picture.
fd0a43be
JP
235* Enrol plugins which provide enrolment actions can now declare the following "data-action" attributes in their implementation of
236 enrol_plugin::get_user_enrolment_actions() whenever applicable:
237 * "editenrolment" - For editing a user'e enrolment details. Defined by constant ENROL_ACTION_EDIT.
238 * "unenrol" - For unenrolling a student. Defined by constant ENROL_ACTION_UNENROL.
239 These attributes enable enrol actions to be rendered via modals. If not added, clicking on the enrolment action buttons will still
240 redirect the user to the appropriate enrolment action page. Though optional, it is recommended to add these attributes for a
241 better user experience when performing enrol actions.
4047fccb
JP
242* The enrol_plugin::get_user_enrolment_actions() implementations for core enrol plugins have been removed and moved to
243 the parent method itself. New enrol plugins don't have to implement get_user_enrolment_actions(), but just need to
244 make sure that they override:
245 - enrol_plugin::allow_manage(), and/or
246 - enrol_plugin::allow_unenrol_user() or enrol_plugin::allow_unenrol()
247 Existing enrol plugins that override enrol_plugin::get_user_enrolment_actions() don't have to do anything, but can
248 also opt to remove their own implementation of the method if they basically have the same logic as the parent method.
bb1c6f85
JP
249* New optional parameter $enrolid for the following functions:
250 - get_enrolled_join()
251 - get_enrolled_sql()
252 - get_enrolled_with_capabilities_join()
253 Setting this parameter to a non-zero value will add a condition to the query such that only users that were enrolled
254 with this enrolment method will be returned.
198d7291
JP
255* New optional parameter 'closeSuggestionsOnSelect' for the enhance() function for form-autocomplete. Setting this to true will
256 close the suggestions popup immediately after an option has been selected. If not specified, it defaults to true for single-select
257 elements and false for multiple-select elements.
4d068a67 258* user_can_view_profile() now also checks the moodle/user:viewalldetails capability.
237efd4f
JP
259* The core/modal_confirm dialogue has been deprecated. Please use the core/modal_save_cancel dialogue instead. Please ensure you
260 update to use the ModalEvents.save and ModalEvents.cancel events instead of their yes/no counterparts.
93b47710
MN
261* Instead of checking the 'moodle/course:viewparticipants' and 'moodle/site:viewparticipants' capabilities use the
262 new functions course_can_view_participants() and course_require_view_participants().
b1eb6dd7 263* $stored_file->add_to_curl_request() now adds the filename to the curl request.
b58764ff
JO
264* The option for Login HTTPS (authentication-only SSL) has been removed
265* $CFG->loginhttps is now deprecated, do not use it.
4b501ec9 266* $PAGE->https_required and $PAGE->verify_https_required() are now deprecated. They are no longer used and will throw a coding_exception.
672f4836 267* $CFG->httpswwwroot is now deprecated and will always result in the same value as wwwroot.
a63cd3e2
AH
268* Added function core_role_set_view_allowed() to check if a user should be able to see a given role.
269 This should be checked whenever displaying a list of roles to a user, however, core_role_set_assign_allowed may need to override it
270 in some cases.
64cd4596 271* Deprecated allow_override, allow_assign and allow_switch and replaced with core_role_set_*_allowed to avoid function names conflicting.
8cf36e9c 272
67bebb69
IA
273=== 3.3.1 ===
274
275* ldap_get_entries_moodle() now always returns lower-cased attribute names in the returned entries.
276 It was suppposed to do so before, but it actually didn't.
277
3be09119 278=== 3.3 ===
1cb5c7b3 279
69cdead3
DP
280* Behat compatibility changes are now being documented at
281 https://docs.moodle.org/dev/Acceptance_testing/Compatibility_changes
55946a89
EL
282* PHPUnit's bootstrap has been changed to use HTTPS wwwroot (https://www.example.com/moodle) from previous HTTP version. Any
283 existing test expecting the old HTTP URLs will need to be switched to the new HTTPS value (reference: MDL-54901).
f59d81f4
DW
284* The information returned by the idp list has changed. This is usually only rendered by the login page and login block.
285 The icon attribute is removed and an iconurl attribute has been added.
151b0f94 286* Support added for a new type of external file: FILE_CONTROLLED_LINK. This is an external file that Moodle can control
141ee541 287 the permissions. Moodle makes files read-only but can grant temporary write access.
151b0f94
DW
288 When accessing a URL, the info from file_browser::get_file_info will be checked to determine if the user has write access,
289 if they do - the remote file will have access controls set to allow editing.
547801a4
FM
290* The method moodleform::after_definition() has been added and can now be used to add some logic
291 to be performed after the form's definition was set. This is useful for intermediate subclasses.
c8d0efc3
DW
292* Moodle has support for font-awesome icons. Plugins should use the xxx_get_fontawesome_icon_map callback
293 to map their custom icons to one from font-awesome.
294* $OUTPUT->pix_url() has been deprecated because it is was used mostly to manually generate image tags for icons.
295 We now distinguish between icons and "small images". The difference is that an icon does not have to be rendered as an image tag
296 with a source. It is OK to still have "small images" - if this desired use $OUTPUT->image_icon() and $OUTPUT->image_url(). For
297 other uses - use $OUTPUT->pix_icon() or the pix helper in mustache templates {{#pix}}...{{/pix}}
c266d256 298 For other valid use cases use $OUTPUT->image_url().
3e6adcd6 299* Activity icons have been split from standard icons. Use $OUTPUT->image_icon instead of $OUTPUT->pix_icon for these
c2dde7ee 300 type of icons (the coloured main icon for each activity).
d83d87f6
DP
301* YUI module moodle-core-formautosubmit has been removed, use jquery .change() instead (see lib/templates/url_select.mustache for
302 an example)
2fa2ed50
DP
303* $mform->init_javascript_enhancement() is deprecated and no longer does anything. Existing uses of smartselect enhancement
304 should be switched to the searchableselector form element or other solutions.
7620746f 305* Return value of the validate_email() is now proper boolean as documented. Previously the function could return 1, 0 or false.
e7ecb4a9
DP
306* The mcore YUI rollup which included various YUI modules such as moodle-core-notification is no longer included on every
307 page. Missing YUI depdencies may be exposed by this change (e.g. missing a requirement on moodle-core-notification when
308 using M.core.dialogue).
e1a38878
DP
309* Various legacy javascript functions have been removed:
310 * M.util.focus_login_form and M.util.focus_login_error no longer do anything. Please use jquery instead. See
311 lib/templates/login.mustache for an example.
312 * Some outdated global JS functions have been removed and should be replaced with calls to jquery
313 or alternative approaches:
314 checkall, checknone, select_all_in_element_with_id, select_all_in, deselect_all_in, confirm_if, findParentNode,
315 filterByParent, stripHTML
316 * M.util.init_toggle_class_on_click has been removed.
16a34ae1
AN
317* The following functions have been deprecated and should not be used any more:
318 - file_storage::try_content_recovery - See MDL-46375 for more information
319 - file_storage::content_exists - See MDL-46375 for more information
320 - file_storage::deleted_file_cleanup - See MDL-46375 for more information
15681687
AN
321 - file_storage::get_converted_document
322 - file_storage::is_format_supported_by_unoconv
323 - file_storage::can_convert_documents
324 - file_storage::send_test_pdf
325 - file_storage::test_unoconv_path
d58adec8
AA
326* Following behat steps have been removed from core:
327 - I click on "<element_string>" "<selector_string>" in the "<row_text_string>" table row
328 - I go to notifications page
329 - I add "<filename_string>" file from recent files to "<filepicker_field_string>" filepicker
330 - I upload "<filepath_string>" file to "<filepicker_field_string>" filepicker
331 - I create "<foldername_string>" folder in "<filepicker_field_string>" filepicker
332 - I open "<foldername_string>" folder from "<filepicker_field_string>" filepicker
333 - I unzip "<filename_string>" file from "<filepicker_field_string>" filepicker
334 - I zip "<filename_string>" folder from "<filepicker_field_string>" filepicker
335 - I delete "<file_or_folder_name_string>" from "<filepicker_field_string>" filepicker
336 - I send "<message_contents_string>" message to "<username_string>"
337 - I add "<user_username_string>" user to "<cohort_idnumber_string>" cohort
338 - I add "<username_string>" user to "<group_name_string>" group
339 - I fill in "<field_string>" with "<value_string>"
340 - I select "<option_string>" from "<select_string>"
341 - I select "<radio_button_string>" radio button
342 - I check "<option_string>"
343 - I uncheck "<option_string>"
344 - the "<field_string>" field should match "<value_string>" value
345 - the "<checkbox_string>" checkbox should be checked
346 - the "<checkbox_string>" checkbox should not be checked
347 - I fill the moodle form with:
348 - "<element_string>" "<selector_string>" should exists
349 - "<element_string>" "<selector_string>" should not exists
350 - the following "<element_string>" exists:
7c8afa8f
AG
351* get_user_capability_course() now has an additional parameter 'limit'. This can be used to return a set number of records with
352 the submitted capability. The parameter 'fieldsexceptid' will now accept context fields which can be used for preloading.
ed0a1cd7 353* The caching option 'immutable' has been added to send_stored_file() and send_file().
37d0c7c7 354* New adhoc task refresh_mod_calendar_events_task that updates existing calendar events of modules.
ca75ec4f 355* New 'priority' column for the event table to determine which event to show in case of events with user and group overrides.
fb41d2f0 356* Webservices core_course_search_courses and core_course_get_courses_by_field will always return the sortorder field.
e9dfeec9 357* core_course_external::get_activities_overview has been deprecated. Please do not call this function any more.
e03d5d47 358* Changed the pix mustache template helper to accept context variables for the key, component and alt text.
627ea5b1
JP
359* New auth_plugin_base helper methods:
360 - get_identity_providers() - Retrieves available auth identity providers.
361 - prepare_identity_providers_for_output() - Prepares auth identity provider data for output (e.g. to templates, WS, etc.).
2fa2ed50 362
af6a4240
CB
363=== 3.2 ===
364
2a7c540c
DW
365* Custom roles with access to any part of site administration that do not use the manager archetype will need
366 moodle/site:configview capability added.
ba5c5083 367* Admin setting "Show My courses expanded on Dashboard" has been removed.
fb045b4e
DW
368* Some backwards and forwards compatibility has been added for different bootstrap versions.
369 This is to allow the same markup to work in "clean" and "boost" themes alot of the time. It is also to allow user text
370 with bootstrap classes to keep working in the new theme. See MDL-56004 for the list of supported classes.
ff392efc 371* MForms element 'submitlink' has been deprecated.
f7ed5cee
DW
372* Searchable selector form element is now a wrapper for autocomplete. A "No selection" option is automatically
373 added to the options list for best backwards compatibility - if you were manually adding a "no selection" option you will need
374 to remove it.
2ce91090 375* Node.js versions >=4 are now required to run grunt.
d863344a
DW
376* JQuery has been updated to 3.1.0. JQuery migrate plugins are no longer shipped - please read
377 https://jquery.com/upgrade-guide/3.0/ and update your javascript.
af6a4240 378* New option 'blanktarget' added to format_text. This option adds target="_blank" to links
6f9ad7e2
AN
379* A new webservice structure `external_files` has been created which provides a standardised view of files in Moodle and
380 should be used for all file return descriptions.
381 Files matching this format can be retrieved via the new `external_util::get_area_files` method.
382 See MDL-54951 for further information.
df52c272
FM
383* The parameter $usepost of the following functions has been deprecated and is not used any more:
384 - get_max_upload_file_size()
385 - get_user_max_upload_file_size()
b34ed08a
AN
386* The following classes have been removed and should not be used any more:
387 - boxclient - See MDL-49599 for more information.
ff3778bf
AN
388* The following functions have been removed and should not be used any more:
389 - file_modify_html_header() - See MDL-29738 for more information.
aa7e371a 390* core_grades_external::get_grades has been deprecated. Please do not call this function any more.
64064315 391 External function gradereport_user_external::get_grade_items can be used for retrieving the course grades information.
6fb1a717 392* New option 'escape' added to format_string. When true (default), escapes HTML entities from the string
f6f0ba2d
AG
393* The following functions have been deprecated and are not used any more:
394 - get_records_csv() Please use csv_import_reader::load_csv_content() instead.
395 - put_records_csv() Please use download_as_dataformat (lib/dataformatlib.php) instead.
2c2f4f17
AN
396 - zip_files() - See MDL-24343 for more information.
397 - unzip_file() - See MDL-24343 for more information.
2017a60e
EL
398 - print_log() - See MDL-43681 for more information
399 - print_log_csv() - See MDL-43681 for more information
400 - print_log_ods() - See MDL-43681 for more information
401 - print_log_xls() - See MDL-43681 for more information
402 - print_mnet_log() - See MDL-43681 for more information
403 - build_logs_array() - See MDL-43681 for more information
404 - get_logs() - See MDL-43681 for more information
405 - get_logs_usercourse() - See MDL-43681 for more information
406 - get_logs_userday() - See MDL-43681 for more information
ac157b0b 407 - prevent_form_autofill_password() Please do not use anymore.
21e8b48d 408* The password_compat library was removed as it is no longer required.
52f3e060
RT
409* Phpunit has been upgraded to 5.4.x and following has been deprecated and is not used any more:
410 - setExpectedException(), use @expectedException or $this->expectException() and $this->expectExceptionMessage()
411 - getMock(), use createMock() or getMockBuilder()->getMock()
412 - UnitTestCase class is removed.
7a07d34d
JP
413* The following methods have been finally deprecated and should no longer be used:
414 - course_modinfo::build_section_cache()
415 - cm_info::get_deprecated_group_members_only()
416 - cm_info::is_user_access_restricted_by_group()
417* The following methods in cm_info::standardmethods have also been finally deprecated and should no longer be used:
418 - cm_info::get_after_edit_icons()
419 - cm_info::get_after_link()
420 - cm_info::get_content()
421 - cm_info::get_custom_data()
422 - cm_info::get_extra_classes()
423 - cm_info::get_on_click()
424 - cm_info::get_url()
425 - cm_info::obtain_dynamic_data()
426 Calling them through the magic method __call() will throw a coding exception.
f1f94da4
AN
427* The alfresco library has been removed from core. It was an old version of
428 the library which was not compatible with newer versions of Alfresco.
7a05bc92 429* Added down arrow: $OUTPUT->darrow.
2c2f4f17
AN
430* All file_packer implementations now accept an additional parameter to allow a simple boolean return value instead of
431 an array of individual file statuses.
e259795c 432* "I set the field "field_string" to multiline:" now end with colon (:), as PyStrings is supposed to end with ":"
51d85c7c
AN
433* New functions to support deprecation of events have been added to the base event. See MDL-46214 for further details.
434* A new function `get_name_with_info` has been added to the base event. This function adds information about event
435 deprecations and should be used where this information is relevant.
e99f0cbb
RT
436* Following api's have been deprecated in behat_config_manager, please use behat_config_util instead.
437 - get_features_with_tags
438 - get_components_steps_definitions
439 - get_config_file_contents
440 - merge_behat_config
441 - get_behat_profile
442 - profile_guided_allocate
443 - merge_config
444 - clean_path
445 - get_behat_tests_path
5aa9b5ce
RT
446* behat_util::start_test_mode() accepts 3 options now:
447 - 1. Theme sute with all features: If behat should initialise theme suite with all core features.
448 - 2. Parallel runs: How many parallel runs will be running.
449 - 3. Run: Which process behat should be initialise for.
450* behat_context_helper::set_session() has been deprecated, please use behat_context_helper::set_environment() instead.
9b9afffe 451* data-fieldtype="type" attribute has been added to form field default template.
721e2def
MG
452* form elements extending MoodleQuickForm_group must call $this->createFormElement() instead of
453 @MoodleQuickForm::createElement() in order to be compatible with PHP 7.1
b5830334
EL
454* Relative paths in $CFG->alternateloginurl will be resolved to absolute path within moodle site. Previously they
455 were resolved to absolute path within the server. That means:
234e1449
RT
456 - $CFG->wwwroot: http://example.com/moodle
457 - $CFG->alternateloginurl : /my/super/login.php
458 - Login url will be: http://example.com/moodle/my/super/login.php (moodle root based)
9d5c12be
EL
459* Database (DML) layer:
460 - new sql_equal() method available for places where case sensitive/insensitive varchar comparisons are required.
f834a8f5
RS
461* PostgreSQL connections now use advanced options to reduce connection overhead. These options are not compatible
462 with some connection poolers. The dbhandlesoptions parameter has been added to allow the database to configure the
463 required defaults. The parameters that are required in the database are;
464 ALTER DATABASE moodle SET client_encoding = UTF8;
465 ALTER DATABASE moodle SET standard_conforming_strings = on;
ce7863ba 466 ALTER DATABASE moodle SET search_path = 'moodle,public'; -- Optional, if you wish to use a custom schema.
f834a8f5 467 You can set these options against the database or the moodle user who connects.
fc7f69e7
FM
468* Some form elements have been refined to better support right-to-left languages. In RTL,
469 most fields should not have their direction flipped, a URL, a path to a file, a number, ...
470 are always displayed LTR. Input fields and text areas now will best guess whether they
471 should be forced to be displayed in LTR based on the PARAM type associated with it. You
472 can call $mform->setForceLtr($elementName, true/false) on some form fields to manually
473 set the value.
370e7637 474* Action menus do_not_enhance() is deprecated, use a list of action_icon instead.
ccc77703
EL
475* The user_not_fully_set_up() function has a new $strict parameter (defaulting to true) in order to decide when
476 custom fields (and other checks) should be evaluated to determine if the user has been completely setup.
3ee392c8
JL
477* profile_field_base class has new methods: get_field_config_for_external() and get_field_properties().
478 This two new methods should be implemented by profile field plugins to make them compatible with Web Services.
4cb24aa9
DP
479* The minifier library used by core_minify has been switched to https://github.com/matthiasmullie/minify - there are minor differences
480 in minifier output.
8b99e163 481* context_header additional buttons can now have a class attribute provided in the link attributes.
dc213b45
AN
482* The return signature for the antivirus::scan_file() function has changed.
483 The calling function will now handle removal of infected files from Moodle based on the new integer return value.
a29bcf78
EL
484* The first parameter $eventdata of both message_send() and \core\message\manager::send_message() should
485 be \core\message\message. Use of stdClass is deprecated.
486* The message_sent event now expects other[courseid] to be always set, exception otherwise. For BC with contrib code,
487 message_sent::create_from_ids() will show a debugging notice if the \core\message\message being sent is missing
488 the courseid property, defaulting to SITEID automatically. In Moodle 3.6 (MDL-55449) courseid will be fully mandatory
489 for all messages sent.
d6a25bc4 490* The send_confirmation_email() function has a new optional parameter $confirmationurl to provide a different confirmation URL.
bb316e07
JD
491* Introduced a new hook for plugin developers:
492 - <component>_course_module_background_deletion_recommended()
493 This hook should be used in conjunction with the existing '<component>_pre_course_module_delete($mod)'. It must
494 return a boolean and is called by core to check whether a plugin's implementation of
495 <component>_pre_course_module_deleted($mod) will take a long time. A plugin should therefore only implement this
496 function if it also implements <component>_pre_course_module_delete($mod).
497 An example in current use is recyclebin, which performs what can be a lengthy backup process in
498 tool_recyclebin_pre_course_module_delete. The recyclebin, if enabled, now returns true in its implementation of
499 tool_recyclebin_course_module_background_deletion_recommended(), to indicate to core that the deletion (and
500 execution of tool_recyclebin_pre_course_module_delete) should be handled with an adhoc task, meaning it will not
501 occur in real time.
af6a4240 502
20dde5e6
JPG
503=== 3.1 ===
504
427e3cbc
EM
505* Webservice function core_course_search_courses accepts a new parameter 'limittoenrolled' to filter the results
506 only to courses the user is enrolled in, and are visible to them.
56fa860e
DW
507* External functions that are not calling external_api::validate_context are buggy and will now generate
508 exceptions. Previously they were only generating warnings in the webserver error log.
e02e7f5a 509 See https://docs.moodle.org/dev/External_functions_API#Security
221bfffd 510* The moodle/blog:associatecourse and moodle/blog:associatemodule capabilities has been removed.
a77e0611
SL
511* The following functions has been finally deprecated and can not be used any more:
512 - profile_display_badges()
513 - useredit_shared_definition_preferences()
514 - calendar_normalize_tz()
515 - get_user_timezone_offset()
516 - get_timezone_offset()
517 - get_list_of_timezones()
518 - calculate_user_dst_table()
519 - dst_changes_for_year()
520 - get_timezone_record()
521 - test_get_list_of_timezones()
522 - test_get_timezone_offset()
523 - test_get_user_timezone_offset()
6648283a
SL
524* The google api library has been updated to version 1.1.7. There was some important changes
525 on the SSL handling. Now the SSL version will be determined by the underlying library.
526 For more information see https://github.com/google/google-api-php-client/pull/644
b6d12864
AE
527* The get_role_users() function will now add the $sort fields that are not part
528 of the requested fields to the query result and will throw a debugging message
529 with the added fields when that happens.
dccf9ca3
SL
530* The core_user::fill_properties_cache() static method has been introduced to be a reference
531 and allow standard user fields data validation. Right now only type validation is supported
532 checking it against the parameter (PARAM_*) type of the target user field. MDL-52781 is
533 going to add support to null/not null and choices validation, replacing the existing code to
534 validate the user fields in different places in a common way.
235ef57a
DW
535* Webservice function core_course_search_courses now returns results when the search string
536 is less than 2 chars long.
537* Webservice function core_course_search_courses accepts a new parameter 'requiredcapabilities' to filter the results
538 by the capabilities of the current user.
539* New mform element 'course' handles thousands of courses with good performance and usability.
3ad96419
AN
540* The redirect() function will now redirect immediately if output has not
541 already started. Messages will be displayed on the subsequent page using
542 session notifications. The type of message output can be configured using the
543 fourth parameter to redirect().
24346803
AN
544* The specification of extra classes in the $OUTPUT->notification()
545 function, and \core\output\notification renderable have been deprecated
546 and will be removed in a future version.
547 Notifications should use the levels found in \core\output\notification.
548* The constants for NOTIFY_PROBLEM, NOTIFY_REDIRECT, and NOTIFY_MESSAGE in
549 \core\output\notification have been deprecated in favour of NOTIFY_ERROR,
550 NOTIFY_WARNING, and NOTIFY_INFO respectively.
1405f010
EL
551* The following functions, previously used (exclusively) by upgrade steps are not available
552 anymore because of the upgrade cleanup performed for this version. See MDL-51580 for more info:
553 - upgrade_mysql_fix_unsigned_and_lob_columns()
554 - upgrade_course_completion_remove_duplicates()
555 - upgrade_save_orphaned_questions()
556 - upgrade_rename_old_backup_files_using_shortname()
557 - upgrade_mssql_nvarcharmax()
558 - upgrade_mssql_varbinarymax()
559 - upgrade_fix_missing_root_folders()
560 - upgrade_course_modules_sequences()
561 - upgrade_grade_item_fix_sortorder()
562 - upgrade_availability_item()
bb690849
DW
563* A new parameter $ajaxformdata was added to the constructor for moodleform. When building a
564 moodleform in a webservice or ajax script (for example using the new fragments API) we
565 cannot allow the moodleform to parse it's own data from _GET and _POST - we must pass it as
566 an array.
20dde5e6
JPG
567* Plugins can extend the navigation for user by declaring the following callback:
568 <frankenstyle>_extend_navigation_user(navigation_node $parentnode, stdClass $user,
569 context_user $context, stdClass $course,
570 context_course $coursecontext)
c917b53a 571* The function notify() now throws a debugging message - see MDL-50269.
53907dbe
DP
572* Ajax calls going through lib/ajax/* now validate the return values before sending
573 the response. If the validation does not pass an exception is raised. This behaviour
574 is consistent with web services.
1a0df553
MG
575* Several changes in Moodle core, standard plugins and third party libraries to
576 ensure compatibility with PHP7. All plugins are recommended to perform testing
479950d4
MG
577 against PHP7 as well. Refer to https://docs.moodle.org/dev/Moodle_and_PHP7 for more
578 information. The following changes may affect you:
1a0df553
MG
579 * Class moodleform, moodleform_mod and some module classes have been changed to use
580 __construct() for the constructor. Calling parent constructors by the class
581 name will display debugging message. Incorrect: parent::moodleform(),
582 correct: parent::__construct()
583 * All form elements have also changed the constructor syntax. No changes are
584 needed for using form elements, however if plugin defines new form element it
585 needs to use correct syntax. For example, incorrect: parent::HTML_QuickForm_input(),
586 HTML_QuickForm_input::HTML_QuickForm_input(), $this->HTML_QuickForm_input().
587 Correct: HTML_QuickForm_input::__construct() or parent::__construct().
c4d0b752
MG
588 * profile_field_base::profile_field_base() is deprecated, use parent::__construct()
589 in custom profile fields constructors. Similar deprecations in exsiting
590 profile_field_* classes.
591 * user_filter_type::user_filter_type() is deprecated, use parent::__construct() in
592 custom user filters. Similar deprecations in existing user_filter_* classes.
593 * table_default_export_format_parent::table_default_export_format_parent() is
594 deprecated, use parent::__construct() in extending classes.
c026a28d
MG
595* groups_delete_group_members() $showfeedback parameter has been removed and is no longer
596 respected. Users of this function should output their own feedback if required.
597* Number of changes to Tags API, see tag/upgrade.txt for more details
32f8bbd8
DM
598* The previous events API handlers are being deprecated in favour of events 2 API, debugging messages are being displayed if
599 there are 3rd party plugins using it. Switch to events 2 API please, see https://docs.moodle.org/dev/Event_2#Event_dispatching_and_observers
600 Note than you will need to bump the plugin version so moodle is aware that you removed the plugin's event handlers.
2edb12ec
DM
601* mforms validation functions are not available in the global JS namespace anymore, event listeners
602 are assigned to fields and buttons through a self-contained JS function.
2ab797c9
BH
603* Added $CFG->urlrewriteclass option to config.php allowing clean / semantic urls to
604 be implemented in a plugin, eg local_cleanurls.
11362ae3
RK
605* $CFG->pathtoclam global setting has been moved to clamav antivirus plugin setting of the same name.
606* clam_message_admins() and get_clam_error_code() have been deprecated, its functionality
607 is now a part of \antivirus_clamav\scanner class methods.
608* \repository::antivir_scan_file() has been deprecated, \core\antivirus\manager::scan_file() that
375223c6 609 applies antivirus plugins is replacing its functionality.
d84a657d 610* Added core_text::str_max_bytes() which safely truncates multi-byte strings to a maximum number of bytes.
b5e6ec44 611* Zend Framework has been removed completely.
322f3141 612* Any plugin can report when a scale is being used with the callback function [pluginname]_scale_used_anywhere(int $scaleid).
529ea77b 613* Changes in file_rewrite_pluginfile_urls: Passing a new option reverse = true in the $options var will make the function to convert
296ab1e2 614 actual URLs in $text to encoded URLs in the @@PLUGINFILE@@ form.
e891c838 615* behat_util::is_server_running() is removed, please use behat_util::check_server_status() instead.
921faad9
RT
616* Behat\Mink\Selector\SelectorsHandler::xpathLiteral() method is deprecated use behat_context_helper::escape instead
617 when building Xpath, or pass the unescaped value when using the named selector.',
9df4ae41 618* table_sql download process is using the new data formats plugin which you can't use if you are buffering any output
a2e6df5e
EL
619 * flexible_table::get_download_menu(), considered private, has been deleted. Use
620 $OUTPUT->download_dataformat_selector() instead.
bc219382
MS
621 when building Xpath, or pass the unescaped value when using the named selector.
622* Add new file_is_executable(), to consistently check for executables even in Windows (PHP bug #41062).
3fb5ddc3 623* Introduced new hooks for plugin developers.
a9ad3002
MN
624 - <component>_pre_course_category_delete($category)
625 - <component>_pre_course_delete($course)
626 - <component>_pre_course_module_delete($cm)
627 - <component>_pre_block_delete($instance)
628 - <component>_pre_user_delete($user)
629 These hooks allow developers to use the item in question before it is deleted by core. For example, if your plugin is
630 a module (plugins located in the mod folder) called 'xxx' and you wish to interact with the user object before it is
631 deleted then the function to create would be mod_xxx_pre_user_delete($user) in mod/xxx/lib.php.
0ddc7e55 632* pear::Net::GeoIP has been removed.
20dde5e6 633
303936aa
TL
634=== 3.0 ===
635
4eeea2cb 636* Minify updated to 2.2.1
7fa6b587 637* htmlpurifier upgraded to 4.7.0
df098760 638* Less.php upgraded to 1.7.0.9
f77cd371 639* The horde library has been updated to version 5.2.7.
80af92f0 640* Google libraries (lib/google) updated to 1.1.5
ec2d33df 641* Html2Text library has been updated to the latest version of the library.
88982b71
DW
642* External functions x_is_allowed_from_ajax() methods have been deprecated. Define 'ajax' => true in db/services.php instead.
643* External functions can be called without a session if they define 'loginrequired' => true in db/services.php.
98ea6973
DM
644* All plugins are required to declare their frankenstyle component name via
645 the $plugin->component property in their version.php file. See
646 https://docs.moodle.org/dev/version.php for details (MDL-48494).
b80b35d0 647* PHPUnit is upgraded to 4.7. Some tests using deprecated assertions etc may need changes to work correctly.
988592c5 648* Users of the text editor API to manually create a text editor should call set_text before calling use_editor.
4e8afd56 649* Javascript - SimpleYUI and the Y instance used for modules have been merged. Y is now always the same instance of Y.
f4864c1c 650* get_referer() has been deprecated, please use the get_local_referer function instead.
303936aa 651* \core\progress\null is renamed to \core\progress\none for improved PHP7 compatibility as null is a reserved word (see MDL-50453).
cd27a860
AN
652* \webservice_xmlrpc_client now respects proxy server settings. If your XMLRPC server is available on your local network and not via your proxy server, you may need to add it to the list of proxy
653 server exceptions in $CFG->proxybypass. See MDL-39353 for details.
ed0fd1f6
DM
654* Group and groupings idnumbers can now be passed to and/or are returned from the following web services functions:
655 ** core_group_external::create_groups
656 ** core_group_external::get_groups
657 ** core_group_external::get_course_groups
658 ** core_group_external::create_groupings
659 ** core_group_external::update_groupings
660 ** core_group_external::get_groupings
661 ** core_group_external::get_course_groupings
662 ** core_group_external::get_course_user_groups
2149326b
AA
663* Following functions are removed from core. See MDL-50049 for details.
664 password_compat_not_supported()
665 session_get_instance()
666 session_is_legacy()
667 session_kill_all()
188458a6
EL
668 session_touch()
669 session_kill()
2149326b
AA
670 session_kill_user()
671 session_set_user()
672 session_is_loggedinas()
673 session_get_realuser()
674 session_loginas()
675 js_minify()
676 css_minify_css()
2149326b
AA
677 update_login_count()
678 reset_login_count()
188458a6 679 check_gd_version()
2149326b
AA
680 update_log_display_entry()
681 get_recent_enrolments()
682 groups_filter_users_by_course_module_visible()
683 groups_course_module_visible()
684 error()
685 formerr()
686 editorhelpbutton()
687 editorshortcutshelpbutton()
688 choose_from_menu()
689 update_event()
690 get_generic_section_name()
691 get_all_sections()
692 add_mod_to_section()
693 get_all_mods()
694 get_course_section()
695 format_weeks_get_section_dates()
696 get_print_section_cm_text()
697 print_section_add_menus()
698 make_editing_buttons()
699 print_section()
700 print_overview()
701 print_recent_activity()
702 delete_course_module()
703 update_category_button()
704 make_categories_list()
705 category_delete_move()
706 category_delete_full()
707 move_category()
708 course_category_hide()
709 course_category_show()
710 get_course_category()
711 create_course_category()
712 get_all_subcategories()
713 get_child_categories()
714 get_categories()
715 print_course_search()
716 print_my_moodle()
717 print_remote_course()
718 print_remote_host()
719 print_whole_category_list()
720 print_category_info()
b164e2ec 721 get_course_category_tree()
2149326b
AA
722 print_courses()
723 print_course()
724 get_category_courses_array()
725 get_category_courses_array_recursively()
b164e2ec 726 blog_get_context_url()
2149326b
AA
727 get_courses_wmanagers()
728 convert_tree_to_html()
729 convert_tabrows_to_tree()
730 can_use_rotated_text()
731 get_parent_contexts()
732 get_parent_contextid()
733 get_child_contexts()
188458a6 734 create_contexts()
2149326b
AA
735 cleanup_contexts()
736 build_context_path()
737 rebuild_contexts()
738 preload_course_contexts()
739 context_moved()
740 fetch_context_capabilities()
741 context_instance_preload()
742 get_contextlevel_name()
743 print_context_name()
744 mark_context_dirty()
745 delete_context()
746 get_context_url()
747 get_course_context()
748 get_user_courses_bycap()
749 get_role_context_caps()
750 get_courseid_from_context()
751 context_instance_preload_sql()
752 get_related_contexts_string()
753 get_plugin_list_with_file()
754 check_browser_operating_system()
755 check_browser_version()
756 get_device_type()
757 get_device_type_list()
758 get_selected_theme_for_device_type()
759 get_device_cfg_var_name()
188458a6 760 set_user_device_type()
2149326b
AA
761 get_user_device_type()
762 get_browser_version_classes()
763 generate_email_supportuser()
764 badges_get_issued_badge_info()
765 can_use_html_editor()
766 enrol_cohort_get_cohorts()
767 enrol_cohort_can_view_cohort()
768 cohort_get_visible_list()
769 enrol_cohort_enrol_all_users()
770 enrol_cohort_search_cohorts()
eee9e47d 771* The never unused webdav_locks table was dropped.
ccfb9b69
NM
772* The actionmenu hideMenu() function now expects an EventFacade object to be passed to it,
773 i.e. a call to M.core.actionmenu.instance.hideMenu() should be change to M.core.actionmenu.instance.hideMenu(e)
40a15455 774* In the html_editors (tinyMCE, Atto), the manage files button can be hidden by changing the 'enable_filemanagement' option to false.
82f0f5e3 775* external_api::validate_context now is public, it can be called from other classes.
20dbcc33
DP
776* rss_error() now supports returning of correct HTTP status of error and will return '404 Not Found'
777 unless other status is specified.
61ce548a
FM
778* Plugins can extend the navigation for categories settings by declaring the following callback:
779 <frankenstyle>_extend_navigation_category_settings(navigation_node, context_coursecat)
028bbc5b
DM
780* The clilib.php provides two new functions cli_write() and cli_writeln() that should be used for outputting texts from the command
781 line interface scripts.
9748791b
JL
782* External function core_course_external::get_course_contents returned parameter "name" has been changed to PARAM_RAW,
783 this is because the new external_format_string function may return raw data if the global moodlewssettingraw parameter is used.
182d9990 784* Function is_web_crawler() has been deprecated, please use core_useragent::is_web_crawler() instead.
303936aa 785
ebea19cb
FM
786=== 2.9.1 ===
787
788* New methods grade_grade::get_grade_max() and get_grade_min() must be used rather than directly the public properties rawgrademax and rawgrademin.
789* New method grade_item::is_aggregate_item() indicates when a grade_item is an aggreggated type grade.
790
a74d4743
SH
791=== 2.9 ===
792
5472f9f4 793* The default home page for users has been changed to the dashboard (formely my home). See MDL-45774.
9bdcf579 794* Support for rendering templates from php or javascript has been added. See MDL-49152.
adeb96d2 795* Support for loading AMD javascript modules has been added. See MDL-49046.
cf02542d 796* Webservice core_course_delete_courses now return warning messages on any failures and does not try to rollback the entire deletion.
a74d4743 797* \core\event\course_viewed 'other' argument renamed from coursesectionid to coursesectionnumber as it contains the section number.
91fed57a 798* New API core_filetypes::add_type (etc.) allows custom filetypes to be added and modified.
556e3a9e
AN
799* PHPUnit: PHPMailer Sink is now started for all tests and is setup within the phpunit wrapper for advanced tests.
800 Catching debugging messages when sending mail will no longer work. Use $sink = $this->redirectEmails(); and then check
801 the message in the sink instead.
c9bd4e41 802* The file pluginlib.php was deprecated since 2.6 and has now been removed, do not include or require it.
9802bd61 803* \core_component::fetch_subsystems() now returns a valid path for completion component instead of null.
7d0d3b36 804* Deprecated JS global methods have been removed (show_item, destroy_item, hide_item, addonload, getElementsByTagName, findChildNodes).
8072628a
NM
805* For 3rd party plugin specific environment.xml files, it's now possible to specify version independent checks by using the
806 <PLUGIN name="component_name"> tag instead of the version dependent <MOODLE version="x.y"> one. If the PLUGIN tag is used any
807 Moodle specific tags will be ignored.
3451a51c 808* html_table: new API for adding captions to tables (new field, $table->caption) and subsequently hiding said captions from sighted users using accesshide (enabled using $table->captionhide).
8d9bdd28
EL
809* The authorization procedure in the mdeploy.php script has been improved. The script
810 now relies on the main config.php when deploying an available update.
45a1a16b 811* sql_internal_reader and sql_select_reader interfaces have been deprecated in favour of sql_internal_table_reader
9fe26fb8 812 and sql_reader which use iterators to be more memory efficient.
79565fa5
DM
813* $CFG->enabletgzbackups setting has been removed as now backups are stored internally using .tar.gz format by default, you can
814 set $CFG->usezipbackups to store them in zip format. This does not affect the restore process, which continues accepting both.
9bcb0ba8
DM
815* Added support for custom string manager implementations via $CFG->customstringmanager
816 directive in the config.php. See MDL-49361 for details.
70be2642 817* Add new make_request_directory() for creation of per-request files.
b7067f06
AN
818* Added generate_image_thumbnail_from_string. This should be used instead of generate_image_thumbnail when the source is a string.
819 This prevents the need to write files to disk unnecessarily.
820* Added generate_image_thumbnail to stored_file class. This should be used when generating thumbnails for stored files.
821 This prevents the need to write files to disk unnecessarily.
3004a923 822* Removed pear/HTTP/WebDav. See MDL-49534 for details.
d6e7a63d 823* Use standard PHP date time classes and methods - see new core_date class for timezone normalisation methods.
aec4292c
DC
824* Moved lib/google/Google/ to lib/google/src/Google. This is to address autoloader issues with Google's provided autoloader
825 for the library. See MDL-49519 for details.
2b90ce65
EL
826* The outdated lib/google/Google_Client.php and related files have been completely removed. To use
827 the new client, read lib/google/readme_moodle.txt, please.
b19cc4ef 828* profile_display_badges() has been deprecated. See MDL-48935 for details.
12261113
AG
829* Added a new method add_report_nodes() to pagelib.php. If you are looking to add links to the user profile page under the heading "Reports"
830 then please use this function to ensure that the breadcrumb and navigation block are created properly for all user profile pages.
cda2a827
FM
831* process_new_icon() now does not always return a PNG file. When possible, it will try to keep the format of the original file.
832 Set the new argument $preferpng to true to force PNG. See MDL-46763 and MDL-50041 for details.
a74d4743 833
4051685b
AG
834=== 2.8 ===
835
47d6e6a7
DW
836* Gradebook grade category option "aggregatesubcats" has been removed completely.
837 This means that the database column is removed, the admin settings are removed and
838 the properties from the grade_category object have been removed. If any courses were
839 found to be using this setting, a warning to check the grades will be shown in the
840 course grader report after upgrading the site. The same warning will be shown on
841 courses restored from backup that had this setting enabled (see MDL-47503).
4051685b 842* lib/excelllib.class.php has been updated. The class MoodleExcelWorkbook will now only produce excel 2007 files.
ebdcb292
SH
843* renderers: We now remove the suffix _renderable when looking for a render method for a renderable.
844 If you have a renderable class named like "blah_renderable" and have a method on a renderer named "render_blah_renderable"
845 you will need to change the name of your render method to "render_blah" instead, as renderable at the end is no longer accepted.
d25c41fb 846* New functions get_course_and_cm_from_cmid($cmorid, $modulename) and
847 get_course_and_cm_from_instance($instanceorid, $modulename) can be used to
848 more efficiently load these basic data objects at the start of a script.
849* New function cm_info::create($cm) can be used when you need a cm_info
850 object, but have a $cm which might only be a standard database record.
061e6b28 851* $CFG->enablegroupmembersonly no longer exists.
16078807
DP
852* Scheduled tasks have gained support for syntax to introduce variability when a
853 task will run across installs. When a when hour or minute are defined as 'R'
854 they will be installed with a random hour/minute value.
b79bf7a2
MG
855* Several classes grade_edit_tree_column_xxx were removed since grades setup page
856 has been significantly changed. These classes should not be used outside of
857 gradebook or developers can copy them into their plugins from 2.7 branch.
885b889d
MG
858* Google APIs Client Library (lib/google/) has been upgraded to 1.0.5-beta and
859 API has changed dramatically without backward compatibility. Any code accessing
860 it must be amended. It does not apply to lib/googleapi.php. See MDL-47297
27b6839f
MN
861* Added an extra parameter to the function get_formatted_help_string() (default null) which is used to specify
862 additional string parameters.
b9ba26b2 863* User settings node and course node in navigation now support callbacks from admin tools.
a7888487 864* grade_get_grades() optional parameteres $itemtype, $itemmodule, $iteminstance are now required.
4051685b 865
83988eb1
EL
866DEPRECATIONS:
867* completion_info->get_incomplete_criteria() is deprecated and will be removed in Moodle 3.0.
d6caf637 868* grade_category::aggregate_values() is deprecated and will be removed in Moodle 3.0.
061e6b28 869* groups_filter_users_by_course_module_visible() is deprecated; replace with
870 core_availability\info::filter_user_list. Will be removed in Moodle 3.0.
871* groups_course_module_visible() is deprecated; replace with $cm->uservisible.
872* cm_info property $cm->groupmembersonly is deprecated and always returns 0.
873 Use core_availability\info::filter_user_list if trying to determine which
874 other users can see an activity.
875* cm_info method $cm->is_user_access_restricted_by_group() is deprecated and
876 always returns false. Use $cm->uservisible to determine whether the user can
877 access the activity.
878* Constant FEATURE_GROUPMEMBERSONLY (used in module _supports functions) is
879 deprecated.
80f98467
MG
880* cohort_get_visible_list() is deprecated. There is a better function cohort_get_available_cohorts()
881 that respects user capabilities to view cohorts.
58b5b04d
MG
882* enrol_cohort_get_cohorts() and enrol_cohort_search_cohorts() are deprecated since
883 functionality is removed. Please use cohort_get_available_cohorts()
884* enrol_cohort_enrol_all_users() is deprecated; enrol_manual is now responsible for this action
80f98467 885* enrol_cohort_can_view_cohort() is deprecated; replace with cohort_can_view_cohort()
83988eb1 886
2b55cb1b 887=== 2.6.4 / 2.7.1 ===
83988eb1 888
2b55cb1b
RT
889* setnew_password_and_mail() and update_internal_user_password() will trigger
890 \core\event\user_password_updated. Previously they used to generate
891 \core\event\user_updated event.
892* update_internal_user_password() accepts optional boolean $fasthash for fast
893 hashing.
894* user_update_user() and user_create_user() api's accept optional param
895 $triggerevent to avoid respective events to be triggred from the api's.
896
c4b0d6dc
AA
897=== 2.7 ===
898
9e00d46b 899* PHPUnit cannot be installed via PEAR any more, please use composer package manager instead.
686e3b3a
FM
900* $core_renderer->block_move_target() changed to support more verbose move-block-here descriptions.
901
1480f6ea
MG
902Events and Logging:
903* Significant changes in Logging API. For upgrading existing events_trigger() and
904 add_to_log() see http://docs.moodle.org/dev/Migrating_logging_calls_in_plugins
e2cb3ffa 905 For accessing logs from plugins see http://docs.moodle.org/dev/Migrating_log_access_in_reports
c446f41a
MN
906* The validation of the following events is now stricter (see MDL-45445):
907 - \core\event\blog_entry_created
908 - \core\event\blog_entry_deleted
909 - \core\event\blog_entry_updated
910 - \core\event\cohort_member_added
911 - \core\event\cohort_member_removed
912 - \core\event\course_category_deleted
913 - \core\event\course_completed
914 - \core\event\course_content_deleted
915 - \core\event\course_created
916 - \core\event\course_deleted
917 - \core\event\course_restored
918 - \core\event\course_section_updated (see MDL-45229)
919 - \core\event\email_failed
920 - \core\event\group_member_added
921 - \core\event\group_member_removed
922 - \core\event\note_created
923 - \core\event\note_deleted
924 - \core\event\note_updated
925 - \core\event\role_assigned
926 - \core\event\role_deleted
927 - \core\event\role_unassigned
928 - \core\event\user_graded
929 - \core\event\user_loggedinas
930 - \core\event\user_profile_viewed
931 - \core\event\webservice_token_created
1480f6ea 932
a4582a51 933DEPRECATIONS:
994e5662 934* $module uses in mod/xxx/version.php files is now deprecated. Please use $plugin instead. It will be removed in Moodle 2.10.
3345e24f 935* Update init methods in all event classes - "level" property was renamed to "edulevel", the level property is now deprecated.
c4b0d6dc 936* Abstract class \core\event\course_module_instances_list_viewed is deprecated now, use \core\event\instances_list_viewed instead.
e1b16f97 937* Abstract class core\event\content_viewed has been deprecated. Please extend base event or other relevant abstract class.
45faf15d
AA
938* mod_book\event\instances_list_viewed has been deprecated. Please use mod_book\event\course_module_instance_list_viewed instead.
939* mod_chat\event\instances_list_viewed has been deprecated. Please use mod_chat\event\course_module_instance_list_viewed instead.
940* mod_choice\event\instances_list_viewed has been deprecated. Please use mod_choice\event\course_module_instance_list_viewed instead.
941* mod_feedback\event\instances_list_viewed has been deprecated. Please use mod_feedback\event\course_module_instance_list_viewed instead.
942* mod_page\event\instances_list_viewed has been deprecated. Please use mod_page\event\course_module_instance_list_viewed instead.
1f1a8f03 943* The constants FRONTPAGECOURSELIST, FRONTPAGETOPICONLY & FRONTPAGECOURSELIMIT have been removed.
8d1f33e1 944* Conditional availability API has moved and changed. The condition_info class is
945 replaced by \core_availability\info_module, and condition_info_section by
946 \core_availability\info_section. (Code that uses the old classes will generally
947 still work.)
948* coursemodule_visible_for_user() has been deprecated but still works - replaced
949 by a new static function \core_availability\info_module::is_user_visible()
950* cm_info::is_user_access_restricted_by_conditional_access has been deprecated
951 but still works (it has never done what its name suggests, and is
952 unnecessary).
953* cm_info and section_info property showavailability has been deprecated, but
954 still works (with the caveat that this information is now per-user).
955* cm_info and section_info properties availablefrom and availableuntil have been
956 deprecated and always return zero (underlying data doesn't have these values).
957* section_info property groupingid has been deprecated and always returns zero,
958 same deal.
07e78d93
DP
959* Various cm_info methods have been deprecated in favour of their read-only properties (get_url(), get_content(), get_extra_classes(),
960 get_on_click(), get_custom_data(), get_after_link, get_after_edit_icons)
af64bc61 961* The ajaxenabled function has been deprecated and always returns true. All code should be fully functional in Javascript.
52dc1de7 962* count_login_failures() has been deprecated, use user_count_login_failures() instead. Refer MDL-42891 for details.
c4b0d6dc 963
8d1f33e1 964Conditional availability (activities and sections):
965* New conditional availability API in /availability, including new availability
966 condition plugins in /availability/condition. The new API is very similar with
967 regard to checking availability, but any code that modifies availability settings
968 for an activity or section is likely to need substantial changes.
969
5947ab33
AN
970YUI:
971 * The lightbox attribute for moodle-core-notification-dialogue has been
972 deprecated and replaced by the modal attribute. This was actually
973 changed in Moodle 2.2, but has only been marked as deprecated now. It
974 will be removed in Moodle 2.9.
0860dd78
AN
975 * When destroying any type of dialogue based on moodle-core-notification, the relevant content is also removed from
976 the DOM. Previously it was left orphaned.
5947ab33 977
a4582a51
AN
978JavaSript:
979 * The findChildNodes global function has been deprecated. Y.all should
980 be used instead.
1d98ca14
AN
981 * The callback argument to confirm_action and M.util.show_confirm_dialog has been deprecated. If you need to write a
982 confirmation which includes a callback, please use moodle-core-notification-confirmation and attach callbacks to the
983 events provided.
a4582a51 984
9843e5ec 985* New locking api and admin settings to configure the system locking type.
3b635513
DM
986* New "Time spent waiting for the database" performance metric displayed along with the
987 other MDL_PERF vars; the change affects both the error logs and the vars displayed in
988 the page footer.
cc033d48
MN
989* Changes in the tag API. The component and contextid are now saved when assigning tags to an item. Please see
990 tag/upgrade.txt for more information.
9843e5ec 991
9e19a0f0 992=== 2.6 ===
8e8891b7 993
cc8fecb5 994* Use new methods from core_component class instead of get_core_subsystems(), get_plugin_types(),
d0cac8b5
FM
995 get_plugin_list(), get_plugin_list_with_class(), get_plugin_directory(), normalize_component(),
996 get_component_directory() and get_plugin_list_with_file(). The names of the new methods are
997 exactly the same, the only differences are that core_component::get_plugin_types() now always returns
998 full paths and core_component::get_plugin_list() does not accept empty parameter any more.
d534708f 999* Use core_text::* instead of textlib:: and also core_collator::* instead of collatorlib::*.
af578aec 1000* Use new function moodleform::mock_submit() to simulate form submission in unit tests (backported).
85b38061 1001* New $CFG->localcachedir setting useful for cluster nodes. Admins have to update X-Sendfile aliases if used.
656250de
PS
1002* MS SQL Server drivers are now using NVARCHAR(MAX) instead of NTEXT and VARBINARY(MAX) instead of IMAGE,
1003 this change should be fully transparent and it should help significantly with add-on compatibility.
598a82c9
PS
1004* The string manager classes were renamed. Note that they should not be modified or used directly,
1005 always use get_string_manager() to get instance of the string manager.
aae18d2a 1006* The ability to use an 'insecure' rc4encrypt/rc4decrypt key has been removed.
96f81ea3
PS
1007* Use $CFG->debugdeveloper instead of debugging('', DEBUG_DEVELOPER).
1008* Use set_debugging(DEBUG_xxx) when changing debugging level for current request.
d55f05ef 1009* Function moveto_module() does not modify $mod argument and instead now returns the new module visibility value.
db5f2d33
DM
1010* Use behat_selectors::get_allowed_text_selectors() and behat_selectors::get_allowed_selectors() instead of
1011 behat_command::$allowedtextselectors and behat_command::$allowedselectors
ac2b2713 1012* Subplugins are supported in admin tools and local plugins.
71ab7e51 1013* file_packer/zip_packer API has been modified so that key functions support a new file_progress interface
1014 to report progress during long operations. Related to this, zip_archive now supports an estimated_count()
1015 function that returns an approximate number of entries in the zip faster than the count() function.
d872881f 1016* Class cm_info no longer extends stdClass. All properties are read-only and calculated on first request only.
44ddd2a1 1017* Class course_modinfo no longer extends stdClass. All properties are read-only.
64501eee
MG
1018* Database fields modinfo and sectioncache in table course are removed. Application cache core/coursemodinfo
1019 is used instead. Course cache is still reset, rebuilt and retrieved using function rebuild_course_cache() and
1020 get_fast_modinfo(). Purging all caches and every core upgrade purges course modinfo cache as well.
1021 If function get_fast_modinfo() is called for multiple courses make sure to include field cacherev in course
1022 object.
3bcf6b3c
RT
1023* Internal (noreply and support) user support has been added for sending/receiving message.
1024 Use core_user::get_noreply_user() and core_user::get_support_user() to get noreply and support user's respectively.
1025 Real users can be used as noreply/support users by setting $CFG->noreplyuserid and $CFG->supportuserid
137885b7 1026* New function readfile_allow_large() in filelib.php for use when very large files may need sending to user.
e87214bd 1027* Use core_plugin_manager::reset_caches() when changing visibility of plugins.
bde002b8
PS
1028* Implement new method get_enabled_plugins() method in subplugin info classes.
1029* Each plugin should include version information in version.php.
723a6e56 1030* Module and block tables do not contain version column any more, use get_config('xx_yy', 'version') instead.
5fed8433 1031* $USER->password field is intentionally unset so that session data does not contain password hashes.
38fc0130 1032* Use core_shutdown_manager::register_function() instead of register_shutdown_function().
c858655d 1033* New file packer for .tar.gz files; obtain by calling get_file_packer('application/x-gzip'). Intended initially
1034 for use in backup/restore only, as there are limitations on supported filenames. Also new packer for
1035 backups which supports both compression formats; get_file_packer('application/vnd.moodle.backup').
1036* New optional parameter to stored_file::get_content_file_handle to open file handle with 'gzopen' instead
1037 of 'fopen' to read gzip-compressed files if required.
6c679d15 1038* update_internal_user_password() and setnew_password_and_mail() now trigger user_updated event.
b2858b91 1039* Add thirdpartylibs.xml file to plugins that bundle any 3rd party libraries.
2dd8e935
DP
1040* New class introduced to help auto generate zIndex values for modal dialogues. Class "moodle-has-zindex"
1041 should set on any element which uses a non-default zindex and needs to ensure it doesn't show above a
1042 dialogue.
0c431257
PS
1043* $CFG->filelifetime is now used consistently for most file serving operations, the default was lowered
1044 to 6 hours from 24 hours because etags and x-sendfile support should make file serving less expensive.
d61d3e82
RT
1045* Date format locale charset for windows server will come from calendar type and for gregorian it will use
1046 lang file.
2d5c7d50
FM
1047* The library to interact with Box.net (class boxclient) is only compatible with their APIv1 which
1048 reaches its end of life on the 14th of Dec. You should migrate your scripts to make usage of the
1049 new class boxnet_client(). Note that the method names and return values have changed.
b404b1f4
AG
1050* Settings pages are now possible for Calendar type plugins. Calendar type plugins that require a settings page to
1051 work properly will need to set their requires version to a number that is equal to or grater than the 2.6.1 release version.
fb16acf2
DP
1052* The admin/tool/generator tool was overhauled to use testing data generators and the previous interface to create
1053 test data was removed (it was not working correctly anyway). If you were using this tool you will probably need to
1054 update your code.
05226d76
DP
1055
1056DEPRECATIONS:
1057Various previously deprecated functions have now been altered to throw DEBUG_DEVELOPER debugging notices
1058and will be removed in a future release (target: 2.8), a summary follows:
1059
1060Accesslib:
c3d2fbf9
SH
1061 * get_context_instance() -> context_xxxx::instance()
1062 * get_context_instance_by_id() -> context::instance_by_id($id)
1063 * get_system_context() -> context_system::instance()
1064 * context_moved() -> context::update_moved()
1065 * preload_course_contexts() -> context_helper::preload_course()
1066 * context_instance_preload() -> context_helper::preload_from_record()
1067 * context_instance_preload_sql() -> context_helper::get_preload_record_columns_sql()
1068 * get_contextlevel_name() -> context_helper::get_level_name()
1069 * create_contexts() -> context_helper::create_instances()
1070 * cleanup_contexts() -> context_helper::cleanup_instances()
1071 * build_context_path() -> context_helper::build_all_paths()
1072 * print_context_name() -> $context->get_context_name()
1073 * mark_context_dirty() -> $context->mark_dirty()
1074 * delete_context() -> $context->delete_content() or context_helper::delete_instance()
1075 * get_context_url() -> $context->get_url()
1076 * get_course_context() -> $context->get_course_context()
1077 * get_parent_contexts() -> $context->get_parent_context_ids()
1078 * get_parent_contextid() -> $context->get_parent_context()
1079 * get_child_contexts() -> $context->get_child_contexts()
1080 * rebuild_contexts() -> $context->reset_paths()
1081 * get_user_courses_bycap() -> enrol_get_users_courses()
1082 * get_courseid_from_context() -> $context->get_course_context(false)
1083 * get_role_context_caps() -> (no replacement)
1084 * load_temp_role() -> (no replacement)
1085 * remove_temp_roles() -> (no replacement)
1086 * get_related_contexts_string() -> $context->get_parent_context_ids(true)
1087 * get_recent_enrolments() -> (no replacement)
05226d76
DP
1088
1089Enrollment:
c3d2fbf9
SH
1090 * get_course_participants() -> get_enrolled_users()
1091 * is_course_participant() -> is_enrolled()
05226d76
DP
1092
1093Output:
c3d2fbf9
SH
1094 * current_theme() -> $PAGE->theme->name
1095 * skip_main_destination() -> $OUTPUT->skip_link_target()
1096 * print_container() -> $OUTPUT->container()
1097 * print_container_start() -> $OUTPUT->container_start()
1098 * print_container_end() -> $OUTPUT->container_end()
1099 * print_continue() -> $OUTPUT->continue_button()
1100 * print_header() -> $PAGE methods
1101 * print_header_simple() -> $PAGE methods
1102 * print_side_block() -> $OUTPUT->block()
1103 * print_arrow() -> $OUTPUT->arrow()
1104 * print_scale_menu_helpbutton() -> $OUTPUT->help_icon_scale($courseid, $scale)
1105 * print_checkbox() -> html_writer::checkbox()
05226d76
DP
1106
1107Navigation:
c3d2fbf9
SH
1108 * print_navigation() -> $OUTPUT->navbar()
1109 * build_navigation() -> $PAGE->navbar methods
1110 * navmenu() -> (no replacement)
50ae8814
MN
1111 * settings_navigation::
1112 get_course_modules() -> (no replacement)
05226d76 1113
2a68ee0e
MG
1114Files and repositories:
1115 * stored_file::replace_content_with() -> stored_file::replace_file_with()
1116 * stored_file::set_filesize() -> stored_file::replace_file_with()
87355560
MG
1117 * stored_file::get_referencelifetime() -> (no replacement)
1118 * repository::sync_external_file() -> see repository::sync_reference()
1119 * repository::get_file_by_reference() -> repository::sync_reference()
1120 * repository::
1121 get_reference_file_lifetime() -> (no replacement)
1122 * repository::sync_individual_file() -> (no replacement)
1123 * repository::reset_caches() -> (no replacement)
2a68ee0e 1124
05226d76 1125Calendar:
c3d2fbf9
SH
1126 * add_event() -> calendar_event::create()
1127 * update_event() -> calendar_event->update()
1128 * delete_event() -> calendar_event->delete()
1129 * hide_event() -> calendar_event->toggle_visibility(false)
1130 * show_event() -> calendar_event->toggle_visibility(true)
05226d76
DP
1131
1132Misc:
c3d2fbf9
SH
1133 * filter_text() -> format_text(), format_string()...
1134 * httpsrequired() -> $PAGE->https_required()
1135 * detect_munged_arguments() -> clean_param([...], PARAM_FILE)
1136 * mygroupid() -> groups_get_all_groups()
1137 * js_minify() -> core_minify::js_files()
1138 * css_minify_css() -> core_minify::css_files()
64501eee 1139 * course_modinfo::build_section_cache() -> (no replacement)
3bcf6b3c 1140 * generate_email_supportuser() -> core_user::get_support_user()
c3d2fbf9 1141
d79d5ac2
PS
1142Sessions:
1143 * session_get_instance()->xxx() -> \core\session\manager::xxx()
1144 * session_kill_all() -> \core\session\manager::kill_all_sessions()
1145 * session_touch() -> \core\session\manager::touch_session()
1146 * session_kill() -> \core\session\manager::kill_session()
1147 * session_kill_user() -> \core\session\manager::kill_user_sessions()
1148 * session_gc() -> \core\session\manager::gc()
1149 * session_set_user() -> \core\session\manager::set_user()
1150 * session_is_loggedinas() -> \core\session\manager::is_loggedinas()
1151 * session_get_realuser() -> \core\session\manager::get_realuser()
1152 * session_loginas() -> \core\session\manager::loginas()
1153
c3d2fbf9
SH
1154User-agent related functions:
1155 * check_browser_operating_system() -> core_useragent::check_browser_operating_system()
1156 * check_browser_version() -> core_useragent::check_browser_version()
1157 * get_device_type() -> core_useragent::get_device_type()
1158 * get_device_type_list() -> core_useragent::get_device_type_list()
1159 * get_selected_theme_for_device_type() -> core_useragent::get_device_type_theme()
1160 * get_device_cfg_var_name() -> core_useragent::get_device_type_cfg_var_name()
1161 * set_user_device_type() -> core_useragent::set_user_device_type()
1162 * get_user_device_type() -> core_useragent::get_user_device_type()
1163 * get_browser_version_classes() -> core_useragent::get_browser_version_classes()
9e19a0f0 1164
78686995
AN
1165YUI:
1166 * moodle-core-notification has been deprecated with a recommendation of
73b4c1da 1167 using its subclasses instead. This is to allow for reduced page
78686995
AN
1168 transport costs. Current subclasses include:
1169 * dialogue
1170 * alert
1171 * confirm
1172 * exception
1173 * ajaxexception
1174
f0f0e1fe
PS
1175Event triggering and event handlers:
1176 * All existing events and event handlers should be replaced by new
1177 event classes and matching new event observers.
1178 * See http://docs.moodle.org/dev/Event_2 for more information.
861b0510
FM
1179 * The following events will be entirely removed, though they can still
1180 be captured using handlers, but they should not be used any more.
1181 * groups_members_removed -> \core\event\group_member_removed
1182 * groups_groupings_groups_removed -> (no replacement)
1183 * groups_groups_deleted -> \core\event\group_deleted
1184 * groups_groupings_deleted -> \core\event\grouping_deleted
63deb5c3 1185 * edit_module_post_actions() does not trigger events any more.
f0f0e1fe 1186
a2602457 1187=== 2.5.1 ===
1188
1189* New get_course() function for use when obtaining the course record from database. Will
1190 reuse existing $COURSE or $SITE globals if possible to improve performance.
1191
9a36be73
MG
1192=== 2.5 ===
1193
bae2846c
EL
1194* The database drivers (moodle_database and subclasses) aren't using anymore the ::columns property
1195 for caching database metadata. MUC (databasemeta) is used instead. Any custom DB driver should
1196 apply for that change.
cedc656b
EL
1197* The cron output has been changed to include time and memory usage (see cron_trace_time_and_memory()),
1198 so any custom utility relying on the old output may require modification.
6b219310
DW
1199* Function get_max_file_sizes now returns an option for (for example) "Course limit (500MB)" or
1200 "Site limit (200MB)" when appropriate with the option set to 0. This function no longer returns
1201 an option for 0 bytes. Existing code that was replacing the 0 option in the return
1202 from this function with a more sensible message, can now use the return from this function directly.
9a36be73 1203* Functions responsible for output in course/lib.php are deprecated, the code is moved to
b1c2fc65
MG
1204 appropriate renderers: print_section(), print_section_add_menus(), get_print_section_cm_text(),
1205 make_editing_buttons()
9a36be73
MG
1206 See functions' phpdocs in lib/deprecatedlib.php
1207* Function get_print_section_cm_text() is deprecated, replaced with methods in cm_info
3cb856c7
PS
1208* zip_packer may create empty zip archives, there is a new option to ignore
1209 problematic files when creating archive
93cc145f
MN
1210* The function delete_course_module was deprecated and has been replaced with
1211 course_delete_module. The reason for this was because the function delete_course_module
1212 only partially deletes data, so wherever it was called extra code was needed to
1213 perform the whole deletion process. The function course_delete_module now takes care
1214 of the whole process.
91c8cf99
F
1215* curl::setopt() does not accept constant values any more. As it never worked properly,
1216 we decided to make the type check stricter. Now, the keys of the array pass must be a string
1217 corresponding to the curl constant name.
043f1005
RT
1218* Function get_users_listing now return list of users except guest and deleted users. Previously
1219 deleted users were excluded by get_users_listing. As guest user is not expected while browsing users,
1220 and not included in get_user function, it will not be returned by get_users_listing.
1c14b1c1
DW
1221* The add_* functions in course/dnduploadlib.php have been deprecated. Plugins should be using the
1222 MODNAME_dndupload_register callback instead.
690a55f6
DM
1223* The signature of the add() method of classes implementing the parentable_part_of_admin_tree
1224 interface (such as admin_category) has been extended. The new parameter allows the caller
1225 to prepend the new node before an existing sibling in the admin tree.
87b6981e
EL
1226* condition_info:get_condition_user_fields($formatoptions) now accepts the optional
1227 param $formatoptions, that will determine if the field names are processed by
1228 format_string() with the passed options.
689096bc 1229* remove all references to $CFG->gdversion, GD PHP extension is now required
b45ba7f6
DP
1230* Formslib will now throw a developer warning if a PARAM_ type hasn't been set for elements which
1231 need it. Please set PARAM_RAW explicitly if you do not want any cleaning.
4e0b6025 1232* Functions responsible for managing and accessing course categories are moved to class coursecat
09ae7ee0
MG
1233 in lib/coursecatlib.php, functions responsible for rendering courses and categories lists are
1234 moved to course/renderer.php. The following global functions are deprecated: make_categories_list(),
6e1d1ee0 1235 category_delete_move(), category_delete_full(), move_category(), course_category_hide(),
8db5dcb7 1236 course_category_show(), get_course_category(), create_course_category(), get_all_subcategories(),
09ae7ee0
MG
1237 get_child_categories(), get_categories(), print_my_moodle(), print_remote_course(),
1238 print_remote_host(), print_whole_category_list(), print_category_info(), get_course_category_tree(),
1239 print_courses(), print_course(), get_category_courses_array(), get_category_courses_array_recursively(),
1240 get_courses_wmanagers()
1241 See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
0e2ca62e 1242* $core_renderer->block_move_target() changed to support more verbose move-block-here descriptions.
38c1dd19
RT
1243* Additional (optional) param $onlyactive has been added to get_enrolled_users, count_enrolled_users
1244 functions to get information for only active (excluding suspended enrolments) users. Included two
1245 helper functions extract_suspended_users, get_suspended_userids to extract suspended user information.
e87214bd 1246* The core_plugin_manager class now provides two new helper methods for getting information
d7d48b40 1247 about known plugins: get_plugins_of_type() and get_subplugins_of_plugin().
e87214bd 1248* The get_uninstall_url() method of all subclasses of \core\plugininfo\base class is now expected
73658371
DM
1249 to always return moodle_url. Subclasses can use the new method is_uninstall_allowed()
1250 to control the availability of the 'Uninstall' link at the Plugins overview page (previously
1251 they would do it by get_uninstall_url() returning null). By default, URL to a new general plugin
1252 uninstall tool is returned. Unless the plugin type needs extra steps that can't be handled by
1253 plugininfo_xxx::uninstall() method or xmldb_xxx_uninstall() function, this default URL should
1254 satisfy all plugin types.
9a36be73 1255
4efcfaa3 1256Database (DML) layer:
77a5c093
PS
1257* $DB->sql_empty() is deprecated, you have to use sql parameters with empty values instead,
1258 please note hardcoding of empty strings in SQL queries breaks execution in Oracle database.
2d97513d
PS
1259* Indexes must not be defined on the same columns as keys, this is now reported as fatal problem.
1260 Please note that internally we create indexes instead of foreign keys.
9a36be73 1261
238b8bc9
ARN
1262YUI changes:
1263* M.util.help_icon has been deprecated. Code should be updated to use moodle-core-popuphelp
1264 instead. To do so, remove any existing JS calls to M.util.help_icon from your PHP and ensure
1265 that your help link is placed in a span which has the class 'helplink'.
1266
6c2be903
DP
1267=== 2.4 ===
1268
1269* Pagelib: Numerous deprecated functions were removed as classes page_base, page_course
1270 and page_generic_activity.
704533fc 1271* use $CFG->googlemapkey3 instead of removed $CFG->googlemapkey and migrate to Google Maps API V3
b874d5c6 1272* Function settings_navigation::add_course_editing_links() is completely removed
ee7084e9
MG
1273* function global_navigation::format_display_course_content() is removed completely (the
1274 functionality is moved to course format class)
1275* in the function global_navigation::load_generic_course_sections() the argument $courseformat is
1276 removed
7881024e
PS
1277* New component and itemid columns in groups_members table - this allows plugin to create protected
1278 group memberships using 'xx_yy_allow_group_member_remove' callback and there is also a new restore
1279 callback 'xx_yy_restore_group_member()'.
1280* New general role assignment restore plugin callback 'xx_yy_restore_role_assignment()'.
97960146
MG
1281* functions get_generic_section_name(), get_all_sections(), add_mod_to_section(), get_all_mods()
1282 are deprecated. See their phpdocs in lib/deprecatedlib.php on how to replace them
ee362526 1283
d2a27ab0
ARN
1284YUI changes:
1285* moodle-enrol-notification has been renamed to moodle-core-notification
3542e01a 1286* YUI2 code must now use 2in3, see http://yuilibrary.com/yui/docs/yui/yui-yui2.html
7266bd3e
ARN
1287* M.util.init_select_autosubmit() and M.util.init_url_select() have been deprecated. Code using this should be updated
1288 to use moodle-core-formautosubmit
d2a27ab0 1289
94c9db54
PS
1290Unit testing changes:
1291* output debugging() is not sent to standard output any more,
1292 use $this->assertDebuggingCalled(), $this->assertDebuggingNotCalled(),
1293 $this->getDebuggingMessages() or $this->assertResetDebugging() instead.
1294
e618cdf3
PS
1295=== 2.3 ===
1296
1297Database layer changes:
1298* objects are not allowed in paramters of DML functions, use explicit casting to strings if necessary
1299
19526d91
DP
1300Note:
1301* DDL and DML methods which were deprecated in 2.0 have now been removed, they will no longer produce
1302debug messages and will produce fatal errors
e618cdf3 1303
796495fe 1304API changes:
daefd6eb 1305
796495fe 1306* send_stored_file() has changed its interface
daefd6eb 1307* deleted several resourcelib_embed_* functions from resourcelib.php
796495fe 1308
ee362526
PS
1309=== 2.2 ===
1310
1311removed unused libraries:
1312* odbc, base32, CodeSniffer, overlib, apd profiling, kses, Smarty, PEAR Console, swfobject, cssshover.htc, md5.js
1313
1314API changes:
1315* new admin/tool plugin type
1316* new context API - old API is still available
8e470797 1317* deleted users do not have context any more
ee362526
PS
1318* removed global search
1319
1320
1321=== 2.1 ===
1322
1323API changes:
1324* basic suport for restore from 1.9
1325* new mobile devices API
1326* new questions API
1327
1328
1329=== 2.0 ===
1330
1331API changes:
1332* new DML API - http://docs.moodle.org/dev/DML_functions
1333* new DDL API - http://docs.moodle.org/dev/DDL_functions
1334* new file API - http://docs.moodle.org/dev/File_API
1335* new $PAGE and $OUTPUT API
1336* new navigation API
1337* new theme API - http://docs.moodle.org/dev/Theme_changes_in_2.0
1338* new javascript API - http://docs.moodle.org/dev/JavaScript_usage_guide
1339* new portfolio API
1340* new local plugin type
1341* new translation support - http://lang.moodle.org
1342* new web service API
1343* new cohorts API
1344* new messaging API
1345* new rating API
1346* new comment API
1347* new sessions API
1348* new enrolment API
1349* new backup/restore API
1350* new blocks API
1351* new filters API
1352* improved plugin support (aka Frankenstyle)
1353* new registration and hub API
1354* new course completion API
1355* new plagiarism API
1356* changed blog API
1357* new text editor API
19526d91 1358* new my moodle and profiles API