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