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