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