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