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