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