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