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