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