lib/upgrade.txt

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