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