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