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