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