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