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