MDL-41437 inform developers that version column was removed from module and block...
[moodle.git] / lib / upgrade.txt
CommitLineData
690a55f6 1This files describes API changes in core libraries and APIs,
ee362526
PS
2information provided here is intended especially for developers.
3
9e19a0f0 4=== 2.6 ===
8e8891b7 5
cc8fecb5 6* Use new methods from core_component class instead of get_core_subsystems(), get_plugin_types(),
d0cac8b5
FM
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.
d534708f 11* Use core_text::* instead of textlib:: and also core_collator::* instead of collatorlib::*.
af578aec 12* Use new function moodleform::mock_submit() to simulate form submission in unit tests (backported).
85b38061 13* New $CFG->localcachedir setting useful for cluster nodes. Admins have to update X-Sendfile aliases if used.
656250de
PS
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.
598a82c9
PS
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.
aae18d2a 18* The ability to use an 'insecure' rc4encrypt/rc4decrypt key has been removed.
96f81ea3
PS
19* Use $CFG->debugdeveloper instead of debugging('', DEBUG_DEVELOPER).
20* Use set_debugging(DEBUG_xxx) when changing debugging level for current request.
d55f05ef 21* Function moveto_module() does not modify $mod argument and instead now returns the new module visibility value.
db5f2d33
DM
22* Use behat_selectors::get_allowed_text_selectors() and behat_selectors::get_allowed_selectors() instead of
23 behat_command::$allowedtextselectors and behat_command::$allowedselectors
ac2b2713 24* Subplugins are supported in admin tools and local plugins.
71ab7e51 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.
d872881f 28* Class cm_info no longer extends stdClass. All properties are read-only and calculated on first request only.
44ddd2a1 29* Class course_modinfo no longer extends stdClass. All properties are read-only.
64501eee
MG
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.
3bcf6b3c
RT
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
137885b7 38* New function readfile_allow_large() in filelib.php for use when very large files may need sending to user.
bde002b8
PS
39* Use 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.
723a6e56 42* Module and block tables do not contain version column any more, use get_config('xx_yy', 'version') instead.
05226d76
DP
43
44DEPRECATIONS:
45Various previously deprecated functions have now been altered to throw DEBUG_DEVELOPER debugging notices
46and will be removed in a future release (target: 2.8), a summary follows:
47
48Accesslib:
c3d2fbf9
SH
49 * get_context_instance() -> context_xxxx::instance()
50 * get_context_instance_by_id() -> context::instance_by_id($id)
51 * get_system_context() -> context_system::instance()
52 * context_moved() -> context::update_moved()
53 * preload_course_contexts() -> context_helper::preload_course()
54 * context_instance_preload() -> context_helper::preload_from_record()
55 * context_instance_preload_sql() -> context_helper::get_preload_record_columns_sql()
56 * get_contextlevel_name() -> context_helper::get_level_name()
57 * create_contexts() -> context_helper::create_instances()
58 * cleanup_contexts() -> context_helper::cleanup_instances()
59 * build_context_path() -> context_helper::build_all_paths()
60 * print_context_name() -> $context->get_context_name()
61 * mark_context_dirty() -> $context->mark_dirty()
62 * delete_context() -> $context->delete_content() or context_helper::delete_instance()
63 * get_context_url() -> $context->get_url()
64 * get_course_context() -> $context->get_course_context()
65 * get_parent_contexts() -> $context->get_parent_context_ids()
66 * get_parent_contextid() -> $context->get_parent_context()
67 * get_child_contexts() -> $context->get_child_contexts()
68 * rebuild_contexts() -> $context->reset_paths()
69 * get_user_courses_bycap() -> enrol_get_users_courses()
70 * get_courseid_from_context() -> $context->get_course_context(false)
71 * get_role_context_caps() -> (no replacement)
72 * load_temp_role() -> (no replacement)
73 * remove_temp_roles() -> (no replacement)
74 * get_related_contexts_string() -> $context->get_parent_context_ids(true)
75 * get_recent_enrolments() -> (no replacement)
05226d76
DP
76
77Enrollment:
c3d2fbf9
SH
78 * get_course_participants() -> get_enrolled_users()
79 * is_course_participant() -> is_enrolled()
05226d76
DP
80
81Output:
c3d2fbf9
SH
82 * current_theme() -> $PAGE->theme->name
83 * skip_main_destination() -> $OUTPUT->skip_link_target()
84 * print_container() -> $OUTPUT->container()
85 * print_container_start() -> $OUTPUT->container_start()
86 * print_container_end() -> $OUTPUT->container_end()
87 * print_continue() -> $OUTPUT->continue_button()
88 * print_header() -> $PAGE methods
89 * print_header_simple() -> $PAGE methods
90 * print_side_block() -> $OUTPUT->block()
91 * print_arrow() -> $OUTPUT->arrow()
92 * print_scale_menu_helpbutton() -> $OUTPUT->help_icon_scale($courseid, $scale)
93 * print_checkbox() -> html_writer::checkbox()
05226d76
DP
94
95Navigation:
c3d2fbf9
SH
96 * print_navigation() -> $OUTPUT->navbar()
97 * build_navigation() -> $PAGE->navbar methods
98 * navmenu() -> (no replacement)
05226d76
DP
99
100Calendar:
c3d2fbf9
SH
101 * add_event() -> calendar_event::create()
102 * update_event() -> calendar_event->update()
103 * delete_event() -> calendar_event->delete()
104 * hide_event() -> calendar_event->toggle_visibility(false)
105 * show_event() -> calendar_event->toggle_visibility(true)
05226d76
DP
106
107Misc:
c3d2fbf9
SH
108 * filter_text() -> format_text(), format_string()...
109 * httpsrequired() -> $PAGE->https_required()
110 * detect_munged_arguments() -> clean_param([...], PARAM_FILE)
111 * mygroupid() -> groups_get_all_groups()
112 * js_minify() -> core_minify::js_files()
113 * css_minify_css() -> core_minify::css_files()
64501eee 114 * course_modinfo::build_section_cache() -> (no replacement)
3bcf6b3c 115 * generate_email_supportuser() -> core_user::get_support_user()
c3d2fbf9 116
d79d5ac2
PS
117Sessions:
118 * session_get_instance()->xxx() -> \core\session\manager::xxx()
119 * session_kill_all() -> \core\session\manager::kill_all_sessions()
120 * session_touch() -> \core\session\manager::touch_session()
121 * session_kill() -> \core\session\manager::kill_session()
122 * session_kill_user() -> \core\session\manager::kill_user_sessions()
123 * session_gc() -> \core\session\manager::gc()
124 * session_set_user() -> \core\session\manager::set_user()
125 * session_is_loggedinas() -> \core\session\manager::is_loggedinas()
126 * session_get_realuser() -> \core\session\manager::get_realuser()
127 * session_loginas() -> \core\session\manager::loginas()
128
c3d2fbf9
SH
129User-agent related functions:
130 * check_browser_operating_system() -> core_useragent::check_browser_operating_system()
131 * check_browser_version() -> core_useragent::check_browser_version()
132 * get_device_type() -> core_useragent::get_device_type()
133 * get_device_type_list() -> core_useragent::get_device_type_list()
134 * get_selected_theme_for_device_type() -> core_useragent::get_device_type_theme()
135 * get_device_cfg_var_name() -> core_useragent::get_device_type_cfg_var_name()
136 * set_user_device_type() -> core_useragent::set_user_device_type()
137 * get_user_device_type() -> core_useragent::get_user_device_type()
138 * get_browser_version_classes() -> core_useragent::get_browser_version_classes()
9e19a0f0 139
78686995
AN
140YUI:
141 * moodle-core-notification has been deprecated with a recommendation of
73b4c1da 142 using its subclasses instead. This is to allow for reduced page
78686995
AN
143 transport costs. Current subclasses include:
144 * dialogue
145 * alert
146 * confirm
147 * exception
148 * ajaxexception
149
f0f0e1fe
PS
150Event triggering and event handlers:
151 * All existing events and event handlers should be replaced by new
152 event classes and matching new event observers.
153 * See http://docs.moodle.org/dev/Event_2 for more information.
861b0510
FM
154 * The following events will be entirely removed, though they can still
155 be captured using handlers, but they should not be used any more.
156 * groups_members_removed -> \core\event\group_member_removed
157 * groups_groupings_groups_removed -> (no replacement)
158 * groups_groups_deleted -> \core\event\group_deleted
159 * groups_groupings_deleted -> \core\event\grouping_deleted
63deb5c3 160 * edit_module_post_actions() does not trigger events any more.
f0f0e1fe 161
a2602457 162=== 2.5.1 ===
163
164* New get_course() function for use when obtaining the course record from database. Will
165 reuse existing $COURSE or $SITE globals if possible to improve performance.
166
9a36be73
MG
167=== 2.5 ===
168
bae2846c
EL
169* The database drivers (moodle_database and subclasses) aren't using anymore the ::columns property
170 for caching database metadata. MUC (databasemeta) is used instead. Any custom DB driver should
171 apply for that change.
cedc656b
EL
172* The cron output has been changed to include time and memory usage (see cron_trace_time_and_memory()),
173 so any custom utility relying on the old output may require modification.
6b219310
DW
174* Function get_max_file_sizes now returns an option for (for example) "Course limit (500MB)" or
175 "Site limit (200MB)" when appropriate with the option set to 0. This function no longer returns
176 an option for 0 bytes. Existing code that was replacing the 0 option in the return
177 from this function with a more sensible message, can now use the return from this function directly.
9a36be73 178* Functions responsible for output in course/lib.php are deprecated, the code is moved to
b1c2fc65
MG
179 appropriate renderers: print_section(), print_section_add_menus(), get_print_section_cm_text(),
180 make_editing_buttons()
9a36be73
MG
181 See functions' phpdocs in lib/deprecatedlib.php
182* Function get_print_section_cm_text() is deprecated, replaced with methods in cm_info
3cb856c7
PS
183* zip_packer may create empty zip archives, there is a new option to ignore
184 problematic files when creating archive
93cc145f
MN
185* The function delete_course_module was deprecated and has been replaced with
186 course_delete_module. The reason for this was because the function delete_course_module
187 only partially deletes data, so wherever it was called extra code was needed to
188 perform the whole deletion process. The function course_delete_module now takes care
189 of the whole process.
91c8cf99
F
190* curl::setopt() does not accept constant values any more. As it never worked properly,
191 we decided to make the type check stricter. Now, the keys of the array pass must be a string
192 corresponding to the curl constant name.
043f1005
RT
193* Function get_users_listing now return list of users except guest and deleted users. Previously
194 deleted users were excluded by get_users_listing. As guest user is not expected while browsing users,
195 and not included in get_user function, it will not be returned by get_users_listing.
1c14b1c1
DW
196* The add_* functions in course/dnduploadlib.php have been deprecated. Plugins should be using the
197 MODNAME_dndupload_register callback instead.
690a55f6
DM
198* The signature of the add() method of classes implementing the parentable_part_of_admin_tree
199 interface (such as admin_category) has been extended. The new parameter allows the caller
200 to prepend the new node before an existing sibling in the admin tree.
87b6981e
EL
201* condition_info:get_condition_user_fields($formatoptions) now accepts the optional
202 param $formatoptions, that will determine if the field names are processed by
203 format_string() with the passed options.
689096bc 204* remove all references to $CFG->gdversion, GD PHP extension is now required
b45ba7f6
DP
205* Formslib will now throw a developer warning if a PARAM_ type hasn't been set for elements which
206 need it. Please set PARAM_RAW explicitly if you do not want any cleaning.
4e0b6025 207* Functions responsible for managing and accessing course categories are moved to class coursecat
09ae7ee0
MG
208 in lib/coursecatlib.php, functions responsible for rendering courses and categories lists are
209 moved to course/renderer.php. The following global functions are deprecated: make_categories_list(),
6e1d1ee0 210 category_delete_move(), category_delete_full(), move_category(), course_category_hide(),
8db5dcb7 211 course_category_show(), get_course_category(), create_course_category(), get_all_subcategories(),
09ae7ee0
MG
212 get_child_categories(), get_categories(), print_my_moodle(), print_remote_course(),
213 print_remote_host(), print_whole_category_list(), print_category_info(), get_course_category_tree(),
214 print_courses(), print_course(), get_category_courses_array(), get_category_courses_array_recursively(),
215 get_courses_wmanagers()
216 See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
0e2ca62e 217* $core_renderer->block_move_target() changed to support more verbose move-block-here descriptions.
38c1dd19
RT
218* Additional (optional) param $onlyactive has been added to get_enrolled_users, count_enrolled_users
219 functions to get information for only active (excluding suspended enrolments) users. Included two
220 helper functions extract_suspended_users, get_suspended_userids to extract suspended user information.
d7d48b40
DM
221* The plugin_manager class now provides two new helper methods for getting information
222 about known plugins: get_plugins_of_type() and get_subplugins_of_plugin().
73658371
DM
223* The get_uninstall_url() method of all subclasses of plugininfo_base class is now expected
224 to always return moodle_url. Subclasses can use the new method is_uninstall_allowed()
225 to control the availability of the 'Uninstall' link at the Plugins overview page (previously
226 they would do it by get_uninstall_url() returning null). By default, URL to a new general plugin
227 uninstall tool is returned. Unless the plugin type needs extra steps that can't be handled by
228 plugininfo_xxx::uninstall() method or xmldb_xxx_uninstall() function, this default URL should
229 satisfy all plugin types.
9a36be73 230
4efcfaa3 231Database (DML) layer:
77a5c093
PS
232* $DB->sql_empty() is deprecated, you have to use sql parameters with empty values instead,
233 please note hardcoding of empty strings in SQL queries breaks execution in Oracle database.
2d97513d
PS
234* Indexes must not be defined on the same columns as keys, this is now reported as fatal problem.
235 Please note that internally we create indexes instead of foreign keys.
9a36be73 236
238b8bc9
ARN
237YUI changes:
238* M.util.help_icon has been deprecated. Code should be updated to use moodle-core-popuphelp
239 instead. To do so, remove any existing JS calls to M.util.help_icon from your PHP and ensure
240 that your help link is placed in a span which has the class 'helplink'.
241
6c2be903
DP
242=== 2.4 ===
243
244* Pagelib: Numerous deprecated functions were removed as classes page_base, page_course
245 and page_generic_activity.
704533fc 246* use $CFG->googlemapkey3 instead of removed $CFG->googlemapkey and migrate to Google Maps API V3
b874d5c6 247* Function settings_navigation::add_course_editing_links() is completely removed
ee7084e9
MG
248* function global_navigation::format_display_course_content() is removed completely (the
249 functionality is moved to course format class)
250* in the function global_navigation::load_generic_course_sections() the argument $courseformat is
251 removed
7881024e
PS
252* New component and itemid columns in groups_members table - this allows plugin to create protected
253 group memberships using 'xx_yy_allow_group_member_remove' callback and there is also a new restore
254 callback 'xx_yy_restore_group_member()'.
255* New general role assignment restore plugin callback 'xx_yy_restore_role_assignment()'.
97960146
MG
256* functions get_generic_section_name(), get_all_sections(), add_mod_to_section(), get_all_mods()
257 are deprecated. See their phpdocs in lib/deprecatedlib.php on how to replace them
ee362526 258
d2a27ab0
ARN
259YUI changes:
260* moodle-enrol-notification has been renamed to moodle-core-notification
3542e01a 261* YUI2 code must now use 2in3, see http://yuilibrary.com/yui/docs/yui/yui-yui2.html
7266bd3e
ARN
262* M.util.init_select_autosubmit() and M.util.init_url_select() have been deprecated. Code using this should be updated
263 to use moodle-core-formautosubmit
d2a27ab0 264
94c9db54
PS
265Unit testing changes:
266* output debugging() is not sent to standard output any more,
267 use $this->assertDebuggingCalled(), $this->assertDebuggingNotCalled(),
268 $this->getDebuggingMessages() or $this->assertResetDebugging() instead.
269
e618cdf3
PS
270=== 2.3 ===
271
272Database layer changes:
273* objects are not allowed in paramters of DML functions, use explicit casting to strings if necessary
274
19526d91
DP
275Note:
276* DDL and DML methods which were deprecated in 2.0 have now been removed, they will no longer produce
277debug messages and will produce fatal errors
e618cdf3 278
796495fe 279API changes:
daefd6eb 280
796495fe 281* send_stored_file() has changed its interface
daefd6eb 282* deleted several resourcelib_embed_* functions from resourcelib.php
796495fe 283
ee362526
PS
284=== 2.2 ===
285
286removed unused libraries:
287* odbc, base32, CodeSniffer, overlib, apd profiling, kses, Smarty, PEAR Console, swfobject, cssshover.htc, md5.js
288
289API changes:
290* new admin/tool plugin type
291* new context API - old API is still available
8e470797 292* deleted users do not have context any more
ee362526
PS
293* removed global search
294
295
296=== 2.1 ===
297
298API changes:
299* basic suport for restore from 1.9
300* new mobile devices API
301* new questions API
302
303
304=== 2.0 ===
305
306API changes:
307* new DML API - http://docs.moodle.org/dev/DML_functions
308* new DDL API - http://docs.moodle.org/dev/DDL_functions
309* new file API - http://docs.moodle.org/dev/File_API
310* new $PAGE and $OUTPUT API
311* new navigation API
312* new theme API - http://docs.moodle.org/dev/Theme_changes_in_2.0
313* new javascript API - http://docs.moodle.org/dev/JavaScript_usage_guide
314* new portfolio API
315* new local plugin type
316* new translation support - http://lang.moodle.org
317* new web service API
318* new cohorts API
319* new messaging API
320* new rating API
321* new comment API
322* new sessions API
323* new enrolment API
324* new backup/restore API
325* new blocks API
326* new filters API
327* improved plugin support (aka Frankenstyle)
328* new registration and hub API
329* new course completion API
330* new plagiarism API
331* changed blog API
332* new text editor API
19526d91 333* new my moodle and profiles API