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