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