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