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