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