Merge branch 'wip-MDL-40430-master' of git://
[moodle.git] / lib / upgrade.txt
1 This files describes API changes in core libraries and APIs,
2 information provided here is intended especially for developers.
4 === 2.6 ===
6 * Use new core_component::* plugin listing and component normalisation methods.
7 * Use core_text::* instead of textlib:: and also core_collator::* instead of collatorlib::*.
8 * Use new function moodleform::mock_submit() to simulate form submission in unit tests (backported).
9 * get_context_instance() is deprecated, please use use context_xxxx::instance().
10 * get_context_instance_by_id() is deprecated, please use context::instance_by_id($id).
11 * load_temp_role() and remove_temp_roles() can not be used any more.
12 * get_system_context() is deprecated, please use context_system::instance().
13 * get_parent_contexts() is deprecated, please use $context->get_parent_context_ids().
14 * get_parent_contextid() is deprecated, please use $context->get_parent_context().
15 * get_child_contexts() is deprecated, please use $context->get_child_contexts().
16 * create_contexts() is deprecated, please use context_helper::create_instances().
17 * cleanup_contexts() is deprecated, please use context_helper::cleanup_instances().
18 * build_context_path() is deprecated, please use context_helper::build_all_paths().
19 * rebuild_contexts() is deprecated, please use $context->reset_paths().
20 * preload_course_contexts() is deprecated, please use context_helper::preload_course().
21 * context_moved() is deprecated, please use context::update_moved().
22 * context_instance_preload() is deprecated, please use context_helper::preload_from_record().
23 * get_contextlevel_name() is deprecated, please use context_helper::get_level_name().
24 * print_context_name() is deprecated, please use $context->get_context_name().
26 === 2.5.1 ===
28 * New get_course() function for use when obtaining the course record from database. Will
29   reuse existing $COURSE or $SITE globals if possible to improve performance.
31 === 2.5 ===
33 * The database drivers (moodle_database and subclasses) aren't using anymore the ::columns property
34   for caching database metadata. MUC (databasemeta) is used instead. Any custom DB driver should
35   apply for that change.
36 * The cron output has been changed to include time and memory usage (see cron_trace_time_and_memory()),
37   so any custom utility relying on the old output may require modification.
38 * Function get_max_file_sizes now returns an option for (for example) "Course limit (500MB)" or
39   "Site limit (200MB)" when appropriate with the option set to 0. This function no longer returns
40   an option for 0 bytes. Existing code that was replacing the 0 option in the return
41   from this function with a more sensible message, can now use the return from this function directly.
42 * Functions responsible for output in course/lib.php are deprecated, the code is moved to
43   appropriate renderers: print_section(), print_section_add_menus(), get_print_section_cm_text(),
44   make_editing_buttons()
45   See functions' phpdocs in lib/deprecatedlib.php
46 * Function get_print_section_cm_text() is deprecated, replaced with methods in cm_info
47 * zip_packer may create empty zip archives, there is a new option to ignore
48   problematic files when creating archive
49 * The function delete_course_module was deprecated and has been replaced with
50   course_delete_module. The reason for this was because the function delete_course_module
51   only partially deletes data, so wherever it was called extra code was needed to
52   perform the whole deletion process. The function course_delete_module now takes care
53   of the whole process.
54 * curl::setopt() does not accept constant values any more. As it never worked properly,
55   we decided to make the type check stricter. Now, the keys of the array pass must be a string
56   corresponding to the curl constant name.
57 * Function get_users_listing now return list of users except guest and deleted users. Previously
58   deleted users were excluded by get_users_listing. As guest user is not expected while browsing users,
59   and not included in get_user function, it will not be returned by get_users_listing.
60 * The add_* functions in course/dnduploadlib.php have been deprecated. Plugins should be using the
61   MODNAME_dndupload_register callback instead.
62 * The signature of the add() method of classes implementing the parentable_part_of_admin_tree
63   interface (such as admin_category) has been extended. The new parameter allows the caller
64   to prepend the new node before an existing sibling in the admin tree.
65 * condition_info:get_condition_user_fields($formatoptions) now accepts the optional
66   param $formatoptions, that will determine if the field names are processed by
67   format_string() with the passed options.
68 * remove all references to $CFG->gdversion, GD PHP extension is now required
69 * Formslib will now throw a developer warning if a PARAM_ type hasn't been set for elements which
70   need it. Please set PARAM_RAW explicitly if you do not want any cleaning.
71 * Functions responsible for managing and accessing course categories are moved to class coursecat
72   in lib/coursecatlib.php, functions responsible for rendering courses and categories lists are
73   moved to course/renderer.php. The following global functions are deprecated: make_categories_list(),
74   category_delete_move(), category_delete_full(), move_category(), course_category_hide(),
75   course_category_show(), get_course_category(), create_course_category(), get_all_subcategories(),
76   get_child_categories(), get_categories(), print_my_moodle(), print_remote_course(),
77   print_remote_host(), print_whole_category_list(), print_category_info(), get_course_category_tree(),
78   print_courses(), print_course(), get_category_courses_array(), get_category_courses_array_recursively(),
79   get_courses_wmanagers()
80   See
81 * $core_renderer->block_move_target() changed to support more verbose move-block-here descriptions.
82 * Additional (optional) param $onlyactive has been added to get_enrolled_users, count_enrolled_users
83   functions to get information for only active (excluding suspended enrolments) users. Included two
84   helper functions extract_suspended_users, get_suspended_userids to extract suspended user information.
85 * The plugin_manager class now provides two new helper methods for getting information
86   about known plugins: get_plugins_of_type() and get_subplugins_of_plugin().
87 * The get_uninstall_url() method of all subclasses of plugininfo_base class is now expected
88   to always return moodle_url. Subclasses can use the new method is_uninstall_allowed()
89   to control the availability of the 'Uninstall' link at the Plugins overview page (previously
90   they would do it by get_uninstall_url() returning null). By default, URL to a new general plugin
91   uninstall tool is returned. Unless the plugin type needs extra steps that can't be handled by
92   plugininfo_xxx::uninstall() method or xmldb_xxx_uninstall() function, this default URL should
93   satisfy all plugin types.
95 Database (DML) layer:
96 * $DB->sql_empty() is deprecated, you have to use sql parameters with empty values instead,
97   please note hardcoding of empty strings in SQL queries breaks execution in Oracle database.
98 * Indexes must not be defined on the same columns as keys, this is now reported as fatal problem.
99   Please note that internally we create indexes instead of foreign keys.
101 YUI changes:
102 * M.util.help_icon has been deprecated. Code should be updated to use moodle-core-popuphelp
103   instead. To do so, remove any existing JS calls to M.util.help_icon from your PHP and ensure
104   that your help link is placed in a span which has the class 'helplink'.
106 === 2.4 ===
108 * Pagelib: Numerous deprecated functions were removed as classes page_base, page_course
109   and page_generic_activity.
110 * use $CFG->googlemapkey3 instead of removed $CFG->googlemapkey and migrate to Google Maps API V3
111 * Function settings_navigation::add_course_editing_links() is completely removed
112 * function global_navigation::format_display_course_content() is removed completely (the
113   functionality is moved to course format class)
114 * in the function global_navigation::load_generic_course_sections() the argument $courseformat is
115   removed
116 * New component and itemid columns in groups_members table - this allows plugin to create protected
117   group memberships using 'xx_yy_allow_group_member_remove' callback and there is also a new restore
118   callback 'xx_yy_restore_group_member()'.
119 * New general role assignment restore plugin callback 'xx_yy_restore_role_assignment()'.
120 * functions get_generic_section_name(), get_all_sections(), add_mod_to_section(), get_all_mods()
121   are deprecated. See their phpdocs in lib/deprecatedlib.php on how to replace them
123 YUI changes:
124 * moodle-enrol-notification has been renamed to moodle-core-notification
125 * YUI2 code must now use 2in3, see
126 * M.util.init_select_autosubmit() and M.util.init_url_select() have been deprecated. Code using this should be updated
127   to use moodle-core-formautosubmit
129 Unit testing changes:
130 * output debugging() is not sent to standard output any more,
131   use $this->assertDebuggingCalled(), $this->assertDebuggingNotCalled(),
132   $this->getDebuggingMessages() or $this->assertResetDebugging() instead.
134 === 2.3 ===
136 Database layer changes:
137 * objects are not allowed in paramters of DML functions, use explicit casting to strings if necessary
139 Note:
140 * DDL and DML methods which were deprecated in 2.0 have now been removed, they will no longer produce
141 debug messages and will produce fatal errors
143 API changes:
145 * send_stored_file() has changed its interface
146 * deleted several resourcelib_embed_* functions from resourcelib.php
148 === 2.2 ===
150 removed unused libraries:
151 * odbc, base32, CodeSniffer, overlib, apd profiling, kses, Smarty, PEAR Console, swfobject,, md5.js
153 API changes:
154 * new admin/tool plugin type
155 * new context API - old API is still available
156 * deleted users do not have context any more
157 * removed global search
160 === 2.1 ===
162 API changes:
163 * basic suport for restore from 1.9
164 * new mobile devices API
165 * new questions API
168 === 2.0 ===
170 API changes:
171 * new DML API -
172 * new DDL API -
173 * new file API -
174 * new $PAGE and $OUTPUT API
175 * new navigation API
176 * new theme API -
177 * new javascript API -
178 * new portfolio API
179 * new local plugin type
180 * new translation support -
181 * new web service API
182 * new cohorts API
183 * new messaging API
184 * new rating API
185 * new comment API
186 * new sessions API
187 * new enrolment API
188 * new backup/restore API
189 * new blocks API
190 * new filters API
191 * improved plugin support (aka Frankenstyle)
192 * new registration and hub API
193 * new course completion API
194 * new plagiarism API
195 * changed blog API
196 * new text editor API
197 * new my moodle and profiles API