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