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