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