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