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