[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 === 4.2 ===
6 * Travis CI integration has been removed from core (MDLSITE-7135). Please, use GitHub Actions (GHA) instead. For
7   more information visit https://moodledev.io/general/development/tools/gha
8 * A new constant COMPLETION_COMPLETE_FAIL_HIDDEN is introduced to mark that user has received a failing grade
9   for a hidden grade item. This state returned by internal_get_grade_state() and is only used by get_core_completion_state()
10   for processing the passgrade completion data.
11 * \single_button constructor signature has been changed to manage more types than just primary buttons.
12   The boolean "primary" parameter has been deprecated and replaced by a more generic type allowing to use
13   Bootstrap styles of buttons (danger, warning...). The constructor will still manage the boolean primary
14   parameter but will display a debugging message.
15 * In enrollib.php, the methods get_enrolled_with_capabilities_join, get_enrolled_sql, get_enrolled_users and
16   count_enrolled_users used to only be able to accept a single group id, even though internally, they used
17   groups_get_members_join which could also accept an array of groups, or the constant USERSWITHOUTGROUP.
18   This has now been made consistent. These enrol methods now accept all the group-related options that
19   groups_get_members_join can handle.
20 * assign_capability() now has an optional $performancehints parameter which can be used in
21   situations where it is being called in a loop in response to a database query, to reduce the
22   amount of checks it has to do.
23 * New DB parameter 'versionfromdb', only available for MySQL and MariaDB drivers. It allows to force the DB version to be
24   evaluated through an explicit call to VERSION() to skip the PHP client version which appears to be sometimes fooled by the
25   underlying infrastructure, e.g. PaaS on Azure.
26 * The actionmenu component has now a set_kebab_trigger that will setup the action menu for use in kebab menus.
27 * The useexternalyui configuration setting has been removed as a part of the migration away from YUI.
28   It only worked with http sites and did not officially support SSL, and is at risk of disappearing should Yahoo! decide
29   to remove it.
30 * New `properties_filter` method of persistent class for filtering properties of a record against persistent definition
31 * Added 'extrainfo' in the DB options config. Its extra information for the DB driver, e.g. SQL Server
32   has additional configuration according to its environment, which the administrator can specify to alter and
33   override any connection options.
34 * In outputcomponents.php, initials_bar() can now be rendered in a smaller (mini) way. This provides purely the
35   initials bar without the bootstrapping and form handling on each initials bar. If you use this mini render,
36   you'll need to implement your own form handling. Example usage can be found within the grader report.
37 * There is a new helper function mtrace_exception to help with reporting exceptions you have caught in scheduled tasks.
38 * Box/Spout has been archived and is no longer maintained, so it has now been removed and replaced by OpenSpout.
39 * The following parts of the external API have been moved to the core_external subsystem:
40   Classes:
41     - external_api                      => core_external\external_api
42     - external_description              => core_external\external_description
43     - external_files                    => core_external\files
44     - external_format_value             => core_external\external_format_value
45     - external_function_parameters      => core_external\external_function_parameters
46     - external_multiple_structure       => core_external\external_multiple_structure
47     - external_settings                 => core_external\external_settings
48     - external_single_structure         => core_external\external_single_structure
49     - external_util                     => core_external\util
50     - external_value                    => core_external\external_value
51     - external_warnings                 => core_external\external_warnings
52     - restricted_context_exception      => core_external\restricted_context_exception
53   Functions:
54     - external_format_string()          => core_external\util::format_string()
55     - external_format_text()            => core_external\util::format_text()
56     - external_create_service_token()   => core_external\util::generate_token()
57     - external_generate_token()         => core_external\util::generate_token()
58     - external_generate_token_for_current_user()
59                                         => core_external\util::generate_token_for_current_user()
60     - external_log_token_request        => core_external\util::log_token_request()
62   The old class locations have been aliased for backwards compatibility and will emit a deprecation notice in a future
63   release.
64 * The following methods, deprecated since 3.10, have been removed and can no longer be used:
65   - `\core\output\mustache_helper_collection::strip_blacklisted_helpers`
66   - `\core_form\filetypes_util::is_whitelisted`
67   - `\core_form\filetypes_util::get_not_whitelisted`
68 * Convert a floating value to an integer in lib/graphlib.php to avoid PHP 8.1 deprecated function error.
69 * The $required parameter for \core_external\external_description is now being validated in order to prevent
70   unintentionally passing incorrect parameters to the external_description's (and its subclasses') constructors (e.g. the parameter
71   description being incorrectly passed for the $required parameter). A debugging notice will be shown when such cases occur.
72 * The moodle-core-popuphelp YUI modal has been removed. It has not been actively used in Moodle since 3.3. It should be replaced with appropriate ESM/AMD JavaScript.
73 * The moodle-core-tooltip YUI modal has been removed. It should be replaced with appropriate ESM/AMD JavaScript.
74 * A `\core\event\role_created` event is now triggered when roles are created via the `create_role` API.
75 * Event \core\event\user_created is now triggered if the user is created during course restore. In this case
76   $event->other has properties 'restoreid' and 'courseid'.
77 * The core/modal module and all their versions (SAVE_CANCEL, DELETE_CANCEL...) now has a setButtonDisable to disable or enable
78   specific modal action buttons. This function allows developers to have modals that could only be submited if the user do some
79   action in the modal body like ticking a checkbox or selecting an element.
80 * Course module indentation has been recovered for course format using components via Move right/left feature.
81   Course formats using components will be allowed to use one level indentation only.
82 * The method `flexible_table::set_columnsattributes` now can be used with 'class' key to add custom classes to the DOM.
83 * The editor_tinymce plugin has been removed from core.
84 * A new grunt task, upgradablelibs, has been added to get the list of libraries that have a newer version in their repositories.
85 * Support for serving of AMD modules built in really old versions of Moodle (<= 3.8) has been removed.
86   Please ensure that your AMD modules have been rebuilt with a supported Moodle version.
87 * Addition of new 'visibility' and 'participation' fields in the groups table, and 'moodle/group:viewhiddengroups' capability.
88   The following grouplib functions will now return groups and members based on group visibility and the user's permissions:
89    - groups_get_all_groups()
90    - groups_get_user_groups()
91    - groups_get_my_groups()
92    - groups_is_member()
93    - groups_get_members()
94    - groups_get_groups_members()
95   groups_print_activity_menu() will now only return groups where particiation == true.
96 * Cron utility functions have been moved from the global namespaces to the \core\cron class.
97 * The following phpunit advanced testcase helper methods, deprecated since 3.10, have been removed and can no longer be used:
98   - `createXMLDataSet`
99   - `createCsvDataSet`
100   - `createArrayDataSet`
101   - `loadDataSet`
102 * The external function core_grades_get_enrolled_users_for_search_widget is now deprecated.
103   Please use the new core_grades_get_enrolled_users_for_selector external function instead.
104 * The external function core_grades_get_groups_for_search_widget is now deprecated.
105   Please use the new core_grades_get_groups_for_selector external function instead.
106 * New \core_component::has_monologo_icon() that determines whether a plugin has monologo icons. This can be used to
107   determine whether to apply CSS filtering to the plugin's icon when rendering it.
108 * \cm_info::get_icon_url() resolves the icon's file type and adds a `filtericon` parameter in the URL when rendering the monologo
109   version of the course module icon or when the plugin declares, via its `filtericon` custom data, that the icon needs to be
110   filtered. This additional information can be used by plugins when rendering the module icon to determine whether to apply
111   CSS filtering to the icon.
112 * Activity plugins displaying activity module icons using \cm_info::get_icon_url() can declare the `filtericon` custom data in their
113   `get_coursemodule_info()` callback. If set, this will be used by \cm_info::get_icon_url() to set the icon URL's `filtericon`
114   parameter. This information can be used by the plugins when enclosing the icons in `.activityiconcontainer .icon` or
115   `.activityiconcontainer .activityicon` containers to determine whether CSS filtering should be applied to the icon. If the icon
116   needs to be rendered as is and not whitened out, the `.nofilter` CSS class needs to be applied to the icon.
118 === 4.1 ===
120 * HTMLPurifier has been upgraded to the latest version - 4.16.0
121 * A process to deprecate capabilities by flagging them in the access.php by adding a $deprecatedcapabilities variable (an array).
122   This array will list the deprecated capabilities and a possible replacement. Once we declare the capability as deprecated, a debugging
123   message will be displayed (in DEBUG_DEVELOPPER mode only) when using the deprecated capability.
124   Declaration is as follow:
125     $deprecatedcapabilities = [
126         'fake/access:fakecapability' => ['replacement' => '', 'message' => 'This capability should not be used anymore.']
127     ];
128 * coursemodinfo cache uses the new `requirelockingbeforewrite` option, and rebuilding the cache now uses the cache lock API, rather
129   than using the core lock factory directly. This allows the locks to be stored locally if the cache is stored locally, and
130   avoids the risk of delays and timeouts when multiple nodes need to rebuild the cache locally, but are waiting for a central lock.
131 * Final deprecation and removal of the class \admin_setting_managelicenses, please use \tool_licensemanager\manager instead.
132 * Final deprecation and removal of the function license_manager::add(). Please use license_manager::save() instead.
133 * Final deprecation of the following functions behat_field_manager::get_node_type() and behat_field_manager::get_field()
134   please call behat_field_manager::get_field_node_type() and behat_field_manager::get_form_field().
135 * Final deprecation and removal of the following class, please use \core\task\manager.
136     - \tool_task\run_from_cli
137 * Final deprecation and removal of the following CLI scripts:
138   - admin/tool/task/cli/schedule_task.php please use admin/cli/scheduled_task.php
139   - admin/tool/task/cli/adhoc_task.php please use admin/cli/adhoc_task.php
140 * Final deprecation and removal of cron_run_single_task(), please use \core\task\manager::run_from_cli().
141 * The $USER->groupmember hack that fills the user object with the groups that the user belongs to has been removed.
142   Please use the Groups API function groups_get_user_groups() to fetch the cached list of groups the user is a member of.
143 * The following functions, previously used (exclusively) by upgrade steps are not available anymore
144   because of the upgrade cleanup performed for this version. See MDL-71747 for more info:
145     - upgrade_analytics_fix_contextids_defaults()
146     - upgrade_convert_hub_config_site_param_names()
147     - upgrade_rename_prediction_actions_useful_incorrectly_flagged()
148 * The method ensure_adhoc_task_qos() in lib/classes/task/manager.php  has been deprecated, please use get_next_adhoc_task()
149   instead.
150 * New setting $CFG->enrolments_sync_interval controls the minimum time in seconds between re-synchronization of enrollment via enrol_check_plugins.
151   This only applies to web requests without a session such as webservice calls, tokenpluginfile.php and rss links Function
152   enrol_check_plugins now has $ignoreintervalcheck flag to bypass checking for that setting.
153 * For performance reasons, sql_reader interface has a new function get_events_select_exists() which determines whether
154   an event exists with the given criteria (see MDL-72723 for details).
155    - Breaking: 3rd party log readers implementing interface sql_reader will need to implement get_events_select_exists()
156 * Added $strictness parameter to persistent `get_record` method, optionally allowing caller to ensure record exists
157 * New DML driver method `$DB->sql_cast_to_char` for casting given field/expression to char
158 * The core renderer `edit_button` method now accepts an optional `$method` argument (get/post) for the button
159 * For plugins that override secondary navigation, the namespace for the custom secondary navigation class has
160   changed. It was (for example) mod_mymodule\local\views\secondary but is now
161   mod_mymodule\navigation\views\secondary. The old location will continue to work, but is deprecated.
162 * The check for $plugin->incompatible was found to be incorrect. The $plugin->incompatible attribute is meant to define the minimum
163   Moodle version the plugin is incompatible with but the implemented logic for the check was the opposite. Plugins declaring this
164   attribute may encounter different behaviours between older Moodle versions (<v3.11.8, <v4.0.2) and the later ones. We recommend
165   plugin developers to not use this attribute for Moodle versions 4.0 and below in order to avoid this problem.
166 * Added $CFG->proxylogunsafe and proxyfixunsafe to detect code which doesn't honor the proxy config
167 * Function admin_externalpage_setup() now has additional option 'nosearch' allowing to remove Site administration search form.
168 * The function print_error has been deprecated. Kindly use moodle_exception.
169 * When exporting table content, HTML tags/entities will be removed when the selected dataformat does not support HTML
170 * The abstract `get_name` method has been moved from `\core\task\scheduled_task` to the `\core\task\task_base` class and can now be
171   implemented by adhoc tasks. For backwards compatibility, a default implementation has been added to `\core\task\adhoc_task` to
172   return the class name.
173 * The function get_module_metadata() has been finally deprecated and can not be used anymore.
174 * New DML driver method `$DB->sql_order_by_null` for sorting nulls sort nulls first when ascending and last when descending.
175 * Allow plugins to callback on all pages just prior to the session start.
176 * New function set_additional_classes() has been implemented to add additional classes to action_menu.
177 * Most Behat functionality for the Moodle App has been removed from core, refer to the documentation in order to upgrade your testing
178   setup: https://moodledev.io/general/app/development/testing/acceptance-testing#upgrading-tests-from-an-older-version
179 * New DML driver methods `$DB->sql_regex_get_word_beginning_boundary_marker` and `$DB->sql_regex_get_word_end_boundary_marker`
180   for managing word boundary markers in a database driver supporting regex syntax when searching.
181 * The plugin_functions cache in core has been made localisable by prefixing the
182   key it uses with the all versions hash, which only changes when there are code
183   changes.
185 === 4.0 ===
187 * To better detect wrong floats (like, for example, unformatted, using local-dependent separators ones) a number of
188   gradebook functions now have stricter float type checking. All them will require now the "float" being passed to be
189   a correct float value (numeric or string). Usually, that's achieved by using unformat_float() or
190   PARAM_LOCALISEDFLOAT for all the user-entered grades before any processing on them. Functions affected are:
191     - grade_format_gradevalue(), $value param (keeping it as optional/nullable).
192     - grade_format_gradevalue_real(), $value param (keeping it as optional/nullable).
193     - grade_format_gradevalue_percentage(), $value param (keeping it as optional/nullable).
194     - grade_format_gradevalue_letter(), $value param (keeping it as optional/nullable).
195     - grade_floats_different(), $f1 and $f2 params (keeping them as optional/nullable).
196     - grade_floats_equal(), $f1 and $f2 params (keeping them as optional/nullable).
197 * The method action_menu->set_alignment() has been deprecated, please use action_menu->set_menu_left if you need a dropdown
198   to align to the left of the dropdown button.
199 * The $OUTPUT->should_display_main_logo() function has been deprecated and should no longer be used.
200 * New method flexible_table::set_columnsattributes() has been introduced to add column attributes applied in every cell.
201 * New method flexible_table::get_row_cells_html() has been introduced, extracted from flexible_table::get_row_html
202   so it can be overriden individually.
203 * Since Boxnet has been remove from core then boxnet_client() class has been removed from core too.
204 * New navigation classes to mimic the new navigation project. The existing navigation callbacks are still available and
205   will be called. The following behaviour will be the new standard for nodes added via callbacks in Boost and Boost-based themes:
206   - Module nodes added will be appended to the end and will appear within the More menu.
207   - Course nodes added will also be appended and appear within the 'More' menu.
208 * The core/event events have been renamed and now fire native events, in addition to the legacy YUI and jQuery events.
209   The following events have been renamed:
210   - The BLOCK_CONTENT_UPDATED event has been replaced with a new native event in the `core_block/events` AMD module
211     eventTypes.blockContentUpdated.
212   - The EDITOR_CONTENT_RESTORED event has been replaced with a new native event in the `core_editor/events` AMD module
213     eventTypes.editorContentRestored.
214   - The FILTER_CONTENT_UPDATED event has been replaced with a new native event in the `core_filters/events` AMD module
215     eventTypes.filterContentUpdated.
216   - The FORM_FIELD_VALIDATION event has been replaced with a new native event in the `core_form/events` AMD module
217     eventTypes.formFieldValidationFailed.
218   - The FORM_SUBMIT_AJAX event has been replaced with a new native event in the `core_form/events` AMD module
219     eventTypes.formSubmittedByJavascript.
220 * The block template now includues a block-instanceid data attribute.
221 * The core/event::getLegacyEvents() function has been deprecated and should no longer be used.
222 * Typo3 has now been removed. Use native mbstring or iconv functions.
223 * A new index has been added on mdl_user_preferences.name. This upgrade step might take some time on big sites.
224 * The completion_info function display_help_icon() which returned the 'Your progress' help icon has been deprecated and
225   should no longer be used.
226 * The completion_info function print_help_icon() which has been deprecated since Moodle 2.0 should no longer be used.
227 * @babel/polyfill has been removed in favour of corejs@3.
228 * A new parameter $partialrebuild has been added to the rebuild_course_cache to invalidate the cache
229   of the section or module only, not the whole course cache
230 * A new parameter $isbulkupdate has been added to the following functions:
231   - grade_category::update()
232   - grade_category::insert()
233   - grade_grade::update()
234   - grade_grade::insert()
235   - grade_grade::notify_changed()
236   - grade_item::insert()
237   - grade_item::update()
238   - grade_item::update_final_grade()
239   - grade_item::update_raw_grade()
240   - grade_object::update()
241   - grade_object::insert()
242   - grade_outcome::update()
243   - grade_outcome::insert()
244   - grade_scale::update()
245   - grade_scale::insert()
246   - grade_update()
247   - completion_info::inform_grade_changed()
248   - completion_info::update_state()
249   - completion_info::internal_set_data()
250   All functions except completion_info::internal_set_data() are only passing this parameter from very beginning of
251   workflow (like grade report page where bulk grade update is possible) so this parameter is used in
252   completion_info::internal_set_data() to decide if we need to mark completions instantly without waiting for cron.
253 * Following methods now return an int instead of bool:
254   - completion_completion::_save()
255   - completion_completion::mark_enrolled()
256   - completion_completion::mark_inprogress()
257   - completion_completion::mark_complete()
258   which is needed to store id of completion record on successful update which is later beeing used by
259   completion_info::internal_set_data() to reaggregate completions that have been marked for instant course completion.
260 * The following functions have been finally deprecated and can not be used anymore:
261   - generate_uuid
262 * The YUI moodle-core-formchangechecker module has been deprecated and replaced with a new AMD module
263   core_form/changechecker.
264 * New method \core_user::awaiting_action() has been introduced to check if the user is fully ready to use the site or
265   whether there is an action (such as filling the missing profile field, changing password or agreeing to the site
266   policy) needed.
267 * The signature of the get_name() function for grade_category and grade_item has been extended. The new parameter allows
268   callers to get the name without escaped characters.
269 * The inplace_editable element constructor now accepts an optional pix_icon parameter to use as it's editing icon when
270   rendered. The default icon for "select" types has also changed to a dropdown caret ("t/expanded").
271 * The inplace_editable Javascript module now emits native events, removing the jQuery dependency from calling code
272   that wants to listen for the events. Backwards compatibility with existing code using jQuery is preserved.
273 * The function message_send() in messagelib.php now returns false if there is an error sending the message to the
274   message processor (MDL-70046).
275 * Moodle 4.0 has major changes to the question bank. Therefore, there are major changes in questionlib.php
276   and the core_question database tables. These are documented in detail in question/upgrade.txt.
277 * The postgres driver now wraps calls to pg_field_type() and caches them in databasemeta to save an invisible internal
278   DB call on every request.
279 * The default type of 'core/toast' messages has been changed to 'information' (callers can still explicitely set the type)
280 * As the message_jabber notification plugin has been moved to the plugins database, the XMPPHP library (aka Jabber) has been
281 completely removed from Moodle core too.
282 * The SWF media player has been completely removed (The Flash Player was deprecated in 2017 and officially discontinued
283   on 31 December 2020).
284 * The display_size function has been improved to add new optional parameters (decimal places,
285   fixed units), to always include a non-breaking space between the number and unit, and to use
286   consistent rounding (always 1 decimal place by default).
287 * The persistent method get() now returns the correct type for each property defined in the persistent class.
288 * The persistent method from_record() now only attempts to load record properties defined in the persistent class.
289 * New persistent set_many() helper for setting multiple properties in single method call.
290 * Require pass grade criteria is now part of core.
291   Refer to upgrade.php to see transitioning from similar plugin criteria to core
292   Refer to completion/upgrade.txt for additional information.
293 * The method enable_plugin() has been added to the core_plugininfo\base class and it has been implemented by all the plugininfo
294 classes extending it. When possible, the enable_plugin() method will store these changes into the config_log table, to let admins
295 check when and who has enabled/disabled plugins.
296 * Final deprecation: The following functions along with associated tests have been removed:
297   - core_grades_external::get_grades
298   - core_grades_external::get_grade_item
299   - report_insights_context_insights
300 * \core\session\manager::init_empty_session() has a new optional parameter $newsid to indicate whether this is a new user session
301 * New html_table attribute "$responsive" which defaults to true. When set to true, tables created via html_writer::table() will be enclosed
302   in a .table-responsive div container which will allow the table to be scrolled horizontally with ease, especially when the table is rendered in smaller viewports.
303   Set to false to prevent the table from being enclosed in the responsive container.
304 * Two new helper functions have been added to lib/datalib.php, for safely preparing SQL ORDER BY statements where user
305   interactions define sort parameters (see the respective docblocks for full details and examples):
306   -get_safe_orderby() - where a single sort parameter is required.
307   -get_safe_orderby_multiple() - where multiple sort parameters are required.
308 * Added the cleanstr mustache template helper to clean strings after loading them from language packs.
309 * The following behat functions have been modified to work with the new navigation
310   - i_add_the_block
311   - the_add_block_selector_should_contain_block
312   - the_add_block_selector_should_contain_block
313   - go_to_the_current_course_activity_completion_report
314   - i_navigate_to_course_participants
315   - i_go_to_advanced_grading_page
316   - i_navigate_to_in_the_course_gradebook
317   - should_exist_in_current_page_administration
318   - should_not_exist_in_current_page_administration
319   - go_to_main_course_page
320   - select_on_administration_page
321   - find_header_administration_menu
322   - select_from_administration_menu
323   - i_edit_the_lesson
324   - i_add_a_question_filling_the_form_with
325 * The following behat step has been deprecated
326   - i_select_from_flat_navigation_drawer
327 * The type for the "message" field in the external_warnings() structure has been changed from PARAM_TEXT to PARAM_RAW
328 * A new parameter $displayoptions has been added to the core_renderer::confirm() to allow better customization for confirming page
329 such as the title and strings for continue and cancel buttons.
330 * The method get_enabled_plugin($pluginname) has been added to the core_plugininfo\base class. It has a default implementation for
331 all the plugininfo classes and it can be overwritten when required (like it has been done with filter). This method returns the
332 current value for a pluginname depending on its status (enabled, disabled, other...).
333 * Unit Test coverage defaults have been updated to include some sensible defaults.
334   The default values now include:
335   * /classes/
336   * /tests/generator/
337   * /externallib.php
338   * /lib.php
339   * /locallib.php
340   * /renderer.php
341   * /rsslib.php
342   This default applies both when there is no supplied coverage.php file, and is used to supplement any existing coverage configuration file if one is found.
343 * New method get_unaddable_by_theme_block_types() has been added to block_manager class. It uses the 'unaddableblocks' theme setting
344 value to get the list of blocks that won't be displayed for a theme.
345 * Loggedin / Loggedoff component settings on notification preferences have been merged to a single enabled switch:
346   MESSAGE_DEFAULT_LOGGEDIN and MESSAGE_DEFAULT_LOGGEDOFF are now deprecated, so plugins should be updated if db/messages.php is present and replace
347     MESSAGE_DEFAULT_LOGGEDIN + MESSAGE_DEFAULT_LOGGEDOFF to MESSAGE_DEFAULT_ENABLED. Backward compatibility will take any of both settings as enabled.
348   MESSAGE_DEFAULT_PERMITTED also deprecated.
349   core_message_get_user_notification_preferences and core_message_get_user_message_preferences Webservice are now returning enabled boolean on
350     components > notifications > processors. loggedin and loggedoff are deprecated but present for backward compatibility.
351 * A new parameter $strength of type int is added to method search_for_active_node. This parameter would help us to search for the active nodes based on the
352   $strength passed to it.
353 * A new method get_page() has been added to the settings_navigation class. This method can be used to obtain the
354   moodle_page object associated to the settings navigation.
355 * A new interface, `core\output\named_templatable` has been created to allow renderable classes to define a
356   `get_template_name(\renderer_base): string` function which will inform the default render() function with a template
357   name.
358 * The parameter $modinfo of the get_data method in completion_info class has been deprecated and is not used anymore.
359 * A new method, get_default_home_page(), has been added to moodlelib to get the default home page to display if current one is not
360 defined or can't be applied.
361 * A new language_menu renderable is created to handle collecting available languages and generating the menu for use in different situations
362 * New primary navigation classes to mimic the primary nav. Consists of the views/primary.php and output/primary.php. The
363   base nodes are added within the views/primary.php while output/primary.php is a renderable that combines the primary
364   view and the lang, user and any custom menu items.
365   - The language menu now resides within the user menu.
366 * New primary and secondary magic getters/setters included in pagelib.php that also initialises the objects
367 * All secondary navigation nodes have a predefined ordering within the relevant context and are defined as a
368   mapping construct within core\navigation\views\secondary. Secondary navigation ordering can be overridden by
369   generating a custom secondary class within a plugin's {plugin}\local\views namespace. This is only applicable to the
370   following plugin types and is automatically loaded:
371     * Module - refer to mod_assign\local\views\secondary for examples and magic_get_secondarynav for calling code
372     * Block - refer to core_block\local\views\secondary for examples and blocklib::get_secondarynav for calling code
373   - Additionally a custom secondary object may be set using the convenient setters in pagelib.php.
374   - Secondary nav nodes can be forced into the 'More' menu using the 'set_force_into_more_menu'. It is advisable to set
375     this in the existing nav callbacks when generating the nodes. Alternately, the corresponding
376     'get_default_{admin/course/module}_more_menu_nodes functions in secondary can be overridded to provide a custom set
377     of node keys to push into the more menu
378   - The secondary navigation can be omitted from a theme/page by setting $PAGE->set_secondary_navigation(false). e.g. admin/search.php and in classic.
379   - Within a single activity course format, the course and module level secondary navigation options are displayed within
380     dropdowns in the secondary navigation bar
381 * New function 'get_overflow_menu_data' introduced in core\navigation\views\secondary to get additional/custom sub navigation
382   to be displayed as a url_select for tertiary navigation.
383 * It is required that the action provided to navigation_node::create be of type moodle_url/action_link. Non conformance
384   results in a debugging message being thrown.
385 * New page lib config '_navigationoverflow' and associated getters/setters to toggle whether the overflow menu is displayed
386 * New functions to explicitly set what tabs should be highlighted on the primary and secondary navigation
387 * Breadcrumbs modified to follow standards defined here https://www.nngroup.com/articles/breadcrumbs/
388   - New navbar class in boost to follow the standards defined above.
389 * Settings cog have been removed and replaced with either secondary and tertiary navigation components
390 * New activity_header class to handle display of common content for plugins.
391   * Handles display of the activity name, completion information and description.
392   * New pagelib.php magic getters to fetch activity_header
393   * New theme level config to govern display of the activity name $THEME->activityheaderconfig['notitle']
394         - Default for boost is to show no activity title.
395   * New page layout level option to handle display within activity header. Options should be defined
396     within 'activityheader' and accept the following array keys:
397         - notitle
398         - nocompletion
399         - nodescription
400   * Convenient functions to set the parameters in the header OR hide them altogether.
401 * Category navigations has been updated with a preference of tertiary navigation components over buttons within the page
402   content and/or context header actions
403 * A new 'My courses' page has been introduced which houses the course overview block
404 * Default blocks for dashboard has been updated. The page will now have the following in the corresponding region:
405     * Calendar, Timeline - Center
406     * Recently accessed courses - Side bar/blocks drawer
407 * Flat navigation classes have been marked for deprecation with the introduction of primary and secondary navigation concepts.
408 * A new method, force_lock_all_blocks(), has been added to the moodle_page class to allow pages to force the value of
409   user_can_edit_blocks() to return false where necessary. This makes it possible to remove block editing on a page
410   from ALL users, including admins, where required on pages with multi region layouts exist, such as "My courses".
411 * Add an early $CFG->session_redis_acquire_lock_warn option
412 * Removed $CFG->conversionattemptlimit setting from config.php. assignfeedback_editpdf\task\convert_submissions task
413   is now replaced with adhoc tasks with standard fail delay approach.
414 * With strftime() being deprecated in PHP 8.1, a new function \core_date::strftime() that can be used as a PHP 8.1-compatible
415   alternative has been introduced.
417 === 3.11.4 ===
418 * A new option dontforcesvgdownload has been added to the $options parameter of the send_file() function.
419   Note: This option overrides the forced download of directly accessed SVGs, so should only be used where the calling method is
420   rendering SVGs directly for content created using XSS risk flagged capabilities (such as creating a SCORM activity).
421   This is also not necessary where SVGs are already being safely loaded into <img> tags by Moodle (eg within forum posts).
423 === 3.11.2 ===
424 * For security reasons, filelib has been updated so all requests now use emulated redirects.
425   For this reason, manually disabling emulateredirects will no longer have any effect (and will generate a debugging message).
427 === 3.11 ===
428 * PHPUnit has been upgraded to 9.5 (see MDL-71036 for details).
429   That comes with a few changes:
430   - Breaking: All the changes that were deprecated with PHPUnit 8.5
431     are now removed (see the 3.10 section below).
432   - Breaking: assertContains() now performs stricter comparison (like assertSame()
433     does). New assertContainsEquals() has been created to provide the old
434     behavior.
435   - Deprecation: A number of file-related assertions have been deprecated, will
436     be removed with PHPUnit 10. Alternatives for all them have been created:
437       - assertNotIsReadable()         -> assertIsNotReadable()
438       - assertNotIsWritable()         -> assertIsNotWritable()
439       - assertDirectoryNotExists()    -> assertDirectoryDoesNotExist()
440       - assertDirectoryNotIsReadable()-> assertDirectoryIsNotReadable()
441       - assertDirectoryNotIsWritable()-> assertDirectoryIsNotWritable()
442       - assertFileNotExists()         -> assertFileDoesNotExist()
443       - assertFileNotIsReadable()     -> assertFileIsNotReadable()
444       - assertFileNotIsWritable()     -> assertFileIsNotWritable()
445   - Deprecation: Regexp-related assertions have been deprecated, will be
446     removed with PHPUnit 10. Alternatives for all them have been created:
447       - assertRegExp()     -> assertMatchesRegularExpression()
448       - assertNotRegExp()  -> assertDoesNotMatchRegularExpression()
449   - Deprecation: The expectException() for Notice, Warning, Deprecation and
450     Error is deprecated, will be removed with PHPUnit 10. New expectations
451     have been created to better define the expectation:
452       - expectDeprecation() for E_DEPRECATED and E_USER_DEPRECATED.
453       - expectNotice() for E_NOTICE, E_USER_NOTICE, and E_STRICT.
454       - expectWarning() for E_WARNING and E_USER_WARNING.
455       - expectError() for everything else.
456    - Deprecation: The Mock->at() matcher has been deprecated and will be
457      removed with PHPUnit 10. Switch to better, more deterministic and clearer
458      matchers is recommended (->once(), ->exactly(), ->never()...).
459    - Deprecation: The Mock->setMethods() method has been *silently* deprecated
460      and will be removed in the future. Change uses to the new Mock->onlyMethods()
461      alternative. Also, it doesn't accept "null" anymore, new default must
462      be [] (empty array).
463    - Mostly internal: With the raise to PHP 7.3 as lower version supported,
464      various internal bits perform now stricter type checking in params and
465      return values. If your tests have own-created comparators, assertions...
466      they may need to be adjusted.
467    - Mostly internal: The phpunit.xml schema has changed, basically removing
468      the old <filter> section and replacing it with a new, less confusing
469      <coverage> section. Also the elements within them have been changed:
470        - <whitelist> has been replaced by <include>.
471        - <exclude> is not a child of <whitelist> anymore, but of <coverage>.
472      Note that this only will affect if you've custom phpunit.xml files
473      instead of using the automatically generated ones by Moodle.
474    - Deprecation: Related to the previous point, the $whitelistxxx properties
475      used by the coverage.php files have been deprecated (will continue
476      working until Moodle 4.3) to follow the same pattern:
477        - whitelistfolders -> includelistfolders
478        - whitelistfiles   -> includelistfiles
479    - Internal: Custom autoloaders are deprecated and will be removed with
480      PHPUnit 10. Hence we have removed our one already.
481      Note that it was not useful since PHPUnit 8.5, where the ability
482      to run tests by class name was removed.
483    - Warning: Because of some new restrictions about how test files and
484      test classes must be named (that Moodle haven't followed ever) it's not
485      possible to run individual test files any more. Use any of the alternative
486      execution methods (filter, suite, config) to specify which tests
487      you want to run. This will be hopefully fixed in MDL-71049
488      once it has been agreed which the best way to proceed is.
489 * The horde library has been updated to version 5.2.23.
490 * New optional parameter $extracontent for print_collapsible_region_start(). This allows developers to add interactive HTML elements
491   (e.g. a help icon) after the collapsible region's toggle link.
492 * Final deprecation i_dock_block() in behat_deprecated.php
493 * Final deprecation of get_courses_page. Function has been removed and core_course_category::get_courses() should be
494   used instead.
495 * New encryption API in \core\encryption allows secure encryption and decryption of data. By
496   default the key is stored in moodledata but admins can configure a different, more secure
497   location in config.php if required. To get the best possible security for this feature, we
498   recommend enabling the Sodium PHP extension.
499   The OpenSSL alternative for this API, used when Sodium is not available, is considered deprecated
500   at all effects, and will be removed in Moodle 4.2. See MDL-71421 for more information.
501 * Behat timeout constants behat_base::TIMEOUT, EXTENDED_TIMEOUT, and REDUCED_TIMEOUT, which were deprecated in 3.7, have been removed.
502 * \core_table\local\filter\filterset::JOINTYPE_DEFAULT is being changed from 1 (ANY) to 2 (ALL). Filterset implementations
503   can override the default filterset join type by overriding \core_table\local\filter\filterset::get_join_type() instead.
504 * HTMLPurifier has been upgraded to the latest version - 4.13.0
505 * Markdown lib has been upgraded to the latest version - 1.9.0
506 * The minify lib has been upgraded to 1.3.63 and pathconvertor to 1.1.3
507 * A new optional parameter `$sort` has been added to all `$context->get_capabilities()` methods to be able to define order of
508   returned capability array.
509 * Spout has been upgraded to the latest version - 3.1.0
510 * emoji-data has been upgraded to 6.0.0.
511 * The final deprecation of /message/defaultoutputs.php file and admin_page_defaultmessageoutputs.
512   All their settings moved to admin/message.php (see MDL-64495). Please use admin_page_managemessageoutputs class instead.
513 * Behat now supports date selection from the date form element. Examples:
514     - I set the field "<field_string>" to "##15 March 2021##"
515     - I set the field "<field_string>" to "##first day of January last year##"
516 * Behat now supports date and time selection from the datetime form element. Examples:
517     - I set the field "<field_string>" to "##15 March 2021 08:15##"
518     - I set the field "<field_string>" to "##first day of January last year noon##"
519 * New DML driver method `$DB->sql_group_concat` for performing group concatenation of a field within a SQL query
520 * Added new class, AMD modules and WS that allow displaying forms in modal popups or load and submit in AJAX requests.
521   See https://docs.moodle.org/dev/Modal_and_AJAX_forms for more details.
522 * New base class for defining an activity's custom completion requirements: \core_completion\activity_custom_completion.
523   Activity module plugins that define custom completion conditions should implement a mod_[modname]\completion\custom_completion
524   subclass and the following methods:
525   - get_state(): Provides the completion state for a given custom completion rule.
526   - get_defined_custom_rules(): Returns an array of the activity module's custom completion rules.
527     e.g. ['completionsubmit']
528   - get_custom_rule_descriptions(): Returns an associative array with values containing the user-facing textual description
529     of the custom completion rules (which serve as the keys to these values).
530     e.g. ['completionsubmit' => 'Must submit']
531   - get_sort_order(): Returns an array listing the order the activity module's completion rules should be displayed to the user,
532     including both custom completion and relevant core completion rules
533     e.g. ['completionview', 'completionsubmit', 'completionusegrade']
534 * Admin setting admin_setting_configmulticheckbox now supports lazy-loading the options list by
535   supplying a callback function instead of an array of options.
536 * A new core API class \core_user\fields provides ways to get lists of user fields, and SQL related to
537   those fields. This replaces existing functions get_extra_user_fields(), get_extra_user_fields_sql(),
538   get_user_field_name(), get_all_user_name_fields(), and user_picture::fields(), which have all been
539   deprecated.
540 * Allow plugins to augment the curl security helper via callback. The plugin's function has to be defined as
541   plugintype_pluginname_curl_security_helper in pluginname/lib.php file and the function should return a plugin's security
542   helper instance.
543 * The behat transformation 'string time to timestamp' no longer supports datetime format. If provided, the format must
544   be strftime compatible. Example:
545     - I should see "##tomorrow noon##%A, %d %B %Y, %I:%M %p##"
546 * External functions implementation classes should use 'execute' as the method name, in which case the
547   'methodname' property should not be specified in db/services.php file.
548 * The core_grades_create_gradecategory webservice has been deprecated in favour of core_grades_create_gradecategories, which is
549   functionally identical but allows for parallel gradecategory creations by supplying a data array to the webservice.
550 * The signature of the get_context_name() function in the abstract class context and all extending classes (such as context_course)
551   has been extended. The new parameter allows the to get the name without escaped characters.
552 * The signature of the question_category_options() has been extended. The new parameter allows the to get the categories name
553   in the returned array without escaped characters.
554 * The \core\hub\site_registration_form::add_select_with_email() method has been deprecated in favour of
555   \core\hub\site_registration_form::add_checkbox_with_email().
557 === 3.10 ===
558 * PHPUnit has been upgraded to 8.5. That comes with a few changes:
559   - Breaking change: All the "template methods" (setUp(), tearDown()...) now require to return void. This implies
560     that the minimum version of PHP able to run tests will be PHP 7.1
561   - A good number of assertions have been deprecated with this version
562     and will be removed in a future one. In core all cases have been removed
563     (so it's deprecation-warnings free). It's recommended to perform the
564     switch to their new counterparts ASAP:
565       - assertInternalType() has been deprecated. Use the assertIsXXX() methods instead.
566       - assertArraySubset() has been deprecated. Use looping + assertArrayHasKey() or similar.
567       - @expectedExceptionXXX annotations have been deprecated. Use the expectExceptionXXX()
568         methods instead (and put them exactly before the line that is expected to throw the exception).
569       - assertAttributeXXX() have been deprecated. If testing public attributes use normal assertions. If
570         testing non-public attributes... you're doing something wrong :-)
571       - assertContains() to find substrings on strings has been deprecated. Use assertStringContainsString() instead.
572         (note that there are "IgnoringCase()" variants to perform case-insensitive matching.
573       - assertEquals() extra params have been deprecated and new assertions for them created:
574         - delta => use assertEqualsWithDelta()
575         - canonicalize => use assertEqualsCanonicalizing()
576         - ignoreCase => use assertEqualsIgnoringCase()
577         - maxDepth => removed without replacement.
578   - The custom printer that was used to show how to rerun a failure has been removed, it was old and "hacky"
579     solution, for more information about how to run tests, see the docs, there are plenty of options.
580   - phpunit/dbunit is not available any more and it has been replaced by a lightweight phpunit_dataset class, able to
581     load XML/CSV and PHP arrays, send the to database and return rows to calling code (in tests). That implies the
582     follwoing changes in the advanced_testcase class:
583       - createFlatXMLDataSet() has been removed. No uses in core, uses can switch to createXMLDataSet() (read below).
584       - createXMLDataSet() has been deprecated. Use dataset_from_files() instead.
585       - createCsvDataSet() has been deprecated. Use dataset_from_files() instead.
586       - createArrayDataSet() has been deprecated. This method was using the phpunit_ArrayDataSet class
587         that has been also removed from core. Use dataset_from_array() instead.
588       - loadDataSet() has been deprecated. Use phpunit_dataset->to_database() instead.
589       - All the previous uses of phpunit/dbunit methods like Dataset:getRows(), Dataset::getRowCount()
590         must be replaced by the new phpunit_dataset->get_rows() method.
591 * Retains the source course id when a course is copied from another course on the same site.
592 * Added function setScrollable in core/modal. This function can be used to set the modal's body to be scrollable or not
593   when the modal's height exceeds the browser's height. This is also supported in core/modal_factory through the
594   'scrollable' config parameter which can be set to either true or false. If not explicitly defined, the default value
595   of 'scrollable' is true.
596 * The `$CFG->behat_retart_browser_after` configuration setting has been removed.
597   The browser session is now restarted between all tests.
598 * add_to_log() has been through final deprecation, please rewrite your code to the new events API.
599 * The following functions have been finally deprecated and can not be used anymore:
600   - print_textarea
601   - calendar_get_all_allowed_types
602   - groups_get_all_groups_for_courses
603   - events_get_cached
604   - events_uninstall
605   - events_cleanup
606   - events_dequeue
607   - events_get_handlers
608   - get_roles_on_exact_context
609   - get_roles_with_assignment_on_context
610   - message_add_contact
611   - message_remove_contact
612   - message_unblock_contact
613   - message_block_contact
614   - message_get_contact
615   - get_legacy_logdata
616   - set_legacy_logdata
617   - get_legacy_eventname
618   - get_legacy_eventdata
619 * The following renamed classes have been completely removed:
620     - course_in_list (now: core_course_list_element)
621     - coursecat (now: core_course_category)
622 * The form element 'htmleditor', which was deprecated in 3.6, has been removed.
623 * The `core_output_load_fontawesome_icon_map` web service has been deprecated and replaced by
624   `core_output_load_fontawesome_icon_system_map` which takes the name of the theme to generate the icon system map for.
625 * A new parameter `$rolenamedisplay` has been added to `get_viewable_roles()` and `get_switchable_roles` to define how role names
626   should be returned.
627 * The class coursecat_sortable_records has been removed.
628 * Admin setting admin_setting_configselect now supports lazy-loading the options list by supplying
629   a callback function instead of an array of options.
630 * Admin setting admin_setting_configselect now supports validating the selection by supplying a
631   callback function.
632 * The task system has new functions adhoc_task_starting() and scheduled_task_starting() which must
633   be called before executing a task, and a new function \core\task\manager::get_running_tasks()
634   returns information about currently-running tasks.
635 * New library function rename_to_unused_name() to rename a file within its current location.
636 * Constant \core_h5p\file_storage::EDITOR_FILEAREA has been deprecated
637   because it's not required any more.
638 * The ZipStream-PHP library has been added to Moodle core in /lib/zipstream.
639 * The php-enum library has been added to Moodle core in /lib/php-enum.
640 * The http-message library has been added to Moodle core in /lib/http-message.
641 * Methods `filetypes_util::is_whitelisted()` and `filetypes_util::get_not_whitelisted()` have been deprecated and
642   renamed to `is_listed()` and `get_not_listed()` respectively.
643 * Method `mustache_helper_collection::strip_blacklisted_helpers()` has been deprecated and renamed to
644   `strip_disallowed_helpers()`.
645 * A new admin externalpage type `\core_admin\local\externalpage\accesscallback` for use in plugin settings is available that allows
646   a callback to be provided to determine whether page can be accessed.
647 * New setting $CFG->localrequestdir overrides which defaults to sys_get_temp_dir()
648 * Function redirect() now emits a line of backtrace into the X-Redirect-By header when debugging is on
649 * New DML function $DB->delete_records_subquery() to delete records based on a subquery in a way
650   that will work across databases.
651 * Add support for email DKIM signatures via $CFG->emaildkimselector
653 === 3.9 ===
654 * Following function has been deprecated, please use \core\task\manager::run_from_cli().
655     - cron_run_single_task()
656 * Following class has been deprecated, please use \core\task\manager.
657     - \tool_task\run_from_cli
658 * Following CLI scripts has been deprecated:
659   - admin/tool/task/cli/schedule_task.php please use admin/cli/scheduled_task.php
660   - admin/tool/task/cli/adhoc_task.php please use admin/cli/adhoc_task.php
661 * Old Safe Exam Browser quiz access rule (quizaccess_safebrowser) replaced by new Safe Exam Browser access rule (quizaccess_seb).
662   Experimental setting enablesafebrowserintegration was deleted.
663 * New CFPropertyList library has been added to Moodle core in /lib/plist.
664 * behat_data_generators::the_following_exist() has been removed, please use
665   behat_data_generators::the_following_entities_exist() instead. See MDL-67691 for more info.
666 * admin/tool/task/cli/adhoc_task.php now observers the concurrency limits.
667   If you want to get the previous (unlimited) behavior, use the --ignorelimits switch).
668 * Removed the following deprecated functions:
669   - question_add_tops
670   - question_is_only_toplevel_category_in_context
671 * format_float() now accepts a special value (-1) as the $decimalpoints parameter
672   which means auto-detecting number of decimal points.
673 * plagiarism_save_form_elements() has been deprecated. Please use {plugin name}_coursemodule_edit_post_actions() instead.
674 * plagiarism_get_form_elements_module() has been deprecated. Please use {plugin name}_coursemodule_standard_elements() instead.
675 * Changed default sessiontimeout to 8 hours to cover most normal working days
676 * Plugins can now explicitly declare supported and incompatible Moodle versions in version.php
677   - $plugin->supported = [37,39];
678     supported takes an array of ascending numbers, that correspond to a range of branch numbers of supported versions, inclusive.
679     Moodle versions that are outside of this range will produce a message notifying at install time, but will allow for installation.
680   - $plugin->incompatible = 36;
681     incompatible takes a single int corresponding to the first incompatible branch. Any Moodle versions including and
682     above this will be prevented from installing the plugin, and a message will be given when attempting installation.
683 * Added the <component>_bulk_user_actions() callback which returns a list of custom action_links objects
684 * Add 'required' admin flag for mod forms allows elements to be toggled between being required or not in admin settings.
685   - In mod settings, along with lock, advanced flags, the required flag can now be set with $setting->set_required_flag_options().
686     The name of the admin setting must be exactly the same as the mod_form element.
687   - Currently supported by:
688     - mod_assign
689     - mod_quiz
690 * Added a native MySQL / MariaDB lock implementation
691 * The database drivers (moodle_database and subclasses) don't need to implement get_columns() anymore.
692   They have to implement fetch_columns instead.
693 * Added function cleanup_after_drop to the database_manager class to take care of all the cleanups that need to be done after a table is dropped.
694 * The 'xxxx_check_password_policy' callback now only fires if $CFG->passwordpolicy is true
695 * grade_item::update_final_grade() can now take an optional parameter to set the grade->timemodified. If not present the current time will carry on being used.
696 * lib/outputrequirementslib::get_jsrev now is public, it can be called from other classes.
697 * H5P libraries have been moved from /lib/h5p to h5p/h5plib as an h5plib plugintype.
698 * mdn-polyfills has been renamed to polyfills. The reason there is no polyfill from the MDN is
699   because there is no example polyfills on the MDN for this functionality.
700 * AJAX pages can be called without requiring a session lock if they set READ_ONLY_SESSION to true, eg.
701   define('READ_ONLY_SESSION', true); Note - this also requires $CFG->enable_read_only_sessions to be set to true.
702 * External functions can be called without requiring a session lock if they define 'readonlysession' => true in
703   db/services.php. Note - this also requires $CFG->enable_read_only_sessions to be set to true.
704 * database_manager::check_database_schema() now checks for missing and extra indexes.
705 * Implement a more direct xsendfile_file() method for an alternative_file_system_class
706 * A new `dynamic` table interface has been defined, which allows any `flexible_table` to be converted into a table which
707   is updatable via ajax calls. See MDL-68495 and `\core_table\dynamic` for further information.
708 * The core/notification module has been updated to use AMD modals for its confirmation and alert dialogues.
709   The confirmation dialogue no longer has a configurable "No" button as per similar changes in MDL-59759.
710   This set of confirmation modals was unintentionally missed from that deprecation process.
711 * The download_as_dataformat() method has been deprecated. Please use \core\dataformat::download_data() instead
712 * The following functions have been updated to support passing in an array of group IDs (but still support passing in a single ID):
713   * groups_get_members_join()
714   * groups_get_members_ids_sql()
715 * Additional parameters were added to core_get_user_dates:
716     - type: specifies the calendar type. Optional, defaults to Gregorian.
717     - fixday: Whether to remove leading zero for day. Optional, defaults to 1.
718     - fixhour: Whether to remove leading zero for hour. Optional, defaults to 1.
719 * Legacy cron has been deprecated and will be removed in Moodle 4.1. This includes the functions:
720   - cron_execute_plugin_type()
721   - cron_bc_hack_plugin_functions()
722   Please, use the Task API instead: https://docs.moodle.org/dev/Task_API
723 * Introduce new hooks for plugin developers:
724     - <component>_can_course_category_delete($category)
725     - <component>_can_course_category_delete_move($category, $newcategory)
726   These hooks allow plugin developers greater control over category deletion. Plugin can return false in those
727   functions if category deletion or deletion with content move to the new parent category is not permitted.
728   Both $category and $newcategory params are instances of core_course_category class.
729     - <component>_pre_course_category_delete_move($category, $newcategory)
730   This hook is expanding functionality of existing <component>_pre_course_category_delete hook and allow plugin developers
731   to execute code prior to category deletion when its content is moved to another category.
732   Both $category and $newcategory params are instances of core_course_category class.
733     - <component>_get_course_category_contents($category)
734   This hook allow plugin developers to add information that is displayed on category deletion form. Function should
735   return string, which will be added to the list of category contents shown on the form. $category param is an instance
736   of core_course_category class.
737 * Data generator create_user in both unittests and behat now validates user fields and triggers user_created event
739 === 3.8 ===
740 * Add CLI option to notify all cron tasks to stop: admin/cli/cron.php --stop
741 * The rotate_image function has been added to the stored_file class (MDL-63349)
742 * The yui checknet module is removed. Call \core\session\manager::keepalive instead.
743 * The generate_uuid() function has been deprecated. Please use \core\uuid::generate() instead.
744 * Remove lib/pear/auth/RADIUS.php (MDL-65746)
745 * Core components are now defined in /lib/components.json instead of coded into /lib/classes/component.php
746 * Subplugins should now be defined using /db/subplugins.json instead of /db/subplugins.php
747 * The following functions have been finally deprecated and can not be used anymore:
748     * allow_override()
749     * allow_assign()
750     * allow_switch()
751     * https_required()
752     * verify_https_required()
753 * Remove duplicate font-awesome SCSS, Please see /theme/boost/scss/fontawesome for usage (MDL-65936)
754 * Remove lib/pear/Crypt/CHAP.php (MDL-65747)
755 * New output component available: \core\output\checkbox_toggleall
756   - This allows developers to easily output groups of checkboxes that can be toggled by master controls in the form of a checkbox or
757     a button. Action elements which perform actions on the selected checkboxes can also be enabled/disabled depending on whether
758     at least a single checkbox item is selected or not.
759 * Final deprecation (removal) of the core/modal_confirm dialogue.
760 * Upgrade scssphp to v1.0.2, This involves renaming classes from Leafo => ScssPhp as the repo has changed.
761 * Implement supports_xsendfile() method and allow support for xsendfile in alternative_file_system_class
762   independently of local files (MDL-66304).
763 * The methods get_local_path_from_storedfile and get_remote_path_from_storedfile in lib/filestore/file_system.php
764   are now public. If you are overriding these then you will need to change your methods to public in your class.
765 * It is now possible to use sub-directories for AMD modules.
766   The standard rules for Level 2 namespaces also apply to AMD modules.
767   The sub-directory used must be either an valid component, or placed inside a 'local' directory to ensure that it does not conflict with other components.
769     The following are all valid module names and locations in your plugin:
770       mod_forum/view: mod/forum/amd/src/view.js
771       mod_forum/local/views/post: mod/forum/amd/src/local/views/post
772       mod_forum/form/checkbox-toggle: mod/forum/amd/src/form/checkbox-toggle.js
774     The following are all invalid module names and locations in your plugin:
775       mod_forum/views/post: mod/forum/amd/src/views/post
776 * The 'xxxx_check_password_policy' method now has an extra parameter: $user. It contains the user object to perform password
777 validation against and defaults to null (so, no user needed) if not provided.
778 * It is now possible to use sub-directories when creating mustache templates.
779   The standard rules for Level 2 namespaces also apply to templates.
780   The sub-directory used must be either an valid component, or placed inside a 'local' directory to ensure that it does not conflict with other components.
782     The following are all valid template names and locations in your plugin:
783       mod_forum/forum_post: mod/forum/templates/forum_post.mustache
784       mod_forum/local/post/user: mod/forum/templates/local/post/user.mustache
785       mod_forum/form/checkbox_toggle: mod/forum/templates/form/checkbox_toggle.mustache
787     The following are _invalid_ template names and locations:
788       mod_forum/post/user: mod/forum/templates/local/post/user.mustache
789 * Following behat steps have been removed from core:
790     - I go to "<gradepath_string>" in the course gradebook
791 * A new admin setting widget 'core_admin\local\settings\filesize' is added.
792 * Core capabilities 'moodle/community:add' and 'moodle/community:download' have been removed from core as part of Moodle.net sunsetting.
793 * As part of Moodle.net sunsetting process the following hub api functions have been deprecated:
794     - get_courses
795     - unregister_courses
796     - register_course
797     - add_screenshot
798     - download_course_backup
799     - upload_course_backup
800 * A new setting 'Cache templates' was added (see MDL-66367). This setting determines if templates are cached or not.
801   This setting can be set via the UI or by defining $CFG->cachetemplates in your config.php file. It is a boolean
802   and should be set to either false or true. Developers will probably want to set this to false.
803 * The core_enrol_edit_user_enrolment webservice has been deprecated. Please use core_enrol_submit_user_enrolment_form instead.
804 * \single_button constructor has a new attributes param to add attributes to the button HTML tag.
805 * Improved url matching behaviour for profiled urls and excluded urls
806 * Attempting to use xsendfile via the 3rd param of readstring_accel() is now ignored.
807 * New H5P libraries have been added to Moodle core in /lib/h5p.
808 * New H5P core subsystem have been added.
809 * Introduced new callback for plugin developers '<component>_get_path_from_pluginfile($filearea, $args)': This will return
810 the itemid and filepath for the filearea and path defined in $args. It has been added in order to get the correct itemid and
811 filepath because some components, such as mod_page or mod_resource, add the revision to the URL where the itemid should be placed
812 (to prevent caching problems), but then they don't store it in database.
813 * New utility function \core_form\util::form_download_complete should be called if your code sends
814   a file with Content-Disposition: Attachment in response to a Moodle form submit button (to ensure
815   that disabled submit buttons get re-enabled in that case). It is automatically called by the
816   filelib.php send_xx functions.
817 * If you have a form which sends a file in response to a Moodle form submit button, but you cannot
818   call the above function because the file is sent by a third party library, then you should add
819   the attribute data-double-submit-protection="off" to your form.
821 === 3.7 ===
823 * Nodes in the navigation api can have labels for each group. See set/get_collectionlabel().
824 * The method core_user::is_real_user() now returns false for userid = 0 parameter
825 * 'mform1' dependencies (in themes, js...) will stop working because a randomly generated string has been added to the id
826 attribute on forms to avoid collisions in forms loaded in AJAX requests.
827 * A new method to allow queueing or rescheduling of an existing scheduled task was added. This allows an existing task
828   to be updated or queued as required. This new functionality can be found in \core\task\manager::reschedule_or_queue_adhoc_task.
829 * Icons are displayed for screen readers unless they have empty alt text (aria-hidden). Do not provide an icon with alt text immediately beside an element with exactly the same text.
830 * admin_settingpage has a new function hide_if(), modeled after the same functionality in the forms library. This allows admin settings to be dynamically hidden based on the values of other settings.
831 * The \core_rating provider's get_sql_join function now accepts an optional $innerjoin parameter.
832   It is recommended that privacy providers using this function call rewrite any long query into a number of separate
833   calls to add_from_sql for improved performance, and that the new argument is used.
834   This will allow queries to remain backwards-compatible with older versions of Moodle but will have significantly better performance in version supporting the innerjoin parameter.
835 * /message/defaultoutputs.php file and admin_page_defaultmessageoutputs class have been deprecated
836   and all their settings moved to admin/message.php (see MDL-64495). Please use admin_page_managemessageoutputs class instead.
837 * A new parameter $lang has been added to mustache_template_source_loader->load_with_dependencies() method
838   so it is possible for Mustache to request string in a specific language.
839 * Behat timeout constants behat_base::TIMEOUT, EXTENDED_TIMEOUT, and REDUCED_TIMEOUT have been
840   deprecated. Please instead use the functions behat_base::get_timeout(), get_extended_timeout(),
841   and get_reduced_timeout(). These allow for timeouts to be increased by a setting in config.php.
842 * The $draftitemid parameter of file_save_draft_area_files() function now supports the constant IGNORE_FILE_MERGE:
843   When the parameter is set to that constant, the function won't process file merging, keeping the original state of the file area.
844   Notice also than when $text is set, pluginfile rewrite won't be processed so the text will not be modified.
845 * Introduced new callback for plugin developers '<component>_pre_processor_message_send($procname, $proceventdata)':
846   This will allow any plugin to manipulate messages or notifications before they are sent by a processor (email, mobile...)
847 * New capability 'moodle/category:viewcourselist' in category context that controls whether user is able to browse list of courses
848   in this category. To work with list of courses use API methods in core_course_category and also 'course' form element.
849 * It is possible to pass additional conditions to get_courses_search();
850   core_course_category::search_courses() now allows to search only among courses with completion enabled.
851 * Add support for a new xxx_after_require_login callback
852 * A new conversation type has been created for self-conversations. During the upgrading process:
853   - Firstly, the existing self-conversations will be starred and migrated to the new type, removing the duplicated members in the
854   message_conversation_members table.
855   - Secondly, the legacy self conversations will be migrated from the legacy 'message_read' table. They will be created using the
856   new conversation type and will be favourited.
857   - Finally, the self-conversations for all remaining users without them will be created and starred.
858 Besides, from now, a self-conversation will be created and starred by default to all the new users (even when $CFG->messaging
859 is disabled).
860 * New optional parameter $throwexception for \get_complete_user_data(). If true, an exception will be thrown when there's no
861   matching record found or when there are multiple records found for the given field value. If false, it will simply return false.
862   Defaults to false when not set.
863 * Exposed submit button to allow custom styling (via customclassoverride variable) which can override btn-primary/btn-secondary classes
864 * `$includetoken` parameter type has been changed. Now supports:
865    boolean: False indicates to not include the token, true indicates to generate a token for the current user ($USER).
866    integer: Indicates to generate a token for the user whose id is the integer value.
867 * The following functions have been updated to support the new usage:
868     - make_pluginfile_url
869     - file_rewrite_pluginfile_urls
870 * New mform element 'float' handles localised floating point numbers.
872 === 3.6 ===
874 * A new token-based version of pluginfile.php has been added which can be used for out-of-session file serving by
875   setting the `$includetoken` parameter to true on the `moodle_url::make_pluginfile_url()`, and
876   `moodle_url::make_file_url()` functions.
877 * The following picture functions have been updated to support use of the new token-based file serving:
878     - print_group_picture
879     - get_group_picture_url
880 * The `user_picture` class has a new public `$includetoken` property which can be set to make use of the new token-based
881   file serving.
882 * Custom AJAX handlers for the form autocomplete fields can now optionally return string in their processResults()
883   callback. If a string is returned, it is displayed instead of the list of suggested items. This can be used, for
884   example, to inform the user that there are too many items matching the current search criteria.
885 * The form element 'htmleditor' has been deprecated. Please use the 'editor' element instead.
886 * The print_textarea() function has been deprecated. Please use $OUTPUT->print_textarea() instead.
887 * The following functions have been finally deprecated and can not be used any more:
888     - external_function_info()
889     - core_renderer::update_module_button()
890     - events_trigger()
891     - events_cron()
892     - events_dispatch()
893     - events_is_registered()
894     - events_load_def()
895     - events_pending_count()
896     - events_process_queued_handler()
897     - events_queue_handler()
898     - events_trigger_legacy()
899     - events_update_definition()
900     - get_file_url()
901     - course_get_cm_rename_action()
902     - course_scale_used()
903     - site_scale_used()
904     - clam_message_admins()
905     - get_clam_error_code()
906     - get_records_csv()
907     - put_records_csv()
908     - print_log()
909     - print_mnet_log()
910     - print_log_csv()
911     - print_log_xls()
912     - print_log_ods()
913     - build_logs_array()
914     - get_logs_usercourse()
915     - get_logs_userday()
916     - get_logs()
917     - prevent_form_autofill_password()
918     - prefixed_tablenode_transformations()
919     - core_media_renderer
920     - core_media
921 * Following api's have been removed in behat_config_manager, please use behat_config_util instead.
922     - get_features_with_tags()
923     - get_components_steps_definitions()
924     - get_config_file_contents()
925     - merge_behat_config()
926     - get_behat_profile()
927     - profile_guided_allocate()
928     - merge_config()
929     - clean_path()
930     - get_behat_tests_path()
931 * Following behat steps have been removed from core:
932     - I set the field "<field_string>" to multiline
933     - I follow "<link_string>"" in the open menu
934 * The following behat steps have been deprecated, please do not use these step definitions any more:
935     - behat_navigation.php: i_navigate_to_node_in()
936     - theme/boost/tests/behat/behat_theme_boost_behat_navigation.php: i_navigate_to_node_in()
937   Use one of the following steps instead:
938     - I navigate to "PATH > ITEM" in current page administration
939     - I navigate to "PATH > ITEM" in site administration
940     - I navigate to course participants
941     - I navigate to "TAB1 > TAB2" in the course gradebook
942   If some items are not available without Navigation block at all, one can use combination of:
943     - I add the "Navigation" block if not present
944     - I click on "LINK" "link" in the "Navigation" "block"
945 * The core\session\util class has been removed. This contained one function only used by the memcached class which has
946   been moved there instead (connection_string_to_memcache_servers).
947 * Removed the lib/password_compat/lib/password.php file.
948 * The eventslib.php file has been deleted and its functions have been moved to deprecatedlib.php. The affected functions are:
949   - events_get_cached()
950   - events_uninstall()
951   - events_cleanup()
952   - events_dequeue()
953   - events_get_handlers()
954 * coursecat::get() now has optional $user parameter.
955 * coursecat::is_uservisible() now has optional $user parameter.
956 * Removed the lib/form/submitlink.php element which was deprecated in 3.2.
957 * The user_selector classes do not support custom list of extra identity fields any more. They obey the configured user
958   policy and respect the privacy setting made by site administrators. The list of user identifiers should never be
959   hard-coded. Instead, the setting $CFG->showuseridentity should be always respected, which has always been the default
960   behaviour (MDL-59847).
961 * The function message_send() in messagelib.php will now only take the object \core\message\message as a parameter.
962 * The method message_sent::create_from_ids() parameter courseid is now required. A debugging
963   message was previously displayed, and the SITEID was used, when not provided.
964 * The method \core\message\manager::send_message() now only takes the object \core\message\message as the first parameter.
965 * Following functions have been deprecated, please use get_roles_used_in_context.
966     - get_roles_on_exact_context()
967     - get_roles_with_assignment_on_context()
968 * New functions to support the merging of user draft areas from the interface; see MDL-45170 for details:
969   - file_copy_file_to_file_area()
970   - file_merge_draft_areas()
971   - file_replace_file_area_in_text()
972   - extract_draft_file_urls_from_text()
973 * Class coursecat is now alias to autoloaded class core_course_category, course_in_list is an alias to
974   core_course_list_element, class coursecat_sortable_records is deprecated without replacement.
975 * \core_user_external::create_users() and \core_user_external::update_users() can now accept more user profile fields so user
976   creation/update via web service can now be very similar to the edit profile page's functionality. The new fields that have been
977   added are:
978   - maildisplay
979   - interests
980   - url
981   - icq
982   - skype
983   - aim
984   - yahoo
985   - msn
986   - institution
987   - department
988   - phone1
989   - phone2
990   - address
991 * New function mark_user_dirty() must be called after changing data that gets cached in user sessions. Examples:
992   - Assigning roles to users.
993   - Unassigning roles from users.
994   - Enrolling users into courses.
995   - Unenrolling users from courses.
996 * New optional parameter $context for the groups_get_members_join() function and ability to filter users that are not members of
997 any group. Besides, groups_get_members_ids_sql, get_enrolled_sql and get_enrolled_users now accepts -1 (USERSWITHOUTGROUP) for
998 the groupid field.
999 * Added $CFG->conversionattemptlimit setting to config.php allowing a maximum number of retries before giving up conversion
1000   of a given document by the assignfeedback_editpdf\task\convert_submissions task. Default value: 3.
1001 * The following events have been deprecated and should not be used any more:
1002   - message_contact_blocked
1003   - message_contact_unblocked
1004   The reason for this is because you can now block/unblock users without them necessarily being a contact. These events
1005   have been replaced with message_user_blocked and message_user_unblocked respectively.
1006 * The event message_deleted has been changed, it no longer records the value of the 'useridto' due to
1007   the introduction of group messaging. Please, if you have any observers or are triggering this event
1008   in your code you will have to make some changes!
1009 * The gradebook now supports the ability to accept files as feedback. This can be achieved by adding
1010   'feedbackfiles' to the $grades parameter passed to grade_update().
1011     For example -
1012         $grades['feedbackfiles'] = [
1013             'contextid' => 1,
1014             'component' => 'mod_xyz',
1015             'filearea' => 'mod_xyz_feedback',
1016             'itemid' => 2
1017         ];
1018   These files will be then copied to the gradebook file area.
1019 * Allow users to choose who can message them for privacy reasons, with a 'growing circle of contactability':
1020   - Added $CFG->messagingallusers, for enabling messaging to all site users. Default value: 0.
1021     When $CFG->messagingallusers = false users can choose being contacted by only contacts or contacts and users sharing a course with them.
1022     In that case, the default user preference is MESSAGE_PRIVACY_COURSEMEMBER (users sharing a course).
1023     When $CFG->messagingallusers = true users have a new option for the privacy messaging preferences: "Anyone on the site". In that case,
1024     the default user preference is MESSAGE_PRIVACY_SITE (all site users).
1025   - Added $CFG->keepmessagingallusersenabled setting to config.php to force enabling $CFG->messagingallusers during the upgrading process.
1026     Default value: 0.
1027     When $CFG->keepmessagingallusersenabled is set to true, $CFG->messagingallusers will be also set to true to enable messaging site users.
1028     However, when it is empty, $CFG->messagingallusers will be disabled during the upgrading process, so the users will only be able to
1029     message contacts and users sharing a course with them.
1030 * There has been interface and functional changes to admin_apply_default_settings() (/lib/adminlib.php).  The function now takes two
1031   additional optional parameters, $admindefaultsettings and $settingsoutput.  It also has a return value $settingsoutput.
1032   The function now does not need to be called twice to ensure all default settings are set.  Instead the function calls itself recursively
1033   until all settings have been set. The additional parameters are used recursively and shouldn't be need to be explicitly passed in when calling
1034   the function from other parts of Moodle.
1035   The return value: $settingsoutput is an array of setting names and the values that were set by the function.
1036 * Webservices no longer update the lastaccess time for a user in a course. Call core_course_view_course() manually if needed.
1037 * A new field has been added to the context table. Please ensure that any contxt preloading uses get_preload_record_columns_sql or get_preload_record_columns to fetch the list of columns.
1039 === 3.5 ===
1041 * There is a new privacy API that every subsystem and plugin has to implement so that the site can become GDPR
1042   compliant. Plugins use this API to report what information they store or process regarding users, and provide ability
1043   to export and delete personal data. See https://docs.moodle.org/dev/Privacy_API for guidelines on how to implement the
1044   privacy API in your plugin.
1045 * The cron runner now sets up a fresh PAGE and OUTPUT between each task.
1046 * The core_renderer methods notify_problem(), notify_success(), notify_message() and notify_redirect() that were
1047   deprecated in Moodle 3.1 have been removed. Use \core\notification::add(), or \core\output\notification as required.
1048 * The maximum supported precision (the total number of digits) for XMLDB_TYPE_NUMBER ("number") fields raised from 20 to
1049   38 digits. Additionally, the whole number part (precision minus scale) must not be longer than the maximum length of
1050   integer fields (20 digits). Note that PHP floats commonly support precision of roughly 15 digits only (MDL-32113).
1051 * Event triggering and event handlers:
1052     - The following events, deprecated since moodle 2.6, have been finally removed: groups_members_removed,
1053       groups_groupings_groups_removed, groups_groups_deleted, groups_groupings_deleted.
1054 * The following functions have been finally deprecated and can not be used any more:
1055   - notify()
1056 * XMLDB now validates the PATH attribute on every install.xml file. Both the XMLDB editor and installation will fail
1057   when a problem is detected with it. Please ensure your plugins contain correct directory relative paths.
1058 * Add recaptchalib_v2.php for support of reCAPTCHA v2.
1059 * Plugins can define class 'PLUGINNAME\privacy\local\sitepolicy\handler' if they implement an alternative mechanisms for
1060   site policies managements and agreements. Administrators can define which component is to be used for handling site
1061   policies and agreements. See https://docs.moodle.org/dev/Site_policy_handler
1062 * Scripts can define a constant NO_SITEPOLICY_CHECK and set it to true before requiring the main config.php file. It
1063   will make the require_login() skipping the test for the user's policyagreed status. This is useful for plugins that
1064   act as a site policy handler.
1065 * There is a new is_fulltext_search_supported() DML function. The default implementation returns false. This function
1066   is used by 'Simple search' global search engine to determine if the database full-text search capabilities can be used.
1067 * The following have been removed from the list of core subsystems:
1068    - core_register
1069    - core_publish
1070   Following this change, \core_register_renderer and \core_publish_renderer have been removed and their methods have been
1071   moved to \core_admin_renderer and \core_course_renderer respectively.
1073 === 3.4 ===
1075 * oauth2_client::request method has an extra parameter to specify the accept header for the response (MDL-60733)
1076 * The following functions, previously used (exclusively) by upgrade steps are not available
1077   anymore because of the upgrade cleanup performed for this version. See MDL-57432 for more info:
1078     - upgrade_mimetypes()
1079     - upgrade_fix_missing_root_folders_draft()
1080     - upgrade_minmaxgrade()
1081     - upgrade_course_tags()
1083 * Added new moodleform element 'filetypes' and new admin setting widget 'admin_setting_filetypes'. These new widgets
1084   allow users to define a list of file types; either by typing them manually or selecting them from a list. The widgets
1085   directly support the syntax used to feed the 'accepted_types' option of the filemanager and filepicker elements. File
1086   types can be specified as extensions (.jpg or just jpg), mime types (text/plain) or groups (image).
1087 * Removed accesslib private functions: load_course_context(), load_role_access_by_context(), dedupe_user_access() (MDL-49398).
1088 * Internal "accessdata" structure format has changed to improve ability to perform role definition caching (MDL-49398).
1089 * Role definitions are no longer cached in user session (MDL-49398).
1090 * External function core_group_external::get_activity_allowed_groups now returns an additional field: canaccessallgroups.
1091   It indicates whether the user will be able to access all the activity groups.
1092 * file_get_draft_area_info does not sum the root folder anymore when calculating the foldercount.
1093 * The moodleform element classes can now optionally provide a public function validateSubmitValue(). This method can be
1094   used to perform implicit validation of submitted values - without the need to explicitly add the validation rules to
1095   every form. The method should accept a single parameter with the submitted value. It should return a string with the
1096   eventual validation error, or an empty value if the validation passes.
1097 * New user_picture attribute $includefullname to determine whether to include the user's full name with the user's picture.
1098 * Enrol plugins which provide enrolment actions can now declare the following "data-action" attributes in their implementation of
1099   enrol_plugin::get_user_enrolment_actions() whenever applicable:
1100   * "editenrolment" - For editing a user'e enrolment details. Defined by constant ENROL_ACTION_EDIT.
1101   * "unenrol" - For unenrolling a student. Defined by constant ENROL_ACTION_UNENROL.
1102   These attributes enable enrol actions to be rendered via modals. If not added, clicking on the enrolment action buttons will still
1103   redirect the user to the appropriate enrolment action page. Though optional, it is recommended to add these attributes for a
1104   better user experience when performing enrol actions.
1105 * The enrol_plugin::get_user_enrolment_actions() implementations for core enrol plugins have been removed and moved to
1106   the parent method itself. New enrol plugins don't have to implement get_user_enrolment_actions(), but just need to
1107   make sure that they override:
1108   - enrol_plugin::allow_manage(), and/or
1109   - enrol_plugin::allow_unenrol_user() or enrol_plugin::allow_unenrol()
1110   Existing enrol plugins that override enrol_plugin::get_user_enrolment_actions() don't have to do anything, but can
1111   also opt to remove their own implementation of the method if they basically have the same logic as the parent method.
1112 * New optional parameter $enrolid for the following functions:
1113   - get_enrolled_join()
1114   - get_enrolled_sql()
1115   - get_enrolled_with_capabilities_join()
1116   Setting this parameter to a non-zero value will add a condition to the query such that only users that were enrolled
1117   with this enrolment method will be returned.
1118 * New optional parameter 'closeSuggestionsOnSelect' for the enhance() function for form-autocomplete. Setting this to true will
1119   close the suggestions popup immediately after an option has been selected. If not specified, it defaults to true for single-select
1120   elements and false for multiple-select elements.
1121 * user_can_view_profile() now also checks the moodle/user:viewalldetails capability.
1122 * The core/modal_confirm dialogue has been deprecated. Please use the core/modal_save_cancel dialogue instead. Please ensure you
1123   update to use the ModalEvents.save and ModalEvents.cancel events instead of their yes/no counterparts.
1124 * Instead of checking the 'moodle/course:viewparticipants' and 'moodle/site:viewparticipants' capabilities use the
1125   new functions course_can_view_participants() and course_require_view_participants().
1126 * $stored_file->add_to_curl_request() now adds the filename to the curl request.
1127 * The option for Login HTTPS (authentication-only SSL) has been removed
1128 * $CFG->loginhttps is now deprecated, do not use it.
1129 * $PAGE->https_required and $PAGE->verify_https_required() are now deprecated. They are no longer used and will throw a coding_exception.
1130 * $CFG->httpswwwroot is now deprecated and will always result in the same value as wwwroot.
1131 * Added function core_role_set_view_allowed() to check if a user should be able to see a given role.
1132   This should be checked whenever displaying a list of roles to a user, however, core_role_set_assign_allowed may need to override it
1133   in some cases.
1134 * Deprecated allow_override, allow_assign and allow_switch and replaced with core_role_set_*_allowed to avoid function names conflicting.
1136 === 3.3.1 ===
1138 * ldap_get_entries_moodle() now always returns lower-cased attribute names in the returned entries.
1139   It was suppposed to do so before, but it actually didn't.
1141 === 3.3 ===
1143 * Behat compatibility changes are now being documented at
1144   https://docs.moodle.org/dev/Acceptance_testing/Compatibility_changes
1145 * PHPUnit's bootstrap has been changed to use HTTPS wwwroot (https://www.example.com/moodle) from previous HTTP version. Any
1146   existing test expecting the old HTTP URLs will need to be switched to the new HTTPS value (reference: MDL-54901).
1147 * The information returned by the idp list has changed. This is usually only rendered by the login page and login block.
1148   The icon attribute is removed and an iconurl attribute has been added.
1149 * Support added for a new type of external file: FILE_CONTROLLED_LINK. This is an external file that Moodle can control
1150   the permissions. Moodle makes files read-only but can grant temporary write access.
1151     When accessing a URL, the info from file_browser::get_file_info will be checked to determine if the user has write access,
1152     if they do - the remote file will have access controls set to allow editing.
1153 * The method moodleform::after_definition() has been added and can now be used to add some logic
1154   to be performed after the form's definition was set. This is useful for intermediate subclasses.
1155 * Moodle has support for font-awesome icons. Plugins should use the xxx_get_fontawesome_icon_map callback
1156   to map their custom icons to one from font-awesome.
1157 * $OUTPUT->pix_url() has been deprecated because it is was used mostly to manually generate image tags for icons.
1158   We now distinguish between icons and "small images". The difference is that an icon does not have to be rendered as an image tag
1159   with a source. It is OK to still have "small images" - if this desired use $OUTPUT->image_icon() and $OUTPUT->image_url(). For
1160   other uses - use $OUTPUT->pix_icon() or the pix helper in mustache templates {{#pix}}...{{/pix}}
1161   For other valid use cases use $OUTPUT->image_url().
1162 * Activity icons have been split from standard icons. Use $OUTPUT->image_icon instead of $OUTPUT->pix_icon for these
1163   type of icons (the coloured main icon for each activity).
1164 * YUI module moodle-core-formautosubmit has been removed, use jquery .change() instead (see lib/templates/url_select.mustache for
1165   an example)
1166 * $mform->init_javascript_enhancement() is deprecated and no longer does anything. Existing uses of smartselect enhancement
1167   should be switched to the searchableselector form element or other solutions.
1168 * Return value of the validate_email() is now proper boolean as documented. Previously the function could return 1, 0 or false.
1169 * The mcore YUI rollup which included various YUI modules such as moodle-core-notification is no longer included on every
1170   page. Missing YUI depdencies may be exposed by this change (e.g. missing a requirement on moodle-core-notification when
1171   using M.core.dialogue).
1172 * Various legacy javascript functions have been removed:
1173     * M.util.focus_login_form and M.util.focus_login_error no longer do anything. Please use jquery instead. See
1174       lib/templates/login.mustache for an example.
1175     * Some outdated global JS functions have been removed and should be replaced with calls to jquery
1176       or alternative approaches:
1177         checkall, checknone, select_all_in_element_with_id, select_all_in, deselect_all_in, confirm_if, findParentNode,
1178         filterByParent, stripHTML
1179     * M.util.init_toggle_class_on_click has been removed.
1180 * The following functions have been deprecated and should not be used any more:
1181   - file_storage::try_content_recovery  - See MDL-46375 for more information
1182   - file_storage::content_exists        - See MDL-46375 for more information
1183   - file_storage::deleted_file_cleanup  - See MDL-46375 for more information
1184   - file_storage::get_converted_document
1185   - file_storage::is_format_supported_by_unoconv
1186   - file_storage::can_convert_documents
1187   - file_storage::send_test_pdf
1188   - file_storage::test_unoconv_path
1189 * Following behat steps have been removed from core:
1190     - I click on "<element_string>" "<selector_string>" in the "<row_text_string>" table row
1191     - I go to notifications page
1192     - I add "<filename_string>" file from recent files to "<filepicker_field_string>" filepicker
1193     - I upload "<filepath_string>" file to "<filepicker_field_string>" filepicker
1194     - I create "<foldername_string>" folder in "<filepicker_field_string>" filepicker
1195     - I open "<foldername_string>" folder from "<filepicker_field_string>" filepicker
1196     - I unzip "<filename_string>" file from "<filepicker_field_string>" filepicker
1197     - I zip "<filename_string>" folder from "<filepicker_field_string>" filepicker
1198     - I delete "<file_or_folder_name_string>" from "<filepicker_field_string>" filepicker
1199     - I send "<message_contents_string>" message to "<username_string>"
1200     - I add "<user_username_string>" user to "<cohort_idnumber_string>" cohort
1201     - I add "<username_string>" user to "<group_name_string>" group
1202     - I fill in "<field_string>" with "<value_string>"
1203     - I select "<option_string>" from "<select_string>"
1204     - I select "<radio_button_string>" radio button
1205     - I check "<option_string>"
1206     - I uncheck "<option_string>"
1207     - the "<field_string>" field should match "<value_string>" value
1208     - the "<checkbox_string>" checkbox should be checked
1209     - the "<checkbox_string>" checkbox should not be checked
1210     - I fill the moodle form with:
1211     - "<element_string>" "<selector_string>" should exists
1212     - "<element_string>" "<selector_string>" should not exists
1213     - the following "<element_string>" exists:
1214 * get_user_capability_course() now has an additional parameter 'limit'. This can be used to return a set number of records with
1215   the submitted capability. The parameter 'fieldsexceptid' will now accept context fields which can be used for preloading.
1216 * The caching option 'immutable' has been added to send_stored_file() and send_file().
1217 * New adhoc task refresh_mod_calendar_events_task that updates existing calendar events of modules.
1218 * New 'priority' column for the event table to determine which event to show in case of events with user and group overrides.
1219 * Webservices core_course_search_courses and core_course_get_courses_by_field will always return the sortorder field.
1220 * core_course_external::get_activities_overview has been deprecated. Please do not call this function any more.
1221 * Changed the pix mustache template helper to accept context variables for the key, component and alt text.
1222 * New auth_plugin_base helper methods:
1223   - get_identity_providers() - Retrieves available auth identity providers.
1224   - prepare_identity_providers_for_output() - Prepares auth identity provider data for output (e.g. to templates, WS, etc.).
1226 === 3.2 ===
1228 * Custom roles with access to any part of site administration that do not use the manager archetype will need
1229   moodle/site:configview capability added.
1230 * Admin setting "Show My courses expanded on Dashboard" has been removed.
1231 * Some backwards and forwards compatibility has been added for different bootstrap versions.
1232   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
1233   with bootstrap classes to keep working in the new theme. See MDL-56004 for the list of supported classes.
1234 * MForms element 'submitlink' has been deprecated.
1235 * Searchable selector form element is now a wrapper for autocomplete. A "No selection" option is automatically
1236   added to the options list for best backwards compatibility - if you were manually adding a "no selection" option you will need
1237   to remove it.
1238 * Node.js versions >=4 are now required to run grunt.
1239 * JQuery has been updated to 3.1.0. JQuery migrate plugins are no longer shipped - please read
1240   https://jquery.com/upgrade-guide/3.0/ and update your javascript.
1241 * New option 'blanktarget' added to format_text. This option adds target="_blank" to links
1242 * A new webservice structure `external_files` has been created which provides a standardised view of files in Moodle and
1243   should be used for all file return descriptions.
1244   Files matching this format can be retrieved via the new `external_util::get_area_files` method.
1245   See MDL-54951 for further information.
1246 * The parameter $usepost of the following functions has been deprecated and is not used any more:
1247   - get_max_upload_file_size()
1248   - get_user_max_upload_file_size()
1249 * The following classes have been removed and should not be used any more:
1250     - boxclient - See MDL-49599 for more information.
1251 * The following functions have been removed and should not be used any more:
1252     - file_modify_html_header() - See MDL-29738 for more information.
1253 * core_grades_external::get_grades has been deprecated. Please do not call this function any more.
1254   External function gradereport_user_external::get_grade_items can be used for retrieving the course grades information.
1255 * New option 'escape' added to format_string. When true (default), escapes HTML entities from the string
1256 * The following functions have been deprecated and are not used any more:
1257   - get_records_csv() Please use csv_import_reader::load_csv_content() instead.
1258   - put_records_csv() Please use download_as_dataformat (lib/dataformatlib.php) instead.
1259   - zip_files()   - See MDL-24343 for more information.
1260   - unzip_file()  - See MDL-24343 for more information.
1261   - print_log()           - See MDL-43681 for more information
1262   - print_log_csv()       - See MDL-43681 for more information
1263   - print_log_ods()       - See MDL-43681 for more information
1264   - print_log_xls()       - See MDL-43681 for more information
1265   - print_mnet_log()      - See MDL-43681 for more information
1266   - build_logs_array()    - See MDL-43681 for more information
1267   - get_logs()            - See MDL-43681 for more information
1268   - get_logs_usercourse() - See MDL-43681 for more information
1269   - get_logs_userday()    - See MDL-43681 for more information
1270   - prevent_form_autofill_password() Please do not use anymore.
1271 * The password_compat library was removed as it is no longer required.
1272 * Phpunit has been upgraded to 5.4.x and following has been deprecated and is not used any more:
1273   - setExpectedException(), use @expectedException or $this->expectException() and $this->expectExceptionMessage()
1274   - getMock(), use createMock() or getMockBuilder()->getMock()
1275   - UnitTestCase class is removed.
1276 * The following methods have been finally deprecated and should no longer be used:
1277   - course_modinfo::build_section_cache()
1278   - cm_info::get_deprecated_group_members_only()
1279   - cm_info::is_user_access_restricted_by_group()
1280 * The following methods in cm_info::standardmethods have also been finally deprecated and should no longer be used:
1281   - cm_info::get_after_edit_icons()
1282   - cm_info::get_after_link()
1283   - cm_info::get_content()
1284   - cm_info::get_custom_data()
1285   - cm_info::get_extra_classes()
1286   - cm_info::get_on_click()
1287   - cm_info::get_url()
1288   - cm_info::obtain_dynamic_data()
1289   Calling them through the magic method __call() will throw a coding exception.
1290 * The alfresco library has been removed from core. It was an old version of
1291   the library which was not compatible with newer versions of Alfresco.
1292 * Added down arrow: $OUTPUT->darrow.
1293 * All file_packer implementations now accept an additional parameter to allow a simple boolean return value instead of
1294   an array of individual file statuses.
1295 * "I set the field "field_string" to multiline:" now end with colon (:), as PyStrings is supposed to end with ":"
1296 * New functions to support deprecation of events have been added to the base event. See MDL-46214 for further details.
1297 * A new function `get_name_with_info` has been added to the base event. This function adds information about event
1298   deprecations and should be used where this information is relevant.
1299 * Following api's have been deprecated in behat_config_manager, please use behat_config_util instead.
1300   - get_features_with_tags
1301   - get_components_steps_definitions
1302   - get_config_file_contents
1303   - merge_behat_config
1304   - get_behat_profile
1305   - profile_guided_allocate
1306   - merge_config
1307   - clean_path
1308   - get_behat_tests_path
1309 * behat_util::start_test_mode() accepts 3 options now:
1310   - 1. Theme sute with all features: If behat should initialise theme suite with all core features.
1311   - 2. Parallel runs: How many parallel runs will be running.
1312   - 3. Run: Which process behat should be initialise for.
1313 * behat_context_helper::set_session() has been deprecated, please use behat_context_helper::set_environment() instead.
1314 * data-fieldtype="type" attribute has been added to form field default template.
1315 * form elements extending MoodleQuickForm_group must call $this->createFormElement() instead of
1316   @MoodleQuickForm::createElement() in order to be compatible with PHP 7.1
1317 * Relative paths in $CFG->alternateloginurl will be resolved to absolute path within moodle site. Previously they
1318   were resolved to absolute path within the server. That means:
1319   - $CFG->wwwroot: http://example.com/moodle
1320   - $CFG->alternateloginurl : /my/super/login.php
1321   - Login url will be: http://example.com/moodle/my/super/login.php (moodle root based)
1322 * Database (DML) layer:
1323   - new sql_equal() method available for places where case sensitive/insensitive varchar comparisons are required.
1324 * PostgreSQL connections now use advanced options to reduce connection overhead.  These options are not compatible
1325   with some connection poolers.  The dbhandlesoptions parameter has been added to allow the database to configure the
1326   required defaults. The parameters that are required in the database are;
1327     ALTER DATABASE moodle SET client_encoding = UTF8;
1328     ALTER DATABASE moodle SET standard_conforming_strings = on;
1329     ALTER DATABASE moodle SET search_path = 'moodle,public';  -- Optional, if you wish to use a custom schema.
1330   You can set these options against the database or the moodle user who connects.
1331 * Some form elements have been refined to better support right-to-left languages. In RTL,
1332   most fields should not have their direction flipped, a URL, a path to a file, a number, ...
1333   are always displayed LTR. Input fields and text areas now will best guess whether they
1334   should be forced to be displayed in LTR based on the PARAM type associated with it. You
1335   can call $mform->setForceLtr($elementName, true/false) on some form fields to manually
1336   set the value.
1337 * Action menus do_not_enhance() is deprecated, use a list of action_icon instead.
1338 * The user_not_fully_set_up() function has a new $strict parameter (defaulting to true) in order to decide when
1339   custom fields (and other checks) should be evaluated to determine if the user has been completely setup.
1340 * profile_field_base class has new methods: get_field_config_for_external() and get_field_properties().
1341   This two new methods should be implemented by profile field plugins to make them compatible with Web Services.
1342 * The minifier library used by core_minify has been switched to https://github.com/matthiasmullie/minify - there are minor differences
1343   in minifier output.
1344 * context_header additional buttons can now have a class attribute provided in the link attributes.
1345 * The return signature for the antivirus::scan_file() function has changed.
1346   The calling function will now handle removal of infected files from Moodle based on the new integer return value.
1347 * The first parameter $eventdata of both message_send() and \core\message\manager::send_message() should
1348   be \core\message\message. Use of stdClass is deprecated.
1349 * The message_sent event now expects other[courseid] to be always set, exception otherwise. For BC with contrib code,
1350   message_sent::create_from_ids() will show a debugging notice if the \core\message\message being sent is missing
1351   the courseid property, defaulting to SITEID automatically. In Moodle 3.6 (MDL-55449) courseid will be fully mandatory
1352   for all messages sent.
1353 * The send_confirmation_email() function has a new optional parameter $confirmationurl to provide a different confirmation URL.
1354 * Introduced a new hook for plugin developers:
1355     - <component>_course_module_background_deletion_recommended()
1356   This hook should be used in conjunction with the existing '<component>_pre_course_module_delete($mod)'. It must
1357   return a boolean and is called by core to check whether a plugin's implementation of
1358   <component>_pre_course_module_deleted($mod) will take a long time. A plugin should therefore only implement this
1359   function if it also implements <component>_pre_course_module_delete($mod).
1360   An example in current use is recyclebin, which performs what can be a lengthy backup process in
1361   tool_recyclebin_pre_course_module_delete. The recyclebin, if enabled, now returns true in its implementation of
1362   tool_recyclebin_course_module_background_deletion_recommended(), to indicate to core that the deletion (and
1363   execution of tool_recyclebin_pre_course_module_delete) should be handled with an adhoc task, meaning it will not
1364   occur in real time.
1366 === 3.1 ===
1368 * Webservice function core_course_search_courses accepts a new parameter 'limittoenrolled' to filter the results
1369   only to courses the user is enrolled in, and are visible to them.
1370 * External functions that are not calling external_api::validate_context are buggy and will now generate
1371   exceptions. Previously they were only generating warnings in the webserver error log.
1372   See https://docs.moodle.org/dev/External_functions_API#Security
1373 * The moodle/blog:associatecourse and moodle/blog:associatemodule capabilities has been removed.
1374 * The following functions has been finally deprecated and can not be used any more:
1375     - profile_display_badges()
1376     - useredit_shared_definition_preferences()
1377     - calendar_normalize_tz()
1378     - get_user_timezone_offset()
1379     - get_timezone_offset()
1380     - get_list_of_timezones()
1381     - calculate_user_dst_table()
1382     - dst_changes_for_year()
1383     - get_timezone_record()
1384     - test_get_list_of_timezones()
1385     - test_get_timezone_offset()
1386     - test_get_user_timezone_offset()
1387 * The google api library has been updated to version 1.1.7. There was some important changes
1388   on the SSL handling. Now the SSL version will be determined by the underlying library.
1389   For more information see https://github.com/googleapis/google-api-php-client/pull/644
1390 * The get_role_users() function will now add the $sort fields that are not part
1391   of the requested fields to the query result and will throw a debugging message
1392   with the added fields when that happens.
1393 * The core_user::fill_properties_cache() static method has been introduced to be a reference
1394   and allow standard user fields data validation. Right now only type validation is supported
1395   checking it against the parameter (PARAM_*) type of the target user field. MDL-52781 is
1396   going to add support to null/not null and choices validation, replacing the existing code to
1397   validate the user fields in different places in a common way.
1398 * Webservice function core_course_search_courses now returns results when the search string
1399   is less than 2 chars long.
1400 * Webservice function core_course_search_courses accepts a new parameter 'requiredcapabilities' to filter the results
1401   by the capabilities of the current user.
1402 * New mform element 'course' handles thousands of courses with good performance and usability.
1403 * The redirect() function will now redirect immediately if output has not
1404   already started. Messages will be displayed on the subsequent page using
1405   session notifications. The type of message output can be configured using the
1406   fourth parameter to redirect().
1407 * The specification of extra classes in the $OUTPUT->notification()
1408   function, and \core\output\notification renderable have been deprecated
1409   and will be removed in a future version.
1410   Notifications should use the levels found in \core\output\notification.
1412   \core\output\notification have been deprecated in favour of NOTIFY_ERROR,
1413   NOTIFY_WARNING, and NOTIFY_INFO respectively.
1414 * The following functions, previously used (exclusively) by upgrade steps are not available
1415   anymore because of the upgrade cleanup performed for this version. See MDL-51580 for more info:
1416     - upgrade_mysql_fix_unsigned_and_lob_columns()
1417     - upgrade_course_completion_remove_duplicates()
1418     - upgrade_save_orphaned_questions()
1419     - upgrade_rename_old_backup_files_using_shortname()
1420     - upgrade_mssql_nvarcharmax()
1421     - upgrade_mssql_varbinarymax()
1422     - upgrade_fix_missing_root_folders()
1423     - upgrade_course_modules_sequences()
1424     - upgrade_grade_item_fix_sortorder()
1425     - upgrade_availability_item()
1426 * A new parameter $ajaxformdata was added to the constructor for moodleform. When building a
1427   moodleform in a webservice or ajax script (for example using the new fragments API) we
1428   cannot allow the moodleform to parse it's own data from _GET and _POST - we must pass it as
1429   an array.
1430 * Plugins can extend the navigation for user by declaring the following callback:
1431   <frankenstyle>_extend_navigation_user(navigation_node $parentnode, stdClass $user,
1432                                         context_user $context, stdClass $course,
1433                                         context_course $coursecontext)
1434 * The function notify() now throws a debugging message - see MDL-50269.
1435 * Ajax calls going through lib/ajax/* now validate the return values before sending
1436   the response. If the validation does not pass an exception is raised. This behaviour
1437   is consistent with web services.
1438 * Several changes in Moodle core, standard plugins and third party libraries to
1439   ensure compatibility with PHP7. All plugins are recommended to perform testing
1440   against PHP7 as well. Refer to https://docs.moodle.org/dev/Moodle_and_PHP7 for more
1441   information. The following changes may affect you:
1442   * Class moodleform, moodleform_mod and some module classes have been changed to use
1443     __construct() for the constructor. Calling parent constructors by the class
1444     name will display debugging message. Incorrect: parent::moodleform(),
1445     correct: parent::__construct()
1446   * All form elements have also changed the constructor syntax. No changes are
1447     needed for using form elements, however if plugin defines new form element it
1448     needs to use correct syntax. For example, incorrect: parent::HTML_QuickForm_input(),
1449     HTML_QuickForm_input::HTML_QuickForm_input(), $this->HTML_QuickForm_input().
1450     Correct: HTML_QuickForm_input::__construct() or parent::__construct().
1451   * profile_field_base::profile_field_base() is deprecated, use parent::__construct()
1452     in custom profile fields constructors. Similar deprecations in exsiting
1453     profile_field_* classes.
1454   * user_filter_type::user_filter_type() is deprecated, use parent::__construct() in
1455     custom user filters. Similar deprecations in existing user_filter_* classes.
1456   * table_default_export_format_parent::table_default_export_format_parent() is
1457     deprecated, use parent::__construct() in extending classes.
1458 * groups_delete_group_members() $showfeedback parameter has been removed and is no longer
1459   respected. Users of this function should output their own feedback if required.
1460 * Number of changes to Tags API, see tag/upgrade.txt for more details
1461 * The previous events API handlers are being deprecated in favour of events 2 API, debugging messages are being displayed if
1462   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
1463   Note than you will need to bump the plugin version so moodle is aware that you removed the plugin's event handlers.
1464 * mforms validation functions are not available in the global JS namespace anymore, event listeners
1465   are assigned to fields and buttons through a self-contained JS function.
1466 * Added $CFG->urlrewriteclass option to config.php allowing clean / semantic urls to
1467   be implemented in a plugin, eg local_cleanurls.
1468 * $CFG->pathtoclam global setting has been moved to clamav antivirus plugin setting of the same name.
1469 * clam_message_admins() and get_clam_error_code() have been deprecated, its functionality
1470   is now a part of \antivirus_clamav\scanner class methods.
1471 * \repository::antivir_scan_file() has been deprecated, \core\antivirus\manager::scan_file() that
1472   applies antivirus plugins is replacing its functionality.
1473 * Added core_text::str_max_bytes() which safely truncates multi-byte strings to a maximum number of bytes.
1474 * Zend Framework has been removed completely.
1475 * Any plugin can report when a scale is being used with the callback function [pluginname]_scale_used_anywhere(int $scaleid).
1476 * Changes in file_rewrite_pluginfile_urls: Passing a new option reverse = true in the $options var will make the function to convert
1477   actual URLs in $text to encoded URLs in the @@PLUGINFILE@@ form.
1478 * behat_util::is_server_running() is removed, please use behat_util::check_server_status() instead.
1479 * Behat\Mink\Selector\SelectorsHandler::xpathLiteral() method is deprecated use behat_context_helper::escape instead
1480   when building Xpath, or pass the unescaped value when using the named selector.',
1481 * table_sql download process is using the new data formats plugin which you can't use if you are buffering any output
1482     * flexible_table::get_download_menu(), considered private, has been deleted. Use
1483       $OUTPUT->download_dataformat_selector() instead.
1484   when building Xpath, or pass the unescaped value when using the named selector.
1485 * Add new file_is_executable(), to consistently check for executables even in Windows (PHP bug #41062).
1486 * Introduced new hooks for plugin developers.
1487     - <component>_pre_course_category_delete($category)
1488     - <component>_pre_course_delete($course)
1489     - <component>_pre_course_module_delete($cm)
1490     - <component>_pre_block_delete($instance)
1491     - <component>_pre_user_delete($user)
1492   These hooks allow developers to use the item in question before it is deleted by core. For example, if your plugin is
1493   a module (plugins located in the mod folder) called 'xxx' and you wish to interact with the user object before it is
1494   deleted then the function to create would be mod_xxx_pre_user_delete($user) in mod/xxx/lib.php.
1495 * pear::Net::GeoIP has been removed.
1497 === 3.0 ===
1499 * Minify updated to 2.2.1
1500 * htmlpurifier upgraded to 4.7.0
1501 * Less.php upgraded to
1502 * The horde library has been updated to version 5.2.7.
1503 * Google libraries (lib/google) updated to 1.1.5
1504 * Html2Text library has been updated to the latest version of the library.
1505 * External functions x_is_allowed_from_ajax() methods have been deprecated. Define 'ajax' => true in db/services.php instead.
1506 * External functions can be called without a session if they define 'loginrequired' => true in db/services.php.
1507 * All plugins are required to declare their frankenstyle component name via
1508   the $plugin->component property in their version.php file. See
1509   https://docs.moodle.org/dev/version.php for details (MDL-48494).
1510 * PHPUnit is upgraded to 4.7. Some tests using deprecated assertions etc may need changes to work correctly.
1511 * Users of the text editor API to manually create a text editor should call set_text before calling use_editor.
1512 * Javascript - SimpleYUI and the Y instance used for modules have been merged. Y is now always the same instance of Y.
1513 * get_referer() has been deprecated, please use the get_local_referer function instead.
1514 * \core\progress\null is renamed to \core\progress\none for improved PHP7 compatibility as null is a reserved word (see MDL-50453).
1515 * \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
1516   server exceptions in $CFG->proxybypass. See MDL-39353 for details.
1517 * Group and groupings idnumbers can now be passed to and/or are returned from the following web services functions:
1518   ** core_group_external::create_groups
1519   ** core_group_external::get_groups
1520   ** core_group_external::get_course_groups
1521   ** core_group_external::create_groupings
1522   ** core_group_external::update_groupings
1523   ** core_group_external::get_groupings
1524   ** core_group_external::get_course_groupings
1525   ** core_group_external::get_course_user_groups
1526 * Following functions are removed from core. See MDL-50049 for details.
1527     password_compat_not_supported()
1528     session_get_instance()
1529     session_is_legacy()
1530     session_kill_all()
1531     session_touch()
1532     session_kill()
1533     session_kill_user()
1534     session_set_user()
1535     session_is_loggedinas()
1536     session_get_realuser()
1537     session_loginas()
1538     js_minify()
1539     css_minify_css()
1540     update_login_count()
1541     reset_login_count()
1542     check_gd_version()
1543     update_log_display_entry()
1544     get_recent_enrolments()
1545     groups_filter_users_by_course_module_visible()
1546     groups_course_module_visible()
1547     error()
1548     formerr()
1549     editorhelpbutton()
1550     editorshortcutshelpbutton()
1551     choose_from_menu()
1552     update_event()
1553     get_generic_section_name()
1554     get_all_sections()
1555     add_mod_to_section()
1556     get_all_mods()
1557     get_course_section()
1558     format_weeks_get_section_dates()
1559     get_print_section_cm_text()
1560     print_section_add_menus()
1561     make_editing_buttons()
1562     print_section()
1563     print_overview()
1564     print_recent_activity()
1565     delete_course_module()
1566     update_category_button()
1567     make_categories_list()
1568     category_delete_move()
1569     category_delete_full()
1570     move_category()
1571     course_category_hide()
1572     course_category_show()
1573     get_course_category()
1574     create_course_category()
1575     get_all_subcategories()
1576     get_child_categories()
1577     get_categories()
1578     print_course_search()
1579     print_my_moodle()
1580     print_remote_course()
1581     print_remote_host()
1582     print_whole_category_list()
1583     print_category_info()
1584     get_course_category_tree()
1585     print_courses()
1586     print_course()
1587     get_category_courses_array()
1588     get_category_courses_array_recursively()
1589     blog_get_context_url()
1590     get_courses_wmanagers()
1591     convert_tree_to_html()
1592     convert_tabrows_to_tree()
1593     can_use_rotated_text()
1594     get_parent_contexts()
1595     get_parent_contextid()
1596     get_child_contexts()
1597     create_contexts()
1598     cleanup_contexts()
1599     build_context_path()
1600     rebuild_contexts()
1601     preload_course_contexts()
1602     context_moved()
1603     fetch_context_capabilities()
1604     context_instance_preload()
1605     get_contextlevel_name()
1606     print_context_name()
1607     mark_context_dirty()
1608     delete_context()
1609     get_context_url()
1610     get_course_context()
1611     get_user_courses_bycap()
1612     get_role_context_caps()
1613     get_courseid_from_context()
1614     context_instance_preload_sql()
1615     get_related_contexts_string()
1616     get_plugin_list_with_file()
1617     check_browser_operating_system()
1618     check_browser_version()
1619     get_device_type()
1620     get_device_type_list()
1621     get_selected_theme_for_device_type()
1622     get_device_cfg_var_name()
1623     set_user_device_type()
1624     get_user_device_type()
1625     get_browser_version_classes()
1626     generate_email_supportuser()
1627     badges_get_issued_badge_info()
1628     can_use_html_editor()
1629     enrol_cohort_get_cohorts()
1630     enrol_cohort_can_view_cohort()
1631     cohort_get_visible_list()
1632     enrol_cohort_enrol_all_users()
1633     enrol_cohort_search_cohorts()
1634 * The never unused webdav_locks table was dropped.
1635 * The actionmenu hideMenu() function now expects an EventFacade object to be passed to it,
1636   i.e. a call to M.core.actionmenu.instance.hideMenu() should be change to M.core.actionmenu.instance.hideMenu(e)
1637 * In the html_editors (tinyMCE, Atto), the manage files button can be hidden by changing the 'enable_filemanagement' option to false.
1638 * external_api::validate_context now is public, it can be called from other classes.
1639 * rss_error() now supports returning of correct HTTP status of error and will return '404 Not Found'
1640   unless other status is specified.
1641 * Plugins can extend the navigation for categories settings by declaring the following callback:
1642   <frankenstyle>_extend_navigation_category_settings(navigation_node, context_coursecat)
1643 * The clilib.php provides two new functions cli_write() and cli_writeln() that should be used for outputting texts from the command
1644   line interface scripts.
1645 * External function core_course_external::get_course_contents returned parameter "name" has been changed to PARAM_RAW,
1646   this is because the new external_format_string function may return raw data if the global moodlewssettingraw parameter is used.
1647 * Function is_web_crawler() has been deprecated, please use core_useragent::is_web_crawler() instead.
1649 === 2.9.1 ===
1651 * New methods grade_grade::get_grade_max() and get_grade_min() must be used rather than directly the public properties rawgrademax and rawgrademin.
1652 * New method grade_item::is_aggregate_item() indicates when a grade_item is an aggreggated type grade.
1654 === 2.9 ===
1656 * The default home page for users has been changed to the dashboard (formely my home). See MDL-45774.
1657 * Support for rendering templates from php or javascript has been added. See MDL-49152.
1658 * Support for loading AMD javascript modules has been added. See MDL-49046.
1659 * Webservice core_course_delete_courses now return warning messages on any failures and does not try to rollback the entire deletion.
1660 * \core\event\course_viewed 'other' argument renamed from coursesectionid to coursesectionnumber as it contains the section number.
1661 * New API core_filetypes::add_type (etc.) allows custom filetypes to be added and modified.
1662 * PHPUnit: PHPMailer Sink is now started for all tests and is setup within the phpunit wrapper for advanced tests.
1663   Catching debugging messages when sending mail will no longer work. Use $sink = $this->redirectEmails(); and then check
1664   the message in the sink instead.
1665 * The file pluginlib.php was deprecated since 2.6 and has now been removed, do not include or require it.
1666 * \core_component::fetch_subsystems() now returns a valid path for completion component instead of null.
1667 * Deprecated JS global methods have been removed (show_item, destroy_item, hide_item, addonload, getElementsByTagName, findChildNodes).
1668 * For 3rd party plugin specific environment.xml files, it's now possible to specify version independent checks by using the
1669   <PLUGIN name="component_name"> tag instead of the version dependent <MOODLE version="x.y"> one. If the PLUGIN tag is used any
1670   Moodle specific tags will be ignored.
1671 * 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).
1672 * The authorization procedure in the mdeploy.php script has been improved. The script
1673   now relies on the main config.php when deploying an available update.
1674 * sql_internal_reader and sql_select_reader interfaces have been deprecated in favour of sql_internal_table_reader
1675   and sql_reader which use iterators to be more memory efficient.
1676 * $CFG->enabletgzbackups setting has been removed as now backups are stored internally using .tar.gz format by default, you can
1677   set $CFG->usezipbackups to store them in zip format. This does not affect the restore process, which continues accepting both.
1678 * Added support for custom string manager implementations via $CFG->customstringmanager
1679   directive in the config.php. See MDL-49361 for details.
1680 * Add new make_request_directory() for creation of per-request files.
1681 * Added generate_image_thumbnail_from_string. This should be used instead of generate_image_thumbnail when the source is a string.
1682   This prevents the need to write files to disk unnecessarily.
1683 * Added generate_image_thumbnail to stored_file class. This should be used when generating thumbnails for stored files.
1684   This prevents the need to write files to disk unnecessarily.
1685 * Removed pear/HTTP/WebDav. See MDL-49534 for details.
1686 * Use standard PHP date time classes and methods - see new core_date class for timezone normalisation methods.
1687 * Moved lib/google/Google/ to lib/google/src/Google. This is to address autoloader issues with Google's provided autoloader
1688   for the library. See MDL-49519 for details.
1689 * The outdated lib/google/Google_Client.php and related files have been completely removed. To use
1690   the new client, read lib/google/readme_moodle.txt, please.
1691 * profile_display_badges() has been deprecated. See MDL-48935 for details.
1692 * 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"
1693   then please use this function to ensure that the breadcrumb and navigation block are created properly for all user profile pages.
1694 * process_new_icon() now does not always return a PNG file. When possible, it will try to keep the format of the original file.
1695   Set the new argument $preferpng to true to force PNG. See MDL-46763 and MDL-50041 for details.
1697 === 2.8 ===
1699 * Gradebook grade category option "aggregatesubcats" has been removed completely.
1700   This means that the database column is removed, the admin settings are removed and
1701   the properties from the grade_category object have been removed. If any courses were
1702   found to be using this setting, a warning to check the grades will be shown in the
1703   course grader report after upgrading the site. The same warning will be shown on
1704   courses restored from backup that had this setting enabled (see MDL-47503).
1705 * lib/excelllib.class.php has been updated. The class MoodleExcelWorkbook will now only produce excel 2007 files.
1706 * renderers: We now remove the suffix _renderable when looking for a render method for a renderable.
1707   If you have a renderable class named like "blah_renderable" and have a method on a renderer named "render_blah_renderable"
1708   you will need to change the name of your render method to "render_blah" instead, as renderable at the end is no longer accepted.
1709 * New functions get_course_and_cm_from_cmid($cmorid, $modulename) and
1710   get_course_and_cm_from_instance($instanceorid, $modulename) can be used to
1711   more efficiently load these basic data objects at the start of a script.
1712 * New function cm_info::create($cm) can be used when you need a cm_info
1713   object, but have a $cm which might only be a standard database record.
1714 * $CFG->enablegroupmembersonly no longer exists.
1715 * Scheduled tasks have gained support for syntax to introduce variability when a
1716   task will run across installs. When a when hour or minute are defined as 'R'
1717   they will be installed with a random hour/minute value.
1718 * Several classes grade_edit_tree_column_xxx were removed since grades setup page
1719   has been significantly changed. These classes should not be used outside of
1720   gradebook or developers can copy them into their plugins from 2.7 branch.
1721 * Google APIs Client Library (lib/google/) has been upgraded to 1.0.5-beta and
1722   API has changed dramatically without backward compatibility. Any code accessing
1723   it must be amended. It does not apply to lib/googleapi.php. See MDL-47297
1724 * Added an extra parameter to the function get_formatted_help_string() (default null) which is used to specify
1725   additional string parameters.
1726 * User settings node and course node in navigation now support callbacks from admin tools.
1727 * grade_get_grades() optional parameteres $itemtype, $itemmodule, $iteminstance are now required.
1730 * completion_info->get_incomplete_criteria() is deprecated and will be removed in Moodle 3.0.
1731 * grade_category::aggregate_values() is deprecated and will be removed in Moodle 3.0.
1732 * groups_filter_users_by_course_module_visible() is deprecated; replace with
1733   core_availability\info::filter_user_list. Will be removed in Moodle 3.0.
1734 * groups_course_module_visible() is deprecated; replace with $cm->uservisible.
1735 * cm_info property $cm->groupmembersonly is deprecated and always returns 0.
1736   Use core_availability\info::filter_user_list if trying to determine which
1737   other users can see an activity.
1738 * cm_info method $cm->is_user_access_restricted_by_group() is deprecated and
1739   always returns false. Use $cm->uservisible to determine whether the user can
1740   access the activity.
1741 * Constant FEATURE_GROUPMEMBERSONLY (used in module _supports functions) is
1742   deprecated.
1743 * cohort_get_visible_list() is deprecated. There is a better function cohort_get_available_cohorts()
1744   that respects user capabilities to view cohorts.
1745 * enrol_cohort_get_cohorts() and enrol_cohort_search_cohorts() are deprecated since
1746   functionality is removed. Please use cohort_get_available_cohorts()
1747 * enrol_cohort_enrol_all_users() is deprecated; enrol_manual is now responsible for this action
1748 * enrol_cohort_can_view_cohort() is deprecated; replace with cohort_can_view_cohort()
1750 === 2.6.4 / 2.7.1 ===
1752 * setnew_password_and_mail() and update_internal_user_password() will trigger
1753   \core\event\user_password_updated. Previously they used to generate
1754   \core\event\user_updated event.
1755 * update_internal_user_password() accepts optional boolean $fasthash for fast
1756   hashing.
1757 * user_update_user() and user_create_user() api's accept optional param
1758   $triggerevent to avoid respective events to be triggred from the api's.
1760 === 2.7 ===
1762 * PHPUnit cannot be installed via PEAR any more, please use composer package manager instead.
1763 * $core_renderer->block_move_target() changed to support more verbose move-block-here descriptions.
1765 Events and Logging:
1766 * Significant changes in Logging API. For upgrading existing events_trigger() and
1767   add_to_log() see http://docs.moodle.org/dev/Migrating_logging_calls_in_plugins
1768   For accessing logs from plugins see http://docs.moodle.org/dev/Migrating_log_access_in_reports
1769 * The validation of the following events is now stricter (see MDL-45445):
1770     - \core\event\blog_entry_created
1771     - \core\event\blog_entry_deleted
1772     - \core\event\blog_entry_updated
1773     - \core\event\cohort_member_added
1774     - \core\event\cohort_member_removed
1775     - \core\event\course_category_deleted
1776     - \core\event\course_completed
1777     - \core\event\course_content_deleted
1778     - \core\event\course_created
1779     - \core\event\course_deleted
1780     - \core\event\course_restored
1781     - \core\event\course_section_updated (see MDL-45229)
1782     - \core\event\email_failed
1783     - \core\event\group_member_added
1784     - \core\event\group_member_removed
1785     - \core\event\note_created
1786     - \core\event\note_deleted
1787     - \core\event\note_updated
1788     - \core\event\role_assigned
1789     - \core\event\role_deleted
1790     - \core\event\role_unassigned
1791     - \core\event\user_graded
1792     - \core\event\user_loggedinas
1793     - \core\event\user_profile_viewed
1794     - \core\event\webservice_token_created
1797 * $module uses in mod/xxx/version.php files is now deprecated. Please use $plugin instead. It will be removed in Moodle 2.10.
1798 * Update init methods in all event classes - "level" property was renamed to "edulevel", the level property is now deprecated.
1799 * Abstract class \core\event\course_module_instances_list_viewed is deprecated now, use \core\event\instances_list_viewed instead.
1800 * Abstract class core\event\content_viewed has been deprecated. Please extend base event or other relevant abstract class.
1801 * mod_book\event\instances_list_viewed has been deprecated. Please use mod_book\event\course_module_instance_list_viewed instead.
1802 * mod_chat\event\instances_list_viewed has been deprecated. Please use mod_chat\event\course_module_instance_list_viewed instead.
1803 * mod_choice\event\instances_list_viewed has been deprecated. Please use mod_choice\event\course_module_instance_list_viewed instead.
1804 * mod_feedback\event\instances_list_viewed has been deprecated. Please use mod_feedback\event\course_module_instance_list_viewed instead.
1805 * mod_page\event\instances_list_viewed has been deprecated. Please use mod_page\event\course_module_instance_list_viewed instead.
1807 * Conditional availability API has moved and changed. The condition_info class is
1808   replaced by \core_availability\info_module, and condition_info_section by
1809   \core_availability\info_section. (Code that uses the old classes will generally
1810   still work.)
1811 * coursemodule_visible_for_user() has been deprecated but still works - replaced
1812   by a new static function \core_availability\info_module::is_user_visible()
1813 * cm_info::is_user_access_restricted_by_conditional_access has been deprecated
1814   but still works (it has never done what its name suggests, and is
1815   unnecessary).
1816 * cm_info and section_info property showavailability has been deprecated, but
1817   still works (with the caveat that this information is now per-user).
1818 * cm_info and section_info properties availablefrom and availableuntil have been
1819   deprecated and always return zero (underlying data doesn't have these values).
1820 * section_info property groupingid has been deprecated and always returns zero,
1821   same deal.
1822 * Various cm_info methods have been deprecated in favour of their read-only properties (get_url(), get_content(), get_extra_classes(),
1823   get_on_click(), get_custom_data(), get_after_link, get_after_edit_icons)
1824 * The ajaxenabled function has been deprecated and always returns true. All code should be fully functional in Javascript.
1825 * count_login_failures() has been deprecated, use user_count_login_failures() instead. Refer MDL-42891 for details.
1827 Conditional availability (activities and sections):
1828 * New conditional availability API in /availability, including new availability
1829   condition plugins in /availability/condition. The new API is very similar with
1830   regard to checking availability, but any code that modifies availability settings
1831   for an activity or section is likely to need substantial changes.
1833 YUI:
1834   * The lightbox attribute for moodle-core-notification-dialogue has been
1835     deprecated and replaced by the modal attribute. This was actually
1836     changed in Moodle 2.2, but has only been marked as deprecated now. It
1837     will be removed in Moodle 2.9.
1838   * When destroying any type of dialogue based on moodle-core-notification, the relevant content is also removed from
1839     the DOM. Previously it was left orphaned.
1841 JavaSript:
1842     * The findChildNodes global function has been deprecated. Y.all should
1843       be used instead.
1844     * The callback argument to confirm_action and M.util.show_confirm_dialog has been deprecated. If you need to write a
1845       confirmation which includes a callback, please use moodle-core-notification-confirmation and attach callbacks to the
1846       events provided.
1848 * New locking api and admin settings to configure the system locking type.
1849 * New "Time spent waiting for the database" performance metric displayed along with the
1850   other MDL_PERF vars; the change affects both the error logs and the vars displayed in
1851   the page footer.
1852 * Changes in the tag API. The component and contextid are now saved when assigning tags to an item. Please see
1853   tag/upgrade.txt for more information.
1855 === 2.6 ===
1857 * Use new methods from core_component class instead of get_core_subsystems(), get_plugin_types(),
1858   get_plugin_list(), get_plugin_list_with_class(), get_plugin_directory(), normalize_component(),
1859   get_component_directory() and get_plugin_list_with_file(). The names of the new methods are
1860   exactly the same, the only differences are that core_component::get_plugin_types() now always returns
1861   full paths and core_component::get_plugin_list() does not accept empty parameter any more.
1862 * Use core_text::* instead of textlib:: and also core_collator::* instead of collatorlib::*.
1863 * Use new function moodleform::mock_submit() to simulate form submission in unit tests (backported).
1864 * New $CFG->localcachedir setting useful for cluster nodes. Admins have to update X-Sendfile aliases if used.
1865 * MS SQL Server drivers are now using NVARCHAR(MAX) instead of NTEXT and VARBINARY(MAX) instead of IMAGE,
1866   this change should be fully transparent and it should help significantly with add-on compatibility.
1867 * The string manager classes were renamed. Note that they should not be modified or used directly,
1868   always use get_string_manager() to get instance of the string manager.
1869 * The ability to use an 'insecure' rc4encrypt/rc4decrypt key has been removed.
1870 * Use $CFG->debugdeveloper instead of debugging('', DEBUG_DEVELOPER).
1871 * Use set_debugging(DEBUG_xxx) when changing debugging level for current request.
1872 * Function moveto_module() does not modify $mod argument and instead now returns the new module visibility value.
1873 * Use behat_selectors::get_allowed_text_selectors() and behat_selectors::get_allowed_selectors() instead of
1874   behat_command::$allowedtextselectors and behat_command::$allowedselectors
1875 * Subplugins are supported in admin tools and local plugins.
1876 * file_packer/zip_packer API has been modified so that key functions support a new file_progress interface
1877   to report progress during long operations. Related to this, zip_archive now supports an estimated_count()
1878   function that returns an approximate number of entries in the zip faster than the count() function.
1879 * Class cm_info no longer extends stdClass. All properties are read-only and calculated on first request only.
1880 * Class course_modinfo no longer extends stdClass. All properties are read-only.
1881 * Database fields modinfo and sectioncache in table course are removed. Application cache core/coursemodinfo
1882   is used instead. Course cache is still reset, rebuilt and retrieved using function rebuild_course_cache() and
1883   get_fast_modinfo(). Purging all caches and every core upgrade purges course modinfo cache as well.
1884   If function get_fast_modinfo() is called for multiple courses make sure to include field cacherev in course
1885   object.
1886 * Internal (noreply and support) user support has been added for sending/receiving message.
1887   Use core_user::get_noreply_user() and core_user::get_support_user() to get noreply and support user's respectively.
1888   Real users can be used as noreply/support users by setting $CFG->noreplyuserid and $CFG->supportuserid
1889 * New function readfile_allow_large() in filelib.php for use when very large files may need sending to user.
1890 * Use core_plugin_manager::reset_caches() when changing visibility of plugins.
1891 * Implement new method get_enabled_plugins() method in subplugin info classes.
1892 * Each plugin should include version information in version.php.
1893 * Module and block tables do not contain version column any more, use get_config('xx_yy', 'version') instead.
1894 * $USER->password field is intentionally unset so that session data does not contain password hashes.
1895 * Use core_shutdown_manager::register_function() instead of register_shutdown_function().
1896 * New file packer for .tar.gz files; obtain by calling get_file_packer('application/x-gzip'). Intended initially
1897   for use in backup/restore only, as there are limitations on supported filenames. Also new packer for
1898   backups which supports both compression formats; get_file_packer('application/vnd.moodle.backup').
1899 * New optional parameter to stored_file::get_content_file_handle to open file handle with 'gzopen' instead
1900   of 'fopen' to read gzip-compressed files if required.
1901 * update_internal_user_password() and setnew_password_and_mail() now trigger user_updated event.
1902 * Add thirdpartylibs.xml file to plugins that bundle any 3rd party libraries.
1903 * New class introduced to help auto generate zIndex values for modal dialogues. Class "moodle-has-zindex"
1904   should set on any element which uses a non-default zindex and needs to ensure it doesn't show above a
1905   dialogue.
1906 * $CFG->filelifetime is now used consistently for most file serving operations, the default was lowered
1907   to 6 hours from 24 hours because etags and x-sendfile support should make file serving less expensive.
1908 * Date format locale charset for windows server will come from calendar type and for gregorian it will use
1909   lang file.
1910 * The library to interact with Box.net (class boxclient) is only compatible with their APIv1 which
1911   reaches its end of life on the 14th of Dec. You should migrate your scripts to make usage of the
1912   new class boxnet_client(). Note that the method names and return values have changed.
1913 * Settings pages are now possible for Calendar type plugins. Calendar type plugins that require a settings page to
1914   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.
1915 * The admin/tool/generator tool was overhauled to use testing data generators and the previous interface to create
1916   test data was removed (it was not working correctly anyway). If you were using this tool you will probably need to
1917   update your code.
1920 Various previously deprecated functions have now been altered to throw DEBUG_DEVELOPER debugging notices
1921 and will be removed in a future release (target: 2.8), a summary follows:
1923 Accesslib:
1924     * get_context_instance()                ->  context_xxxx::instance()
1925     * get_context_instance_by_id()          ->  context::instance_by_id($id)
1926     * get_system_context()                  ->  context_system::instance()
1927     * context_moved()                       ->  context::update_moved()
1928     * preload_course_contexts()             ->  context_helper::preload_course()
1929     * context_instance_preload()            ->  context_helper::preload_from_record()
1930     * context_instance_preload_sql()        ->  context_helper::get_preload_record_columns_sql()
1931     * get_contextlevel_name()               ->  context_helper::get_level_name()
1932     * create_contexts()                     ->  context_helper::create_instances()
1933     * cleanup_contexts()                    ->  context_helper::cleanup_instances()
1934     * build_context_path()                  ->  context_helper::build_all_paths()
1935     * print_context_name()                  ->  $context->get_context_name()
1936     * mark_context_dirty()                  ->  $context->mark_dirty()
1937     * delete_context()                      ->  $context->delete_content() or context_helper::delete_instance()
1938     * get_context_url()                     ->  $context->get_url()
1939     * get_course_context()                  ->  $context->get_course_context()
1940     * get_parent_contexts()                 ->  $context->get_parent_context_ids()
1941     * get_parent_contextid()                ->  $context->get_parent_context()
1942     * get_child_contexts()                  ->  $context->get_child_contexts()
1943     * rebuild_contexts()                    ->  $context->reset_paths()
1944     * get_user_courses_bycap()              ->  enrol_get_users_courses()
1945     * get_courseid_from_context()           ->  $context->get_course_context(false)
1946     * get_role_context_caps()               ->  (no replacement)
1947     * load_temp_role()                      ->  (no replacement)
1948     * remove_temp_roles()                   ->  (no replacement)
1949     * get_related_contexts_string()         ->  $context->get_parent_context_ids(true)
1950     * get_recent_enrolments()               ->  (no replacement)
1952 Enrollment:
1953     * get_course_participants()             -> get_enrolled_users()
1954     * is_course_participant()               -> is_enrolled()
1956 Output:
1957     * current_theme()                       -> $PAGE->theme->name
1958     * skip_main_destination()               -> $OUTPUT->skip_link_target()
1959     * print_container()                     -> $OUTPUT->container()
1960     * print_container_start()               -> $OUTPUT->container_start()
1961     * print_container_end()                 -> $OUTPUT->container_end()
1962     * print_continue()                      -> $OUTPUT->continue_button()
1963     * print_header()                        -> $PAGE methods
1964     * print_header_simple()                 -> $PAGE methods
1965     * print_side_block()                    -> $OUTPUT->block()
1966     * print_arrow()                         -> $OUTPUT->arrow()
1967     * print_scale_menu_helpbutton()         -> $OUTPUT->help_icon_scale($courseid, $scale)
1968     * print_checkbox()                      -> html_writer::checkbox()
1970 Navigation:
1971     * print_navigation()                    -> $OUTPUT->navbar()
1972     * build_navigation()                    -> $PAGE->navbar methods
1973     * navmenu()                             -> (no replacement)
1974     * settings_navigation::
1975           get_course_modules()              -> (no replacement)
1977 Files and repositories:
1978     * stored_file::replace_content_with()   -> stored_file::replace_file_with()
1979     * stored_file::set_filesize()           -> stored_file::replace_file_with()
1980     * stored_file::get_referencelifetime()  -> (no replacement)
1981     * repository::sync_external_file()      -> see repository::sync_reference()
1982     * repository::get_file_by_reference()   -> repository::sync_reference()
1983     * repository::
1984           get_reference_file_lifetime()     -> (no replacement)
1985     * repository::sync_individual_file()    -> (no replacement)
1986     * repository::reset_caches()            -> (no replacement)
1988 Calendar:
1989     * add_event()                           -> calendar_event::create()
1990     * update_event()                        -> calendar_event->update()
1991     * delete_event()                        -> calendar_event->delete()
1992     * hide_event()                          -> calendar_event->toggle_visibility(false)
1993     * show_event()                          -> calendar_event->toggle_visibility(true)
1995 Misc:
1996     * filter_text()                         -> format_text(), format_string()...
1997     * httpsrequired()                       -> $PAGE->https_required()
1998     * detect_munged_arguments()             -> clean_param([...], PARAM_FILE)
1999     * mygroupid()                           -> groups_get_all_groups()
2000     * js_minify()                           -> core_minify::js_files()
2001     * css_minify_css()                      -> core_minify::css_files()
2002     * course_modinfo::build_section_cache() -> (no replacement)
2003     * generate_email_supportuser()          -> core_user::get_support_user()
2005 Sessions:
2006     * session_get_instance()->xxx()         -> \core\session\manager::xxx()
2007     * session_kill_all()                    -> \core\session\manager::kill_all_sessions()
2008     * session_touch()                       -> \core\session\manager::touch_session()
2009     * session_kill()                        -> \core\session\manager::kill_session()
2010     * session_kill_user()                   -> \core\session\manager::kill_user_sessions()
2011     * session_gc()                          -> \core\session\manager::gc()
2012     * session_set_user()                    -> \core\session\manager::set_user()
2013     * session_is_loggedinas()               -> \core\session\manager::is_loggedinas()
2014     * session_get_realuser()                -> \core\session\manager::get_realuser()
2015     * session_loginas()                     -> \core\session\manager::loginas()
2017 User-agent related functions:
2018     * check_browser_operating_system()      -> core_useragent::check_browser_operating_system()
2019     * check_browser_version()               -> core_useragent::check_browser_version()
2020     * get_device_type()                     -> core_useragent::get_device_type()
2021     * get_device_type_list()                -> core_useragent::get_device_type_list()
2022     * get_selected_theme_for_device_type()  -> core_useragent::get_device_type_theme()
2023     * get_device_cfg_var_name()             -> core_useragent::get_device_type_cfg_var_name()
2024     * set_user_device_type()                -> core_useragent::set_user_device_type()
2025     * get_user_device_type()                -> core_useragent::get_user_device_type()
2026     * get_browser_version_classes()         -> core_useragent::get_browser_version_classes()
2028 YUI:
2029     * moodle-core-notification has been deprecated with a recommendation of
2030       using its subclasses instead. This is to allow for reduced page
2031       transport costs. Current subclasses include:
2032       * dialogue
2033       * alert
2034       * confirm
2035       * exception
2036       * ajaxexception
2038 Event triggering and event handlers:
2039     * All existing events and event handlers should be replaced by new
2040       event classes and matching new event observers.
2041     * See http://docs.moodle.org/dev/Event_2 for more information.
2042     * The following events will be entirely removed, though they can still
2043       be captured using handlers, but they should not be used any more.
2044       * groups_members_removed          -> \core\event\group_member_removed
2045       * groups_groupings_groups_removed -> (no replacement)
2046       * groups_groups_deleted           -> \core\event\group_deleted
2047       * groups_groupings_deleted        -> \core\event\grouping_deleted
2048     * edit_module_post_actions() does not trigger events any more.
2050 === 2.5.1 ===
2052 * New get_course() function for use when obtaining the course record from database. Will
2053   reuse existing $COURSE or $SITE globals if possible to improve performance.
2055 === 2.5 ===
2057 * The database drivers (moodle_database and subclasses) aren't using anymore the ::columns property
2058   for caching database metadata. MUC (databasemeta) is used instead. Any custom DB driver should
2059   apply for that change.
2060 * The cron output has been changed to include time and memory usage (see cron_trace_time_and_memory()),
2061   so any custom utility relying on the old output may require modification.
2062 * Function get_max_file_sizes now returns an option for (for example) "Course limit (500MB)" or
2063   "Site limit (200MB)" when appropriate with the option set to 0. This function no longer returns
2064   an option for 0 bytes. Existing code that was replacing the 0 option in the return
2065   from this function with a more sensible message, can now use the return from this function directly.
2066 * Functions responsible for output in course/lib.php are deprecated, the code is moved to
2067   appropriate renderers: print_section(), print_section_add_menus(), get_print_section_cm_text(),
2068   make_editing_buttons()
2069   See functions' phpdocs in lib/deprecatedlib.php
2070 * Function get_print_section_cm_text() is deprecated, replaced with methods in cm_info
2071 * zip_packer may create empty zip archives, there is a new option to ignore
2072   problematic files when creating archive
2073 * The function delete_course_module was deprecated and has been replaced with
2074   course_delete_module. The reason for this was because the function delete_course_module
2075   only partially deletes data, so wherever it was called extra code was needed to
2076   perform the whole deletion process. The function course_delete_module now takes care
2077   of the whole process.
2078 * curl::setopt() does not accept constant values any more. As it never worked properly,
2079   we decided to make the type check stricter. Now, the keys of the array pass must be a string
2080   corresponding to the curl constant name.
2081 * Function get_users_listing now return list of users except guest and deleted users. Previously
2082   deleted users were excluded by get_users_listing. As guest user is not expected while browsing users,
2083   and not included in get_user function, it will not be returned by get_users_listing.
2084 * The add_* functions in course/dnduploadlib.php have been deprecated. Plugins should be using the
2085   MODNAME_dndupload_register callback instead.
2086 * The signature of the add() method of classes implementing the parentable_part_of_admin_tree
2087   interface (such as admin_category) has been extended. The new parameter allows the caller
2088   to prepend the new node before an existing sibling in the admin tree.
2089 * condition_info:get_condition_user_fields($formatoptions) now accepts the optional
2090   param $formatoptions, that will determine if the field names are processed by
2091   format_string() with the passed options.
2092 * remove all references to $CFG->gdversion, GD PHP extension is now required
2093 * Formslib will now throw a developer warning if a PARAM_ type hasn't been set for elements which
2094   need it. Please set PARAM_RAW explicitly if you do not want any cleaning.
2095 * Functions responsible for managing and accessing course categories are moved to class coursecat
2096   in lib/coursecatlib.php, functions responsible for rendering courses and categories lists are
2097   moved to course/renderer.php. The following global functions are deprecated: make_categories_list(),
2098   category_delete_move(), category_delete_full(), move_category(), course_category_hide(),
2099   course_category_show(), get_course_category(), create_course_category(), get_all_subcategories(),
2100   get_child_categories(), get_categories(), print_my_moodle(), print_remote_course(),
2101   print_remote_host(), print_whole_category_list(), print_category_info(), get_course_category_tree(),
2102   print_courses(), print_course(), get_category_courses_array(), get_category_courses_array_recursively(),
2103   get_courses_wmanagers()
2104   See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
2105 * $core_renderer->block_move_target() changed to support more verbose move-block-here descriptions.
2106 * Additional (optional) param $onlyactive has been added to get_enrolled_users, count_enrolled_users
2107   functions to get information for only active (excluding suspended enrolments) users. Included two
2108   helper functions extract_suspended_users, get_suspended_userids to extract suspended user information.
2109 * The core_plugin_manager class now provides two new helper methods for getting information
2110   about known plugins: get_plugins_of_type() and get_subplugins_of_plugin().
2111 * The get_uninstall_url() method of all subclasses of \core\plugininfo\base class is now expected
2112   to always return moodle_url. Subclasses can use the new method is_uninstall_allowed()
2113   to control the availability of the 'Uninstall' link at the Plugins overview page (previously
2114   they would do it by get_uninstall_url() returning null). By default, URL to a new general plugin
2115   uninstall tool is returned. Unless the plugin type needs extra steps that can't be handled by
2116   plugininfo_xxx::uninstall() method or xmldb_xxx_uninstall() function, this default URL should
2117   satisfy all plugin types.
2119 Database (DML) layer:
2120 * $DB->sql_empty() is deprecated, you have to use sql parameters with empty values instead,
2121   please note hardcoding of empty strings in SQL queries breaks execution in Oracle database.
2122 * Indexes must not be defined on the same columns as keys, this is now reported as fatal problem.
2123   Please note that internally we create indexes instead of foreign keys.
2125 YUI changes:
2126 * M.util.help_icon has been deprecated. Code should be updated to use moodle-core-popuphelp
2127   instead. To do so, remove any existing JS calls to M.util.help_icon from your PHP and ensure
2128   that your help link is placed in a span which has the class 'helplink'.
2130 === 2.4 ===
2132 * Pagelib: Numerous deprecated functions were removed as classes page_base, page_course
2133   and page_generic_activity.
2134 * use $CFG->googlemapkey3 instead of removed $CFG->googlemapkey and migrate to Google Maps API V3
2135 * Function settings_navigation::add_course_editing_links() is completely removed
2136 * function global_navigation::format_display_course_content() is removed completely (the
2137   functionality is moved to course format class)
2138 * in the function global_navigation::load_generic_course_sections() the argument $courseformat is
2139   removed
2140 * New component and itemid columns in groups_members table - this allows plugin to create protected
2141   group memberships using 'xx_yy_allow_group_member_remove' callback and there is also a new restore
2142   callback 'xx_yy_restore_group_member()'.
2143 * New general role assignment restore plugin callback 'xx_yy_restore_role_assignment()'.
2144 * functions get_generic_section_name(), get_all_sections(), add_mod_to_section(), get_all_mods()
2145   are deprecated. See their phpdocs in lib/deprecatedlib.php on how to replace them
2147 YUI changes:
2148 * moodle-enrol-notification has been renamed to moodle-core-notification
2149 * YUI2 code must now use 2in3, see http://yuilibrary.com/yui/docs/yui/yui-yui2.html
2150 * M.util.init_select_autosubmit() and M.util.init_url_select() have been deprecated. Code using this should be updated
2151   to use moodle-core-formautosubmit
2153 Unit testing changes:
2154 * output debugging() is not sent to standard output any more,
2155   use $this->assertDebuggingCalled(), $this->assertDebuggingNotCalled(),
2156   $this->getDebuggingMessages() or $this->assertResetDebugging() instead.
2158 === 2.3 ===
2160 Database layer changes:
2161 * objects are not allowed in paramters of DML functions, use explicit casting to strings if necessary
2163 Note:
2164 * DDL and DML methods which were deprecated in 2.0 have now been removed, they will no longer produce
2165 debug messages and will produce fatal errors
2167 API changes:
2169 * send_stored_file() has changed its interface
2170 * deleted several resourcelib_embed_* functions from resourcelib.php
2172 === 2.2 ===
2174 removed unused libraries:
2175 * odbc, base32, CodeSniffer, overlib, apd profiling, kses, Smarty, PEAR Console, swfobject, cssshover.htc, md5.js
2177 API changes:
2178 * new admin/tool plugin type
2179 * new context API - old API is still available
2180 * deleted users do not have context any more
2181 * removed global search
2184 === 2.1 ===
2186 API changes:
2187 * basic suport for restore from 1.9
2188 * new mobile devices API
2189 * new questions API
2192 === 2.0 ===
2194 API changes:
2195 * new DML API - http://docs.moodle.org/dev/DML_functions
2196 * new DDL API - http://docs.moodle.org/dev/DDL_functions
2197 * new file API - http://docs.moodle.org/dev/File_API
2198 * new $PAGE and $OUTPUT API
2199 * new navigation API
2200 * new theme API - http://docs.moodle.org/dev/Theme_changes_in_2.0
2201 * new javascript API - http://docs.moodle.org/dev/JavaScript_usage_guide
2202 * new portfolio API
2203 * new local plugin type
2204 * new translation support - http://lang.moodle.org
2205 * new web service API
2206 * new cohorts API
2207 * new messaging API
2208 * new rating API
2209 * new comment API
2210 * new sessions API
2211 * new enrolment API
2212 * new backup/restore API
2213 * new blocks API
2214 * new filters API
2215 * improved plugin support (aka Frankenstyle)
2216 * new registration and hub API
2217 * new course completion API
2218 * new plagiarism API
2219 * changed blog API
2220 * new text editor API
2221 * new my moodle and profiles API