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