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