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