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