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