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