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