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