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