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