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