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