MDL-69145 core: Set the default filterset join type to ALL
[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
d74c9c62 4=== 3.11 ===
39652702 5* New optional parameter $extracontent for print_collapsible_region_start(). This allows developers to add interactive HTML elements
6 (e.g. a help icon) after the collapsible region's toggle link.
3f934e4a 7* Final deprecation i_dock_block() in behat_deprecated.php
86269654
PD
8* Final deprecation of get_courses_page. Function has been removed and core_course_category::get_courses() should be
9 used instead.
a489f20f
JP
10* \core_table\local\filter\filterset::JOINTYPE_DEFAULT is being changed from 1 (ANY) to 2 (ALL). Filterset implementations
11 can override the default filterset join type by overriding \core_table\local\filter\filterset::get_join_type() instead.
39652702 12
9a79c34e 13=== 3.10 ===
447316a9 14* PHPUnit has been upgraded to 8.5. That comes with a few changes:
07c1522d
EL
15 - Breaking change: All the "template methods" (setUp(), tearDown()...) now require to return void. This implies
16 that the minimum version of PHP able to run tests will be PHP 7.1
17 - A good number of assertions have been deprecated with this version
18 and will be removed in a future one. In core all cases have been removed
19 (so it's deprecation-warnings free). It's recommended to perform the
20 switch to their new counterparts ASAP:
21 - assertInternalType() has been deprecated. Use the assertIsXXX() methods instead.
22 - assertArraySubset() has been deprecated. Use looping + assertArrayHasKey() or similar.
23 - @expectedExceptionXXX annotations have been deprecated. Use the expectExceptionXXX()
24 methods instead (and put them exactly before the line that is expected to throw the exception).
25 - assertAttributeXXX() have been deprecated. If testing public attributes use normal assertions. If
26 testing non-public attributes... you're doing something wrong :-)
27 - assertContains() to find substrings on strings has been deprecated. Use assertStringContainsString() instead.
28 (note that there are "IgnoringCase()" variants to perform case-insensitive matching.
29 - assertEquals() extra params have been deprecated and new assertions for them created:
30 - delta => use assertEqualsWithDelta()
31 - canonicalize => use assertEqualsCanonicalizing()
32 - ignoreCase => use assertEqualsIgnoringCase()
33 - maxDepth => removed without replacement.
34 - The custom printer that was used to show how to rerun a failure has been removed, it was old and "hacky"
35 solution, for more information about how to run tests, see the docs, there are plenty of options.
447316a9
EL
36 - phpunit/dbunit is not available any more and it has been replaced by a lightweight phpunit_dataset class, able to
37 load XML/CSV and PHP arrays, send the to database and return rows to calling code (in tests). That implies the
38 follwoing changes in the advanced_testcase class:
39 - createFlatXMLDataSet() has been removed. No uses in core, uses can switch to createXMLDataSet() (read below).
40 - createXMLDataSet() has been deprecated. Use dataset_from_files() instead.
41 - createCsvDataSet() has been deprecated. Use dataset_from_files() instead.
42 - createArrayDataSet() has been deprecated. This method was using the phpunit_ArrayDataSet class
43 that has been also removed from core. Use dataset_from_array() instead.
44 - loadDataSet() has been deprecated. Use phpunit_dataset->to_database() instead.
45 - All the previous uses of phpunit/dbunit methods like Dataset:getRows(), Dataset::getRowCount()
46 must be replaced by the new phpunit_dataset->get_rows() method.
5b8c646e 47* Retains the source course id when a course is copied from another course on the same site.
e13cbf9e
MG
48* Added function setScrollable in core/modal. This function can be used to set the modal's body to be scrollable or not
49 when the modal's height exceeds the browser's height. This is also supported in core/modal_factory through the
50 'scrollable' config parameter which can be set to either true or false. If not explicitly defined, the default value
51 of 'scrollable' is true.
aacfff0b
AN
52* The `$CFG->behat_retart_browser_after` configuration setting has been removed.
53 The browser session is now restarted between all tests.
d464fb43 54* add_to_log() has been through final deprecation, please rewrite your code to the new events API.
b27a27ad
MM
55* The following functions have been finally deprecated and can not be used anymore:
56 - print_textarea
57 - calendar_get_all_allowed_types
58 - groups_get_all_groups_for_courses
59 - events_get_cached
60 - events_uninstall
61 - events_cleanup
62 - events_dequeue
63 - events_get_handlers
64 - get_roles_on_exact_context
65 - get_roles_with_assignment_on_context
66 - message_add_contact
67 - message_remove_contact
68 - message_unblock_contact
69 - message_block_contact
70 - message_get_contact
8efa87ed
MG
71* The following renamed classes have been completely removed:
72 - course_in_list (now: core_course_list_element)
73 - coursecat (now: core_course_category)
8cdb2fcc 74* The form element 'htmleditor', which was deprecated in 3.6, has been removed.
4a4a3672
AN
75* The `core_output_load_fontawesome_icon_map` web service has been deprecated and replaced by
76 `core_output_load_fontawesome_icon_system_map` which takes the name of the theme to generate the icon system map for.
a9165e69
PH
77* A new parameter `$rolenamedisplay` has been added to `get_viewable_roles()` and `get_switchable_roles` to define how role names
78 should be returned.
c4296f77 79* The class coursecat_sortable_records has been removed.
f87597aa 80* Admin setting admin_setting_configselect now supports lazy-loading the options list by supplying
81 a callback function instead of an array of options.
b5800959 82* Admin setting admin_setting_configselect now supports validating the selection by supplying a
83 callback function.
b465a541
MG
84* The task system has new functions adhoc_task_starting() and scheduled_task_starting() which must
85 be called before executing a task, and a new function \core\task\manager::get_running_tasks()
86 returns information about currently-running tasks.
9538ba0d 87* New library function rename_to_unused_name() to rename a file within its current location.
67a11150
SA
88* Constant \core_h5p\file_storage::EDITOR_FILEAREA has been deprecated
89 because it's not required any more.
6d3c27fe 90* The ZipStream-PHP library has been added to Moodle core in /lib/zipstream.
8eee0f5e 91* The php-enum library has been added to Moodle core in /lib/php-enum.
5dc3df0e 92* The http-message library has been added to Moodle core in /lib/http-message.
00b67721
DM
93* Methods `filetypes_util::is_whitelisted()` and `filetypes_util::get_not_whitelisted()` have been deprecated and
94 renamed to `is_listed()` and `get_not_listed()` respectively.
9ce76800
DM
95* Method `mustache_helper_collection::strip_blacklisted_helpers()` has been deprecated and renamed to
96 `strip_disallowed_helpers()`.
96ec6ee8
PH
97* A new admin externalpage type `\core_admin\local\externalpage\accesscallback` for use in plugin settings is available that allows
98 a callback to be provided to determine whether page can be accessed.
9fabe1dd 99* New setting $CFG->localtempdir overrides which defaults to sys_get_temp_dir()
df611498 100* Function redirect() now emits a line of backtrace into the X-Redirect-By header when debugging is on
edb5cd0d 101* New DML function $DB->delete_records_subquery() to delete records based on a subquery in a way
102 that will work across databases.
1b47d4bc 103* Add support for email DKIM signatures via $CFG->emaildkimselector
e13cbf9e 104
2ead888f 105=== 3.9 ===
079736cc 106* Following function has been deprecated, please use \core\task\manager::run_from_cli().
107 - cron_run_single_task()
108* Following class has been deprecated, please use \core\task\manager.
109 - \tool_task\run_from_cli
110* Following CLI scripts has been deprecated:
111 - admin/tool/task/cli/schedule_task.php please use admin/cli/scheduled_task.php
112 - admin/tool/task/cli/adhoc_task.php please use admin/cli/adhoc_task.php
78adf6f6
DM
113* Old Safe Exam Browser quiz access rule (quizaccess_safebrowser) replaced by new Safe Exam Browser access rule (quizaccess_seb).
114 Experimental setting enablesafebrowserintegration was deleted.
3df84921 115* New CFPropertyList library has been added to Moodle core in /lib/plist.
88154551
EL
116* behat_data_generators::the_following_exist() has been removed, please use
117 behat_data_generators::the_following_entities_exist() instead. See MDL-67691 for more info.
4234159e
MG
118* admin/tool/task/cli/adhoc_task.php now observers the concurrency limits.
119 If you want to get the previous (unlimited) behavior, use the --ignorelimits switch).
08f3363b 120* Removed the following deprecated functions:
2ead888f
AA
121 - question_add_tops
122 - question_is_only_toplevel_category_in_context
b4b4c895
EL
123* format_float() now accepts a special value (-1) as the $decimalpoints parameter
124 which means auto-detecting number of decimal points.
d0d65b49
AG
125* plagiarism_save_form_elements() has been deprecated. Please use {plugin name}_coursemodule_edit_post_actions() instead.
126* plagiarism_get_form_elements_module() has been deprecated. Please use {plugin name}_coursemodule_standard_elements() instead.
859ed92f 127* Changed default sessiontimeout to 8 hours to cover most normal working days
147a895a
PB
128* Plugins can now explicitly declare supported and incompatible Moodle versions in version.php
129 - $plugin->supported = [37,39];
130 supported takes an array of ascending numbers, that correspond to a range of branch numbers of supported versions, inclusive.
131 Moodle versions that are outside of this range will produce a message notifying at install time, but will allow for installation.
132 - $plugin->incompatible = 36;
133 incompatible takes a single int corresponding to the first incompatible branch. Any Moodle versions including and
134 above this will be prevented from installing the plugin, and a message will be given when attempting installation.
b2eec327 135* Added the <component>_bulk_user_actions() callback which returns a list of custom action_links objects
948a951a
AM
136* Add 'required' admin flag for mod forms allows elements to be toggled between being required or not in admin settings.
137 - In mod settings, along with lock, advanced flags, the required flag can now be set with $setting->set_required_flag_options().
138 The name of the admin setting must be exactly the same as the mod_form element.
139 - Currently supported by:
140 - mod_assign
141 - mod_quiz
262061d6 142* Added a native MySQL / MariaDB lock implementation
b4d062c6
SR
143* The database drivers (moodle_database and subclasses) don't need to implement get_columns() anymore.
144 They have to implement fetch_columns instead.
934c2ee1 145* Added function cleanup_after_drop to the database_manager class to take care of all the cleanups that need to be done after a table is dropped.
648e20ab 146* The 'xxxx_check_password_policy' callback now only fires if $CFG->passwordpolicy is true
ae46b744 147* grade_item::update_final_grade() can now take an optional parameter to set the grade->timemodified. If not present the current time will carry on being used.
06299fc6 148* lib/outputrequirementslib::get_jsrev now is public, it can be called from other classes.
08fda3e0 149* H5P libraries have been moved from /lib/h5p to h5p/h5plib as an h5plib plugintype.
3180869e
MG
150* mdn-polyfills has been renamed to polyfills. The reason there is no polyfill from the MDN is
151 because there is no example polyfills on the MDN for this functionality.
4400ed3e
MN
152* AJAX pages can be called without requiring a session lock if they set READ_ONLY_SESSION to true, eg.
153 define('READ_ONLY_SESSION', true); Note - this also requires $CFG->enable_read_only_sessions to be set to true.
154* External functions can be called without requiring a session lock if they define 'readonlysession' => true in
155 db/services.php. Note - this also requires $CFG->enable_read_only_sessions to be set to true.
47f3fa13 156* database_manager::check_database_schema() now checks for missing and extra indexes.
5bf5a7aa 157* Implement a more direct xsendfile_file() method for an alternative_file_system_class
685fe080
AN
158* A new `dynamic` table interface has been defined, which allows any `flexible_table` to be converted into a table which
159 is updatable via ajax calls. See MDL-68495 and `\core_table\dynamic` for further information.
9050f3f1
AN
160* The core/notification module has been updated to use AMD modals for its confirmation and alert dialogues.
161 The confirmation dialogue no longer has a configurable "No" button as per similar changes in MDL-59759.
162 This set of confirmation modals was unintentionally missed from that deprecation process.
8844cb82 163* The download_as_dataformat() method has been deprecated. Please use \core\dataformat::download_data() instead
44e47eff
MH
164* The following functions have been updated to support passing in an array of group IDs (but still support passing in a single ID):
165 * groups_get_members_join()
166 * groups_get_members_ids_sql()
4f9bcde9
SR
167* Additional parameters were added to core_get_user_dates:
168 - type: specifies the calendar type. Optional, defaults to Gregorian.
169 - fixday: Whether to remove leading zero for day. Optional, defaults to 1.
170 - fixhour: Whether to remove leading zero for hour. Optional, defaults to 1.
432b9a90 171* Legacy cron has been deprecated and will be removed in Moodle 4.1. This includes the functions:
d2ecc75e
EL
172 - cron_execute_plugin_type()
173 - cron_bc_hack_plugin_functions()
174 Please, use the Task API instead: https://docs.moodle.org/dev/Task_API
72316a9f
RK
175* Introduce new hooks for plugin developers:
176 - <component>_can_course_category_delete($category)
177 - <component>_can_course_category_delete_move($category, $newcategory)
178 These hooks allow plugin developers greater control over category deletion. Plugin can return false in those
179 functions if category deletion or deletion with content move to the new parent category is not permitted.
180 Both $category and $newcategory params are instances of core_course_category class.
181 - <component>_pre_course_category_delete_move($category, $newcategory)
182 This hook is expanding functionality of existing <component>_pre_course_category_delete hook and allow plugin developers
183 to execute code prior to category deletion when its content is moved to another category.
184 Both $category and $newcategory params are instances of core_course_category class.
185 - <component>_get_course_category_contents($category)
186 This hook allow plugin developers to add information that is displayed on category deletion form. Function should
187 return string, which will be added to the list of category contents shown on the form. $category param is an instance
188 of core_course_category class.
5b529aca 189* Data generator create_user in both unittests and behat now validates user fields and triggers user_created event
2ead888f 190
7aeeb444 191=== 3.8 ===
0bcc273f 192* Add CLI option to notify all cron tasks to stop: admin/cli/cron.php --stop
4a6edc57 193* The rotate_image function has been added to the stored_file class (MDL-63349)
7aeeb444 194* The yui checknet module is removed. Call \core\session\manager::keepalive instead.
c7321899 195* The generate_uuid() function has been deprecated. Please use \core\uuid::generate() instead.
b71e734b 196* Remove lib/pear/auth/RADIUS.php (MDL-65746)
29c442c5 197* Core components are now defined in /lib/components.json instead of coded into /lib/classes/component.php
e63a35dc 198* Subplugins should now be defined using /db/subplugins.json instead of /db/subplugins.php
db9f122f
MM
199* The following functions have been finally deprecated and can not be used anymore:
200 * allow_override()
201 * allow_assign()
202 * allow_switch()
b6e465c8
JP
203 * https_required()
204 * verify_https_required()
91930754 205* Remove duplicate font-awesome SCSS, Please see /theme/boost/scss/fontawesome for usage (MDL-65936)
062dc67e 206* Remove lib/pear/Crypt/CHAP.php (MDL-65747)
05b25140
JP
207* New output component available: \core\output\checkbox_toggleall
208 - This allows developers to easily output groups of checkboxes that can be toggled by master controls in the form of a checkbox or
209 a button. Action elements which perform actions on the selected checkboxes can also be enabled/disabled depending on whether
210 at least a single checkbox item is selected or not.
c5681f7f 211* Final deprecation (removal) of the core/modal_confirm dialogue.
d7b43fd9 212* Upgrade scssphp to v1.0.2, This involves renaming classes from Leafo => ScssPhp as the repo has changed.
1a159252
MG
213* Implement supports_xsendfile() method and allow support for xsendfile in alternative_file_system_class
214 independently of local files (MDL-66304).
94c71056
MN
215* The methods get_local_path_from_storedfile and get_remote_path_from_storedfile in lib/filestore/file_system.php
216 are now public. If you are overriding these then you will need to change your methods to public in your class.
9ea892d2
AN
217* It is now possible to use sub-directories for AMD modules.
218 The standard rules for Level 2 namespaces also apply to AMD modules.
219 The sub-directory used must be either an valid component, or placed inside a 'local' directory to ensure that it does not conflict with other components.
220
221 The following are all valid module names and locations in your plugin:
222 mod_forum/view: mod/forum/amd/src/view.js
223 mod_forum/local/views/post: mod/forum/amd/src/local/views/post
224 mod_forum/form/checkbox-toggle: mod/forum/amd/src/form/checkbox-toggle.js
225
226 The following are all invalid module names and locations in your plugin:
227 mod_forum/views/post: mod/forum/amd/src/views/post
c5f3e924
SA
228* The 'xxxx_check_password_policy' method now has an extra parameter: $user. It contains the user object to perform password
229validation against and defaults to null (so, no user needed) if not provided.
0261d1ef
AN
230* It is now possible to use sub-directories when creating mustache templates.
231 The standard rules for Level 2 namespaces also apply to templates.
232 The sub-directory used must be either an valid component, or placed inside a 'local' directory to ensure that it does not conflict with other components.
233
234 The following are all valid template names and locations in your plugin:
235 mod_forum/forum_post: mod/forum/templates/forum_post.mustache
236 mod_forum/local/post/user: mod/forum/templates/local/post/user.mustache
237 mod_forum/form/checkbox_toggle: mod/forum/templates/form/checkbox_toggle.mustache
c5f3e924 238
0261d1ef
AN
239 The following are _invalid_ template names and locations:
240 mod_forum/post/user: mod/forum/templates/local/post/user.mustache
09dedee2
MM
241* Following behat steps have been removed from core:
242 - I go to "<gradepath_string>" in the course gradebook
e2d97a46 243* A new admin setting widget 'core_admin\local\settings\filesize' is added.
1d6f041a 244* Core capabilities 'moodle/community:add' and 'moodle/community:download' have been removed from core as part of Moodle.net sunsetting.
14db7374
P
245* As part of Moodle.net sunsetting process the following hub api functions have been deprecated:
246 - get_courses
247 - unregister_courses
248 - register_course
249 - add_screenshot
250 - download_course_backup
251 - upload_course_backup
5beb3885
MN
252* A new setting 'Cache templates' was added (see MDL-66367). This setting determines if templates are cached or not.
253 This setting can be set via the UI or by defining $CFG->cachetemplates in your config.php file. It is a boolean
254 and should be set to either false or true. Developers will probably want to set this to false.
2d4ce64d 255* The core_enrol_edit_user_enrolment webservice has been deprecated. Please use core_enrol_submit_user_enrolment_form instead.
ca81e906 256* \single_button constructor has a new attributes param to add attributes to the button HTML tag.
60dc0242 257* Improved url matching behaviour for profiled urls and excluded urls
d6f5fbb7 258* Attempting to use xsendfile via the 3rd param of readstring_accel() is now ignored.
45899564
AA
259* New H5P libraries have been added to Moodle core in /lib/h5p.
260* New H5P core subsystem have been added.
810d7a3d
SA
261* Introduced new callback for plugin developers '<component>_get_path_from_pluginfile($filearea, $args)': This will return
262the itemid and filepath for the filearea and path defined in $args. It has been added in order to get the correct itemid and
263filepath because some components, such as mod_page or mod_resource, add the revision to the URL where the itemid should be placed
264(to prevent caching problems), but then they don't store it in database.
225eb7b2 265* New utility function \core_form\util::form_download_complete should be called if your code sends
266 a file with Content-Disposition: Attachment in response to a Moodle form submit button (to ensure
267 that disabled submit buttons get re-enabled in that case). It is automatically called by the
268 filelib.php send_xx functions.
269* If you have a form which sends a file in response to a Moodle form submit button, but you cannot
270 call the above function because the file is sent by a third party library, then you should add
271 the attribute data-double-submit-protection="off" to your form.
7aeeb444 272
b91ddd16 273=== 3.7 ===
21406f66 274
9df03b19 275* Nodes in the navigation api can have labels for each group. See set/get_collectionlabel().
b91ddd16 276* The method core_user::is_real_user() now returns false for userid = 0 parameter
cabdadf3
SA
277* 'mform1' dependencies (in themes, js...) will stop working because a randomly generated string has been added to the id
278attribute on forms to avoid collisions in forms loaded in AJAX requests.
b51b6969
AN
279* A new method to allow queueing or rescheduling of an existing scheduled task was added. This allows an existing task
280 to be updated or queued as required. This new functionality can be found in \core\task\manager::reschedule_or_queue_adhoc_task.
ef96eb02 281* Icons are displayed for screen readers unless they have empty alt text (aria-hidden). Do not provide an icon with alt text immediately beside an element with exactly the same text.
d940855f 282* admin_settingpage has a new function hide_if(), modeled after the same functionality in the forms library. This allows admin settings to be dynamically hidden based on the values of other settings.
9f3bf966
AN
283* The \core_rating provider's get_sql_join function now accepts an optional $innerjoin parameter.
284 It is recommended that privacy providers using this function call rewrite any long query into a number of separate
285 calls to add_from_sql for improved performance, and that the new argument is used.
286 This will allow queries to remain backwards-compatible with older versions of Moodle but will have significantly better performance in version supporting the innerjoin parameter.
4bbec310
AA
287* /message/defaultoutputs.php file and admin_page_defaultmessageoutputs class have been deprecated
288 and all their settings moved to admin/message.php (see MDL-64495). Please use admin_page_managemessageoutputs class instead.
545e2abb
SL
289* A new parameter $lang has been added to mustache_template_source_loader->load_with_dependencies() method
290 so it is possible for Mustache to request string in a specific language.
05a5d547 291* Behat timeout constants behat_base::TIMEOUT, EXTENDED_TIMEOUT, and REDUCED_TIMEOUT have been
292 deprecated. Please instead use the functions behat_base::get_timeout(), get_extended_timeout(),
293 and get_reduced_timeout(). These allow for timeouts to be increased by a setting in config.php.
e0695f87
JL
294* The $draftitemid parameter of file_save_draft_area_files() function now supports the constant IGNORE_FILE_MERGE:
295 When the parameter is set to that constant, the function won't process file merging, keeping the original state of the file area.
418a86c6 296 Notice also than when $text is set, pluginfile rewrite won't be processed so the text will not be modified.
5ba12283
JL
297* Introduced new callback for plugin developers '<component>_pre_processor_message_send($procname, $proceventdata)':
298 This will allow any plugin to manipulate messages or notifications before they are sent by a processor (email, mobile...)
f7b52799 299* New capability 'moodle/category:viewcourselist' in category context that controls whether user is able to browse list of courses
beff3806
MG
300 in this category. To work with list of courses use API methods in core_course_category and also 'course' form element.
301* It is possible to pass additional conditions to get_courses_search();
302 core_course_category::search_courses() now allows to search only among courses with completion enabled.
bf9f2555 303* Add support for a new xxx_after_require_login callback
734b198f
SA
304* A new conversation type has been created for self-conversations. During the upgrading process:
305 - Firstly, the existing self-conversations will be starred and migrated to the new type, removing the duplicated members in the
306 message_conversation_members table.
307 - Secondly, the legacy self conversations will be migrated from the legacy 'message_read' table. They will be created using the
308 new conversation type and will be favourited.
309 - Finally, the self-conversations for all remaining users without them will be created and starred.
310Besides, from now, a self-conversation will be created and starred by default to all the new users (even when $CFG->messaging
311is disabled).
b858b161
JP
312* New optional parameter $throwexception for \get_complete_user_data(). If true, an exception will be thrown when there's no
313 matching record found or when there are multiple records found for the given field value. If false, it will simply return false.
314 Defaults to false when not set.
cb28132d 315* Exposed submit button to allow custom styling (via customclassoverride variable) which can override btn-primary/btn-secondary classes
26e778d1
JL
316* `$includetoken` parameter type has been changed. Now supports:
317 boolean: False indicates to not include the token, true indicates to generate a token for the current user ($USER).
318 integer: Indicates to generate a token for the user whose id is the integer value.
319* The following functions have been updated to support the new usage:
320 - make_pluginfile_url
321 - file_rewrite_pluginfile_urls
e240a000 322* New mform element 'float' handles localised floating point numbers.
b91ddd16 323
437ffc9f 324=== 3.6 ===
325
883f6555
AN
326* A new token-based version of pluginfile.php has been added which can be used for out-of-session file serving by
327 setting the `$includetoken` parameter to true on the `moodle_url::make_pluginfile_url()`, and
328 `moodle_url::make_file_url()` functions.
329* The following picture functions have been updated to support use of the new token-based file serving:
330 - print_group_picture
331 - get_group_picture_url
88d89512
AN
332* The `user_picture` class has a new public `$includetoken` property which can be set to make use of the new token-based
333 file serving.
9411beb3 334* Custom AJAX handlers for the form autocomplete fields can now optionally return string in their processResults()
2dd33840 335 callback. If a string is returned, it is displayed instead of the list of suggested items. This can be used, for
9411beb3 336 example, to inform the user that there are too many items matching the current search criteria.
f8d15c66 337* The form element 'htmleditor' has been deprecated. Please use the 'editor' element instead.
350d7b06 338* The print_textarea() function has been deprecated. Please use $OUTPUT->print_textarea() instead.
437ffc9f 339* The following functions have been finally deprecated and can not be used any more:
d8e87342
MG
340 - external_function_info()
341 - core_renderer::update_module_button()
627d9aa6
DM
342 - events_trigger()
343 - events_cron()
344 - events_dispatch()
345 - events_is_registered()
346 - events_load_def()
347 - events_pending_count()
348 - events_process_queued_handler()
349 - events_queue_handler()
350 - events_trigger_legacy()
351 - events_update_definition()
5ab88243
MG
352 - get_file_url()
353 - course_get_cm_rename_action()
354 - course_scale_used()
355 - site_scale_used()
356 - clam_message_admins()
357 - get_clam_error_code()
216b8947
MG
358 - get_records_csv()
359 - put_records_csv()
360 - print_log()
361 - print_mnet_log()
362 - print_log_csv()
363 - print_log_xls()
364 - print_log_ods()
365 - build_logs_array()
366 - get_logs_usercourse()
367 - get_logs_userday()
368 - get_logs()
369 - prevent_form_autofill_password()
f2cdf993 370 - prefixed_tablenode_transformations()
a50b8a43
DM
371 - core_media_renderer
372 - core_media
8d2432f5 373* Following api's have been removed in behat_config_manager, please use behat_config_util instead.
374 - get_features_with_tags()
375 - get_components_steps_definitions()
376 - get_config_file_contents()
377 - merge_behat_config()
378 - get_behat_profile()
379 - profile_guided_allocate()
380 - merge_config()
381 - clean_path()
382 - get_behat_tests_path()
5f2628c5
MG
383* Following behat steps have been removed from core:
384 - I set the field "<field_string>" to multiline
385 - I follow "<link_string>"" in the open menu
02fda279
VDF
386* The following behat steps have been deprecated, please do not use these step definitions any more:
387 - behat_navigation.php: i_navigate_to_node_in()
388 - theme/boost/tests/behat/behat_theme_boost_behat_navigation.php: i_navigate_to_node_in()
389 Use one of the following steps instead:
390 - I navigate to "PATH > ITEM" in current page administration
391 - I navigate to "PATH > ITEM" in site administration
392 - I navigate to course participants
393 - I navigate to "TAB1 > TAB2" in the course gradebook
02fda279
VDF
394 If some items are not available without Navigation block at all, one can use combination of:
395 - I add the "Navigation" block if not present
396 - I click on "LINK" "link" in the "Navigation" "block"
4f06a977
EL
397* The core\session\util class has been removed. This contained one function only used by the memcached class which has
398 been moved there instead (connection_string_to_memcache_servers).
512a1d31 399* Removed the lib/password_compat/lib/password.php file.
5454e72c
AG
400* The eventslib.php file has been deleted and its functions have been moved to deprecatedlib.php. The affected functions are:
401 - events_get_cached()
402 - events_uninstall()
403 - events_cleanup()
404 - events_dequeue()
405 - events_get_handlers()
f7115c2e
SR
406* coursecat::get() now has optional $user parameter.
407* coursecat::is_uservisible() now has optional $user parameter.
2dd33840 408* Removed the lib/form/submitlink.php element which was deprecated in 3.2.
afa3e0ff
DM
409* The user_selector classes do not support custom list of extra identity fields any more. They obey the configured user
410 policy and respect the privacy setting made by site administrators. The list of user identifiers should never be
411 hard-coded. Instead, the setting $CFG->showuseridentity should be always respected, which has always been the default
412 behaviour (MDL-59847).
cc4952e9
AG
413* The function message_send() in messagelib.php will now only take the object \core\message\message as a parameter.
414* The method message_sent::create_from_ids() parameter courseid is now required. A debugging
415 message was previously displayed, and the SITEID was used, when not provided.
416* The method \core\message\manager::send_message() now only takes the object \core\message\message as the first parameter.
df536ab1 417* Following functions have been deprecated, please use get_roles_used_in_context.
418 - get_roles_on_exact_context()
419 - get_roles_with_assignment_on_context()
7d7d3b17 420* New functions to support the merging of user draft areas from the interface; see MDL-45170 for details:
c353ad20
JP
421 - file_copy_file_to_file_area()
422 - file_merge_draft_areas()
423 - file_replace_file_area_in_text()
424 - extract_draft_file_urls_from_text()
442f12f8
MG
425* Class coursecat is now alias to autoloaded class core_course_category, course_in_list is an alias to
426 core_course_list_element, class coursecat_sortable_records is deprecated without replacement.
69781cda
JP
427* \core_user_external::create_users() and \core_user_external::update_users() can now accept more user profile fields so user
428 creation/update via web service can now be very similar to the edit profile page's functionality. The new fields that have been
429 added are:
430 - maildisplay
431 - interests
432 - url
433 - icq
434 - skype
435 - aim
436 - yahoo
437 - msn
438 - institution
439 - department
440 - phone1
441 - phone2
442 - address
1d049e08
JC
443* New function mark_user_dirty() must be called after changing data that gets cached in user sessions. Examples:
444 - Assigning roles to users.
445 - Unassigning roles from users.
bdc51136
DM
446 - Enrolling users into courses.
447 - Unenrolling users from courses.
5290d060
SA
448* New optional parameter $context for the groups_get_members_join() function and ability to filter users that are not members of
449any group. Besides, groups_get_members_ids_sql, get_enrolled_sql and get_enrolled_users now accepts -1 (USERSWITHOUTGROUP) for
450the groupid field.
1afbb97b
AO
451* Added $CFG->conversionattemptlimit setting to config.php allowing a maximum number of retries before giving up conversion
452 of a given document by the assignfeedback_editpdf\task\convert_submissions task. Default value: 3.
beeadbf7
MN
453* The following events have been deprecated and should not be used any more:
454 - message_contact_blocked
455 - message_contact_unblocked
456 The reason for this is because you can now block/unblock users without them necessarily being a contact. These events
457 have been replaced with message_user_blocked and message_user_unblocked respectively.
14de10c4
MN
458* The event message_deleted has been changed, it no longer records the value of the 'useridto' due to
459 the introduction of group messaging. Please, if you have any observers or are triggering this event
460 in your code you will have to make some changes!
5d7a9ea6
MN
461* The gradebook now supports the ability to accept files as feedback. This can be achieved by adding
462 'feedbackfiles' to the $grades parameter passed to grade_update().
463 For example -
464 $grades['feedbackfiles'] = [
465 'contextid' => 1,
466 'component' => 'mod_xyz',
467 'filearea' => 'mod_xyz_feedback',
468 'itemid' => 2
469 ];
470 These files will be then copied to the gradebook file area.
32791416
SA
471* Allow users to choose who can message them for privacy reasons, with a 'growing circle of contactability':
472 - Added $CFG->messagingallusers, for enabling messaging to all site users. Default value: 0.
473 When $CFG->messagingallusers = false users can choose being contacted by only contacts or contacts and users sharing a course with them.
474 In that case, the default user preference is MESSAGE_PRIVACY_COURSEMEMBER (users sharing a course).
475 When $CFG->messagingallusers = true users have a new option for the privacy messaging preferences: "Anyone on the site". In that case,
476 the default user preference is MESSAGE_PRIVACY_SITE (all site users).
477 - Added $CFG->keepmessagingallusersenabled setting to config.php to force enabling $CFG->messagingallusers during the upgrading process.
478 Default value: 0.
479 When $CFG->keepmessagingallusersenabled is set to true, $CFG->messagingallusers will be also set to true to enable messaging site users.
480 However, when it is empty, $CFG->messagingallusers will be disabled during the upgrading process, so the users will only be able to
481 message contacts and users sharing a course with them.
d5adb60f
MP
482* There has been interface and functional changes to admin_apply_default_settings() (/lib/adminlib.php). The function now takes two
483 additional optional parameters, $admindefaultsettings and $settingsoutput. It also has a return value $settingsoutput.
484 The function now does not need to be called twice to ensure all default settings are set. Instead the function calls itself recursively
485 until all settings have been set. The additional parameters are used recursively and shouldn't be need to be explicitly passed in when calling
486 the function from other parts of Moodle.
487 The return value: $settingsoutput is an array of setting names and the values that were set by the function.
160e77f9 488* Webservices no longer update the lastaccess time for a user in a course. Call core_course_view_course() manually if needed.
0616f045 489* A new field has been added to the context table. Please ensure that any contxt preloading uses get_preload_record_columns_sql or get_preload_record_columns to fetch the list of columns.
f7115c2e 490
521252d6
DM
491=== 3.5 ===
492
4f41ae27
DM
493* There is a new privacy API that every subsystem and plugin has to implement so that the site can become GDPR
494 compliant. Plugins use this API to report what information they store or process regarding users, and provide ability
495 to export and delete personal data. See https://docs.moodle.org/dev/Privacy_API for guidelines on how to implement the
496 privacy API in your plugin.
cd305dc2 497* The cron runner now sets up a fresh PAGE and OUTPUT between each task.
76f8b361
EL
498* The core_renderer methods notify_problem(), notify_success(), notify_message() and notify_redirect() that were
499 deprecated in Moodle 3.1 have been removed. Use \core\notification::add(), or \core\output\notification as required.
521252d6
DM
500* The maximum supported precision (the total number of digits) for XMLDB_TYPE_NUMBER ("number") fields raised from 20 to
501 38 digits. Additionally, the whole number part (precision minus scale) must not be longer than the maximum length of
502 integer fields (20 digits). Note that PHP floats commonly support precision of roughly 15 digits only (MDL-32113).
0e68db9e
EL
503* Event triggering and event handlers:
504 - The following events, deprecated since moodle 2.6, have been finally removed: groups_members_removed,
505 groups_groupings_groups_removed, groups_groups_deleted, groups_groupings_deleted.
56c9d666
JP
506* The following functions have been finally deprecated and can not be used any more:
507 - notify()
54a099e9
EL
508* XMLDB now validates the PATH attribute on every install.xml file. Both the XMLDB editor and installation will fail
509 when a problem is detected with it. Please ensure your plugins contain correct directory relative paths.
caae0820 510* Add recaptchalib_v2.php for support of reCAPTCHA v2.
1727c939
MG
511* Plugins can define class 'PLUGINNAME\privacy\local\sitepolicy\handler' if they implement an alternative mechanisms for
512 site policies managements and agreements. Administrators can define which component is to be used for handling site
513 policies and agreements. See https://docs.moodle.org/dev/Site_policy_handler
0bdc5785
DM
514* Scripts can define a constant NO_SITEPOLICY_CHECK and set it to true before requiring the main config.php file. It
515 will make the require_login() skipping the test for the user's policyagreed status. This is useful for plugins that
516 act as a site policy handler.
c2e97077
DM
517* There is a new is_fulltext_search_supported() DML function. The default implementation returns false. This function
518 is used by 'Simple search' global search engine to determine if the database full-text search capabilities can be used.
3cfbce12
JP
519* The following have been removed from the list of core subsystems:
520 - core_register
521 - core_publish
3127fe10
MG
522 Following this change, \core_register_renderer and \core_publish_renderer have been removed and their methods have been
523 moved to \core_admin_renderer and \core_course_renderer respectively.
521252d6 524
8cf36e9c 525=== 3.4 ===
521252d6 526
d3882ea4 527* oauth2_client::request method has an extra parameter to specify the accept header for the response (MDL-60733)
f83d212b
EL
528* The following functions, previously used (exclusively) by upgrade steps are not available
529 anymore because of the upgrade cleanup performed for this version. See MDL-57432 for more info:
530 - upgrade_mimetypes()
531 - upgrade_fix_missing_root_folders_draft()
532 - upgrade_minmaxgrade()
533 - upgrade_course_tags()
534
8cf36e9c
DM
535* Added new moodleform element 'filetypes' and new admin setting widget 'admin_setting_filetypes'. These new widgets
536 allow users to define a list of file types; either by typing them manually or selecting them from a list. The widgets
537 directly support the syntax used to feed the 'accepted_types' option of the filemanager and filepicker elements. File
538 types can be specified as extensions (.jpg or just jpg), mime types (text/plain) or groups (image).
e705e69e
TL
539* Removed accesslib private functions: load_course_context(), load_role_access_by_context(), dedupe_user_access() (MDL-49398).
540* Internal "accessdata" structure format has changed to improve ability to perform role definition caching (MDL-49398).
541* Role definitions are no longer cached in user session (MDL-49398).
0f398b50
JL
542* External function core_group_external::get_activity_allowed_groups now returns an additional field: canaccessallgroups.
543 It indicates whether the user will be able to access all the activity groups.
bef201c7 544* file_get_draft_area_info does not sum the root folder anymore when calculating the foldercount.
6c8e25fa
DM
545* The moodleform element classes can now optionally provide a public function validateSubmitValue(). This method can be
546 used to perform implicit validation of submitted values - without the need to explicitly add the validation rules to
547 every form. The method should accept a single parameter with the submitted value. It should return a string with the
548 eventual validation error, or an empty value if the validation passes.
3b1eba06 549* New user_picture attribute $includefullname to determine whether to include the user's full name with the user's picture.
fd0a43be
JP
550* Enrol plugins which provide enrolment actions can now declare the following "data-action" attributes in their implementation of
551 enrol_plugin::get_user_enrolment_actions() whenever applicable:
552 * "editenrolment" - For editing a user'e enrolment details. Defined by constant ENROL_ACTION_EDIT.
553 * "unenrol" - For unenrolling a student. Defined by constant ENROL_ACTION_UNENROL.
554 These attributes enable enrol actions to be rendered via modals. If not added, clicking on the enrolment action buttons will still
555 redirect the user to the appropriate enrolment action page. Though optional, it is recommended to add these attributes for a
556 better user experience when performing enrol actions.
4047fccb
JP
557* The enrol_plugin::get_user_enrolment_actions() implementations for core enrol plugins have been removed and moved to
558 the parent method itself. New enrol plugins don't have to implement get_user_enrolment_actions(), but just need to
559 make sure that they override:
560 - enrol_plugin::allow_manage(), and/or
561 - enrol_plugin::allow_unenrol_user() or enrol_plugin::allow_unenrol()
562 Existing enrol plugins that override enrol_plugin::get_user_enrolment_actions() don't have to do anything, but can
563 also opt to remove their own implementation of the method if they basically have the same logic as the parent method.
bb1c6f85
JP
564* New optional parameter $enrolid for the following functions:
565 - get_enrolled_join()
566 - get_enrolled_sql()
567 - get_enrolled_with_capabilities_join()
568 Setting this parameter to a non-zero value will add a condition to the query such that only users that were enrolled
569 with this enrolment method will be returned.
198d7291
JP
570* New optional parameter 'closeSuggestionsOnSelect' for the enhance() function for form-autocomplete. Setting this to true will
571 close the suggestions popup immediately after an option has been selected. If not specified, it defaults to true for single-select
572 elements and false for multiple-select elements.
4d068a67 573* user_can_view_profile() now also checks the moodle/user:viewalldetails capability.
237efd4f
JP
574* The core/modal_confirm dialogue has been deprecated. Please use the core/modal_save_cancel dialogue instead. Please ensure you
575 update to use the ModalEvents.save and ModalEvents.cancel events instead of their yes/no counterparts.
93b47710
MN
576* Instead of checking the 'moodle/course:viewparticipants' and 'moodle/site:viewparticipants' capabilities use the
577 new functions course_can_view_participants() and course_require_view_participants().
b1eb6dd7 578* $stored_file->add_to_curl_request() now adds the filename to the curl request.
b58764ff
JO
579* The option for Login HTTPS (authentication-only SSL) has been removed
580* $CFG->loginhttps is now deprecated, do not use it.
4b501ec9 581* $PAGE->https_required and $PAGE->verify_https_required() are now deprecated. They are no longer used and will throw a coding_exception.
672f4836 582* $CFG->httpswwwroot is now deprecated and will always result in the same value as wwwroot.
a63cd3e2
AH
583* Added function core_role_set_view_allowed() to check if a user should be able to see a given role.
584 This should be checked whenever displaying a list of roles to a user, however, core_role_set_assign_allowed may need to override it
585 in some cases.
64cd4596 586* Deprecated allow_override, allow_assign and allow_switch and replaced with core_role_set_*_allowed to avoid function names conflicting.
8cf36e9c 587
67bebb69
IA
588=== 3.3.1 ===
589
590* ldap_get_entries_moodle() now always returns lower-cased attribute names in the returned entries.
591 It was suppposed to do so before, but it actually didn't.
592
3be09119 593=== 3.3 ===
1cb5c7b3 594
69cdead3
DP
595* Behat compatibility changes are now being documented at
596 https://docs.moodle.org/dev/Acceptance_testing/Compatibility_changes
55946a89
EL
597* PHPUnit's bootstrap has been changed to use HTTPS wwwroot (https://www.example.com/moodle) from previous HTTP version. Any
598 existing test expecting the old HTTP URLs will need to be switched to the new HTTPS value (reference: MDL-54901).
f59d81f4
DW
599* The information returned by the idp list has changed. This is usually only rendered by the login page and login block.
600 The icon attribute is removed and an iconurl attribute has been added.
151b0f94 601* Support added for a new type of external file: FILE_CONTROLLED_LINK. This is an external file that Moodle can control
141ee541 602 the permissions. Moodle makes files read-only but can grant temporary write access.
151b0f94
DW
603 When accessing a URL, the info from file_browser::get_file_info will be checked to determine if the user has write access,
604 if they do - the remote file will have access controls set to allow editing.
547801a4
FM
605* The method moodleform::after_definition() has been added and can now be used to add some logic
606 to be performed after the form's definition was set. This is useful for intermediate subclasses.
c8d0efc3
DW
607* Moodle has support for font-awesome icons. Plugins should use the xxx_get_fontawesome_icon_map callback
608 to map their custom icons to one from font-awesome.
609* $OUTPUT->pix_url() has been deprecated because it is was used mostly to manually generate image tags for icons.
610 We now distinguish between icons and "small images". The difference is that an icon does not have to be rendered as an image tag
611 with a source. It is OK to still have "small images" - if this desired use $OUTPUT->image_icon() and $OUTPUT->image_url(). For
612 other uses - use $OUTPUT->pix_icon() or the pix helper in mustache templates {{#pix}}...{{/pix}}
c266d256 613 For other valid use cases use $OUTPUT->image_url().
3e6adcd6 614* Activity icons have been split from standard icons. Use $OUTPUT->image_icon instead of $OUTPUT->pix_icon for these
c2dde7ee 615 type of icons (the coloured main icon for each activity).
d83d87f6
DP
616* YUI module moodle-core-formautosubmit has been removed, use jquery .change() instead (see lib/templates/url_select.mustache for
617 an example)
2fa2ed50
DP
618* $mform->init_javascript_enhancement() is deprecated and no longer does anything. Existing uses of smartselect enhancement
619 should be switched to the searchableselector form element or other solutions.
7620746f 620* Return value of the validate_email() is now proper boolean as documented. Previously the function could return 1, 0 or false.
e7ecb4a9
DP
621* The mcore YUI rollup which included various YUI modules such as moodle-core-notification is no longer included on every
622 page. Missing YUI depdencies may be exposed by this change (e.g. missing a requirement on moodle-core-notification when
623 using M.core.dialogue).
e1a38878
DP
624* Various legacy javascript functions have been removed:
625 * M.util.focus_login_form and M.util.focus_login_error no longer do anything. Please use jquery instead. See
626 lib/templates/login.mustache for an example.
627 * Some outdated global JS functions have been removed and should be replaced with calls to jquery
628 or alternative approaches:
629 checkall, checknone, select_all_in_element_with_id, select_all_in, deselect_all_in, confirm_if, findParentNode,
630 filterByParent, stripHTML
631 * M.util.init_toggle_class_on_click has been removed.
16a34ae1
AN
632* The following functions have been deprecated and should not be used any more:
633 - file_storage::try_content_recovery - See MDL-46375 for more information
634 - file_storage::content_exists - See MDL-46375 for more information
635 - file_storage::deleted_file_cleanup - See MDL-46375 for more information
15681687
AN
636 - file_storage::get_converted_document
637 - file_storage::is_format_supported_by_unoconv
638 - file_storage::can_convert_documents
639 - file_storage::send_test_pdf
640 - file_storage::test_unoconv_path
d58adec8
AA
641* Following behat steps have been removed from core:
642 - I click on "<element_string>" "<selector_string>" in the "<row_text_string>" table row
643 - I go to notifications page
644 - I add "<filename_string>" file from recent files to "<filepicker_field_string>" filepicker
645 - I upload "<filepath_string>" file to "<filepicker_field_string>" filepicker
646 - I create "<foldername_string>" folder in "<filepicker_field_string>" filepicker
647 - I open "<foldername_string>" folder from "<filepicker_field_string>" filepicker
648 - I unzip "<filename_string>" file from "<filepicker_field_string>" filepicker
649 - I zip "<filename_string>" folder from "<filepicker_field_string>" filepicker
650 - I delete "<file_or_folder_name_string>" from "<filepicker_field_string>" filepicker
651 - I send "<message_contents_string>" message to "<username_string>"
652 - I add "<user_username_string>" user to "<cohort_idnumber_string>" cohort
653 - I add "<username_string>" user to "<group_name_string>" group
654 - I fill in "<field_string>" with "<value_string>"
655 - I select "<option_string>" from "<select_string>"
656 - I select "<radio_button_string>" radio button
657 - I check "<option_string>"
658 - I uncheck "<option_string>"
659 - the "<field_string>" field should match "<value_string>" value
660 - the "<checkbox_string>" checkbox should be checked
661 - the "<checkbox_string>" checkbox should not be checked
662 - I fill the moodle form with:
663 - "<element_string>" "<selector_string>" should exists
664 - "<element_string>" "<selector_string>" should not exists
665 - the following "<element_string>" exists:
7c8afa8f
AG
666* get_user_capability_course() now has an additional parameter 'limit'. This can be used to return a set number of records with
667 the submitted capability. The parameter 'fieldsexceptid' will now accept context fields which can be used for preloading.
ed0a1cd7 668* The caching option 'immutable' has been added to send_stored_file() and send_file().
37d0c7c7 669* New adhoc task refresh_mod_calendar_events_task that updates existing calendar events of modules.
ca75ec4f 670* New 'priority' column for the event table to determine which event to show in case of events with user and group overrides.
fb41d2f0 671* Webservices core_course_search_courses and core_course_get_courses_by_field will always return the sortorder field.
e9dfeec9 672* core_course_external::get_activities_overview has been deprecated. Please do not call this function any more.
e03d5d47 673* Changed the pix mustache template helper to accept context variables for the key, component and alt text.
627ea5b1
JP
674* New auth_plugin_base helper methods:
675 - get_identity_providers() - Retrieves available auth identity providers.
676 - prepare_identity_providers_for_output() - Prepares auth identity provider data for output (e.g. to templates, WS, etc.).
2fa2ed50 677
af6a4240
CB
678=== 3.2 ===
679
2a7c540c
DW
680* Custom roles with access to any part of site administration that do not use the manager archetype will need
681 moodle/site:configview capability added.
ba5c5083 682* Admin setting "Show My courses expanded on Dashboard" has been removed.
fb045b4e
DW
683* Some backwards and forwards compatibility has been added for different bootstrap versions.
684 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
685 with bootstrap classes to keep working in the new theme. See MDL-56004 for the list of supported classes.
ff392efc 686* MForms element 'submitlink' has been deprecated.
f7ed5cee
DW
687* Searchable selector form element is now a wrapper for autocomplete. A "No selection" option is automatically
688 added to the options list for best backwards compatibility - if you were manually adding a "no selection" option you will need
689 to remove it.
2ce91090 690* Node.js versions >=4 are now required to run grunt.
d863344a
DW
691* JQuery has been updated to 3.1.0. JQuery migrate plugins are no longer shipped - please read
692 https://jquery.com/upgrade-guide/3.0/ and update your javascript.
af6a4240 693* New option 'blanktarget' added to format_text. This option adds target="_blank" to links
6f9ad7e2
AN
694* A new webservice structure `external_files` has been created which provides a standardised view of files in Moodle and
695 should be used for all file return descriptions.
696 Files matching this format can be retrieved via the new `external_util::get_area_files` method.
697 See MDL-54951 for further information.
df52c272
FM
698* The parameter $usepost of the following functions has been deprecated and is not used any more:
699 - get_max_upload_file_size()
700 - get_user_max_upload_file_size()
b34ed08a
AN
701* The following classes have been removed and should not be used any more:
702 - boxclient - See MDL-49599 for more information.
ff3778bf
AN
703* The following functions have been removed and should not be used any more:
704 - file_modify_html_header() - See MDL-29738 for more information.
aa7e371a 705* core_grades_external::get_grades has been deprecated. Please do not call this function any more.
64064315 706 External function gradereport_user_external::get_grade_items can be used for retrieving the course grades information.
6fb1a717 707* New option 'escape' added to format_string. When true (default), escapes HTML entities from the string
f6f0ba2d
AG
708* The following functions have been deprecated and are not used any more:
709 - get_records_csv() Please use csv_import_reader::load_csv_content() instead.
710 - put_records_csv() Please use download_as_dataformat (lib/dataformatlib.php) instead.
2c2f4f17
AN
711 - zip_files() - See MDL-24343 for more information.
712 - unzip_file() - See MDL-24343 for more information.
2017a60e
EL
713 - print_log() - See MDL-43681 for more information
714 - print_log_csv() - See MDL-43681 for more information
715 - print_log_ods() - See MDL-43681 for more information
716 - print_log_xls() - See MDL-43681 for more information
717 - print_mnet_log() - See MDL-43681 for more information
718 - build_logs_array() - See MDL-43681 for more information
719 - get_logs() - See MDL-43681 for more information
720 - get_logs_usercourse() - See MDL-43681 for more information
721 - get_logs_userday() - See MDL-43681 for more information
ac157b0b 722 - prevent_form_autofill_password() Please do not use anymore.
21e8b48d 723* The password_compat library was removed as it is no longer required.
52f3e060
RT
724* Phpunit has been upgraded to 5.4.x and following has been deprecated and is not used any more:
725 - setExpectedException(), use @expectedException or $this->expectException() and $this->expectExceptionMessage()
726 - getMock(), use createMock() or getMockBuilder()->getMock()
727 - UnitTestCase class is removed.
7a07d34d
JP
728* The following methods have been finally deprecated and should no longer be used:
729 - course_modinfo::build_section_cache()
730 - cm_info::get_deprecated_group_members_only()
731 - cm_info::is_user_access_restricted_by_group()
732* The following methods in cm_info::standardmethods have also been finally deprecated and should no longer be used:
733 - cm_info::get_after_edit_icons()
734 - cm_info::get_after_link()
735 - cm_info::get_content()
736 - cm_info::get_custom_data()
737 - cm_info::get_extra_classes()
738 - cm_info::get_on_click()
739 - cm_info::get_url()
740 - cm_info::obtain_dynamic_data()
741 Calling them through the magic method __call() will throw a coding exception.
f1f94da4
AN
742* The alfresco library has been removed from core. It was an old version of
743 the library which was not compatible with newer versions of Alfresco.
7a05bc92 744* Added down arrow: $OUTPUT->darrow.
2c2f4f17
AN
745* All file_packer implementations now accept an additional parameter to allow a simple boolean return value instead of
746 an array of individual file statuses.
e259795c 747* "I set the field "field_string" to multiline:" now end with colon (:), as PyStrings is supposed to end with ":"
51d85c7c
AN
748* New functions to support deprecation of events have been added to the base event. See MDL-46214 for further details.
749* A new function `get_name_with_info` has been added to the base event. This function adds information about event
750 deprecations and should be used where this information is relevant.
e99f0cbb
RT
751* Following api's have been deprecated in behat_config_manager, please use behat_config_util instead.
752 - get_features_with_tags
753 - get_components_steps_definitions
754 - get_config_file_contents
755 - merge_behat_config
756 - get_behat_profile
757 - profile_guided_allocate
758 - merge_config
759 - clean_path
760 - get_behat_tests_path
5aa9b5ce
RT
761* behat_util::start_test_mode() accepts 3 options now:
762 - 1. Theme sute with all features: If behat should initialise theme suite with all core features.
763 - 2. Parallel runs: How many parallel runs will be running.
764 - 3. Run: Which process behat should be initialise for.
765* behat_context_helper::set_session() has been deprecated, please use behat_context_helper::set_environment() instead.
9b9afffe 766* data-fieldtype="type" attribute has been added to form field default template.
721e2def
MG
767* form elements extending MoodleQuickForm_group must call $this->createFormElement() instead of
768 @MoodleQuickForm::createElement() in order to be compatible with PHP 7.1
b5830334
EL
769* Relative paths in $CFG->alternateloginurl will be resolved to absolute path within moodle site. Previously they
770 were resolved to absolute path within the server. That means:
234e1449
RT
771 - $CFG->wwwroot: http://example.com/moodle
772 - $CFG->alternateloginurl : /my/super/login.php
773 - Login url will be: http://example.com/moodle/my/super/login.php (moodle root based)
9d5c12be
EL
774* Database (DML) layer:
775 - new sql_equal() method available for places where case sensitive/insensitive varchar comparisons are required.
f834a8f5
RS
776* PostgreSQL connections now use advanced options to reduce connection overhead. These options are not compatible
777 with some connection poolers. The dbhandlesoptions parameter has been added to allow the database to configure the
778 required defaults. The parameters that are required in the database are;
779 ALTER DATABASE moodle SET client_encoding = UTF8;
780 ALTER DATABASE moodle SET standard_conforming_strings = on;
ce7863ba 781 ALTER DATABASE moodle SET search_path = 'moodle,public'; -- Optional, if you wish to use a custom schema.
f834a8f5 782 You can set these options against the database or the moodle user who connects.
fc7f69e7
FM
783* Some form elements have been refined to better support right-to-left languages. In RTL,
784 most fields should not have their direction flipped, a URL, a path to a file, a number, ...
785 are always displayed LTR. Input fields and text areas now will best guess whether they
786 should be forced to be displayed in LTR based on the PARAM type associated with it. You
787 can call $mform->setForceLtr($elementName, true/false) on some form fields to manually
788 set the value.
370e7637 789* Action menus do_not_enhance() is deprecated, use a list of action_icon instead.
ccc77703
EL
790* The user_not_fully_set_up() function has a new $strict parameter (defaulting to true) in order to decide when
791 custom fields (and other checks) should be evaluated to determine if the user has been completely setup.
3ee392c8
JL
792* profile_field_base class has new methods: get_field_config_for_external() and get_field_properties().
793 This two new methods should be implemented by profile field plugins to make them compatible with Web Services.
4cb24aa9
DP
794* The minifier library used by core_minify has been switched to https://github.com/matthiasmullie/minify - there are minor differences
795 in minifier output.
8b99e163 796* context_header additional buttons can now have a class attribute provided in the link attributes.
dc213b45
AN
797* The return signature for the antivirus::scan_file() function has changed.
798 The calling function will now handle removal of infected files from Moodle based on the new integer return value.
a29bcf78
EL
799* The first parameter $eventdata of both message_send() and \core\message\manager::send_message() should
800 be \core\message\message. Use of stdClass is deprecated.
801* The message_sent event now expects other[courseid] to be always set, exception otherwise. For BC with contrib code,
802 message_sent::create_from_ids() will show a debugging notice if the \core\message\message being sent is missing
803 the courseid property, defaulting to SITEID automatically. In Moodle 3.6 (MDL-55449) courseid will be fully mandatory
804 for all messages sent.
d6a25bc4 805* The send_confirmation_email() function has a new optional parameter $confirmationurl to provide a different confirmation URL.
bb316e07
JD
806* Introduced a new hook for plugin developers:
807 - <component>_course_module_background_deletion_recommended()
808 This hook should be used in conjunction with the existing '<component>_pre_course_module_delete($mod)'. It must
809 return a boolean and is called by core to check whether a plugin's implementation of
810 <component>_pre_course_module_deleted($mod) will take a long time. A plugin should therefore only implement this
811 function if it also implements <component>_pre_course_module_delete($mod).
812 An example in current use is recyclebin, which performs what can be a lengthy backup process in
813 tool_recyclebin_pre_course_module_delete. The recyclebin, if enabled, now returns true in its implementation of
814 tool_recyclebin_course_module_background_deletion_recommended(), to indicate to core that the deletion (and
815 execution of tool_recyclebin_pre_course_module_delete) should be handled with an adhoc task, meaning it will not
816 occur in real time.
af6a4240 817
20dde5e6
JPG
818=== 3.1 ===
819
427e3cbc
EM
820* Webservice function core_course_search_courses accepts a new parameter 'limittoenrolled' to filter the results
821 only to courses the user is enrolled in, and are visible to them.
56fa860e
DW
822* External functions that are not calling external_api::validate_context are buggy and will now generate
823 exceptions. Previously they were only generating warnings in the webserver error log.
e02e7f5a 824 See https://docs.moodle.org/dev/External_functions_API#Security
221bfffd 825* The moodle/blog:associatecourse and moodle/blog:associatemodule capabilities has been removed.
a77e0611
SL
826* The following functions has been finally deprecated and can not be used any more:
827 - profile_display_badges()
828 - useredit_shared_definition_preferences()
829 - calendar_normalize_tz()
830 - get_user_timezone_offset()
831 - get_timezone_offset()
832 - get_list_of_timezones()
833 - calculate_user_dst_table()
834 - dst_changes_for_year()
835 - get_timezone_record()
836 - test_get_list_of_timezones()
837 - test_get_timezone_offset()
838 - test_get_user_timezone_offset()
6648283a
SL
839* The google api library has been updated to version 1.1.7. There was some important changes
840 on the SSL handling. Now the SSL version will be determined by the underlying library.
841 For more information see https://github.com/google/google-api-php-client/pull/644
b6d12864
AE
842* The get_role_users() function will now add the $sort fields that are not part
843 of the requested fields to the query result and will throw a debugging message
844 with the added fields when that happens.
dccf9ca3
SL
845* The core_user::fill_properties_cache() static method has been introduced to be a reference
846 and allow standard user fields data validation. Right now only type validation is supported
847 checking it against the parameter (PARAM_*) type of the target user field. MDL-52781 is
848 going to add support to null/not null and choices validation, replacing the existing code to
849 validate the user fields in different places in a common way.
235ef57a
DW
850* Webservice function core_course_search_courses now returns results when the search string
851 is less than 2 chars long.
852* Webservice function core_course_search_courses accepts a new parameter 'requiredcapabilities' to filter the results
853 by the capabilities of the current user.
854* New mform element 'course' handles thousands of courses with good performance and usability.
3ad96419
AN
855* The redirect() function will now redirect immediately if output has not
856 already started. Messages will be displayed on the subsequent page using
857 session notifications. The type of message output can be configured using the
858 fourth parameter to redirect().
24346803
AN
859* The specification of extra classes in the $OUTPUT->notification()
860 function, and \core\output\notification renderable have been deprecated
861 and will be removed in a future version.
862 Notifications should use the levels found in \core\output\notification.
863* The constants for NOTIFY_PROBLEM, NOTIFY_REDIRECT, and NOTIFY_MESSAGE in
864 \core\output\notification have been deprecated in favour of NOTIFY_ERROR,
865 NOTIFY_WARNING, and NOTIFY_INFO respectively.
1405f010
EL
866* The following functions, previously used (exclusively) by upgrade steps are not available
867 anymore because of the upgrade cleanup performed for this version. See MDL-51580 for more info:
868 - upgrade_mysql_fix_unsigned_and_lob_columns()
869 - upgrade_course_completion_remove_duplicates()
870 - upgrade_save_orphaned_questions()
871 - upgrade_rename_old_backup_files_using_shortname()
872 - upgrade_mssql_nvarcharmax()
873 - upgrade_mssql_varbinarymax()
874 - upgrade_fix_missing_root_folders()
875 - upgrade_course_modules_sequences()
876 - upgrade_grade_item_fix_sortorder()
877 - upgrade_availability_item()
bb690849
DW
878* A new parameter $ajaxformdata was added to the constructor for moodleform. When building a
879 moodleform in a webservice or ajax script (for example using the new fragments API) we
880 cannot allow the moodleform to parse it's own data from _GET and _POST - we must pass it as
881 an array.
20dde5e6
JPG
882* Plugins can extend the navigation for user by declaring the following callback:
883 <frankenstyle>_extend_navigation_user(navigation_node $parentnode, stdClass $user,
884 context_user $context, stdClass $course,
885 context_course $coursecontext)
c917b53a 886* The function notify() now throws a debugging message - see MDL-50269.
53907dbe
DP
887* Ajax calls going through lib/ajax/* now validate the return values before sending
888 the response. If the validation does not pass an exception is raised. This behaviour
889 is consistent with web services.
1a0df553
MG
890* Several changes in Moodle core, standard plugins and third party libraries to
891 ensure compatibility with PHP7. All plugins are recommended to perform testing
479950d4
MG
892 against PHP7 as well. Refer to https://docs.moodle.org/dev/Moodle_and_PHP7 for more
893 information. The following changes may affect you:
1a0df553
MG
894 * Class moodleform, moodleform_mod and some module classes have been changed to use
895 __construct() for the constructor. Calling parent constructors by the class
896 name will display debugging message. Incorrect: parent::moodleform(),
897 correct: parent::__construct()
898 * All form elements have also changed the constructor syntax. No changes are
899 needed for using form elements, however if plugin defines new form element it
900 needs to use correct syntax. For example, incorrect: parent::HTML_QuickForm_input(),
901 HTML_QuickForm_input::HTML_QuickForm_input(), $this->HTML_QuickForm_input().
902 Correct: HTML_QuickForm_input::__construct() or parent::__construct().
c4d0b752
MG
903 * profile_field_base::profile_field_base() is deprecated, use parent::__construct()
904 in custom profile fields constructors. Similar deprecations in exsiting
905 profile_field_* classes.
906 * user_filter_type::user_filter_type() is deprecated, use parent::__construct() in
907 custom user filters. Similar deprecations in existing user_filter_* classes.
908 * table_default_export_format_parent::table_default_export_format_parent() is
909 deprecated, use parent::__construct() in extending classes.
c026a28d
MG
910* groups_delete_group_members() $showfeedback parameter has been removed and is no longer
911 respected. Users of this function should output their own feedback if required.
912* Number of changes to Tags API, see tag/upgrade.txt for more details
32f8bbd8
DM
913* The previous events API handlers are being deprecated in favour of events 2 API, debugging messages are being displayed if
914 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
915 Note than you will need to bump the plugin version so moodle is aware that you removed the plugin's event handlers.
2edb12ec
DM
916* mforms validation functions are not available in the global JS namespace anymore, event listeners
917 are assigned to fields and buttons through a self-contained JS function.
2ab797c9
BH
918* Added $CFG->urlrewriteclass option to config.php allowing clean / semantic urls to
919 be implemented in a plugin, eg local_cleanurls.
11362ae3
RK
920* $CFG->pathtoclam global setting has been moved to clamav antivirus plugin setting of the same name.
921* clam_message_admins() and get_clam_error_code() have been deprecated, its functionality
922 is now a part of \antivirus_clamav\scanner class methods.
923* \repository::antivir_scan_file() has been deprecated, \core\antivirus\manager::scan_file() that
375223c6 924 applies antivirus plugins is replacing its functionality.
d84a657d 925* Added core_text::str_max_bytes() which safely truncates multi-byte strings to a maximum number of bytes.
b5e6ec44 926* Zend Framework has been removed completely.
322f3141 927* Any plugin can report when a scale is being used with the callback function [pluginname]_scale_used_anywhere(int $scaleid).
529ea77b 928* Changes in file_rewrite_pluginfile_urls: Passing a new option reverse = true in the $options var will make the function to convert
296ab1e2 929 actual URLs in $text to encoded URLs in the @@PLUGINFILE@@ form.
e891c838 930* behat_util::is_server_running() is removed, please use behat_util::check_server_status() instead.
921faad9
RT
931* Behat\Mink\Selector\SelectorsHandler::xpathLiteral() method is deprecated use behat_context_helper::escape instead
932 when building Xpath, or pass the unescaped value when using the named selector.',
9df4ae41 933* table_sql download process is using the new data formats plugin which you can't use if you are buffering any output
a2e6df5e
EL
934 * flexible_table::get_download_menu(), considered private, has been deleted. Use
935 $OUTPUT->download_dataformat_selector() instead.
bc219382
MS
936 when building Xpath, or pass the unescaped value when using the named selector.
937* Add new file_is_executable(), to consistently check for executables even in Windows (PHP bug #41062).
b858b161 938* Introduced new hooks for plugin developers.
a9ad3002
MN
939 - <component>_pre_course_category_delete($category)
940 - <component>_pre_course_delete($course)
941 - <component>_pre_course_module_delete($cm)
942 - <component>_pre_block_delete($instance)
943 - <component>_pre_user_delete($user)
b858b161 944 These hooks allow developers to use the item in question before it is deleted by core. For example, if your plugin is
a9ad3002
MN
945 a module (plugins located in the mod folder) called 'xxx' and you wish to interact with the user object before it is
946 deleted then the function to create would be mod_xxx_pre_user_delete($user) in mod/xxx/lib.php.
0ddc7e55 947* pear::Net::GeoIP has been removed.
20dde5e6 948
303936aa
TL
949=== 3.0 ===
950
4eeea2cb 951* Minify updated to 2.2.1
7fa6b587 952* htmlpurifier upgraded to 4.7.0
df098760 953* Less.php upgraded to 1.7.0.9
f77cd371 954* The horde library has been updated to version 5.2.7.
80af92f0 955* Google libraries (lib/google) updated to 1.1.5
ec2d33df 956* Html2Text library has been updated to the latest version of the library.
88982b71
DW
957* External functions x_is_allowed_from_ajax() methods have been deprecated. Define 'ajax' => true in db/services.php instead.
958* External functions can be called without a session if they define 'loginrequired' => true in db/services.php.
98ea6973
DM
959* All plugins are required to declare their frankenstyle component name via
960 the $plugin->component property in their version.php file. See
961 https://docs.moodle.org/dev/version.php for details (MDL-48494).
b80b35d0 962* PHPUnit is upgraded to 4.7. Some tests using deprecated assertions etc may need changes to work correctly.
988592c5 963* Users of the text editor API to manually create a text editor should call set_text before calling use_editor.
4e8afd56 964* Javascript - SimpleYUI and the Y instance used for modules have been merged. Y is now always the same instance of Y.
f4864c1c 965* get_referer() has been deprecated, please use the get_local_referer function instead.
303936aa 966* \core\progress\null is renamed to \core\progress\none for improved PHP7 compatibility as null is a reserved word (see MDL-50453).
cd27a860
AN
967* \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
968 server exceptions in $CFG->proxybypass. See MDL-39353 for details.
ed0fd1f6
DM
969* Group and groupings idnumbers can now be passed to and/or are returned from the following web services functions:
970 ** core_group_external::create_groups
971 ** core_group_external::get_groups
972 ** core_group_external::get_course_groups
973 ** core_group_external::create_groupings
974 ** core_group_external::update_groupings
975 ** core_group_external::get_groupings
976 ** core_group_external::get_course_groupings
977 ** core_group_external::get_course_user_groups
2149326b
AA
978* Following functions are removed from core. See MDL-50049 for details.
979 password_compat_not_supported()
980 session_get_instance()
981 session_is_legacy()
982 session_kill_all()
188458a6
EL
983 session_touch()
984 session_kill()
2149326b
AA
985 session_kill_user()
986 session_set_user()
987 session_is_loggedinas()
988 session_get_realuser()
989 session_loginas()
990 js_minify()
991 css_minify_css()
2149326b
AA
992 update_login_count()
993 reset_login_count()
188458a6 994 check_gd_version()
2149326b
AA
995 update_log_display_entry()
996 get_recent_enrolments()
997 groups_filter_users_by_course_module_visible()
998 groups_course_module_visible()
999 error()
1000 formerr()
1001 editorhelpbutton()
1002 editorshortcutshelpbutton()
1003 choose_from_menu()
1004 update_event()
1005 get_generic_section_name()
1006 get_all_sections()
1007 add_mod_to_section()
1008 get_all_mods()
1009 get_course_section()
1010 format_weeks_get_section_dates()
1011 get_print_section_cm_text()
1012 print_section_add_menus()
1013 make_editing_buttons()
1014 print_section()
1015 print_overview()
1016 print_recent_activity()
1017 delete_course_module()
1018 update_category_button()
1019 make_categories_list()
1020 category_delete_move()
1021 category_delete_full()
1022 move_category()
1023 course_category_hide()
1024 course_category_show()
1025 get_course_category()
1026 create_course_category()
1027 get_all_subcategories()
1028 get_child_categories()
1029 get_categories()
1030 print_course_search()
1031 print_my_moodle()
1032 print_remote_course()
1033 print_remote_host()
1034 print_whole_category_list()
1035 print_category_info()
b164e2ec 1036 get_course_category_tree()
2149326b
AA
1037 print_courses()
1038 print_course()
1039 get_category_courses_array()
1040 get_category_courses_array_recursively()
b164e2ec 1041 blog_get_context_url()
2149326b
AA
1042 get_courses_wmanagers()
1043 convert_tree_to_html()
1044 convert_tabrows_to_tree()
1045 can_use_rotated_text()
1046 get_parent_contexts()
1047 get_parent_contextid()
1048 get_child_contexts()
188458a6 1049 create_contexts()
2149326b
AA
1050 cleanup_contexts()
1051 build_context_path()
1052 rebuild_contexts()
1053 preload_course_contexts()
1054 context_moved()
1055 fetch_context_capabilities()
1056 context_instance_preload()
1057 get_contextlevel_name()
1058 print_context_name()
1059 mark_context_dirty()
1060 delete_context()
1061 get_context_url()
1062 get_course_context()
1063 get_user_courses_bycap()
1064 get_role_context_caps()
1065 get_courseid_from_context()
1066 context_instance_preload_sql()
1067 get_related_contexts_string()
1068 get_plugin_list_with_file()
1069 check_browser_operating_system()
1070 check_browser_version()
1071 get_device_type()
1072 get_device_type_list()
1073 get_selected_theme_for_device_type()
1074 get_device_cfg_var_name()
188458a6 1075 set_user_device_type()
2149326b
AA
1076 get_user_device_type()
1077 get_browser_version_classes()
1078 generate_email_supportuser()
1079 badges_get_issued_badge_info()
1080 can_use_html_editor()
1081 enrol_cohort_get_cohorts()
1082 enrol_cohort_can_view_cohort()
1083 cohort_get_visible_list()
1084 enrol_cohort_enrol_all_users()
1085 enrol_cohort_search_cohorts()
eee9e47d 1086* The never unused webdav_locks table was dropped.
ccfb9b69
NM
1087* The actionmenu hideMenu() function now expects an EventFacade object to be passed to it,
1088 i.e. a call to M.core.actionmenu.instance.hideMenu() should be change to M.core.actionmenu.instance.hideMenu(e)
40a15455 1089* In the html_editors (tinyMCE, Atto), the manage files button can be hidden by changing the 'enable_filemanagement' option to false.
82f0f5e3 1090* external_api::validate_context now is public, it can be called from other classes.
20dbcc33
DP
1091* rss_error() now supports returning of correct HTTP status of error and will return '404 Not Found'
1092 unless other status is specified.
61ce548a
FM
1093* Plugins can extend the navigation for categories settings by declaring the following callback:
1094 <frankenstyle>_extend_navigation_category_settings(navigation_node, context_coursecat)
028bbc5b
DM
1095* The clilib.php provides two new functions cli_write() and cli_writeln() that should be used for outputting texts from the command
1096 line interface scripts.
9748791b
JL
1097* External function core_course_external::get_course_contents returned parameter "name" has been changed to PARAM_RAW,
1098 this is because the new external_format_string function may return raw data if the global moodlewssettingraw parameter is used.
182d9990 1099* Function is_web_crawler() has been deprecated, please use core_useragent::is_web_crawler() instead.
303936aa 1100
ebea19cb
FM
1101=== 2.9.1 ===
1102
1103* New methods grade_grade::get_grade_max() and get_grade_min() must be used rather than directly the public properties rawgrademax and rawgrademin.
1104* New method grade_item::is_aggregate_item() indicates when a grade_item is an aggreggated type grade.
1105
a74d4743
SH
1106=== 2.9 ===
1107
5472f9f4 1108* The default home page for users has been changed to the dashboard (formely my home). See MDL-45774.
9bdcf579 1109* Support for rendering templates from php or javascript has been added. See MDL-49152.
adeb96d2 1110* Support for loading AMD javascript modules has been added. See MDL-49046.
cf02542d 1111* Webservice core_course_delete_courses now return warning messages on any failures and does not try to rollback the entire deletion.
a74d4743 1112* \core\event\course_viewed 'other' argument renamed from coursesectionid to coursesectionnumber as it contains the section number.
91fed57a 1113* New API core_filetypes::add_type (etc.) allows custom filetypes to be added and modified.
556e3a9e
AN
1114* PHPUnit: PHPMailer Sink is now started for all tests and is setup within the phpunit wrapper for advanced tests.
1115 Catching debugging messages when sending mail will no longer work. Use $sink = $this->redirectEmails(); and then check
1116 the message in the sink instead.
c9bd4e41 1117* The file pluginlib.php was deprecated since 2.6 and has now been removed, do not include or require it.
9802bd61 1118* \core_component::fetch_subsystems() now returns a valid path for completion component instead of null.
7d0d3b36 1119* Deprecated JS global methods have been removed (show_item, destroy_item, hide_item, addonload, getElementsByTagName, findChildNodes).
8072628a
NM
1120* For 3rd party plugin specific environment.xml files, it's now possible to specify version independent checks by using the
1121 <PLUGIN name="component_name"> tag instead of the version dependent <MOODLE version="x.y"> one. If the PLUGIN tag is used any
1122 Moodle specific tags will be ignored.
3451a51c 1123* 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
1124* The authorization procedure in the mdeploy.php script has been improved. The script
1125 now relies on the main config.php when deploying an available update.
45a1a16b 1126* sql_internal_reader and sql_select_reader interfaces have been deprecated in favour of sql_internal_table_reader
9fe26fb8 1127 and sql_reader which use iterators to be more memory efficient.
79565fa5
DM
1128* $CFG->enabletgzbackups setting has been removed as now backups are stored internally using .tar.gz format by default, you can
1129 set $CFG->usezipbackups to store them in zip format. This does not affect the restore process, which continues accepting both.
9bcb0ba8
DM
1130* Added support for custom string manager implementations via $CFG->customstringmanager
1131 directive in the config.php. See MDL-49361 for details.
70be2642 1132* Add new make_request_directory() for creation of per-request files.
b7067f06
AN
1133* Added generate_image_thumbnail_from_string. This should be used instead of generate_image_thumbnail when the source is a string.
1134 This prevents the need to write files to disk unnecessarily.
1135* Added generate_image_thumbnail to stored_file class. This should be used when generating thumbnails for stored files.
1136 This prevents the need to write files to disk unnecessarily.
3004a923 1137* Removed pear/HTTP/WebDav. See MDL-49534 for details.
d6e7a63d 1138* Use standard PHP date time classes and methods - see new core_date class for timezone normalisation methods.
aec4292c
DC
1139* Moved lib/google/Google/ to lib/google/src/Google. This is to address autoloader issues with Google's provided autoloader
1140 for the library. See MDL-49519 for details.
2b90ce65
EL
1141* The outdated lib/google/Google_Client.php and related files have been completely removed. To use
1142 the new client, read lib/google/readme_moodle.txt, please.
b19cc4ef 1143* profile_display_badges() has been deprecated. See MDL-48935 for details.
12261113
AG
1144* 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"
1145 then please use this function to ensure that the breadcrumb and navigation block are created properly for all user profile pages.
cda2a827
FM
1146* process_new_icon() now does not always return a PNG file. When possible, it will try to keep the format of the original file.
1147 Set the new argument $preferpng to true to force PNG. See MDL-46763 and MDL-50041 for details.
a74d4743 1148
4051685b
AG
1149=== 2.8 ===
1150
47d6e6a7
DW
1151* Gradebook grade category option "aggregatesubcats" has been removed completely.
1152 This means that the database column is removed, the admin settings are removed and
1153 the properties from the grade_category object have been removed. If any courses were
1154 found to be using this setting, a warning to check the grades will be shown in the
1155 course grader report after upgrading the site. The same warning will be shown on
1156 courses restored from backup that had this setting enabled (see MDL-47503).
4051685b 1157* lib/excelllib.class.php has been updated. The class MoodleExcelWorkbook will now only produce excel 2007 files.
ebdcb292
SH
1158* renderers: We now remove the suffix _renderable when looking for a render method for a renderable.
1159 If you have a renderable class named like "blah_renderable" and have a method on a renderer named "render_blah_renderable"
1160 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 1161* New functions get_course_and_cm_from_cmid($cmorid, $modulename) and
1162 get_course_and_cm_from_instance($instanceorid, $modulename) can be used to
1163 more efficiently load these basic data objects at the start of a script.
1164* New function cm_info::create($cm) can be used when you need a cm_info
1165 object, but have a $cm which might only be a standard database record.
061e6b28 1166* $CFG->enablegroupmembersonly no longer exists.
16078807
DP
1167* Scheduled tasks have gained support for syntax to introduce variability when a
1168 task will run across installs. When a when hour or minute are defined as 'R'
1169 they will be installed with a random hour/minute value.
b79bf7a2
MG
1170* Several classes grade_edit_tree_column_xxx were removed since grades setup page
1171 has been significantly changed. These classes should not be used outside of
1172 gradebook or developers can copy them into their plugins from 2.7 branch.
885b889d
MG
1173* Google APIs Client Library (lib/google/) has been upgraded to 1.0.5-beta and
1174 API has changed dramatically without backward compatibility. Any code accessing
1175 it must be amended. It does not apply to lib/googleapi.php. See MDL-47297
27b6839f
MN
1176* Added an extra parameter to the function get_formatted_help_string() (default null) which is used to specify
1177 additional string parameters.
b9ba26b2 1178* User settings node and course node in navigation now support callbacks from admin tools.
a7888487 1179* grade_get_grades() optional parameteres $itemtype, $itemmodule, $iteminstance are now required.
4051685b 1180
83988eb1
EL
1181DEPRECATIONS:
1182* completion_info->get_incomplete_criteria() is deprecated and will be removed in Moodle 3.0.
d6caf637 1183* grade_category::aggregate_values() is deprecated and will be removed in Moodle 3.0.
061e6b28 1184* groups_filter_users_by_course_module_visible() is deprecated; replace with
1185 core_availability\info::filter_user_list. Will be removed in Moodle 3.0.
1186* groups_course_module_visible() is deprecated; replace with $cm->uservisible.
1187* cm_info property $cm->groupmembersonly is deprecated and always returns 0.
1188 Use core_availability\info::filter_user_list if trying to determine which
1189 other users can see an activity.
1190* cm_info method $cm->is_user_access_restricted_by_group() is deprecated and
1191 always returns false. Use $cm->uservisible to determine whether the user can
1192 access the activity.
1193* Constant FEATURE_GROUPMEMBERSONLY (used in module _supports functions) is
1194 deprecated.
80f98467
MG
1195* cohort_get_visible_list() is deprecated. There is a better function cohort_get_available_cohorts()
1196 that respects user capabilities to view cohorts.
58b5b04d
MG
1197* enrol_cohort_get_cohorts() and enrol_cohort_search_cohorts() are deprecated since
1198 functionality is removed. Please use cohort_get_available_cohorts()
1199* enrol_cohort_enrol_all_users() is deprecated; enrol_manual is now responsible for this action
80f98467 1200* enrol_cohort_can_view_cohort() is deprecated; replace with cohort_can_view_cohort()
83988eb1 1201
2b55cb1b 1202=== 2.6.4 / 2.7.1 ===
83988eb1 1203
2b55cb1b
RT
1204* setnew_password_and_mail() and update_internal_user_password() will trigger
1205 \core\event\user_password_updated. Previously they used to generate
1206 \core\event\user_updated event.
1207* update_internal_user_password() accepts optional boolean $fasthash for fast
1208 hashing.
1209* user_update_user() and user_create_user() api's accept optional param
1210 $triggerevent to avoid respective events to be triggred from the api's.
1211
c4b0d6dc
AA
1212=== 2.7 ===
1213
9e00d46b 1214* PHPUnit cannot be installed via PEAR any more, please use composer package manager instead.
686e3b3a
FM
1215* $core_renderer->block_move_target() changed to support more verbose move-block-here descriptions.
1216
1480f6ea
MG
1217Events and Logging:
1218* Significant changes in Logging API. For upgrading existing events_trigger() and
1219 add_to_log() see http://docs.moodle.org/dev/Migrating_logging_calls_in_plugins
e2cb3ffa 1220 For accessing logs from plugins see http://docs.moodle.org/dev/Migrating_log_access_in_reports
c446f41a
MN
1221* The validation of the following events is now stricter (see MDL-45445):
1222 - \core\event\blog_entry_created
1223 - \core\event\blog_entry_deleted
1224 - \core\event\blog_entry_updated
1225 - \core\event\cohort_member_added
1226 - \core\event\cohort_member_removed
1227 - \core\event\course_category_deleted
1228 - \core\event\course_completed
1229 - \core\event\course_content_deleted
1230 - \core\event\course_created
1231 - \core\event\course_deleted
1232 - \core\event\course_restored
1233 - \core\event\course_section_updated (see MDL-45229)
1234 - \core\event\email_failed
1235 - \core\event\group_member_added
1236 - \core\event\group_member_removed
1237 - \core\event\note_created
1238 - \core\event\note_deleted
1239 - \core\event\note_updated
1240 - \core\event\role_assigned
1241 - \core\event\role_deleted
1242 - \core\event\role_unassigned
1243 - \core\event\user_graded
1244 - \core\event\user_loggedinas
1245 - \core\event\user_profile_viewed
1246 - \core\event\webservice_token_created
1480f6ea 1247
a4582a51 1248DEPRECATIONS:
994e5662 1249* $module uses in mod/xxx/version.php files is now deprecated. Please use $plugin instead. It will be removed in Moodle 2.10.
3345e24f 1250* Update init methods in all event classes - "level" property was renamed to "edulevel", the level property is now deprecated.
c4b0d6dc 1251* Abstract class \core\event\course_module_instances_list_viewed is deprecated now, use \core\event\instances_list_viewed instead.
e1b16f97 1252* Abstract class core\event\content_viewed has been deprecated. Please extend base event or other relevant abstract class.
45faf15d
AA
1253* mod_book\event\instances_list_viewed has been deprecated. Please use mod_book\event\course_module_instance_list_viewed instead.
1254* mod_chat\event\instances_list_viewed has been deprecated. Please use mod_chat\event\course_module_instance_list_viewed instead.
1255* mod_choice\event\instances_list_viewed has been deprecated. Please use mod_choice\event\course_module_instance_list_viewed instead.
1256* mod_feedback\event\instances_list_viewed has been deprecated. Please use mod_feedback\event\course_module_instance_list_viewed instead.
1257* mod_page\event\instances_list_viewed has been deprecated. Please use mod_page\event\course_module_instance_list_viewed instead.
1f1a8f03 1258* The constants FRONTPAGECOURSELIST, FRONTPAGETOPICONLY & FRONTPAGECOURSELIMIT have been removed.
8d1f33e1 1259* Conditional availability API has moved and changed. The condition_info class is
1260 replaced by \core_availability\info_module, and condition_info_section by
1261 \core_availability\info_section. (Code that uses the old classes will generally
1262 still work.)
1263* coursemodule_visible_for_user() has been deprecated but still works - replaced
1264 by a new static function \core_availability\info_module::is_user_visible()
1265* cm_info::is_user_access_restricted_by_conditional_access has been deprecated
1266 but still works (it has never done what its name suggests, and is
1267 unnecessary).
1268* cm_info and section_info property showavailability has been deprecated, but
1269 still works (with the caveat that this information is now per-user).
1270* cm_info and section_info properties availablefrom and availableuntil have been
1271 deprecated and always return zero (underlying data doesn't have these values).
1272* section_info property groupingid has been deprecated and always returns zero,
1273 same deal.
07e78d93
DP
1274* Various cm_info methods have been deprecated in favour of their read-only properties (get_url(), get_content(), get_extra_classes(),
1275 get_on_click(), get_custom_data(), get_after_link, get_after_edit_icons)
af64bc61 1276* The ajaxenabled function has been deprecated and always returns true. All code should be fully functional in Javascript.
52dc1de7 1277* count_login_failures() has been deprecated, use user_count_login_failures() instead. Refer MDL-42891 for details.
c4b0d6dc 1278
8d1f33e1 1279Conditional availability (activities and sections):
1280* New conditional availability API in /availability, including new availability
1281 condition plugins in /availability/condition. The new API is very similar with
1282 regard to checking availability, but any code that modifies availability settings
1283 for an activity or section is likely to need substantial changes.
1284
5947ab33
AN
1285YUI:
1286 * The lightbox attribute for moodle-core-notification-dialogue has been
1287 deprecated and replaced by the modal attribute. This was actually
1288 changed in Moodle 2.2, but has only been marked as deprecated now. It
1289 will be removed in Moodle 2.9.
0860dd78
AN
1290 * When destroying any type of dialogue based on moodle-core-notification, the relevant content is also removed from
1291 the DOM. Previously it was left orphaned.
5947ab33 1292
a4582a51
AN
1293JavaSript:
1294 * The findChildNodes global function has been deprecated. Y.all should
1295 be used instead.
1d98ca14
AN
1296 * The callback argument to confirm_action and M.util.show_confirm_dialog has been deprecated. If you need to write a
1297 confirmation which includes a callback, please use moodle-core-notification-confirmation and attach callbacks to the
1298 events provided.
a4582a51 1299
9843e5ec 1300* New locking api and admin settings to configure the system locking type.
3b635513
DM
1301* New "Time spent waiting for the database" performance metric displayed along with the
1302 other MDL_PERF vars; the change affects both the error logs and the vars displayed in
1303 the page footer.
cc033d48
MN
1304* Changes in the tag API. The component and contextid are now saved when assigning tags to an item. Please see
1305 tag/upgrade.txt for more information.
9843e5ec 1306
9e19a0f0 1307=== 2.6 ===
8e8891b7 1308
cc8fecb5 1309* Use new methods from core_component class instead of get_core_subsystems(), get_plugin_types(),
d0cac8b5
FM
1310 get_plugin_list(), get_plugin_list_with_class(), get_plugin_directory(), normalize_component(),
1311 get_component_directory() and get_plugin_list_with_file(). The names of the new methods are
1312 exactly the same, the only differences are that core_component::get_plugin_types() now always returns
1313 full paths and core_component::get_plugin_list() does not accept empty parameter any more.
d534708f 1314* Use core_text::* instead of textlib:: and also core_collator::* instead of collatorlib::*.
af578aec 1315* Use new function moodleform::mock_submit() to simulate form submission in unit tests (backported).
85b38061 1316* New $CFG->localcachedir setting useful for cluster nodes. Admins have to update X-Sendfile aliases if used.
656250de
PS
1317* MS SQL Server drivers are now using NVARCHAR(MAX) instead of NTEXT and VARBINARY(MAX) instead of IMAGE,
1318 this change should be fully transparent and it should help significantly with add-on compatibility.
598a82c9
PS
1319* The string manager classes were renamed. Note that they should not be modified or used directly,
1320 always use get_string_manager() to get instance of the string manager.
aae18d2a 1321* The ability to use an 'insecure' rc4encrypt/rc4decrypt key has been removed.
96f81ea3
PS
1322* Use $CFG->debugdeveloper instead of debugging('', DEBUG_DEVELOPER).
1323* Use set_debugging(DEBUG_xxx) when changing debugging level for current request.
d55f05ef 1324* Function moveto_module() does not modify $mod argument and instead now returns the new module visibility value.
db5f2d33
DM
1325* Use behat_selectors::get_allowed_text_selectors() and behat_selectors::get_allowed_selectors() instead of
1326 behat_command::$allowedtextselectors and behat_command::$allowedselectors
ac2b2713 1327* Subplugins are supported in admin tools and local plugins.
71ab7e51 1328* file_packer/zip_packer API has been modified so that key functions support a new file_progress interface
1329 to report progress during long operations. Related to this, zip_archive now supports an estimated_count()
1330 function that returns an approximate number of entries in the zip faster than the count() function.
d872881f 1331* Class cm_info no longer extends stdClass. All properties are read-only and calculated on first request only.
44ddd2a1 1332* Class course_modinfo no longer extends stdClass. All properties are read-only.
64501eee
MG
1333* Database fields modinfo and sectioncache in table course are removed. Application cache core/coursemodinfo
1334 is used instead. Course cache is still reset, rebuilt and retrieved using function rebuild_course_cache() and
1335 get_fast_modinfo(). Purging all caches and every core upgrade purges course modinfo cache as well.
1336 If function get_fast_modinfo() is called for multiple courses make sure to include field cacherev in course
1337 object.
3bcf6b3c
RT
1338* Internal (noreply and support) user support has been added for sending/receiving message.
1339 Use core_user::get_noreply_user() and core_user::get_support_user() to get noreply and support user's respectively.
1340 Real users can be used as noreply/support users by setting $CFG->noreplyuserid and $CFG->supportuserid
137885b7 1341* New function readfile_allow_large() in filelib.php for use when very large files may need sending to user.
e87214bd 1342* Use core_plugin_manager::reset_caches() when changing visibility of plugins.
bde002b8
PS
1343* Implement new method get_enabled_plugins() method in subplugin info classes.
1344* Each plugin should include version information in version.php.
723a6e56 1345* Module and block tables do not contain version column any more, use get_config('xx_yy', 'version') instead.
5fed8433 1346* $USER->password field is intentionally unset so that session data does not contain password hashes.
38fc0130 1347* Use core_shutdown_manager::register_function() instead of register_shutdown_function().
c858655d 1348* New file packer for .tar.gz files; obtain by calling get_file_packer('application/x-gzip'). Intended initially
1349 for use in backup/restore only, as there are limitations on supported filenames. Also new packer for
1350 backups which supports both compression formats; get_file_packer('application/vnd.moodle.backup').
1351* New optional parameter to stored_file::get_content_file_handle to open file handle with 'gzopen' instead
1352 of 'fopen' to read gzip-compressed files if required.
6c679d15 1353* update_internal_user_password() and setnew_password_and_mail() now trigger user_updated event.
b2858b91 1354* Add thirdpartylibs.xml file to plugins that bundle any 3rd party libraries.
2dd8e935
DP
1355* New class introduced to help auto generate zIndex values for modal dialogues. Class "moodle-has-zindex"
1356 should set on any element which uses a non-default zindex and needs to ensure it doesn't show above a
1357 dialogue.
0c431257
PS
1358* $CFG->filelifetime is now used consistently for most file serving operations, the default was lowered
1359 to 6 hours from 24 hours because etags and x-sendfile support should make file serving less expensive.
d61d3e82
RT
1360* Date format locale charset for windows server will come from calendar type and for gregorian it will use
1361 lang file.
2d5c7d50
FM
1362* The library to interact with Box.net (class boxclient) is only compatible with their APIv1 which
1363 reaches its end of life on the 14th of Dec. You should migrate your scripts to make usage of the
1364 new class boxnet_client(). Note that the method names and return values have changed.
b404b1f4
AG
1365* Settings pages are now possible for Calendar type plugins. Calendar type plugins that require a settings page to
1366 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
1367* The admin/tool/generator tool was overhauled to use testing data generators and the previous interface to create
1368 test data was removed (it was not working correctly anyway). If you were using this tool you will probably need to
1369 update your code.
05226d76
DP
1370
1371DEPRECATIONS:
1372Various previously deprecated functions have now been altered to throw DEBUG_DEVELOPER debugging notices
1373and will be removed in a future release (target: 2.8), a summary follows:
1374
1375Accesslib:
c3d2fbf9
SH
1376 * get_context_instance() -> context_xxxx::instance()
1377 * get_context_instance_by_id() -> context::instance_by_id($id)
1378 * get_system_context() -> context_system::instance()
1379 * context_moved() -> context::update_moved()
1380 * preload_course_contexts() -> context_helper::preload_course()
1381 * context_instance_preload() -> context_helper::preload_from_record()
1382 * context_instance_preload_sql() -> context_helper::get_preload_record_columns_sql()
1383 * get_contextlevel_name() -> context_helper::get_level_name()
1384 * create_contexts() -> context_helper::create_instances()
1385 * cleanup_contexts() -> context_helper::cleanup_instances()
1386 * build_context_path() -> context_helper::build_all_paths()
1387 * print_context_name() -> $context->get_context_name()
1388 * mark_context_dirty() -> $context->mark_dirty()
1389 * delete_context() -> $context->delete_content() or context_helper::delete_instance()
1390 * get_context_url() -> $context->get_url()
1391 * get_course_context() -> $context->get_course_context()
1392 * get_parent_contexts() -> $context->get_parent_context_ids()
1393 * get_parent_contextid() -> $context->get_parent_context()
1394 * get_child_contexts() -> $context->get_child_contexts()
1395 * rebuild_contexts() -> $context->reset_paths()
1396 * get_user_courses_bycap() -> enrol_get_users_courses()
1397 * get_courseid_from_context() -> $context->get_course_context(false)
1398 * get_role_context_caps() -> (no replacement)
1399 * load_temp_role() -> (no replacement)
1400 * remove_temp_roles() -> (no replacement)
1401 * get_related_contexts_string() -> $context->get_parent_context_ids(true)
1402 * get_recent_enrolments() -> (no replacement)
05226d76
DP
1403
1404Enrollment:
c3d2fbf9
SH
1405 * get_course_participants() -> get_enrolled_users()
1406 * is_course_participant() -> is_enrolled()
05226d76
DP
1407
1408Output:
c3d2fbf9
SH
1409 * current_theme() -> $PAGE->theme->name
1410 * skip_main_destination() -> $OUTPUT->skip_link_target()
1411 * print_container() -> $OUTPUT->container()
1412 * print_container_start() -> $OUTPUT->container_start()
1413 * print_container_end() -> $OUTPUT->container_end()
1414 * print_continue() -> $OUTPUT->continue_button()
1415 * print_header() -> $PAGE methods
1416 * print_header_simple() -> $PAGE methods
1417 * print_side_block() -> $OUTPUT->block()
1418 * print_arrow() -> $OUTPUT->arrow()
1419 * print_scale_menu_helpbutton() -> $OUTPUT->help_icon_scale($courseid, $scale)
1420 * print_checkbox() -> html_writer::checkbox()
05226d76
DP
1421
1422Navigation:
c3d2fbf9
SH
1423 * print_navigation() -> $OUTPUT->navbar()
1424 * build_navigation() -> $PAGE->navbar methods
1425 * navmenu() -> (no replacement)
50ae8814
MN
1426 * settings_navigation::
1427 get_course_modules() -> (no replacement)
05226d76 1428
2a68ee0e
MG
1429Files and repositories:
1430 * stored_file::replace_content_with() -> stored_file::replace_file_with()
1431 * stored_file::set_filesize() -> stored_file::replace_file_with()
87355560
MG
1432 * stored_file::get_referencelifetime() -> (no replacement)
1433 * repository::sync_external_file() -> see repository::sync_reference()
1434 * repository::get_file_by_reference() -> repository::sync_reference()
1435 * repository::
1436 get_reference_file_lifetime() -> (no replacement)
1437 * repository::sync_individual_file() -> (no replacement)
1438 * repository::reset_caches() -> (no replacement)
2a68ee0e 1439
05226d76 1440Calendar:
c3d2fbf9
SH
1441 * add_event() -> calendar_event::create()
1442 * update_event() -> calendar_event->update()
1443 * delete_event() -> calendar_event->delete()
1444 * hide_event() -> calendar_event->toggle_visibility(false)
1445 * show_event() -> calendar_event->toggle_visibility(true)
05226d76
DP
1446
1447Misc:
c3d2fbf9
SH
1448 * filter_text() -> format_text(), format_string()...
1449 * httpsrequired() -> $PAGE->https_required()
1450 * detect_munged_arguments() -> clean_param([...], PARAM_FILE)
1451 * mygroupid() -> groups_get_all_groups()
1452 * js_minify() -> core_minify::js_files()
1453 * css_minify_css() -> core_minify::css_files()
64501eee 1454 * course_modinfo::build_section_cache() -> (no replacement)
3bcf6b3c 1455 * generate_email_supportuser() -> core_user::get_support_user()
c3d2fbf9 1456
d79d5ac2
PS
1457Sessions:
1458 * session_get_instance()->xxx() -> \core\session\manager::xxx()
1459 * session_kill_all() -> \core\session\manager::kill_all_sessions()
1460 * session_touch() -> \core\session\manager::touch_session()
1461 * session_kill() -> \core\session\manager::kill_session()
1462 * session_kill_user() -> \core\session\manager::kill_user_sessions()
1463 * session_gc() -> \core\session\manager::gc()
1464 * session_set_user() -> \core\session\manager::set_user()
1465 * session_is_loggedinas() -> \core\session\manager::is_loggedinas()
1466 * session_get_realuser() -> \core\session\manager::get_realuser()
1467 * session_loginas() -> \core\session\manager::loginas()
1468
c3d2fbf9
SH
1469User-agent related functions:
1470 * check_browser_operating_system() -> core_useragent::check_browser_operating_system()
1471 * check_browser_version() -> core_useragent::check_browser_version()
1472 * get_device_type() -> core_useragent::get_device_type()
1473 * get_device_type_list() -> core_useragent::get_device_type_list()
1474 * get_selected_theme_for_device_type() -> core_useragent::get_device_type_theme()
1475 * get_device_cfg_var_name() -> core_useragent::get_device_type_cfg_var_name()
1476 * set_user_device_type() -> core_useragent::set_user_device_type()
1477 * get_user_device_type() -> core_useragent::get_user_device_type()
1478 * get_browser_version_classes() -> core_useragent::get_browser_version_classes()
9e19a0f0 1479
78686995
AN
1480YUI:
1481 * moodle-core-notification has been deprecated with a recommendation of
73b4c1da 1482 using its subclasses instead. This is to allow for reduced page
78686995
AN
1483 transport costs. Current subclasses include:
1484 * dialogue
1485 * alert
1486 * confirm
1487 * exception
1488 * ajaxexception
1489
f0f0e1fe
PS
1490Event triggering and event handlers:
1491 * All existing events and event handlers should be replaced by new
1492 event classes and matching new event observers.
1493 * See http://docs.moodle.org/dev/Event_2 for more information.
861b0510
FM
1494 * The following events will be entirely removed, though they can still
1495 be captured using handlers, but they should not be used any more.
1496 * groups_members_removed -> \core\event\group_member_removed
1497 * groups_groupings_groups_removed -> (no replacement)
1498 * groups_groups_deleted -> \core\event\group_deleted
1499 * groups_groupings_deleted -> \core\event\grouping_deleted
63deb5c3 1500 * edit_module_post_actions() does not trigger events any more.
f0f0e1fe 1501
a2602457 1502=== 2.5.1 ===
1503
1504* New get_course() function for use when obtaining the course record from database. Will
1505 reuse existing $COURSE or $SITE globals if possible to improve performance.
1506
9a36be73
MG
1507=== 2.5 ===
1508
bae2846c
EL
1509* The database drivers (moodle_database and subclasses) aren't using anymore the ::columns property
1510 for caching database metadata. MUC (databasemeta) is used instead. Any custom DB driver should
1511 apply for that change.
cedc656b
EL
1512* The cron output has been changed to include time and memory usage (see cron_trace_time_and_memory()),
1513 so any custom utility relying on the old output may require modification.
6b219310
DW
1514* Function get_max_file_sizes now returns an option for (for example) "Course limit (500MB)" or
1515 "Site limit (200MB)" when appropriate with the option set to 0. This function no longer returns
1516 an option for 0 bytes. Existing code that was replacing the 0 option in the return
1517 from this function with a more sensible message, can now use the return from this function directly.
9a36be73 1518* Functions responsible for output in course/lib.php are deprecated, the code is moved to
b1c2fc65
MG
1519 appropriate renderers: print_section(), print_section_add_menus(), get_print_section_cm_text(),
1520 make_editing_buttons()
9a36be73
MG
1521 See functions' phpdocs in lib/deprecatedlib.php
1522* Function get_print_section_cm_text() is deprecated, replaced with methods in cm_info
3cb856c7
PS
1523* zip_packer may create empty zip archives, there is a new option to ignore
1524 problematic files when creating archive
93cc145f
MN
1525* The function delete_course_module was deprecated and has been replaced with
1526 course_delete_module. The reason for this was because the function delete_course_module
1527 only partially deletes data, so wherever it was called extra code was needed to
1528 perform the whole deletion process. The function course_delete_module now takes care
1529 of the whole process.
91c8cf99
F
1530* curl::setopt() does not accept constant values any more. As it never worked properly,
1531 we decided to make the type check stricter. Now, the keys of the array pass must be a string
1532 corresponding to the curl constant name.
043f1005
RT
1533* Function get_users_listing now return list of users except guest and deleted users. Previously
1534 deleted users were excluded by get_users_listing. As guest user is not expected while browsing users,
1535 and not included in get_user function, it will not be returned by get_users_listing.
1c14b1c1
DW
1536* The add_* functions in course/dnduploadlib.php have been deprecated. Plugins should be using the
1537 MODNAME_dndupload_register callback instead.
690a55f6
DM
1538* The signature of the add() method of classes implementing the parentable_part_of_admin_tree
1539 interface (such as admin_category) has been extended. The new parameter allows the caller
1540 to prepend the new node before an existing sibling in the admin tree.
87b6981e
EL
1541* condition_info:get_condition_user_fields($formatoptions) now accepts the optional
1542 param $formatoptions, that will determine if the field names are processed by
1543 format_string() with the passed options.
689096bc 1544* remove all references to $CFG->gdversion, GD PHP extension is now required
b45ba7f6
DP
1545* Formslib will now throw a developer warning if a PARAM_ type hasn't been set for elements which
1546 need it. Please set PARAM_RAW explicitly if you do not want any cleaning.
4e0b6025 1547* Functions responsible for managing and accessing course categories are moved to class coursecat
09ae7ee0
MG
1548 in lib/coursecatlib.php, functions responsible for rendering courses and categories lists are
1549 moved to course/renderer.php. The following global functions are deprecated: make_categories_list(),
6e1d1ee0 1550 category_delete_move(), category_delete_full(), move_category(), course_category_hide(),
8db5dcb7 1551 course_category_show(), get_course_category(), create_course_category(), get_all_subcategories(),
09ae7ee0
MG
1552 get_child_categories(), get_categories(), print_my_moodle(), print_remote_course(),
1553 print_remote_host(), print_whole_category_list(), print_category_info(), get_course_category_tree(),
1554 print_courses(), print_course(), get_category_courses_array(), get_category_courses_array_recursively(),
1555 get_courses_wmanagers()
1556 See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
0e2ca62e 1557* $core_renderer->block_move_target() changed to support more verbose move-block-here descriptions.
38c1dd19
RT
1558* Additional (optional) param $onlyactive has been added to get_enrolled_users, count_enrolled_users
1559 functions to get information for only active (excluding suspended enrolments) users. Included two
1560 helper functions extract_suspended_users, get_suspended_userids to extract suspended user information.
e87214bd 1561* The core_plugin_manager class now provides two new helper methods for getting information
d7d48b40 1562 about known plugins: get_plugins_of_type() and get_subplugins_of_plugin().
e87214bd 1563* The get_uninstall_url() method of all subclasses of \core\plugininfo\base class is now expected
73658371
DM
1564 to always return moodle_url. Subclasses can use the new method is_uninstall_allowed()
1565 to control the availability of the 'Uninstall' link at the Plugins overview page (previously
1566 they would do it by get_uninstall_url() returning null). By default, URL to a new general plugin
1567 uninstall tool is returned. Unless the plugin type needs extra steps that can't be handled by
1568 plugininfo_xxx::uninstall() method or xmldb_xxx_uninstall() function, this default URL should
1569 satisfy all plugin types.
9a36be73 1570
4efcfaa3 1571Database (DML) layer:
77a5c093
PS
1572* $DB->sql_empty() is deprecated, you have to use sql parameters with empty values instead,
1573 please note hardcoding of empty strings in SQL queries breaks execution in Oracle database.
2d97513d
PS
1574* Indexes must not be defined on the same columns as keys, this is now reported as fatal problem.
1575 Please note that internally we create indexes instead of foreign keys.
9a36be73 1576
238b8bc9
ARN
1577YUI changes:
1578* M.util.help_icon has been deprecated. Code should be updated to use moodle-core-popuphelp
1579 instead. To do so, remove any existing JS calls to M.util.help_icon from your PHP and ensure
1580 that your help link is placed in a span which has the class 'helplink'.
1581
6c2be903
DP
1582=== 2.4 ===
1583
1584* Pagelib: Numerous deprecated functions were removed as classes page_base, page_course
1585 and page_generic_activity.
704533fc 1586* use $CFG->googlemapkey3 instead of removed $CFG->googlemapkey and migrate to Google Maps API V3
b874d5c6 1587* Function settings_navigation::add_course_editing_links() is completely removed
ee7084e9
MG
1588* function global_navigation::format_display_course_content() is removed completely (the
1589 functionality is moved to course format class)
1590* in the function global_navigation::load_generic_course_sections() the argument $courseformat is
1591 removed
7881024e
PS
1592* New component and itemid columns in groups_members table - this allows plugin to create protected
1593 group memberships using 'xx_yy_allow_group_member_remove' callback and there is also a new restore
1594 callback 'xx_yy_restore_group_member()'.
1595* New general role assignment restore plugin callback 'xx_yy_restore_role_assignment()'.
97960146
MG
1596* functions get_generic_section_name(), get_all_sections(), add_mod_to_section(), get_all_mods()
1597 are deprecated. See their phpdocs in lib/deprecatedlib.php on how to replace them
ee362526 1598
d2a27ab0
ARN
1599YUI changes:
1600* moodle-enrol-notification has been renamed to moodle-core-notification
3542e01a 1601* YUI2 code must now use 2in3, see http://yuilibrary.com/yui/docs/yui/yui-yui2.html
7266bd3e
ARN
1602* M.util.init_select_autosubmit() and M.util.init_url_select() have been deprecated. Code using this should be updated
1603 to use moodle-core-formautosubmit
d2a27ab0 1604
94c9db54
PS
1605Unit testing changes:
1606* output debugging() is not sent to standard output any more,
1607 use $this->assertDebuggingCalled(), $this->assertDebuggingNotCalled(),
1608 $this->getDebuggingMessages() or $this->assertResetDebugging() instead.
1609
e618cdf3
PS
1610=== 2.3 ===
1611
1612Database layer changes:
1613* objects are not allowed in paramters of DML functions, use explicit casting to strings if necessary
1614
19526d91
DP
1615Note:
1616* DDL and DML methods which were deprecated in 2.0 have now been removed, they will no longer produce
1617debug messages and will produce fatal errors
e618cdf3 1618
796495fe 1619API changes:
daefd6eb 1620
796495fe 1621* send_stored_file() has changed its interface
daefd6eb 1622* deleted several resourcelib_embed_* functions from resourcelib.php
796495fe 1623
ee362526
PS
1624=== 2.2 ===
1625
1626removed unused libraries:
1627* odbc, base32, CodeSniffer, overlib, apd profiling, kses, Smarty, PEAR Console, swfobject, cssshover.htc, md5.js
1628
1629API changes:
1630* new admin/tool plugin type
1631* new context API - old API is still available
8e470797 1632* deleted users do not have context any more
ee362526
PS
1633* removed global search
1634
1635
1636=== 2.1 ===
1637
1638API changes:
1639* basic suport for restore from 1.9
1640* new mobile devices API
1641* new questions API
1642
1643
1644=== 2.0 ===
1645
1646API changes:
1647* new DML API - http://docs.moodle.org/dev/DML_functions
1648* new DDL API - http://docs.moodle.org/dev/DDL_functions
1649* new file API - http://docs.moodle.org/dev/File_API
1650* new $PAGE and $OUTPUT API
1651* new navigation API
1652* new theme API - http://docs.moodle.org/dev/Theme_changes_in_2.0
1653* new javascript API - http://docs.moodle.org/dev/JavaScript_usage_guide
1654* new portfolio API
1655* new local plugin type
1656* new translation support - http://lang.moodle.org
1657* new web service API
1658* new cohorts API
1659* new messaging API
1660* new rating API
1661* new comment API
1662* new sessions API
1663* new enrolment API
1664* new backup/restore API
1665* new blocks API
1666* new filters API
1667* improved plugin support (aka Frankenstyle)
1668* new registration and hub API
1669* new course completion API
1670* new plagiarism API
1671* changed blog API
1672* new text editor API
19526d91 1673* new my moodle and profiles API