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