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