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