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.8.7 ===
   5
   6 * New methods grade_grade::get_grade_max() and get_grade_min() must be used rather than directly the public properties rawgrademax and rawgrademin.
   7 * New method grade_item::is_aggregate_item() indicates when a grade_item is an aggreggated type grade.
   8 * \webservice_xmlrpc_client now respects proxy server settings. If your XMLRPC server is available on your local network and not via your proxy server, you may need to add it to the list of proxy
   9   server exceptions in $CFG->proxybypass. See MDL-39353 for details.
  10
  11 === 2.8.4 ===
  12
  13 * The authorization procedure in the mdeploy.php script has been improved. The script
  14   now relies on the main config.php when deploying an available update.
  15
  16 === 2.8.2 ===
  17
  18 * \core_component::fetch_subsystems() now returns a valid path for completion component instead of null.
  19
  20 === 2.8 ===
  21
  22 * Gradebook grade category option "aggregatesubcats" has been removed completely.
  23   This means that the database column is removed, the admin settings are removed and
  24   the properties from the grade_category object have been removed. If any courses were
  25   found to be using this setting, a warning to check the grades will be shown in the
  26   course grader report after upgrading the site. The same warning will be shown on
  27   courses restored from backup that had this setting enabled (see MDL-47503).
  28 * lib/excelllib.class.php has been updated. The class MoodleExcelWorkbook will now only produce excel 2007 files.
  29 * renderers: We now remove the suffix _renderable when looking for a render method for a renderable.
  30   If you have a renderable class named like "blah_renderable" and have a method on a renderer named "render_blah_renderable"
  31   you will need to change the name of your render method to "render_blah" instead, as renderable at the end is no longer accepted.
  32 * New functions get_course_and_cm_from_cmid($cmorid, $modulename) and
  33   get_course_and_cm_from_instance($instanceorid, $modulename) can be used to
  34   more efficiently load these basic data objects at the start of a script.
  35 * New function cm_info::create($cm) can be used when you need a cm_info
  36   object, but have a $cm which might only be a standard database record.
  37 * $CFG->enablegroupmembersonly no longer exists.
  38 * Scheduled tasks have gained support for syntax to introduce variability when a
  39   task will run across installs. When a when hour or minute are defined as 'R'
  40   they will be installed with a random hour/minute value.
  41 * Several classes grade_edit_tree_column_xxx were removed since grades setup page
  42   has been significantly changed. These classes should not be used outside of
  43   gradebook or developers can copy them into their plugins from 2.7 branch.
  44 * Google APIs Client Library (lib/google/) has been upgraded to 1.0.5-beta and
  45   API has changed dramatically without backward compatibility. Any code accessing
  46   it must be amended. It does not apply to lib/googleapi.php. See MDL-47297
  47 * Added an extra parameter to the function get_formatted_help_string() (default null) which is used to specify
  48   additional string parameters.
  49 * User settings node and course node in navigation now support callbacks from admin tools.
  50 * grade_get_grades() optional parameteres $itemtype, $itemmodule, $iteminstance are now required.
  51
  52 DEPRECATIONS:
  53 * completion_info->get_incomplete_criteria() is deprecated and will be removed in Moodle 3.0.
  54 * grade_category::aggregate_values() is deprecated and will be removed in Moodle 3.0.
  55 * groups_filter_users_by_course_module_visible() is deprecated; replace with
  56   core_availability\info::filter_user_list. Will be removed in Moodle 3.0.
  57 * groups_course_module_visible() is deprecated; replace with $cm->uservisible.
  58 * cm_info property $cm->groupmembersonly is deprecated and always returns 0.
  59   Use core_availability\info::filter_user_list if trying to determine which
  60   other users can see an activity.
  61 * cm_info method $cm->is_user_access_restricted_by_group() is deprecated and
  62   always returns false. Use $cm->uservisible to determine whether the user can
  63   access the activity.
  64 * Constant FEATURE_GROUPMEMBERSONLY (used in module _supports functions) is
  65   deprecated.
  66 * cohort_get_visible_list() is deprecated. There is a better function cohort_get_available_cohorts()
  67   that respects user capabilities to view cohorts.
  68 * enrol_cohort_get_cohorts() and enrol_cohort_search_cohorts() are deprecated since
  69   functionality is removed. Please use cohort_get_available_cohorts()
  70 * enrol_cohort_enrol_all_users() is deprecated; enrol_manual is now responsible for this action
  71 * enrol_cohort_can_view_cohort() is deprecated; replace with cohort_can_view_cohort()
  72
  73 === 2.6.4 / 2.7.1 ===
  74
  75 * setnew_password_and_mail() and update_internal_user_password() will trigger
  76   \core\event\user_password_updated. Previously they used to generate
  77   \core\event\user_updated event.
  78 * update_internal_user_password() accepts optional boolean $fasthash for fast
  79   hashing.
  80 * user_update_user() and user_create_user() api's accept optional param
  81   $triggerevent to avoid respective events to be triggred from the api's.
  82
  83 === 2.7 ===
  84
  85 * PHPUnit cannot be installed via PEAR any more, please use composer package manager instead.
  86 * $core_renderer->block_move_target() changed to support more verbose move-block-here descriptions.
  87
  88 Events and Logging:
  89 * Significant changes in Logging API. For upgrading existing events_trigger() and
  90   add_to_log() see http://docs.moodle.org/dev/Migrating_logging_calls_in_plugins
  91   For accessing logs from plugins see http://docs.moodle.org/dev/Migrating_log_access_in_reports
  92 * The validation of the following events is now stricter (see MDL-45445):
  93     - \core\event\blog_entry_created
  94     - \core\event\blog_entry_deleted
  95     - \core\event\blog_entry_updated
  96     - \core\event\cohort_member_added
  97     - \core\event\cohort_member_removed
  98     - \core\event\course_category_deleted
  99     - \core\event\course_completed
 100     - \core\event\course_content_deleted
 101     - \core\event\course_created
 102     - \core\event\course_deleted
 103     - \core\event\course_restored
 104     - \core\event\course_section_updated (see MDL-45229)
 105     - \core\event\email_failed
 106     - \core\event\group_member_added
 107     - \core\event\group_member_removed
 108     - \core\event\note_created
 109     - \core\event\note_deleted
 110     - \core\event\note_updated
 111     - \core\event\role_assigned
 112     - \core\event\role_deleted
 113     - \core\event\role_unassigned
 114     - \core\event\user_graded
 115     - \core\event\user_loggedinas
 116     - \core\event\user_profile_viewed
 117     - \core\event\webservice_token_created
 118
 119 DEPRECATIONS:
 120 * $module uses in mod/xxx/version.php files is now deprecated. Please use $plugin instead. It will be removed in Moodle 2.10.
 121 * Update init methods in all event classes - "level" property was renamed to "edulevel", the level property is now deprecated.
 122 * Abstract class \core\event\course_module_instances_list_viewed is deprecated now, use \core\event\instances_list_viewed instead.
 123 * Abstract class core\event\content_viewed has been deprecated. Please extend base event or other relevant abstract class.
 124 * mod_book\event\instances_list_viewed has been deprecated. Please use mod_book\event\course_module_instance_list_viewed instead.
 125 * mod_chat\event\instances_list_viewed has been deprecated. Please use mod_chat\event\course_module_instance_list_viewed instead.
 126 * mod_choice\event\instances_list_viewed has been deprecated. Please use mod_choice\event\course_module_instance_list_viewed instead.
 127 * mod_feedback\event\instances_list_viewed has been deprecated. Please use mod_feedback\event\course_module_instance_list_viewed instead.
 128 * mod_page\event\instances_list_viewed has been deprecated. Please use mod_page\event\course_module_instance_list_viewed instead.
 129 * The constants FRONTPAGECOURSELIST, FRONTPAGETOPICONLY & FRONTPAGECOURSELIMIT have been removed.
 130 * Conditional availability API has moved and changed. The condition_info class is
 131   replaced by \core_availability\info_module, and condition_info_section by
 132   \core_availability\info_section. (Code that uses the old classes will generally
 133   still work.)
 134 * coursemodule_visible_for_user() has been deprecated but still works - replaced
 135   by a new static function \core_availability\info_module::is_user_visible()
 136 * cm_info::is_user_access_restricted_by_conditional_access has been deprecated
 137   but still works (it has never done what its name suggests, and is
 138   unnecessary).
 139 * cm_info and section_info property showavailability has been deprecated, but
 140   still works (with the caveat that this information is now per-user).
 141 * cm_info and section_info properties availablefrom and availableuntil have been
 142   deprecated and always return zero (underlying data doesn't have these values).
 143 * section_info property groupingid has been deprecated and always returns zero,
 144   same deal.
 145 * Various cm_info methods have been deprecated in favour of their read-only properties (get_url(), get_content(), get_extra_classes(),
 146   get_on_click(), get_custom_data(), get_after_link, get_after_edit_icons)
 147 * The ajaxenabled function has been deprecated and always returns true. All code should be fully functional in Javascript.
 148 * count_login_failures() has been deprecated, use user_count_login_failures() instead. Refer MDL-42891 for details.
 149
 150 Conditional availability (activities and sections):
 151 * New conditional availability API in /availability, including new availability
 152   condition plugins in /availability/condition. The new API is very similar with
 153   regard to checking availability, but any code that modifies availability settings
 154   for an activity or section is likely to need substantial changes.
 155
 156 YUI:
 157   * The lightbox attribute for moodle-core-notification-dialogue has been
 158     deprecated and replaced by the modal attribute. This was actually
 159     changed in Moodle 2.2, but has only been marked as deprecated now. It
 160     will be removed in Moodle 2.9.
 161   * When destroying any type of dialogue based on moodle-core-notification, the relevant content is also removed from
 162     the DOM. Previously it was left orphaned.
 163
 164 JavaSript:
 165     * The findChildNodes global function has been deprecated. Y.all should
 166       be used instead.
 167     * The callback argument to confirm_action and M.util.show_confirm_dialog has been deprecated. If you need to write a
 168       confirmation which includes a callback, please use moodle-core-notification-confirmation and attach callbacks to the
 169       events provided.
 170
 171 * New locking api and admin settings to configure the system locking type.
 172 * New "Time spent waiting for the database" performance metric displayed along with the
 173   other MDL_PERF vars; the change affects both the error logs and the vars displayed in
 174   the page footer.
 175 * Changes in the tag API. The component and contextid are now saved when assigning tags to an item. Please see
 176   tag/upgrade.txt for more information.
 177
 178 === 2.6 ===
 179
 180 * Use new methods from core_component class instead of get_core_subsystems(), get_plugin_types(),
 181   get_plugin_list(), get_plugin_list_with_class(), get_plugin_directory(), normalize_component(),
 182   get_component_directory() and get_plugin_list_with_file(). The names of the new methods are
 183   exactly the same, the only differences are that core_component::get_plugin_types() now always returns
 184   full paths and core_component::get_plugin_list() does not accept empty parameter any more.
 185 * Use core_text::* instead of textlib:: and also core_collator::* instead of collatorlib::*.
 186 * Use new function moodleform::mock_submit() to simulate form submission in unit tests (backported).
 187 * New $CFG->localcachedir setting useful for cluster nodes. Admins have to update X-Sendfile aliases if used.
 188 * MS SQL Server drivers are now using NVARCHAR(MAX) instead of NTEXT and VARBINARY(MAX) instead of IMAGE,
 189   this change should be fully transparent and it should help significantly with add-on compatibility.
 190 * The string manager classes were renamed. Note that they should not be modified or used directly,
 191   always use get_string_manager() to get instance of the string manager.
 192 * The ability to use an 'insecure' rc4encrypt/rc4decrypt key has been removed.
 193 * Use $CFG->debugdeveloper instead of debugging('', DEBUG_DEVELOPER).
 194 * Use set_debugging(DEBUG_xxx) when changing debugging level for current request.
 195 * Function moveto_module() does not modify $mod argument and instead now returns the new module visibility value.
 196 * Use behat_selectors::get_allowed_text_selectors() and behat_selectors::get_allowed_selectors() instead of
 197   behat_command::$allowedtextselectors and behat_command::$allowedselectors
 198 * Subplugins are supported in admin tools and local plugins.
 199 * file_packer/zip_packer API has been modified so that key functions support a new file_progress interface
 200   to report progress during long operations. Related to this, zip_archive now supports an estimated_count()
 201   function that returns an approximate number of entries in the zip faster than the count() function.
 202 * Class cm_info no longer extends stdClass. All properties are read-only and calculated on first request only.
 203 * Class course_modinfo no longer extends stdClass. All properties are read-only.
 204 * Database fields modinfo and sectioncache in table course are removed. Application cache core/coursemodinfo
 205   is used instead. Course cache is still reset, rebuilt and retrieved using function rebuild_course_cache() and
 206   get_fast_modinfo(). Purging all caches and every core upgrade purges course modinfo cache as well.
 207   If function get_fast_modinfo() is called for multiple courses make sure to include field cacherev in course
 208   object.
 209 * Internal (noreply and support) user support has been added for sending/receiving message.
 210   Use core_user::get_noreply_user() and core_user::get_support_user() to get noreply and support user's respectively.
 211   Real users can be used as noreply/support users by setting $CFG->noreplyuserid and $CFG->supportuserid
 212 * New function readfile_allow_large() in filelib.php for use when very large files may need sending to user.
 213 * Use core_plugin_manager::reset_caches() when changing visibility of plugins.
 214 * Implement new method get_enabled_plugins() method in subplugin info classes.
 215 * Each plugin should include version information in version.php.
 216 * Module and block tables do not contain version column any more, use get_config('xx_yy', 'version') instead.
 217 * $USER->password field is intentionally unset so that session data does not contain password hashes.
 218 * Use core_shutdown_manager::register_function() instead of register_shutdown_function().
 219 * New file packer for .tar.gz files; obtain by calling get_file_packer('application/x-gzip'). Intended initially
 220   for use in backup/restore only, as there are limitations on supported filenames. Also new packer for
 221   backups which supports both compression formats; get_file_packer('application/vnd.moodle.backup').
 222 * New optional parameter to stored_file::get_content_file_handle to open file handle with 'gzopen' instead
 223   of 'fopen' to read gzip-compressed files if required.
 224 * update_internal_user_password() and setnew_password_and_mail() now trigger user_updated event.
 225 * Add thirdpartylibs.xml file to plugins that bundle any 3rd party libraries.
 226 * New class introduced to help auto generate zIndex values for modal dialogues. Class "moodle-has-zindex"
 227   should set on any element which uses a non-default zindex and needs to ensure it doesn't show above a
 228   dialogue.
 229 * $CFG->filelifetime is now used consistently for most file serving operations, the default was lowered
 230   to 6 hours from 24 hours because etags and x-sendfile support should make file serving less expensive.
 231 * Date format locale charset for windows server will come from calendar type and for gregorian it will use
 232   lang file.
 233 * The library to interact with Box.net (class boxclient) is only compatible with their APIv1 which
 234   reaches its end of life on the 14th of Dec. You should migrate your scripts to make usage of the
 235   new class boxnet_client(). Note that the method names and return values have changed.
 236 * Settings pages are now possible for Calendar type plugins. Calendar type plugins that require a settings page to
 237   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.
 238 * The admin/tool/generator tool was overhauled to use testing data generators and the previous interface to create
 239   test data was removed (it was not working correctly anyway). If you were using this tool you will probably need to
 240   update your code.
 241
 242 DEPRECATIONS:
 243 Various previously deprecated functions have now been altered to throw DEBUG_DEVELOPER debugging notices
 244 and will be removed in a future release (target: 2.8), a summary follows:
 245
 246 Accesslib:
 247     * get_context_instance()                ->  context_xxxx::instance()
 248     * get_context_instance_by_id()          ->  context::instance_by_id($id)
 249     * get_system_context()                  ->  context_system::instance()
 250     * context_moved()                       ->  context::update_moved()
 251     * preload_course_contexts()             ->  context_helper::preload_course()
 252     * context_instance_preload()            ->  context_helper::preload_from_record()
 253     * context_instance_preload_sql()        ->  context_helper::get_preload_record_columns_sql()
 254     * get_contextlevel_name()               ->  context_helper::get_level_name()
 255     * create_contexts()                     ->  context_helper::create_instances()
 256     * cleanup_contexts()                    ->  context_helper::cleanup_instances()
 257     * build_context_path()                  ->  context_helper::build_all_paths()
 258     * print_context_name()                  ->  $context->get_context_name()
 259     * mark_context_dirty()                  ->  $context->mark_dirty()
 260     * delete_context()                      ->  $context->delete_content() or context_helper::delete_instance()
 261     * get_context_url()                     ->  $context->get_url()
 262     * get_course_context()                  ->  $context->get_course_context()
 263     * get_parent_contexts()                 ->  $context->get_parent_context_ids()
 264     * get_parent_contextid()                ->  $context->get_parent_context()
 265     * get_child_contexts()                  ->  $context->get_child_contexts()
 266     * rebuild_contexts()                    ->  $context->reset_paths()
 267     * get_user_courses_bycap()              ->  enrol_get_users_courses()
 268     * get_courseid_from_context()           ->  $context->get_course_context(false)
 269     * get_role_context_caps()               ->  (no replacement)
 270     * load_temp_role()                      ->  (no replacement)
 271     * remove_temp_roles()                   ->  (no replacement)
 272     * get_related_contexts_string()         ->  $context->get_parent_context_ids(true)
 273     * get_recent_enrolments()               ->  (no replacement)
 274
 275 Enrollment:
 276     * get_course_participants()             -> get_enrolled_users()
 277     * is_course_participant()               -> is_enrolled()
 278
 279 Output:
 280     * current_theme()                       -> $PAGE->theme->name
 281     * skip_main_destination()               -> $OUTPUT->skip_link_target()
 282     * print_container()                     -> $OUTPUT->container()
 283     * print_container_start()               -> $OUTPUT->container_start()
 284     * print_container_end()                 -> $OUTPUT->container_end()
 285     * print_continue()                      -> $OUTPUT->continue_button()
 286     * print_header()                        -> $PAGE methods
 287     * print_header_simple()                 -> $PAGE methods
 288     * print_side_block()                    -> $OUTPUT->block()
 289     * print_arrow()                         -> $OUTPUT->arrow()
 290     * print_scale_menu_helpbutton()         -> $OUTPUT->help_icon_scale($courseid, $scale)
 291     * print_checkbox()                      -> html_writer::checkbox()
 292
 293 Navigation:
 294     * print_navigation()                    -> $OUTPUT->navbar()
 295     * build_navigation()                    -> $PAGE->navbar methods
 296     * navmenu()                             -> (no replacement)
 297     * settings_navigation::
 298           get_course_modules()              -> (no replacement)
 299
 300 Files and repositories:
 301     * stored_file::replace_content_with()   -> stored_file::replace_file_with()
 302     * stored_file::set_filesize()           -> stored_file::replace_file_with()
 303     * stored_file::get_referencelifetime()  -> (no replacement)
 304     * repository::sync_external_file()      -> see repository::sync_reference()
 305     * repository::get_file_by_reference()   -> repository::sync_reference()
 306     * repository::
 307           get_reference_file_lifetime()     -> (no replacement)
 308     * repository::sync_individual_file()    -> (no replacement)
 309     * repository::reset_caches()            -> (no replacement)
 310
 311 Calendar:
 312     * add_event()                           -> calendar_event::create()
 313     * update_event()                        -> calendar_event->update()
 314     * delete_event()                        -> calendar_event->delete()
 315     * hide_event()                          -> calendar_event->toggle_visibility(false)
 316     * show_event()                          -> calendar_event->toggle_visibility(true)
 317
 318 Misc:
 319     * filter_text()                         -> format_text(), format_string()...
 320     * httpsrequired()                       -> $PAGE->https_required()
 321     * detect_munged_arguments()             -> clean_param([...], PARAM_FILE)
 322     * mygroupid()                           -> groups_get_all_groups()
 323     * js_minify()                           -> core_minify::js_files()
 324     * css_minify_css()                      -> core_minify::css_files()
 325     * course_modinfo::build_section_cache() -> (no replacement)
 326     * generate_email_supportuser()          -> core_user::get_support_user()
 327
 328 Sessions:
 329     * session_get_instance()->xxx()         -> \core\session\manager::xxx()
 330     * session_kill_all()                    -> \core\session\manager::kill_all_sessions()
 331     * session_touch()                       -> \core\session\manager::touch_session()
 332     * session_kill()                        -> \core\session\manager::kill_session()
 333     * session_kill_user()                   -> \core\session\manager::kill_user_sessions()
 334     * session_gc()                          -> \core\session\manager::gc()
 335     * session_set_user()                    -> \core\session\manager::set_user()
 336     * session_is_loggedinas()               -> \core\session\manager::is_loggedinas()
 337     * session_get_realuser()                -> \core\session\manager::get_realuser()
 338     * session_loginas()                     -> \core\session\manager::loginas()
 339
 340 User-agent related functions:
 341     * check_browser_operating_system()      -> core_useragent::check_browser_operating_system()
 342     * check_browser_version()               -> core_useragent::check_browser_version()
 343     * get_device_type()                     -> core_useragent::get_device_type()
 344     * get_device_type_list()                -> core_useragent::get_device_type_list()
 345     * get_selected_theme_for_device_type()  -> core_useragent::get_device_type_theme()
 346     * get_device_cfg_var_name()             -> core_useragent::get_device_type_cfg_var_name()
 347     * set_user_device_type()                -> core_useragent::set_user_device_type()
 348     * get_user_device_type()                -> core_useragent::get_user_device_type()
 349     * get_browser_version_classes()         -> core_useragent::get_browser_version_classes()
 350
 351 YUI:
 352     * moodle-core-notification has been deprecated with a recommendation of
 353       using its subclasses instead. This is to allow for reduced page
 354       transport costs. Current subclasses include:
 355       * dialogue
 356       * alert
 357       * confirm
 358       * exception
 359       * ajaxexception
 360
 361 Event triggering and event handlers:
 362     * All existing events and event handlers should be replaced by new
 363       event classes and matching new event observers.
 364     * See http://docs.moodle.org/dev/Event_2 for more information.
 365     * The following events will be entirely removed, though they can still
 366       be captured using handlers, but they should not be used any more.
 367       * groups_members_removed          -> \core\event\group_member_removed
 368       * groups_groupings_groups_removed -> (no replacement)
 369       * groups_groups_deleted           -> \core\event\group_deleted
 370       * groups_groupings_deleted        -> \core\event\grouping_deleted
 371     * edit_module_post_actions() does not trigger events any more.
 372
 373 === 2.5.1 ===
 374
 375 * New get_course() function for use when obtaining the course record from database. Will
 376   reuse existing $COURSE or $SITE globals if possible to improve performance.
 377
 378 === 2.5 ===
 379
 380 * The database drivers (moodle_database and subclasses) aren't using anymore the ::columns property
 381   for caching database metadata. MUC (databasemeta) is used instead. Any custom DB driver should
 382   apply for that change.
 383 * The cron output has been changed to include time and memory usage (see cron_trace_time_and_memory()),
 384   so any custom utility relying on the old output may require modification.
 385 * Function get_max_file_sizes now returns an option for (for example) "Course limit (500MB)" or
 386   "Site limit (200MB)" when appropriate with the option set to 0. This function no longer returns
 387   an option for 0 bytes. Existing code that was replacing the 0 option in the return
 388   from this function with a more sensible message, can now use the return from this function directly.
 389 * Functions responsible for output in course/lib.php are deprecated, the code is moved to
 390   appropriate renderers: print_section(), print_section_add_menus(), get_print_section_cm_text(),
 391   make_editing_buttons()
 392   See functions' phpdocs in lib/deprecatedlib.php
 393 * Function get_print_section_cm_text() is deprecated, replaced with methods in cm_info
 394 * zip_packer may create empty zip archives, there is a new option to ignore
 395   problematic files when creating archive
 396 * The function delete_course_module was deprecated and has been replaced with
 397   course_delete_module. The reason for this was because the function delete_course_module
 398   only partially deletes data, so wherever it was called extra code was needed to
 399   perform the whole deletion process. The function course_delete_module now takes care
 400   of the whole process.
 401 * curl::setopt() does not accept constant values any more. As it never worked properly,
 402   we decided to make the type check stricter. Now, the keys of the array pass must be a string
 403   corresponding to the curl constant name.
 404 * Function get_users_listing now return list of users except guest and deleted users. Previously
 405   deleted users were excluded by get_users_listing. As guest user is not expected while browsing users,
 406   and not included in get_user function, it will not be returned by get_users_listing.
 407 * The add_* functions in course/dnduploadlib.php have been deprecated. Plugins should be using the
 408   MODNAME_dndupload_register callback instead.
 409 * The signature of the add() method of classes implementing the parentable_part_of_admin_tree
 410   interface (such as admin_category) has been extended. The new parameter allows the caller
 411   to prepend the new node before an existing sibling in the admin tree.
 412 * condition_info:get_condition_user_fields($formatoptions) now accepts the optional
 413   param $formatoptions, that will determine if the field names are processed by
 414   format_string() with the passed options.
 415 * remove all references to $CFG->gdversion, GD PHP extension is now required
 416 * Formslib will now throw a developer warning if a PARAM_ type hasn't been set for elements which
 417   need it. Please set PARAM_RAW explicitly if you do not want any cleaning.
 418 * Functions responsible for managing and accessing course categories are moved to class coursecat
 419   in lib/coursecatlib.php, functions responsible for rendering courses and categories lists are
 420   moved to course/renderer.php. The following global functions are deprecated: make_categories_list(),
 421   category_delete_move(), category_delete_full(), move_category(), course_category_hide(),
 422   course_category_show(), get_course_category(), create_course_category(), get_all_subcategories(),
 423   get_child_categories(), get_categories(), print_my_moodle(), print_remote_course(),
 424   print_remote_host(), print_whole_category_list(), print_category_info(), get_course_category_tree(),
 425   print_courses(), print_course(), get_category_courses_array(), get_category_courses_array_recursively(),
 426   get_courses_wmanagers()
 427   See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
 428 * $core_renderer->block_move_target() changed to support more verbose move-block-here descriptions.
 429 * Additional (optional) param $onlyactive has been added to get_enrolled_users, count_enrolled_users
 430   functions to get information for only active (excluding suspended enrolments) users. Included two
 431   helper functions extract_suspended_users, get_suspended_userids to extract suspended user information.
 432 * The core_plugin_manager class now provides two new helper methods for getting information
 433   about known plugins: get_plugins_of_type() and get_subplugins_of_plugin().
 434 * The get_uninstall_url() method of all subclasses of \core\plugininfo\base class is now expected
 435   to always return moodle_url. Subclasses can use the new method is_uninstall_allowed()
 436   to control the availability of the 'Uninstall' link at the Plugins overview page (previously
 437   they would do it by get_uninstall_url() returning null). By default, URL to a new general plugin
 438   uninstall tool is returned. Unless the plugin type needs extra steps that can't be handled by
 439   plugininfo_xxx::uninstall() method or xmldb_xxx_uninstall() function, this default URL should
 440   satisfy all plugin types.
 441
 442 Database (DML) layer:
 443 * $DB->sql_empty() is deprecated, you have to use sql parameters with empty values instead,
 444   please note hardcoding of empty strings in SQL queries breaks execution in Oracle database.
 445 * Indexes must not be defined on the same columns as keys, this is now reported as fatal problem.
 446   Please note that internally we create indexes instead of foreign keys.
 447
 448 YUI changes:
 449 * M.util.help_icon has been deprecated. Code should be updated to use moodle-core-popuphelp
 450   instead. To do so, remove any existing JS calls to M.util.help_icon from your PHP and ensure
 451   that your help link is placed in a span which has the class 'helplink'.
 452
 453 === 2.4 ===
 454
 455 * Pagelib: Numerous deprecated functions were removed as classes page_base, page_course
 456   and page_generic_activity.
 457 * use $CFG->googlemapkey3 instead of removed $CFG->googlemapkey and migrate to Google Maps API V3
 458 * Function settings_navigation::add_course_editing_links() is completely removed
 459 * function global_navigation::format_display_course_content() is removed completely (the
 460   functionality is moved to course format class)
 461 * in the function global_navigation::load_generic_course_sections() the argument $courseformat is
 462   removed
 463 * New component and itemid columns in groups_members table - this allows plugin to create protected
 464   group memberships using 'xx_yy_allow_group_member_remove' callback and there is also a new restore
 465   callback 'xx_yy_restore_group_member()'.
 466 * New general role assignment restore plugin callback 'xx_yy_restore_role_assignment()'.
 467 * functions get_generic_section_name(), get_all_sections(), add_mod_to_section(), get_all_mods()
 468   are deprecated. See their phpdocs in lib/deprecatedlib.php on how to replace them
 469
 470 YUI changes:
 471 * moodle-enrol-notification has been renamed to moodle-core-notification
 472 * YUI2 code must now use 2in3, see http://yuilibrary.com/yui/docs/yui/yui-yui2.html
 473 * M.util.init_select_autosubmit() and M.util.init_url_select() have been deprecated. Code using this should be updated
 474   to use moodle-core-formautosubmit
 475
 476 Unit testing changes:
 477 * output debugging() is not sent to standard output any more,
 478   use $this->assertDebuggingCalled(), $this->assertDebuggingNotCalled(),
 479   $this->getDebuggingMessages() or $this->assertResetDebugging() instead.
 480
 481 === 2.3 ===
 482
 483 Database layer changes:
 484 * objects are not allowed in paramters of DML functions, use explicit casting to strings if necessary
 485
 486 Note:
 487 * DDL and DML methods which were deprecated in 2.0 have now been removed, they will no longer produce
 488 debug messages and will produce fatal errors
 489
 490 API changes:
 491
 492 * send_stored_file() has changed its interface
 493 * deleted several resourcelib_embed_* functions from resourcelib.php
 494
 495 === 2.2 ===
 496
 497 removed unused libraries:
 498 * odbc, base32, CodeSniffer, overlib, apd profiling, kses, Smarty, PEAR Console, swfobject, cssshover.htc, md5.js
 499
 500 API changes:
 501 * new admin/tool plugin type
 502 * new context API - old API is still available
 503 * deleted users do not have context any more
 504 * removed global search
 505
 506
 507 === 2.1 ===
 508
 509 API changes:
 510 * basic suport for restore from 1.9
 511 * new mobile devices API
 512 * new questions API
 513
 514
 515 === 2.0 ===
 516
 517 API changes:
 518 * new DML API - http://docs.moodle.org/dev/DML_functions
 519 * new DDL API - http://docs.moodle.org/dev/DDL_functions
 520 * new file API - http://docs.moodle.org/dev/File_API
 521 * new $PAGE and $OUTPUT API
 522 * new navigation API
 523 * new theme API - http://docs.moodle.org/dev/Theme_changes_in_2.0
 524 * new javascript API - http://docs.moodle.org/dev/JavaScript_usage_guide
 525 * new portfolio API
 526 * new local plugin type
 527 * new translation support - http://lang.moodle.org
 528 * new web service API
 529 * new cohorts API
 530 * new messaging API
 531 * new rating API
 532 * new comment API
 533 * new sessions API
 534 * new enrolment API
 535 * new backup/restore API
 536 * new blocks API
 537 * new filters API
 538 * improved plugin support (aka Frankenstyle)
 539 * new registration and hub API
 540 * new course completion API
 541 * new plagiarism API
 542 * changed blog API
 543 * new text editor API
 544 * new my moodle and profiles API