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