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