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