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