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
  30 DEPRECATIONS:
  31 Various previously deprecated functions have now been altered to throw DEBUG_DEVELOPER debugging notices
  32 and will be removed in a future release (target: 2.8), a summary follows:
  33
  34 Accesslib:
  35     * get_context_instance()                ->  context_xxxx::instance()
  36     * get_context_instance_by_id()          ->  context::instance_by_id($id)
  37     * get_system_context()                  ->  context_system::instance()
  38     * context_moved()                       ->  context::update_moved()
  39     * preload_course_contexts()             ->  context_helper::preload_course()
  40     * context_instance_preload()            ->  context_helper::preload_from_record()
  41     * context_instance_preload_sql()        ->  context_helper::get_preload_record_columns_sql()
  42     * get_contextlevel_name()               ->  context_helper::get_level_name()
  43     * create_contexts()                     ->  context_helper::create_instances()
  44     * cleanup_contexts()                    ->  context_helper::cleanup_instances()
  45     * build_context_path()                  ->  context_helper::build_all_paths()
  46     * print_context_name()                  ->  $context->get_context_name()
  47     * mark_context_dirty()                  ->  $context->mark_dirty()
  48     * delete_context()                      ->  $context->delete_content() or context_helper::delete_instance()
  49     * get_context_url()                     ->  $context->get_url()
  50     * get_course_context()                  ->  $context->get_course_context()
  51     * get_parent_contexts()                 ->  $context->get_parent_context_ids()
  52     * get_parent_contextid()                ->  $context->get_parent_context()
  53     * get_child_contexts()                  ->  $context->get_child_contexts()
  54     * rebuild_contexts()                    ->  $context->reset_paths()
  55     * get_user_courses_bycap()              ->  enrol_get_users_courses()
  56     * get_courseid_from_context()           ->  $context->get_course_context(false)
  57     * get_role_context_caps()               ->  (no replacement)
  58     * load_temp_role()                      ->  (no replacement)
  59     * remove_temp_roles()                   ->  (no replacement)
  60     * get_related_contexts_string()         ->  $context->get_parent_context_ids(true)
  61     * get_recent_enrolments()               ->  (no replacement)
  62
  63 Enrollment:
  64     * get_course_participants()             -> get_enrolled_users()
  65     * is_course_participant()               -> is_enrolled()
  66
  67 Output:
  68     * current_theme()                       -> $PAGE->theme->name
  69     * skip_main_destination()               -> $OUTPUT->skip_link_target()
  70     * print_container()                     -> $OUTPUT->container()
  71     * print_container_start()               -> $OUTPUT->container_start()
  72     * print_container_end()                 -> $OUTPUT->container_end()
  73     * print_continue()                      -> $OUTPUT->continue_button()
  74     * print_header()                        -> $PAGE methods
  75     * print_header_simple()                 -> $PAGE methods
  76     * print_side_block()                    -> $OUTPUT->block()
  77     * print_arrow()                         -> $OUTPUT->arrow()
  78     * print_scale_menu_helpbutton()         -> $OUTPUT->help_icon_scale($courseid, $scale)
  79     * print_checkbox()                      -> html_writer::checkbox()
  80
  81 Navigation:
  82     * print_navigation()                    -> $OUTPUT->navbar()
  83     * build_navigation()                    -> $PAGE->navbar methods
  84     * navmenu()                             -> (no replacement)
  85
  86 Calendar:
  87     * add_event()                           -> calendar_event::create()
  88     * update_event()                        -> calendar_event->update()
  89     * delete_event()                        -> calendar_event->delete()
  90     * hide_event()                          -> calendar_event->toggle_visibility(false)
  91     * show_event()                          -> calendar_event->toggle_visibility(true)
  92
  93 Misc:
  94     * filter_text()                         -> format_text(), format_string()...
  95     * httpsrequired()                       -> $PAGE->https_required()
  96     * detect_munged_arguments()             -> clean_param([...], PARAM_FILE)
  97     * mygroupid()                           -> groups_get_all_groups()
  98     * js_minify()                           -> core_minify::js_files()
  99     * css_minify_css()                      -> core_minify::css_files()
 100
 101 User-agent related functions:
 102     * check_browser_operating_system()      -> core_useragent::check_browser_operating_system()
 103     * check_browser_version()               -> core_useragent::check_browser_version()
 104     * get_device_type()                     -> core_useragent::get_device_type()
 105     * get_device_type_list()                -> core_useragent::get_device_type_list()
 106     * get_selected_theme_for_device_type()  -> core_useragent::get_device_type_theme()
 107     * get_device_cfg_var_name()             -> core_useragent::get_device_type_cfg_var_name()
 108     * set_user_device_type()                -> core_useragent::set_user_device_type()
 109     * get_user_device_type()                -> core_useragent::get_user_device_type()
 110     * get_browser_version_classes()         -> core_useragent::get_browser_version_classes()
 111
 112 YUI:
 113     * moodle-core-notification has been deprecated with a recommendation of
 114       using its subclasses instead. This is to allow for reduced page
 115       transport costs. Current subclasses include:
 116       * dialogue
 117       * alert
 118       * confirm
 119       * exception
 120       * ajaxexception
 121
 122 Event triggering and event handlers:
 123     * All existing events and event handlers should be replaced by new
 124       event classes and matching new event observers.
 125     * See http://docs.moodle.org/dev/Event_2 for more information.
 126     * The following events will be entirely removed, though they can still
 127       be captured using handlers, but they should not be used any more.
 128       * groups_members_removed          -> \core\event\group_member_removed
 129       * groups_groupings_groups_removed -> (no replacement)
 130       * groups_groups_deleted           -> \core\event\group_deleted
 131       * groups_groupings_deleted        -> \core\event\grouping_deleted
 132
 133 === 2.5.1 ===
 134
 135 * New get_course() function for use when obtaining the course record from database. Will
 136   reuse existing $COURSE or $SITE globals if possible to improve performance.
 137
 138 === 2.5 ===
 139
 140 * The database drivers (moodle_database and subclasses) aren't using anymore the ::columns property
 141   for caching database metadata. MUC (databasemeta) is used instead. Any custom DB driver should
 142   apply for that change.
 143 * The cron output has been changed to include time and memory usage (see cron_trace_time_and_memory()),
 144   so any custom utility relying on the old output may require modification.
 145 * Function get_max_file_sizes now returns an option for (for example) "Course limit (500MB)" or
 146   "Site limit (200MB)" when appropriate with the option set to 0. This function no longer returns
 147   an option for 0 bytes. Existing code that was replacing the 0 option in the return
 148   from this function with a more sensible message, can now use the return from this function directly.
 149 * Functions responsible for output in course/lib.php are deprecated, the code is moved to
 150   appropriate renderers: print_section(), print_section_add_menus(), get_print_section_cm_text(),
 151   make_editing_buttons()
 152   See functions' phpdocs in lib/deprecatedlib.php
 153 * Function get_print_section_cm_text() is deprecated, replaced with methods in cm_info
 154 * zip_packer may create empty zip archives, there is a new option to ignore
 155   problematic files when creating archive
 156 * The function delete_course_module was deprecated and has been replaced with
 157   course_delete_module. The reason for this was because the function delete_course_module
 158   only partially deletes data, so wherever it was called extra code was needed to
 159   perform the whole deletion process. The function course_delete_module now takes care
 160   of the whole process.
 161 * curl::setopt() does not accept constant values any more. As it never worked properly,
 162   we decided to make the type check stricter. Now, the keys of the array pass must be a string
 163   corresponding to the curl constant name.
 164 * Function get_users_listing now return list of users except guest and deleted users. Previously
 165   deleted users were excluded by get_users_listing. As guest user is not expected while browsing users,
 166   and not included in get_user function, it will not be returned by get_users_listing.
 167 * The add_* functions in course/dnduploadlib.php have been deprecated. Plugins should be using the
 168   MODNAME_dndupload_register callback instead.
 169 * The signature of the add() method of classes implementing the parentable_part_of_admin_tree
 170   interface (such as admin_category) has been extended. The new parameter allows the caller
 171   to prepend the new node before an existing sibling in the admin tree.
 172 * condition_info:get_condition_user_fields($formatoptions) now accepts the optional
 173   param $formatoptions, that will determine if the field names are processed by
 174   format_string() with the passed options.
 175 * remove all references to $CFG->gdversion, GD PHP extension is now required
 176 * Formslib will now throw a developer warning if a PARAM_ type hasn't been set for elements which
 177   need it. Please set PARAM_RAW explicitly if you do not want any cleaning.
 178 * Functions responsible for managing and accessing course categories are moved to class coursecat
 179   in lib/coursecatlib.php, functions responsible for rendering courses and categories lists are
 180   moved to course/renderer.php. The following global functions are deprecated: make_categories_list(),
 181   category_delete_move(), category_delete_full(), move_category(), course_category_hide(),
 182   course_category_show(), get_course_category(), create_course_category(), get_all_subcategories(),
 183   get_child_categories(), get_categories(), print_my_moodle(), print_remote_course(),
 184   print_remote_host(), print_whole_category_list(), print_category_info(), get_course_category_tree(),
 185   print_courses(), print_course(), get_category_courses_array(), get_category_courses_array_recursively(),
 186   get_courses_wmanagers()
 187   See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
 188 * $core_renderer->block_move_target() changed to support more verbose move-block-here descriptions.
 189 * Additional (optional) param $onlyactive has been added to get_enrolled_users, count_enrolled_users
 190   functions to get information for only active (excluding suspended enrolments) users. Included two
 191   helper functions extract_suspended_users, get_suspended_userids to extract suspended user information.
 192 * The plugin_manager class now provides two new helper methods for getting information
 193   about known plugins: get_plugins_of_type() and get_subplugins_of_plugin().
 194 * The get_uninstall_url() method of all subclasses of plugininfo_base class is now expected
 195   to always return moodle_url. Subclasses can use the new method is_uninstall_allowed()
 196   to control the availability of the 'Uninstall' link at the Plugins overview page (previously
 197   they would do it by get_uninstall_url() returning null). By default, URL to a new general plugin
 198   uninstall tool is returned. Unless the plugin type needs extra steps that can't be handled by
 199   plugininfo_xxx::uninstall() method or xmldb_xxx_uninstall() function, this default URL should
 200   satisfy all plugin types.
 201
 202 Database (DML) layer:
 203 * $DB->sql_empty() is deprecated, you have to use sql parameters with empty values instead,
 204   please note hardcoding of empty strings in SQL queries breaks execution in Oracle database.
 205 * Indexes must not be defined on the same columns as keys, this is now reported as fatal problem.
 206   Please note that internally we create indexes instead of foreign keys.
 207
 208 YUI changes:
 209 * M.util.help_icon has been deprecated. Code should be updated to use moodle-core-popuphelp
 210   instead. To do so, remove any existing JS calls to M.util.help_icon from your PHP and ensure
 211   that your help link is placed in a span which has the class 'helplink'.
 212
 213 === 2.4 ===
 214
 215 * Pagelib: Numerous deprecated functions were removed as classes page_base, page_course
 216   and page_generic_activity.
 217 * use $CFG->googlemapkey3 instead of removed $CFG->googlemapkey and migrate to Google Maps API V3
 218 * Function settings_navigation::add_course_editing_links() is completely removed
 219 * function global_navigation::format_display_course_content() is removed completely (the
 220   functionality is moved to course format class)
 221 * in the function global_navigation::load_generic_course_sections() the argument $courseformat is
 222   removed
 223 * New component and itemid columns in groups_members table - this allows plugin to create protected
 224   group memberships using 'xx_yy_allow_group_member_remove' callback and there is also a new restore
 225   callback 'xx_yy_restore_group_member()'.
 226 * New general role assignment restore plugin callback 'xx_yy_restore_role_assignment()'.
 227 * functions get_generic_section_name(), get_all_sections(), add_mod_to_section(), get_all_mods()
 228   are deprecated. See their phpdocs in lib/deprecatedlib.php on how to replace them
 229
 230 YUI changes:
 231 * moodle-enrol-notification has been renamed to moodle-core-notification
 232 * YUI2 code must now use 2in3, see http://yuilibrary.com/yui/docs/yui/yui-yui2.html
 233 * M.util.init_select_autosubmit() and M.util.init_url_select() have been deprecated. Code using this should be updated
 234   to use moodle-core-formautosubmit
 235
 236 Unit testing changes:
 237 * output debugging() is not sent to standard output any more,
 238   use $this->assertDebuggingCalled(), $this->assertDebuggingNotCalled(),
 239   $this->getDebuggingMessages() or $this->assertResetDebugging() instead.
 240
 241 === 2.3 ===
 242
 243 Database layer changes:
 244 * objects are not allowed in paramters of DML functions, use explicit casting to strings if necessary
 245
 246 Note:
 247 * DDL and DML methods which were deprecated in 2.0 have now been removed, they will no longer produce
 248 debug messages and will produce fatal errors
 249
 250 API changes:
 251
 252 * send_stored_file() has changed its interface
 253 * deleted several resourcelib_embed_* functions from resourcelib.php
 254
 255 === 2.2 ===
 256
 257 removed unused libraries:
 258 * odbc, base32, CodeSniffer, overlib, apd profiling, kses, Smarty, PEAR Console, swfobject, cssshover.htc, md5.js
 259
 260 API changes:
 261 * new admin/tool plugin type
 262 * new context API - old API is still available
 263 * deleted users do not have context any more
 264 * removed global search
 265
 266
 267 === 2.1 ===
 268
 269 API changes:
 270 * basic suport for restore from 1.9
 271 * new mobile devices API
 272 * new questions API
 273
 274
 275 === 2.0 ===
 276
 277 API changes:
 278 * new DML API - http://docs.moodle.org/dev/DML_functions
 279 * new DDL API - http://docs.moodle.org/dev/DDL_functions
 280 * new file API - http://docs.moodle.org/dev/File_API
 281 * new $PAGE and $OUTPUT API
 282 * new navigation API
 283 * new theme API - http://docs.moodle.org/dev/Theme_changes_in_2.0
 284 * new javascript API - http://docs.moodle.org/dev/JavaScript_usage_guide
 285 * new portfolio API
 286 * new local plugin type
 287 * new translation support - http://lang.moodle.org
 288 * new web service API
 289 * new cohorts API
 290 * new messaging API
 291 * new rating API
 292 * new comment API
 293 * new sessions API
 294 * new enrolment API
 295 * new backup/restore API
 296 * new blocks API
 297 * new filters API
 298 * improved plugin support (aka Frankenstyle)
 299 * new registration and hub API
 300 * new course completion API
 301 * new plagiarism API
 302 * changed blog API
 303 * new text editor API
 304 * new my moodle and profiles API