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