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