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