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