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