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