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