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