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