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