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