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