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