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