MDL-28030 weblib: Added $CFG->urlrewriteclass in config.php
[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.1 ===
6 * Plugins can extend the navigation for user by declaring the following callback:
7   <frankenstyle>_extend_navigation_user(navigation_node $parentnode, stdClass $user,
8                                         context_user $context, stdClass $course,
9                                         context_course $coursecontext)
10 * The function notify() now throws a debugging message - see MDL-50269.
11 * Ajax calls going through lib/ajax/* now validate the return values before sending
12   the response. If the validation does not pass an exception is raised. This behaviour
13   is consistent with web services.
14 * Several changes in Moodle core, standard plugins and third party libraries to
15   ensure compatibility with PHP7. All plugins are recommended to perform testing
16   against PHP7 as well. Refer to https://docs.moodle.org/dev/Moodle_and_PHP7 for more
17   information. The following changes may affect you:
18   * Class moodleform, moodleform_mod and some module classes have been changed to use
19     __construct() for the constructor. Calling parent constructors by the class
20     name will display debugging message. Incorrect: parent::moodleform(),
21     correct: parent::__construct()
22   * All form elements have also changed the constructor syntax. No changes are
23     needed for using form elements, however if plugin defines new form element it
24     needs to use correct syntax. For example, incorrect: parent::HTML_QuickForm_input(),
25     HTML_QuickForm_input::HTML_QuickForm_input(), $this->HTML_QuickForm_input().
26     Correct: HTML_QuickForm_input::__construct() or parent::__construct().
27   * profile_field_base::profile_field_base() is deprecated, use parent::__construct()
28     in custom profile fields constructors. Similar deprecations in exsiting
29     profile_field_* classes.
30   * user_filter_type::user_filter_type() is deprecated, use parent::__construct() in
31     custom user filters. Similar deprecations in existing user_filter_* classes.
32   * table_default_export_format_parent::table_default_export_format_parent() is
33     deprecated, use parent::__construct() in extending classes.
34 * groups_delete_group_members() $showfeedback parameter has been removed and is no longer
35   respected. Users of this function should output their own feedback if required.
36 * Number of changes to Tags API, see tag/upgrade.txt for more details
37 * The previous events API handlers are being deprecated in favour of events 2 API, debugging messages are being displayed if
38   there are 3rd party plugins using it. Switch to events 2 API please, see https://docs.moodle.org/dev/Event_2#Event_dispatching_and_observers
39   Note than you will need to bump the plugin version so moodle is aware that you removed the plugin's event handlers.
40 * mforms validation functions are not available in the global JS namespace anymore, event listeners
41   are assigned to fields and buttons through a self-contained JS function.
42 * Added $CFG->urlrewriteclass option to config.php allowing clean / semantic urls to
43   be implemented in a plugin, eg local_cleanurls.
45 === 3.0 ===
47 * Minify updated to 2.2.1
48 * htmlpurifier upgraded to 4.7.0
49 * Less.php upgraded to 1.7.0.9
50 * The horde library has been updated to version 5.2.7.
51 * Google libraries (lib/google) updated to 1.1.5
52 * Html2Text library has been updated to the latest version of the library.
53 * External functions x_is_allowed_from_ajax() methods have been deprecated. Define 'ajax' => true in db/services.php instead.
54 * External functions can be called without a session if they define 'loginrequired' => true in db/services.php.
55 * All plugins are required to declare their frankenstyle component name via
56   the $plugin->component property in their version.php file. See
57   https://docs.moodle.org/dev/version.php for details (MDL-48494).
58 * PHPUnit is upgraded to 4.7. Some tests using deprecated assertions etc may need changes to work correctly.
59 * Users of the text editor API to manually create a text editor should call set_text before calling use_editor.
60 * Javascript - SimpleYUI and the Y instance used for modules have been merged. Y is now always the same instance of Y.
61 * get_referer() has been deprecated, please use the get_local_referer function instead.
62 * \core\progress\null is renamed to \core\progress\none for improved PHP7 compatibility as null is a reserved word (see MDL-50453).
63 * \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
64   server exceptions in $CFG->proxybypass. See MDL-39353 for details.
65 * Group and groupings idnumbers can now be passed to and/or are returned from the following web services functions:
66   ** core_group_external::create_groups
67   ** core_group_external::get_groups
68   ** core_group_external::get_course_groups
69   ** core_group_external::create_groupings
70   ** core_group_external::update_groupings
71   ** core_group_external::get_groupings
72   ** core_group_external::get_course_groupings
73   ** core_group_external::get_course_user_groups
74 * Following functions are removed from core. See MDL-50049 for details.
75     password_compat_not_supported()
76     session_get_instance()
77     session_is_legacy()
78     session_kill_all()
79     session_touch()
80     session_kill()
81     session_kill_user()
82     session_set_user()
83     session_is_loggedinas()
84     session_get_realuser()
85     session_loginas()
86     js_minify()
87     css_minify_css()
88     update_login_count()
89     reset_login_count()
90     check_gd_version()
91     update_log_display_entry()
92     get_recent_enrolments()
93     groups_filter_users_by_course_module_visible()
94     groups_course_module_visible()
95     error()
96     formerr()
97     editorhelpbutton()
98     editorshortcutshelpbutton()
99     choose_from_menu()
100     update_event()
101     get_generic_section_name()
102     get_all_sections()
103     add_mod_to_section()
104     get_all_mods()
105     get_course_section()
106     format_weeks_get_section_dates()
107     get_print_section_cm_text()
108     print_section_add_menus()
109     make_editing_buttons()
110     print_section()
111     print_overview()
112     print_recent_activity()
113     delete_course_module()
114     update_category_button()
115     make_categories_list()
116     category_delete_move()
117     category_delete_full()
118     move_category()
119     course_category_hide()
120     course_category_show()
121     get_course_category()
122     create_course_category()
123     get_all_subcategories()
124     get_child_categories()
125     get_categories()
126     print_course_search()
127     print_my_moodle()
128     print_remote_course()
129     print_remote_host()
130     print_whole_category_list()
131     print_category_info()
132     get_course_category_tree()
133     print_courses()
134     print_course()
135     get_category_courses_array()
136     get_category_courses_array_recursively()
137     blog_get_context_url()
138     get_courses_wmanagers()
139     convert_tree_to_html()
140     convert_tabrows_to_tree()
141     can_use_rotated_text()
142     get_parent_contexts()
143     get_parent_contextid()
144     get_child_contexts()
145     create_contexts()
146     cleanup_contexts()
147     build_context_path()
148     rebuild_contexts()
149     preload_course_contexts()
150     context_moved()
151     fetch_context_capabilities()
152     context_instance_preload()
153     get_contextlevel_name()
154     print_context_name()
155     mark_context_dirty()
156     delete_context()
157     get_context_url()
158     get_course_context()
159     get_user_courses_bycap()
160     get_role_context_caps()
161     get_courseid_from_context()
162     context_instance_preload_sql()
163     get_related_contexts_string()
164     get_plugin_list_with_file()
165     check_browser_operating_system()
166     check_browser_version()
167     get_device_type()
168     get_device_type_list()
169     get_selected_theme_for_device_type()
170     get_device_cfg_var_name()
171     set_user_device_type()
172     get_user_device_type()
173     get_browser_version_classes()
174     generate_email_supportuser()
175     badges_get_issued_badge_info()
176     can_use_html_editor()
177     enrol_cohort_get_cohorts()
178     enrol_cohort_can_view_cohort()
179     cohort_get_visible_list()
180     enrol_cohort_enrol_all_users()
181     enrol_cohort_search_cohorts()
182 * The never unused webdav_locks table was dropped.
183 * The actionmenu hideMenu() function now expects an EventFacade object to be passed to it,
184   i.e. a call to M.core.actionmenu.instance.hideMenu() should be change to M.core.actionmenu.instance.hideMenu(e)
185 * In the html_editors (tinyMCE, Atto), the manage files button can be hidden by changing the 'enable_filemanagement' option to false.
186 * external_api::validate_context now is public, it can be called from other classes.
187 * rss_error() now supports returning of correct HTTP status of error and will return '404 Not Found'
188   unless other status is specified.
189 * Plugins can extend the navigation for categories settings by declaring the following callback:
190   <frankenstyle>_extend_navigation_category_settings(navigation_node, context_coursecat)
191 * The clilib.php provides two new functions cli_write() and cli_writeln() that should be used for outputting texts from the command
192   line interface scripts.
193 * External function core_course_external::get_course_contents returned parameter "name" has been changed to PARAM_RAW,
194   this is because the new external_format_string function may return raw data if the global moodlewssettingraw parameter is used.
195 * Function is_web_crawler() has been deprecated, please use core_useragent::is_web_crawler() instead.
197 === 2.9.1 ===
199 * New methods grade_grade::get_grade_max() and get_grade_min() must be used rather than directly the public properties rawgrademax and rawgrademin.
200 * New method grade_item::is_aggregate_item() indicates when a grade_item is an aggreggated type grade.
202 === 2.9 ===
204 * The default home page for users has been changed to the dashboard (formely my home). See MDL-45774.
205 * Support for rendering templates from php or javascript has been added. See MDL-49152.
206 * Support for loading AMD javascript modules has been added. See MDL-49046.
207 * Webservice core_course_delete_courses now return warning messages on any failures and does not try to rollback the entire deletion.
208 * \core\event\course_viewed 'other' argument renamed from coursesectionid to coursesectionnumber as it contains the section number.
209 * New API core_filetypes::add_type (etc.) allows custom filetypes to be added and modified.
210 * PHPUnit: PHPMailer Sink is now started for all tests and is setup within the phpunit wrapper for advanced tests.
211   Catching debugging messages when sending mail will no longer work. Use $sink = $this->redirectEmails(); and then check
212   the message in the sink instead.
213 * The file pluginlib.php was deprecated since 2.6 and has now been removed, do not include or require it.
214 * \core_component::fetch_subsystems() now returns a valid path for completion component instead of null.
215 * Deprecated JS global methods have been removed (show_item, destroy_item, hide_item, addonload, getElementsByTagName, findChildNodes).
216 * For 3rd party plugin specific environment.xml files, it's now possible to specify version independent checks by using the
217   <PLUGIN name="component_name"> tag instead of the version dependent <MOODLE version="x.y"> one. If the PLUGIN tag is used any
218   Moodle specific tags will be ignored.
219 * 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).
220 * The authorization procedure in the mdeploy.php script has been improved. The script
221   now relies on the main config.php when deploying an available update.
222 * sql_internal_reader and sql_select_reader interfaces have been deprecated in favour of sql_internal_table_reader
223   and sql_reader which use iterators to be more memory efficient.
224 * $CFG->enabletgzbackups setting has been removed as now backups are stored internally using .tar.gz format by default, you can
225   set $CFG->usezipbackups to store them in zip format. This does not affect the restore process, which continues accepting both.
226 * Added support for custom string manager implementations via $CFG->customstringmanager
227   directive in the config.php. See MDL-49361 for details.
228 * Add new make_request_directory() for creation of per-request files.
229 * Added generate_image_thumbnail_from_string. This should be used instead of generate_image_thumbnail when the source is a string.
230   This prevents the need to write files to disk unnecessarily.
231 * Added generate_image_thumbnail to stored_file class. This should be used when generating thumbnails for stored files.
232   This prevents the need to write files to disk unnecessarily.
233 * Removed pear/HTTP/WebDav. See MDL-49534 for details.
234 * Use standard PHP date time classes and methods - see new core_date class for timezone normalisation methods.
235 * Moved lib/google/Google/ to lib/google/src/Google. This is to address autoloader issues with Google's provided autoloader
236   for the library. See MDL-49519 for details.
237 * The outdated lib/google/Google_Client.php and related files have been completely removed. To use
238   the new client, read lib/google/readme_moodle.txt, please.
239 * profile_display_badges() has been deprecated. See MDL-48935 for details.
240 * 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"
241   then please use this function to ensure that the breadcrumb and navigation block are created properly for all user profile pages.
242 * process_new_icon() now does not always return a PNG file. When possible, it will try to keep the format of the original file.
243   Set the new argument $preferpng to true to force PNG. See MDL-46763 and MDL-50041 for details.
245 === 2.8 ===
247 * Gradebook grade category option "aggregatesubcats" has been removed completely.
248   This means that the database column is removed, the admin settings are removed and
249   the properties from the grade_category object have been removed. If any courses were
250   found to be using this setting, a warning to check the grades will be shown in the
251   course grader report after upgrading the site. The same warning will be shown on
252   courses restored from backup that had this setting enabled (see MDL-47503).
253 * lib/excelllib.class.php has been updated. The class MoodleExcelWorkbook will now only produce excel 2007 files.
254 * renderers: We now remove the suffix _renderable when looking for a render method for a renderable.
255   If you have a renderable class named like "blah_renderable" and have a method on a renderer named "render_blah_renderable"
256   you will need to change the name of your render method to "render_blah" instead, as renderable at the end is no longer accepted.
257 * New functions get_course_and_cm_from_cmid($cmorid, $modulename) and
258   get_course_and_cm_from_instance($instanceorid, $modulename) can be used to
259   more efficiently load these basic data objects at the start of a script.
260 * New function cm_info::create($cm) can be used when you need a cm_info
261   object, but have a $cm which might only be a standard database record.
262 * $CFG->enablegroupmembersonly no longer exists.
263 * Scheduled tasks have gained support for syntax to introduce variability when a
264   task will run across installs. When a when hour or minute are defined as 'R'
265   they will be installed with a random hour/minute value.
266 * Several classes grade_edit_tree_column_xxx were removed since grades setup page
267   has been significantly changed. These classes should not be used outside of
268   gradebook or developers can copy them into their plugins from 2.7 branch.
269 * Google APIs Client Library (lib/google/) has been upgraded to 1.0.5-beta and
270   API has changed dramatically without backward compatibility. Any code accessing
271   it must be amended. It does not apply to lib/googleapi.php. See MDL-47297
272 * Added an extra parameter to the function get_formatted_help_string() (default null) which is used to specify
273   additional string parameters.
274 * User settings node and course node in navigation now support callbacks from admin tools.
275 * grade_get_grades() optional parameteres $itemtype, $itemmodule, $iteminstance are now required.
277 DEPRECATIONS:
278 * completion_info->get_incomplete_criteria() is deprecated and will be removed in Moodle 3.0.
279 * grade_category::aggregate_values() is deprecated and will be removed in Moodle 3.0.
280 * groups_filter_users_by_course_module_visible() is deprecated; replace with
281   core_availability\info::filter_user_list. Will be removed in Moodle 3.0.
282 * groups_course_module_visible() is deprecated; replace with $cm->uservisible.
283 * cm_info property $cm->groupmembersonly is deprecated and always returns 0.
284   Use core_availability\info::filter_user_list if trying to determine which
285   other users can see an activity.
286 * cm_info method $cm->is_user_access_restricted_by_group() is deprecated and
287   always returns false. Use $cm->uservisible to determine whether the user can
288   access the activity.
289 * Constant FEATURE_GROUPMEMBERSONLY (used in module _supports functions) is
290   deprecated.
291 * cohort_get_visible_list() is deprecated. There is a better function cohort_get_available_cohorts()
292   that respects user capabilities to view cohorts.
293 * enrol_cohort_get_cohorts() and enrol_cohort_search_cohorts() are deprecated since
294   functionality is removed. Please use cohort_get_available_cohorts()
295 * enrol_cohort_enrol_all_users() is deprecated; enrol_manual is now responsible for this action
296 * enrol_cohort_can_view_cohort() is deprecated; replace with cohort_can_view_cohort()
298 === 2.6.4 / 2.7.1 ===
300 * setnew_password_and_mail() and update_internal_user_password() will trigger
301   \core\event\user_password_updated. Previously they used to generate
302   \core\event\user_updated event.
303 * update_internal_user_password() accepts optional boolean $fasthash for fast
304   hashing.
305 * user_update_user() and user_create_user() api's accept optional param
306   $triggerevent to avoid respective events to be triggred from the api's.
308 === 2.7 ===
310 * PHPUnit cannot be installed via PEAR any more, please use composer package manager instead.
311 * $core_renderer->block_move_target() changed to support more verbose move-block-here descriptions.
313 Events and Logging:
314 * Significant changes in Logging API. For upgrading existing events_trigger() and
315   add_to_log() see http://docs.moodle.org/dev/Migrating_logging_calls_in_plugins
316   For accessing logs from plugins see http://docs.moodle.org/dev/Migrating_log_access_in_reports
317 * The validation of the following events is now stricter (see MDL-45445):
318     - \core\event\blog_entry_created
319     - \core\event\blog_entry_deleted
320     - \core\event\blog_entry_updated
321     - \core\event\cohort_member_added
322     - \core\event\cohort_member_removed
323     - \core\event\course_category_deleted
324     - \core\event\course_completed
325     - \core\event\course_content_deleted
326     - \core\event\course_created
327     - \core\event\course_deleted
328     - \core\event\course_restored
329     - \core\event\course_section_updated (see MDL-45229)
330     - \core\event\email_failed
331     - \core\event\group_member_added
332     - \core\event\group_member_removed
333     - \core\event\note_created
334     - \core\event\note_deleted
335     - \core\event\note_updated
336     - \core\event\role_assigned
337     - \core\event\role_deleted
338     - \core\event\role_unassigned
339     - \core\event\user_graded
340     - \core\event\user_loggedinas
341     - \core\event\user_profile_viewed
342     - \core\event\webservice_token_created
344 DEPRECATIONS:
345 * $module uses in mod/xxx/version.php files is now deprecated. Please use $plugin instead. It will be removed in Moodle 2.10.
346 * Update init methods in all event classes - "level" property was renamed to "edulevel", the level property is now deprecated.
347 * Abstract class \core\event\course_module_instances_list_viewed is deprecated now, use \core\event\instances_list_viewed instead.
348 * Abstract class core\event\content_viewed has been deprecated. Please extend base event or other relevant abstract class.
349 * mod_book\event\instances_list_viewed has been deprecated. Please use mod_book\event\course_module_instance_list_viewed instead.
350 * mod_chat\event\instances_list_viewed has been deprecated. Please use mod_chat\event\course_module_instance_list_viewed instead.
351 * mod_choice\event\instances_list_viewed has been deprecated. Please use mod_choice\event\course_module_instance_list_viewed instead.
352 * mod_feedback\event\instances_list_viewed has been deprecated. Please use mod_feedback\event\course_module_instance_list_viewed instead.
353 * mod_page\event\instances_list_viewed has been deprecated. Please use mod_page\event\course_module_instance_list_viewed instead.
354 * The constants FRONTPAGECOURSELIST, FRONTPAGETOPICONLY & FRONTPAGECOURSELIMIT have been removed.
355 * Conditional availability API has moved and changed. The condition_info class is
356   replaced by \core_availability\info_module, and condition_info_section by
357   \core_availability\info_section. (Code that uses the old classes will generally
358   still work.)
359 * coursemodule_visible_for_user() has been deprecated but still works - replaced
360   by a new static function \core_availability\info_module::is_user_visible()
361 * cm_info::is_user_access_restricted_by_conditional_access has been deprecated
362   but still works (it has never done what its name suggests, and is
363   unnecessary).
364 * cm_info and section_info property showavailability has been deprecated, but
365   still works (with the caveat that this information is now per-user).
366 * cm_info and section_info properties availablefrom and availableuntil have been
367   deprecated and always return zero (underlying data doesn't have these values).
368 * section_info property groupingid has been deprecated and always returns zero,
369   same deal.
370 * Various cm_info methods have been deprecated in favour of their read-only properties (get_url(), get_content(), get_extra_classes(),
371   get_on_click(), get_custom_data(), get_after_link, get_after_edit_icons)
372 * The ajaxenabled function has been deprecated and always returns true. All code should be fully functional in Javascript.
373 * count_login_failures() has been deprecated, use user_count_login_failures() instead. Refer MDL-42891 for details.
375 Conditional availability (activities and sections):
376 * New conditional availability API in /availability, including new availability
377   condition plugins in /availability/condition. The new API is very similar with
378   regard to checking availability, but any code that modifies availability settings
379   for an activity or section is likely to need substantial changes.
381 YUI:
382   * The lightbox attribute for moodle-core-notification-dialogue has been
383     deprecated and replaced by the modal attribute. This was actually
384     changed in Moodle 2.2, but has only been marked as deprecated now. It
385     will be removed in Moodle 2.9.
386   * When destroying any type of dialogue based on moodle-core-notification, the relevant content is also removed from
387     the DOM. Previously it was left orphaned.
389 JavaSript:
390     * The findChildNodes global function has been deprecated. Y.all should
391       be used instead.
392     * The callback argument to confirm_action and M.util.show_confirm_dialog has been deprecated. If you need to write a
393       confirmation which includes a callback, please use moodle-core-notification-confirmation and attach callbacks to the
394       events provided.
396 * New locking api and admin settings to configure the system locking type.
397 * New "Time spent waiting for the database" performance metric displayed along with the
398   other MDL_PERF vars; the change affects both the error logs and the vars displayed in
399   the page footer.
400 * Changes in the tag API. The component and contextid are now saved when assigning tags to an item. Please see
401   tag/upgrade.txt for more information.
403 === 2.6 ===
405 * Use new methods from core_component class instead of get_core_subsystems(), get_plugin_types(),
406   get_plugin_list(), get_plugin_list_with_class(), get_plugin_directory(), normalize_component(),
407   get_component_directory() and get_plugin_list_with_file(). The names of the new methods are
408   exactly the same, the only differences are that core_component::get_plugin_types() now always returns
409   full paths and core_component::get_plugin_list() does not accept empty parameter any more.
410 * Use core_text::* instead of textlib:: and also core_collator::* instead of collatorlib::*.
411 * Use new function moodleform::mock_submit() to simulate form submission in unit tests (backported).
412 * New $CFG->localcachedir setting useful for cluster nodes. Admins have to update X-Sendfile aliases if used.
413 * MS SQL Server drivers are now using NVARCHAR(MAX) instead of NTEXT and VARBINARY(MAX) instead of IMAGE,
414   this change should be fully transparent and it should help significantly with add-on compatibility.
415 * The string manager classes were renamed. Note that they should not be modified or used directly,
416   always use get_string_manager() to get instance of the string manager.
417 * The ability to use an 'insecure' rc4encrypt/rc4decrypt key has been removed.
418 * Use $CFG->debugdeveloper instead of debugging('', DEBUG_DEVELOPER).
419 * Use set_debugging(DEBUG_xxx) when changing debugging level for current request.
420 * Function moveto_module() does not modify $mod argument and instead now returns the new module visibility value.
421 * Use behat_selectors::get_allowed_text_selectors() and behat_selectors::get_allowed_selectors() instead of
422   behat_command::$allowedtextselectors and behat_command::$allowedselectors
423 * Subplugins are supported in admin tools and local plugins.
424 * file_packer/zip_packer API has been modified so that key functions support a new file_progress interface
425   to report progress during long operations. Related to this, zip_archive now supports an estimated_count()
426   function that returns an approximate number of entries in the zip faster than the count() function.
427 * Class cm_info no longer extends stdClass. All properties are read-only and calculated on first request only.
428 * Class course_modinfo no longer extends stdClass. All properties are read-only.
429 * Database fields modinfo and sectioncache in table course are removed. Application cache core/coursemodinfo
430   is used instead. Course cache is still reset, rebuilt and retrieved using function rebuild_course_cache() and
431   get_fast_modinfo(). Purging all caches and every core upgrade purges course modinfo cache as well.
432   If function get_fast_modinfo() is called for multiple courses make sure to include field cacherev in course
433   object.
434 * Internal (noreply and support) user support has been added for sending/receiving message.
435   Use core_user::get_noreply_user() and core_user::get_support_user() to get noreply and support user's respectively.
436   Real users can be used as noreply/support users by setting $CFG->noreplyuserid and $CFG->supportuserid
437 * New function readfile_allow_large() in filelib.php for use when very large files may need sending to user.
438 * Use core_plugin_manager::reset_caches() when changing visibility of plugins.
439 * Implement new method get_enabled_plugins() method in subplugin info classes.
440 * Each plugin should include version information in version.php.
441 * Module and block tables do not contain version column any more, use get_config('xx_yy', 'version') instead.
442 * $USER->password field is intentionally unset so that session data does not contain password hashes.
443 * Use core_shutdown_manager::register_function() instead of register_shutdown_function().
444 * New file packer for .tar.gz files; obtain by calling get_file_packer('application/x-gzip'). Intended initially
445   for use in backup/restore only, as there are limitations on supported filenames. Also new packer for
446   backups which supports both compression formats; get_file_packer('application/vnd.moodle.backup').
447 * New optional parameter to stored_file::get_content_file_handle to open file handle with 'gzopen' instead
448   of 'fopen' to read gzip-compressed files if required.
449 * update_internal_user_password() and setnew_password_and_mail() now trigger user_updated event.
450 * Add thirdpartylibs.xml file to plugins that bundle any 3rd party libraries.
451 * New class introduced to help auto generate zIndex values for modal dialogues. Class "moodle-has-zindex"
452   should set on any element which uses a non-default zindex and needs to ensure it doesn't show above a
453   dialogue.
454 * $CFG->filelifetime is now used consistently for most file serving operations, the default was lowered
455   to 6 hours from 24 hours because etags and x-sendfile support should make file serving less expensive.
456 * Date format locale charset for windows server will come from calendar type and for gregorian it will use
457   lang file.
458 * The library to interact with Box.net (class boxclient) is only compatible with their APIv1 which
459   reaches its end of life on the 14th of Dec. You should migrate your scripts to make usage of the
460   new class boxnet_client(). Note that the method names and return values have changed.
461 * Settings pages are now possible for Calendar type plugins. Calendar type plugins that require a settings page to
462   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.
463 * The admin/tool/generator tool was overhauled to use testing data generators and the previous interface to create
464   test data was removed (it was not working correctly anyway). If you were using this tool you will probably need to
465   update your code.
467 DEPRECATIONS:
468 Various previously deprecated functions have now been altered to throw DEBUG_DEVELOPER debugging notices
469 and will be removed in a future release (target: 2.8), a summary follows:
471 Accesslib:
472     * get_context_instance()                ->  context_xxxx::instance()
473     * get_context_instance_by_id()          ->  context::instance_by_id($id)
474     * get_system_context()                  ->  context_system::instance()
475     * context_moved()                       ->  context::update_moved()
476     * preload_course_contexts()             ->  context_helper::preload_course()
477     * context_instance_preload()            ->  context_helper::preload_from_record()
478     * context_instance_preload_sql()        ->  context_helper::get_preload_record_columns_sql()
479     * get_contextlevel_name()               ->  context_helper::get_level_name()
480     * create_contexts()                     ->  context_helper::create_instances()
481     * cleanup_contexts()                    ->  context_helper::cleanup_instances()
482     * build_context_path()                  ->  context_helper::build_all_paths()
483     * print_context_name()                  ->  $context->get_context_name()
484     * mark_context_dirty()                  ->  $context->mark_dirty()
485     * delete_context()                      ->  $context->delete_content() or context_helper::delete_instance()
486     * get_context_url()                     ->  $context->get_url()
487     * get_course_context()                  ->  $context->get_course_context()
488     * get_parent_contexts()                 ->  $context->get_parent_context_ids()
489     * get_parent_contextid()                ->  $context->get_parent_context()
490     * get_child_contexts()                  ->  $context->get_child_contexts()
491     * rebuild_contexts()                    ->  $context->reset_paths()
492     * get_user_courses_bycap()              ->  enrol_get_users_courses()
493     * get_courseid_from_context()           ->  $context->get_course_context(false)
494     * get_role_context_caps()               ->  (no replacement)
495     * load_temp_role()                      ->  (no replacement)
496     * remove_temp_roles()                   ->  (no replacement)
497     * get_related_contexts_string()         ->  $context->get_parent_context_ids(true)
498     * get_recent_enrolments()               ->  (no replacement)
500 Enrollment:
501     * get_course_participants()             -> get_enrolled_users()
502     * is_course_participant()               -> is_enrolled()
504 Output:
505     * current_theme()                       -> $PAGE->theme->name
506     * skip_main_destination()               -> $OUTPUT->skip_link_target()
507     * print_container()                     -> $OUTPUT->container()
508     * print_container_start()               -> $OUTPUT->container_start()
509     * print_container_end()                 -> $OUTPUT->container_end()
510     * print_continue()                      -> $OUTPUT->continue_button()
511     * print_header()                        -> $PAGE methods
512     * print_header_simple()                 -> $PAGE methods
513     * print_side_block()                    -> $OUTPUT->block()
514     * print_arrow()                         -> $OUTPUT->arrow()
515     * print_scale_menu_helpbutton()         -> $OUTPUT->help_icon_scale($courseid, $scale)
516     * print_checkbox()                      -> html_writer::checkbox()
518 Navigation:
519     * print_navigation()                    -> $OUTPUT->navbar()
520     * build_navigation()                    -> $PAGE->navbar methods
521     * navmenu()                             -> (no replacement)
522     * settings_navigation::
523           get_course_modules()              -> (no replacement)
525 Files and repositories:
526     * stored_file::replace_content_with()   -> stored_file::replace_file_with()
527     * stored_file::set_filesize()           -> stored_file::replace_file_with()
528     * stored_file::get_referencelifetime()  -> (no replacement)
529     * repository::sync_external_file()      -> see repository::sync_reference()
530     * repository::get_file_by_reference()   -> repository::sync_reference()
531     * repository::
532           get_reference_file_lifetime()     -> (no replacement)
533     * repository::sync_individual_file()    -> (no replacement)
534     * repository::reset_caches()            -> (no replacement)
536 Calendar:
537     * add_event()                           -> calendar_event::create()
538     * update_event()                        -> calendar_event->update()
539     * delete_event()                        -> calendar_event->delete()
540     * hide_event()                          -> calendar_event->toggle_visibility(false)
541     * show_event()                          -> calendar_event->toggle_visibility(true)
543 Misc:
544     * filter_text()                         -> format_text(), format_string()...
545     * httpsrequired()                       -> $PAGE->https_required()
546     * detect_munged_arguments()             -> clean_param([...], PARAM_FILE)
547     * mygroupid()                           -> groups_get_all_groups()
548     * js_minify()                           -> core_minify::js_files()
549     * css_minify_css()                      -> core_minify::css_files()
550     * course_modinfo::build_section_cache() -> (no replacement)
551     * generate_email_supportuser()          -> core_user::get_support_user()
553 Sessions:
554     * session_get_instance()->xxx()         -> \core\session\manager::xxx()
555     * session_kill_all()                    -> \core\session\manager::kill_all_sessions()
556     * session_touch()                       -> \core\session\manager::touch_session()
557     * session_kill()                        -> \core\session\manager::kill_session()
558     * session_kill_user()                   -> \core\session\manager::kill_user_sessions()
559     * session_gc()                          -> \core\session\manager::gc()
560     * session_set_user()                    -> \core\session\manager::set_user()
561     * session_is_loggedinas()               -> \core\session\manager::is_loggedinas()
562     * session_get_realuser()                -> \core\session\manager::get_realuser()
563     * session_loginas()                     -> \core\session\manager::loginas()
565 User-agent related functions:
566     * check_browser_operating_system()      -> core_useragent::check_browser_operating_system()
567     * check_browser_version()               -> core_useragent::check_browser_version()
568     * get_device_type()                     -> core_useragent::get_device_type()
569     * get_device_type_list()                -> core_useragent::get_device_type_list()
570     * get_selected_theme_for_device_type()  -> core_useragent::get_device_type_theme()
571     * get_device_cfg_var_name()             -> core_useragent::get_device_type_cfg_var_name()
572     * set_user_device_type()                -> core_useragent::set_user_device_type()
573     * get_user_device_type()                -> core_useragent::get_user_device_type()
574     * get_browser_version_classes()         -> core_useragent::get_browser_version_classes()
576 YUI:
577     * moodle-core-notification has been deprecated with a recommendation of
578       using its subclasses instead. This is to allow for reduced page
579       transport costs. Current subclasses include:
580       * dialogue
581       * alert
582       * confirm
583       * exception
584       * ajaxexception
586 Event triggering and event handlers:
587     * All existing events and event handlers should be replaced by new
588       event classes and matching new event observers.
589     * See http://docs.moodle.org/dev/Event_2 for more information.
590     * The following events will be entirely removed, though they can still
591       be captured using handlers, but they should not be used any more.
592       * groups_members_removed          -> \core\event\group_member_removed
593       * groups_groupings_groups_removed -> (no replacement)
594       * groups_groups_deleted           -> \core\event\group_deleted
595       * groups_groupings_deleted        -> \core\event\grouping_deleted
596     * edit_module_post_actions() does not trigger events any more.
598 === 2.5.1 ===
600 * New get_course() function for use when obtaining the course record from database. Will
601   reuse existing $COURSE or $SITE globals if possible to improve performance.
603 === 2.5 ===
605 * The database drivers (moodle_database and subclasses) aren't using anymore the ::columns property
606   for caching database metadata. MUC (databasemeta) is used instead. Any custom DB driver should
607   apply for that change.
608 * The cron output has been changed to include time and memory usage (see cron_trace_time_and_memory()),
609   so any custom utility relying on the old output may require modification.
610 * Function get_max_file_sizes now returns an option for (for example) "Course limit (500MB)" or
611   "Site limit (200MB)" when appropriate with the option set to 0. This function no longer returns
612   an option for 0 bytes. Existing code that was replacing the 0 option in the return
613   from this function with a more sensible message, can now use the return from this function directly.
614 * Functions responsible for output in course/lib.php are deprecated, the code is moved to
615   appropriate renderers: print_section(), print_section_add_menus(), get_print_section_cm_text(),
616   make_editing_buttons()
617   See functions' phpdocs in lib/deprecatedlib.php
618 * Function get_print_section_cm_text() is deprecated, replaced with methods in cm_info
619 * zip_packer may create empty zip archives, there is a new option to ignore
620   problematic files when creating archive
621 * The function delete_course_module was deprecated and has been replaced with
622   course_delete_module. The reason for this was because the function delete_course_module
623   only partially deletes data, so wherever it was called extra code was needed to
624   perform the whole deletion process. The function course_delete_module now takes care
625   of the whole process.
626 * curl::setopt() does not accept constant values any more. As it never worked properly,
627   we decided to make the type check stricter. Now, the keys of the array pass must be a string
628   corresponding to the curl constant name.
629 * Function get_users_listing now return list of users except guest and deleted users. Previously
630   deleted users were excluded by get_users_listing. As guest user is not expected while browsing users,
631   and not included in get_user function, it will not be returned by get_users_listing.
632 * The add_* functions in course/dnduploadlib.php have been deprecated. Plugins should be using the
633   MODNAME_dndupload_register callback instead.
634 * The signature of the add() method of classes implementing the parentable_part_of_admin_tree
635   interface (such as admin_category) has been extended. The new parameter allows the caller
636   to prepend the new node before an existing sibling in the admin tree.
637 * condition_info:get_condition_user_fields($formatoptions) now accepts the optional
638   param $formatoptions, that will determine if the field names are processed by
639   format_string() with the passed options.
640 * remove all references to $CFG->gdversion, GD PHP extension is now required
641 * Formslib will now throw a developer warning if a PARAM_ type hasn't been set for elements which
642   need it. Please set PARAM_RAW explicitly if you do not want any cleaning.
643 * Functions responsible for managing and accessing course categories are moved to class coursecat
644   in lib/coursecatlib.php, functions responsible for rendering courses and categories lists are
645   moved to course/renderer.php. The following global functions are deprecated: make_categories_list(),
646   category_delete_move(), category_delete_full(), move_category(), course_category_hide(),
647   course_category_show(), get_course_category(), create_course_category(), get_all_subcategories(),
648   get_child_categories(), get_categories(), print_my_moodle(), print_remote_course(),
649   print_remote_host(), print_whole_category_list(), print_category_info(), get_course_category_tree(),
650   print_courses(), print_course(), get_category_courses_array(), get_category_courses_array_recursively(),
651   get_courses_wmanagers()
652   See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
653 * $core_renderer->block_move_target() changed to support more verbose move-block-here descriptions.
654 * Additional (optional) param $onlyactive has been added to get_enrolled_users, count_enrolled_users
655   functions to get information for only active (excluding suspended enrolments) users. Included two
656   helper functions extract_suspended_users, get_suspended_userids to extract suspended user information.
657 * The core_plugin_manager class now provides two new helper methods for getting information
658   about known plugins: get_plugins_of_type() and get_subplugins_of_plugin().
659 * The get_uninstall_url() method of all subclasses of \core\plugininfo\base class is now expected
660   to always return moodle_url. Subclasses can use the new method is_uninstall_allowed()
661   to control the availability of the 'Uninstall' link at the Plugins overview page (previously
662   they would do it by get_uninstall_url() returning null). By default, URL to a new general plugin
663   uninstall tool is returned. Unless the plugin type needs extra steps that can't be handled by
664   plugininfo_xxx::uninstall() method or xmldb_xxx_uninstall() function, this default URL should
665   satisfy all plugin types.
667 Database (DML) layer:
668 * $DB->sql_empty() is deprecated, you have to use sql parameters with empty values instead,
669   please note hardcoding of empty strings in SQL queries breaks execution in Oracle database.
670 * Indexes must not be defined on the same columns as keys, this is now reported as fatal problem.
671   Please note that internally we create indexes instead of foreign keys.
673 YUI changes:
674 * M.util.help_icon has been deprecated. Code should be updated to use moodle-core-popuphelp
675   instead. To do so, remove any existing JS calls to M.util.help_icon from your PHP and ensure
676   that your help link is placed in a span which has the class 'helplink'.
678 === 2.4 ===
680 * Pagelib: Numerous deprecated functions were removed as classes page_base, page_course
681   and page_generic_activity.
682 * use $CFG->googlemapkey3 instead of removed $CFG->googlemapkey and migrate to Google Maps API V3
683 * Function settings_navigation::add_course_editing_links() is completely removed
684 * function global_navigation::format_display_course_content() is removed completely (the
685   functionality is moved to course format class)
686 * in the function global_navigation::load_generic_course_sections() the argument $courseformat is
687   removed
688 * New component and itemid columns in groups_members table - this allows plugin to create protected
689   group memberships using 'xx_yy_allow_group_member_remove' callback and there is also a new restore
690   callback 'xx_yy_restore_group_member()'.
691 * New general role assignment restore plugin callback 'xx_yy_restore_role_assignment()'.
692 * functions get_generic_section_name(), get_all_sections(), add_mod_to_section(), get_all_mods()
693   are deprecated. See their phpdocs in lib/deprecatedlib.php on how to replace them
695 YUI changes:
696 * moodle-enrol-notification has been renamed to moodle-core-notification
697 * YUI2 code must now use 2in3, see http://yuilibrary.com/yui/docs/yui/yui-yui2.html
698 * M.util.init_select_autosubmit() and M.util.init_url_select() have been deprecated. Code using this should be updated
699   to use moodle-core-formautosubmit
701 Unit testing changes:
702 * output debugging() is not sent to standard output any more,
703   use $this->assertDebuggingCalled(), $this->assertDebuggingNotCalled(),
704   $this->getDebuggingMessages() or $this->assertResetDebugging() instead.
706 === 2.3 ===
708 Database layer changes:
709 * objects are not allowed in paramters of DML functions, use explicit casting to strings if necessary
711 Note:
712 * DDL and DML methods which were deprecated in 2.0 have now been removed, they will no longer produce
713 debug messages and will produce fatal errors
715 API changes:
717 * send_stored_file() has changed its interface
718 * deleted several resourcelib_embed_* functions from resourcelib.php
720 === 2.2 ===
722 removed unused libraries:
723 * odbc, base32, CodeSniffer, overlib, apd profiling, kses, Smarty, PEAR Console, swfobject, cssshover.htc, md5.js
725 API changes:
726 * new admin/tool plugin type
727 * new context API - old API is still available
728 * deleted users do not have context any more
729 * removed global search
732 === 2.1 ===
734 API changes:
735 * basic suport for restore from 1.9
736 * new mobile devices API
737 * new questions API
740 === 2.0 ===
742 API changes:
743 * new DML API - http://docs.moodle.org/dev/DML_functions
744 * new DDL API - http://docs.moodle.org/dev/DDL_functions
745 * new file API - http://docs.moodle.org/dev/File_API
746 * new $PAGE and $OUTPUT API
747 * new navigation API
748 * new theme API - http://docs.moodle.org/dev/Theme_changes_in_2.0
749 * new javascript API - http://docs.moodle.org/dev/JavaScript_usage_guide
750 * new portfolio API
751 * new local plugin type
752 * new translation support - http://lang.moodle.org
753 * new web service API
754 * new cohorts API
755 * new messaging API
756 * new rating API
757 * new comment API
758 * new sessions API
759 * new enrolment API
760 * new backup/restore API
761 * new blocks API
762 * new filters API
763 * improved plugin support (aka Frankenstyle)
764 * new registration and hub API
765 * new course completion API
766 * new plagiarism API
767 * changed blog API
768 * new text editor API
769 * new my moodle and profiles API