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