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 === 2.5.5 / 2.6.2 / 2.7 ===
   5
   6 * New "Time spent waiting for the database" performance metric displayed along with the
   7   other MDL_PERF vars; the change affects both the error logs and the vars displayed in
   8   the page footer.
   9
  10 === 2.6 ===
  11
  12 * Use new methods from core_component class instead of get_core_subsystems(), get_plugin_types(),
  13   get_plugin_list(), get_plugin_list_with_class(), get_plugin_directory(), normalize_component(),
  14   get_component_directory() and get_plugin_list_with_file(). The names of the new methods are
  15   exactly the same, the only differences are that core_component::get_plugin_types() now always returns
  16   full paths and core_component::get_plugin_list() does not accept empty parameter any more.
  17 * Use core_text::* instead of textlib:: and also core_collator::* instead of collatorlib::*.
  18 * Use new function moodleform::mock_submit() to simulate form submission in unit tests (backported).
  19 * New $CFG->localcachedir setting useful for cluster nodes. Admins have to update X-Sendfile aliases if used.
  20 * MS SQL Server drivers are now using NVARCHAR(MAX) instead of NTEXT and VARBINARY(MAX) instead of IMAGE,
  21   this change should be fully transparent and it should help significantly with add-on compatibility.
  22 * The string manager classes were renamed. Note that they should not be modified or used directly,
  23   always use get_string_manager() to get instance of the string manager.
  24 * The ability to use an 'insecure' rc4encrypt/rc4decrypt key has been removed.
  25 * Use $CFG->debugdeveloper instead of debugging('', DEBUG_DEVELOPER).
  26 * Use set_debugging(DEBUG_xxx) when changing debugging level for current request.
  27 * Function moveto_module() does not modify $mod argument and instead now returns the new module visibility value.
  28 * Use behat_selectors::get_allowed_text_selectors() and behat_selectors::get_allowed_selectors() instead of
  29   behat_command::$allowedtextselectors and behat_command::$allowedselectors
  30 * Subplugins are supported in admin tools and local plugins.
  31 * file_packer/zip_packer API has been modified so that key functions support a new file_progress interface
  32   to report progress during long operations. Related to this, zip_archive now supports an estimated_count()
  33   function that returns an approximate number of entries in the zip faster than the count() function.
  34 * Class cm_info no longer extends stdClass. All properties are read-only and calculated on first request only.
  35 * Class course_modinfo no longer extends stdClass. All properties are read-only.
  36 * Database fields modinfo and sectioncache in table course are removed. Application cache core/coursemodinfo
  37   is used instead. Course cache is still reset, rebuilt and retrieved using function rebuild_course_cache() and
  38   get_fast_modinfo(). Purging all caches and every core upgrade purges course modinfo cache as well.
  39   If function get_fast_modinfo() is called for multiple courses make sure to include field cacherev in course
  40   object.
  41 * Internal (noreply and support) user support has been added for sending/receiving message.
  42   Use core_user::get_noreply_user() and core_user::get_support_user() to get noreply and support user's respectively.
  43   Real users can be used as noreply/support users by setting $CFG->noreplyuserid and $CFG->supportuserid
  44 * New function readfile_allow_large() in filelib.php for use when very large files may need sending to user.
  45 * Use core_plugin_manager::reset_caches() when changing visibility of plugins.
  46 * Implement new method get_enabled_plugins() method in subplugin info classes.
  47 * Each plugin should include version information in version.php.
  48 * Module and block tables do not contain version column any more, use get_config('xx_yy', 'version') instead.
  49 * $USER->password field is intentionally unset so that session data does not contain password hashes.
  50 * Use core_shutdown_manager::register_function() instead of register_shutdown_function().
  51 * New file packer for .tar.gz files; obtain by calling get_file_packer('application/x-gzip'). Intended initially
  52   for use in backup/restore only, as there are limitations on supported filenames. Also new packer for
  53   backups which supports both compression formats; get_file_packer('application/vnd.moodle.backup').
  54 * New optional parameter to stored_file::get_content_file_handle to open file handle with 'gzopen' instead
  55   of 'fopen' to read gzip-compressed files if required.
  56 * update_internal_user_password() and setnew_password_and_mail() now trigger user_updated event.
  57 * Add thirdpartylibs.xml file to plugins that bundle any 3rd party libraries.
  58 * New class introduced to help auto generate zIndex values for modal dialogues. Class "moodle-has-zindex"
  59   should set on any element which uses a non-default zindex and needs to ensure it doesn't show above a
  60   dialogue.
  61 * $CFG->filelifetime is now used consistently for most file serving operations, the default was lowered
  62   to 6 hours from 24 hours because etags and x-sendfile support should make file serving less expensive.
  63 * Date format locale charset for windows server will come from calendar type and for gregorian it will use
  64   lang file.
  65 * The library to interact with Box.net (class boxclient) is only compatible with their APIv1 which
  66   reaches its end of life on the 14th of Dec. You should migrate your scripts to make usage of the
  67   new class boxnet_client(). Note that the method names and return values have changed.
  68 * Settings pages are now possible for Calendar type plugins. Calendar type plugins that require a settings page to
  69   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.
  70 * The admin/tool/generator tool was overhauled to use testing data generators and the previous interface to create
  71   test data was removed (it was not working correctly anyway). If you were using this tool you will probably need to
  72   update your code.
  73
  74 DEPRECATIONS:
  75 Various previously deprecated functions have now been altered to throw DEBUG_DEVELOPER debugging notices
  76 and will be removed in a future release (target: 2.8), a summary follows:
  77
  78 Accesslib:
  79     * get_context_instance()                ->  context_xxxx::instance()
  80     * get_context_instance_by_id()          ->  context::instance_by_id($id)
  81     * get_system_context()                  ->  context_system::instance()
  82     * context_moved()                       ->  context::update_moved()
  83     * preload_course_contexts()             ->  context_helper::preload_course()
  84     * context_instance_preload()            ->  context_helper::preload_from_record()
  85     * context_instance_preload_sql()        ->  context_helper::get_preload_record_columns_sql()
  86     * get_contextlevel_name()               ->  context_helper::get_level_name()
  87     * create_contexts()                     ->  context_helper::create_instances()
  88     * cleanup_contexts()                    ->  context_helper::cleanup_instances()
  89     * build_context_path()                  ->  context_helper::build_all_paths()
  90     * print_context_name()                  ->  $context->get_context_name()
  91     * mark_context_dirty()                  ->  $context->mark_dirty()
  92     * delete_context()                      ->  $context->delete_content() or context_helper::delete_instance()
  93     * get_context_url()                     ->  $context->get_url()
  94     * get_course_context()                  ->  $context->get_course_context()
  95     * get_parent_contexts()                 ->  $context->get_parent_context_ids()
  96     * get_parent_contextid()                ->  $context->get_parent_context()
  97     * get_child_contexts()                  ->  $context->get_child_contexts()
  98     * rebuild_contexts()                    ->  $context->reset_paths()
  99     * get_user_courses_bycap()              ->  enrol_get_users_courses()
 100     * get_courseid_from_context()           ->  $context->get_course_context(false)
 101     * get_role_context_caps()               ->  (no replacement)
 102     * load_temp_role()                      ->  (no replacement)
 103     * remove_temp_roles()                   ->  (no replacement)
 104     * get_related_contexts_string()         ->  $context->get_parent_context_ids(true)
 105     * get_recent_enrolments()               ->  (no replacement)
 106
 107 Enrollment:
 108     * get_course_participants()             -> get_enrolled_users()
 109     * is_course_participant()               -> is_enrolled()
 110
 111 Output:
 112     * current_theme()                       -> $PAGE->theme->name
 113     * skip_main_destination()               -> $OUTPUT->skip_link_target()
 114     * print_container()                     -> $OUTPUT->container()
 115     * print_container_start()               -> $OUTPUT->container_start()
 116     * print_container_end()                 -> $OUTPUT->container_end()
 117     * print_continue()                      -> $OUTPUT->continue_button()
 118     * print_header()                        -> $PAGE methods
 119     * print_header_simple()                 -> $PAGE methods
 120     * print_side_block()                    -> $OUTPUT->block()
 121     * print_arrow()                         -> $OUTPUT->arrow()
 122     * print_scale_menu_helpbutton()         -> $OUTPUT->help_icon_scale($courseid, $scale)
 123     * print_checkbox()                      -> html_writer::checkbox()
 124
 125 Navigation:
 126     * print_navigation()                    -> $OUTPUT->navbar()
 127     * build_navigation()                    -> $PAGE->navbar methods
 128     * navmenu()                             -> (no replacement)
 129     * settings_navigation::
 130           get_course_modules()              -> (no replacement)
 131
 132 Files and repositories:
 133     * stored_file::replace_content_with()   -> stored_file::replace_file_with()
 134     * stored_file::set_filesize()           -> stored_file::replace_file_with()
 135     * stored_file::get_referencelifetime()  -> (no replacement)
 136     * repository::sync_external_file()      -> see repository::sync_reference()
 137     * repository::get_file_by_reference()   -> repository::sync_reference()
 138     * repository::
 139           get_reference_file_lifetime()     -> (no replacement)
 140     * repository::sync_individual_file()    -> (no replacement)
 141     * repository::reset_caches()            -> (no replacement)
 142
 143 Calendar:
 144     * add_event()                           -> calendar_event::create()
 145     * update_event()                        -> calendar_event->update()
 146     * delete_event()                        -> calendar_event->delete()
 147     * hide_event()                          -> calendar_event->toggle_visibility(false)
 148     * show_event()                          -> calendar_event->toggle_visibility(true)
 149
 150 Misc:
 151     * filter_text()                         -> format_text(), format_string()...
 152     * httpsrequired()                       -> $PAGE->https_required()
 153     * detect_munged_arguments()             -> clean_param([...], PARAM_FILE)
 154     * mygroupid()                           -> groups_get_all_groups()
 155     * js_minify()                           -> core_minify::js_files()
 156     * css_minify_css()                      -> core_minify::css_files()
 157     * course_modinfo::build_section_cache() -> (no replacement)
 158     * generate_email_supportuser()          -> core_user::get_support_user()
 159
 160 Sessions:
 161     * session_get_instance()->xxx()         -> \core\session\manager::xxx()
 162     * session_kill_all()                    -> \core\session\manager::kill_all_sessions()
 163     * session_touch()                       -> \core\session\manager::touch_session()
 164     * session_kill()                        -> \core\session\manager::kill_session()
 165     * session_kill_user()                   -> \core\session\manager::kill_user_sessions()
 166     * session_gc()                          -> \core\session\manager::gc()
 167     * session_set_user()                    -> \core\session\manager::set_user()
 168     * session_is_loggedinas()               -> \core\session\manager::is_loggedinas()
 169     * session_get_realuser()                -> \core\session\manager::get_realuser()
 170     * session_loginas()                     -> \core\session\manager::loginas()
 171
 172 User-agent related functions:
 173     * check_browser_operating_system()      -> core_useragent::check_browser_operating_system()
 174     * check_browser_version()               -> core_useragent::check_browser_version()
 175     * get_device_type()                     -> core_useragent::get_device_type()
 176     * get_device_type_list()                -> core_useragent::get_device_type_list()
 177     * get_selected_theme_for_device_type()  -> core_useragent::get_device_type_theme()
 178     * get_device_cfg_var_name()             -> core_useragent::get_device_type_cfg_var_name()
 179     * set_user_device_type()                -> core_useragent::set_user_device_type()
 180     * get_user_device_type()                -> core_useragent::get_user_device_type()
 181     * get_browser_version_classes()         -> core_useragent::get_browser_version_classes()
 182
 183 YUI:
 184     * moodle-core-notification has been deprecated with a recommendation of
 185       using its subclasses instead. This is to allow for reduced page
 186       transport costs. Current subclasses include:
 187       * dialogue
 188       * alert
 189       * confirm
 190       * exception
 191       * ajaxexception
 192
 193 Event triggering and event handlers:
 194     * All existing events and event handlers should be replaced by new
 195       event classes and matching new event observers.
 196     * See http://docs.moodle.org/dev/Event_2 for more information.
 197     * The following events will be entirely removed, though they can still
 198       be captured using handlers, but they should not be used any more.
 199       * groups_members_removed          -> \core\event\group_member_removed
 200       * groups_groupings_groups_removed -> (no replacement)
 201       * groups_groups_deleted           -> \core\event\group_deleted
 202       * groups_groupings_deleted        -> \core\event\grouping_deleted
 203     * edit_module_post_actions() does not trigger events any more.
 204
 205 === 2.5.1 ===
 206
 207 * New get_course() function for use when obtaining the course record from database. Will
 208   reuse existing $COURSE or $SITE globals if possible to improve performance.
 209
 210 === 2.5 ===
 211
 212 * The database drivers (moodle_database and subclasses) aren't using anymore the ::columns property
 213   for caching database metadata. MUC (databasemeta) is used instead. Any custom DB driver should
 214   apply for that change.
 215 * The cron output has been changed to include time and memory usage (see cron_trace_time_and_memory()),
 216   so any custom utility relying on the old output may require modification.
 217 * Function get_max_file_sizes now returns an option for (for example) "Course limit (500MB)" or
 218   "Site limit (200MB)" when appropriate with the option set to 0. This function no longer returns
 219   an option for 0 bytes. Existing code that was replacing the 0 option in the return
 220   from this function with a more sensible message, can now use the return from this function directly.
 221 * Functions responsible for output in course/lib.php are deprecated, the code is moved to
 222   appropriate renderers: print_section(), print_section_add_menus(), get_print_section_cm_text(),
 223   make_editing_buttons()
 224   See functions' phpdocs in lib/deprecatedlib.php
 225 * Function get_print_section_cm_text() is deprecated, replaced with methods in cm_info
 226 * zip_packer may create empty zip archives, there is a new option to ignore
 227   problematic files when creating archive
 228 * The function delete_course_module was deprecated and has been replaced with
 229   course_delete_module. The reason for this was because the function delete_course_module
 230   only partially deletes data, so wherever it was called extra code was needed to
 231   perform the whole deletion process. The function course_delete_module now takes care
 232   of the whole process.
 233 * curl::setopt() does not accept constant values any more. As it never worked properly,
 234   we decided to make the type check stricter. Now, the keys of the array pass must be a string
 235   corresponding to the curl constant name.
 236 * Function get_users_listing now return list of users except guest and deleted users. Previously
 237   deleted users were excluded by get_users_listing. As guest user is not expected while browsing users,
 238   and not included in get_user function, it will not be returned by get_users_listing.
 239 * The add_* functions in course/dnduploadlib.php have been deprecated. Plugins should be using the
 240   MODNAME_dndupload_register callback instead.
 241 * The signature of the add() method of classes implementing the parentable_part_of_admin_tree
 242   interface (such as admin_category) has been extended. The new parameter allows the caller
 243   to prepend the new node before an existing sibling in the admin tree.
 244 * condition_info:get_condition_user_fields($formatoptions) now accepts the optional
 245   param $formatoptions, that will determine if the field names are processed by
 246   format_string() with the passed options.
 247 * remove all references to $CFG->gdversion, GD PHP extension is now required
 248 * Formslib will now throw a developer warning if a PARAM_ type hasn't been set for elements which
 249   need it. Please set PARAM_RAW explicitly if you do not want any cleaning.
 250 * Functions responsible for managing and accessing course categories are moved to class coursecat
 251   in lib/coursecatlib.php, functions responsible for rendering courses and categories lists are
 252   moved to course/renderer.php. The following global functions are deprecated: make_categories_list(),
 253   category_delete_move(), category_delete_full(), move_category(), course_category_hide(),
 254   course_category_show(), get_course_category(), create_course_category(), get_all_subcategories(),
 255   get_child_categories(), get_categories(), print_my_moodle(), print_remote_course(),
 256   print_remote_host(), print_whole_category_list(), print_category_info(), get_course_category_tree(),
 257   print_courses(), print_course(), get_category_courses_array(), get_category_courses_array_recursively(),
 258   get_courses_wmanagers()
 259   See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
 260 * $core_renderer->block_move_target() changed to support more verbose move-block-here descriptions.
 261 * Additional (optional) param $onlyactive has been added to get_enrolled_users, count_enrolled_users
 262   functions to get information for only active (excluding suspended enrolments) users. Included two
 263   helper functions extract_suspended_users, get_suspended_userids to extract suspended user information.
 264 * The core_plugin_manager class now provides two new helper methods for getting information
 265   about known plugins: get_plugins_of_type() and get_subplugins_of_plugin().
 266 * The get_uninstall_url() method of all subclasses of \core\plugininfo\base class is now expected
 267   to always return moodle_url. Subclasses can use the new method is_uninstall_allowed()
 268   to control the availability of the 'Uninstall' link at the Plugins overview page (previously
 269   they would do it by get_uninstall_url() returning null). By default, URL to a new general plugin
 270   uninstall tool is returned. Unless the plugin type needs extra steps that can't be handled by
 271   plugininfo_xxx::uninstall() method or xmldb_xxx_uninstall() function, this default URL should
 272   satisfy all plugin types.
 273
 274 Database (DML) layer:
 275 * $DB->sql_empty() is deprecated, you have to use sql parameters with empty values instead,
 276   please note hardcoding of empty strings in SQL queries breaks execution in Oracle database.
 277 * Indexes must not be defined on the same columns as keys, this is now reported as fatal problem.
 278   Please note that internally we create indexes instead of foreign keys.
 279
 280 YUI changes:
 281 * M.util.help_icon has been deprecated. Code should be updated to use moodle-core-popuphelp
 282   instead. To do so, remove any existing JS calls to M.util.help_icon from your PHP and ensure
 283   that your help link is placed in a span which has the class 'helplink'.
 284
 285 === 2.4 ===
 286
 287 * Pagelib: Numerous deprecated functions were removed as classes page_base, page_course
 288   and page_generic_activity.
 289 * use $CFG->googlemapkey3 instead of removed $CFG->googlemapkey and migrate to Google Maps API V3
 290 * Function settings_navigation::add_course_editing_links() is completely removed
 291 * function global_navigation::format_display_course_content() is removed completely (the
 292   functionality is moved to course format class)
 293 * in the function global_navigation::load_generic_course_sections() the argument $courseformat is
 294   removed
 295 * New component and itemid columns in groups_members table - this allows plugin to create protected
 296   group memberships using 'xx_yy_allow_group_member_remove' callback and there is also a new restore
 297   callback 'xx_yy_restore_group_member()'.
 298 * New general role assignment restore plugin callback 'xx_yy_restore_role_assignment()'.
 299 * functions get_generic_section_name(), get_all_sections(), add_mod_to_section(), get_all_mods()
 300   are deprecated. See their phpdocs in lib/deprecatedlib.php on how to replace them
 301
 302 YUI changes:
 303 * moodle-enrol-notification has been renamed to moodle-core-notification
 304 * YUI2 code must now use 2in3, see http://yuilibrary.com/yui/docs/yui/yui-yui2.html
 305 * M.util.init_select_autosubmit() and M.util.init_url_select() have been deprecated. Code using this should be updated
 306   to use moodle-core-formautosubmit
 307
 308 Unit testing changes:
 309 * output debugging() is not sent to standard output any more,
 310   use $this->assertDebuggingCalled(), $this->assertDebuggingNotCalled(),
 311   $this->getDebuggingMessages() or $this->assertResetDebugging() instead.
 312
 313 === 2.3 ===
 314
 315 Database layer changes:
 316 * objects are not allowed in paramters of DML functions, use explicit casting to strings if necessary
 317
 318 Note:
 319 * DDL and DML methods which were deprecated in 2.0 have now been removed, they will no longer produce
 320 debug messages and will produce fatal errors
 321
 322 API changes:
 323
 324 * send_stored_file() has changed its interface
 325 * deleted several resourcelib_embed_* functions from resourcelib.php
 326
 327 === 2.2 ===
 328
 329 removed unused libraries:
 330 * odbc, base32, CodeSniffer, overlib, apd profiling, kses, Smarty, PEAR Console, swfobject, cssshover.htc, md5.js
 331
 332 API changes:
 333 * new admin/tool plugin type
 334 * new context API - old API is still available
 335 * deleted users do not have context any more
 336 * removed global search
 337
 338
 339 === 2.1 ===
 340
 341 API changes:
 342 * basic suport for restore from 1.9
 343 * new mobile devices API
 344 * new questions API
 345
 346
 347 === 2.0 ===
 348
 349 API changes:
 350 * new DML API - http://docs.moodle.org/dev/DML_functions
 351 * new DDL API - http://docs.moodle.org/dev/DDL_functions
 352 * new file API - http://docs.moodle.org/dev/File_API
 353 * new $PAGE and $OUTPUT API
 354 * new navigation API
 355 * new theme API - http://docs.moodle.org/dev/Theme_changes_in_2.0
 356 * new javascript API - http://docs.moodle.org/dev/JavaScript_usage_guide
 357 * new portfolio API
 358 * new local plugin type
 359 * new translation support - http://lang.moodle.org
 360 * new web service API
 361 * new cohorts API
 362 * new messaging API
 363 * new rating API
 364 * new comment API
 365 * new sessions API
 366 * new enrolment API
 367 * new backup/restore API
 368 * new blocks API
 369 * new filters API
 370 * improved plugin support (aka Frankenstyle)
 371 * new registration and hub API
 372 * new course completion API
 373 * new plagiarism API
 374 * changed blog API
 375 * new text editor API
 376 * new my moodle and profiles API