MDL-48595 log: Replacing current interfaces
[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
a74d4743
SH
4=== 2.9 ===
5
adeb96d2 6* Support for loading AMD javascript modules has been added. See MDL-49046.
cf02542d 7* Webservice core_course_delete_courses now return warning messages on any failures and does not try to rollback the entire deletion.
a74d4743 8* \core\event\course_viewed 'other' argument renamed from coursesectionid to coursesectionnumber as it contains the section number.
91fed57a 9* New API core_filetypes::add_type (etc.) allows custom filetypes to be added and modified.
556e3a9e
AN
10* PHPUnit: PHPMailer Sink is now started for all tests and is setup within the phpunit wrapper for advanced tests.
11 Catching debugging messages when sending mail will no longer work. Use $sink = $this->redirectEmails(); and then check
12 the message in the sink instead.
c9bd4e41 13* The file pluginlib.php was deprecated since 2.6 and has now been removed, do not include or require it.
9802bd61 14* \core_component::fetch_subsystems() now returns a valid path for completion component instead of null.
7d0d3b36 15* Deprecated JS global methods have been removed (show_item, destroy_item, hide_item, addonload, getElementsByTagName, findChildNodes).
8072628a
NM
16* For 3rd party plugin specific environment.xml files, it's now possible to specify version independent checks by using the
17 <PLUGIN name="component_name"> tag instead of the version dependent <MOODLE version="x.y"> one. If the PLUGIN tag is used any
18 Moodle specific tags will be ignored.
7310dcff 19* External function core_files_get_files returns additional fields (timecreated, filesize, author, license)
3451a51c 20* html_table: new API for adding captions to tables (new field, $table->caption) and subsequently hiding said captions from sighted users using accesshide (enabled using $table->captionhide).
8d9bdd28
EL
21* The authorization procedure in the mdeploy.php script has been improved. The script
22 now relies on the main config.php when deploying an available update.
45a1a16b
DM
23* sql_internal_reader and sql_select_reader interfaces have been deprecated in favour of sql_internal_table_reader
24 and sql_reader.
a74d4743 25
4051685b
AG
26=== 2.8 ===
27
47d6e6a7
DW
28* Gradebook grade category option "aggregatesubcats" has been removed completely.
29 This means that the database column is removed, the admin settings are removed and
30 the properties from the grade_category object have been removed. If any courses were
31 found to be using this setting, a warning to check the grades will be shown in the
32 course grader report after upgrading the site. The same warning will be shown on
33 courses restored from backup that had this setting enabled (see MDL-47503).
4051685b 34* lib/excelllib.class.php has been updated. The class MoodleExcelWorkbook will now only produce excel 2007 files.
ebdcb292
SH
35* renderers: We now remove the suffix _renderable when looking for a render method for a renderable.
36 If you have a renderable class named like "blah_renderable" and have a method on a renderer named "render_blah_renderable"
37 you will need to change the name of your render method to "render_blah" instead, as renderable at the end is no longer accepted.
d25c41fb 38* New functions get_course_and_cm_from_cmid($cmorid, $modulename) and
39 get_course_and_cm_from_instance($instanceorid, $modulename) can be used to
40 more efficiently load these basic data objects at the start of a script.
41* New function cm_info::create($cm) can be used when you need a cm_info
42 object, but have a $cm which might only be a standard database record.
061e6b28 43* $CFG->enablegroupmembersonly no longer exists.
16078807
DP
44* Scheduled tasks have gained support for syntax to introduce variability when a
45 task will run across installs. When a when hour or minute are defined as 'R'
46 they will be installed with a random hour/minute value.
b79bf7a2
MG
47* Several classes grade_edit_tree_column_xxx were removed since grades setup page
48 has been significantly changed. These classes should not be used outside of
49 gradebook or developers can copy them into their plugins from 2.7 branch.
885b889d
MG
50* Google APIs Client Library (lib/google/) has been upgraded to 1.0.5-beta and
51 API has changed dramatically without backward compatibility. Any code accessing
52 it must be amended. It does not apply to lib/googleapi.php. See MDL-47297
27b6839f
MN
53* Added an extra parameter to the function get_formatted_help_string() (default null) which is used to specify
54 additional string parameters.
b9ba26b2 55* User settings node and course node in navigation now support callbacks from admin tools.
a7888487 56* grade_get_grades() optional parameteres $itemtype, $itemmodule, $iteminstance are now required.
4051685b 57
83988eb1
EL
58DEPRECATIONS:
59* completion_info->get_incomplete_criteria() is deprecated and will be removed in Moodle 3.0.
d6caf637 60* grade_category::aggregate_values() is deprecated and will be removed in Moodle 3.0.
061e6b28 61* groups_filter_users_by_course_module_visible() is deprecated; replace with
62 core_availability\info::filter_user_list. Will be removed in Moodle 3.0.
63* groups_course_module_visible() is deprecated; replace with $cm->uservisible.
64* cm_info property $cm->groupmembersonly is deprecated and always returns 0.
65 Use core_availability\info::filter_user_list if trying to determine which
66 other users can see an activity.
67* cm_info method $cm->is_user_access_restricted_by_group() is deprecated and
68 always returns false. Use $cm->uservisible to determine whether the user can
69 access the activity.
70* Constant FEATURE_GROUPMEMBERSONLY (used in module _supports functions) is
71 deprecated.
80f98467
MG
72* cohort_get_visible_list() is deprecated. There is a better function cohort_get_available_cohorts()
73 that respects user capabilities to view cohorts.
58b5b04d
MG
74* enrol_cohort_get_cohorts() and enrol_cohort_search_cohorts() are deprecated since
75 functionality is removed. Please use cohort_get_available_cohorts()
76* enrol_cohort_enrol_all_users() is deprecated; enrol_manual is now responsible for this action
80f98467 77* enrol_cohort_can_view_cohort() is deprecated; replace with cohort_can_view_cohort()
83988eb1 78
2b55cb1b 79=== 2.6.4 / 2.7.1 ===
83988eb1 80
2b55cb1b
RT
81* setnew_password_and_mail() and update_internal_user_password() will trigger
82 \core\event\user_password_updated. Previously they used to generate
83 \core\event\user_updated event.
84* update_internal_user_password() accepts optional boolean $fasthash for fast
85 hashing.
86* user_update_user() and user_create_user() api's accept optional param
87 $triggerevent to avoid respective events to be triggred from the api's.
88
c4b0d6dc
AA
89=== 2.7 ===
90
9e00d46b 91* PHPUnit cannot be installed via PEAR any more, please use composer package manager instead.
686e3b3a
FM
92* $core_renderer->block_move_target() changed to support more verbose move-block-here descriptions.
93
1480f6ea
MG
94Events and Logging:
95* Significant changes in Logging API. For upgrading existing events_trigger() and
96 add_to_log() see http://docs.moodle.org/dev/Migrating_logging_calls_in_plugins
e2cb3ffa 97 For accessing logs from plugins see http://docs.moodle.org/dev/Migrating_log_access_in_reports
c446f41a
MN
98* The validation of the following events is now stricter (see MDL-45445):
99 - \core\event\blog_entry_created
100 - \core\event\blog_entry_deleted
101 - \core\event\blog_entry_updated
102 - \core\event\cohort_member_added
103 - \core\event\cohort_member_removed
104 - \core\event\course_category_deleted
105 - \core\event\course_completed
106 - \core\event\course_content_deleted
107 - \core\event\course_created
108 - \core\event\course_deleted
109 - \core\event\course_restored
110 - \core\event\course_section_updated (see MDL-45229)
111 - \core\event\email_failed
112 - \core\event\group_member_added
113 - \core\event\group_member_removed
114 - \core\event\note_created
115 - \core\event\note_deleted
116 - \core\event\note_updated
117 - \core\event\role_assigned
118 - \core\event\role_deleted
119 - \core\event\role_unassigned
120 - \core\event\user_graded
121 - \core\event\user_loggedinas
122 - \core\event\user_profile_viewed
123 - \core\event\webservice_token_created
1480f6ea 124
a4582a51 125DEPRECATIONS:
994e5662 126* $module uses in mod/xxx/version.php files is now deprecated. Please use $plugin instead. It will be removed in Moodle 2.10.
3345e24f 127* Update init methods in all event classes - "level" property was renamed to "edulevel", the level property is now deprecated.
c4b0d6dc 128* Abstract class \core\event\course_module_instances_list_viewed is deprecated now, use \core\event\instances_list_viewed instead.
e1b16f97 129* Abstract class core\event\content_viewed has been deprecated. Please extend base event or other relevant abstract class.
45faf15d
AA
130* mod_book\event\instances_list_viewed has been deprecated. Please use mod_book\event\course_module_instance_list_viewed instead.
131* mod_chat\event\instances_list_viewed has been deprecated. Please use mod_chat\event\course_module_instance_list_viewed instead.
132* mod_choice\event\instances_list_viewed has been deprecated. Please use mod_choice\event\course_module_instance_list_viewed instead.
133* mod_feedback\event\instances_list_viewed has been deprecated. Please use mod_feedback\event\course_module_instance_list_viewed instead.
134* mod_page\event\instances_list_viewed has been deprecated. Please use mod_page\event\course_module_instance_list_viewed instead.
1f1a8f03 135* The constants FRONTPAGECOURSELIST, FRONTPAGETOPICONLY & FRONTPAGECOURSELIMIT have been removed.
8d1f33e1 136* Conditional availability API has moved and changed. The condition_info class is
137 replaced by \core_availability\info_module, and condition_info_section by
138 \core_availability\info_section. (Code that uses the old classes will generally
139 still work.)
140* coursemodule_visible_for_user() has been deprecated but still works - replaced
141 by a new static function \core_availability\info_module::is_user_visible()
142* cm_info::is_user_access_restricted_by_conditional_access has been deprecated
143 but still works (it has never done what its name suggests, and is
144 unnecessary).
145* cm_info and section_info property showavailability has been deprecated, but
146 still works (with the caveat that this information is now per-user).
147* cm_info and section_info properties availablefrom and availableuntil have been
148 deprecated and always return zero (underlying data doesn't have these values).
149* section_info property groupingid has been deprecated and always returns zero,
150 same deal.
07e78d93
DP
151* Various cm_info methods have been deprecated in favour of their read-only properties (get_url(), get_content(), get_extra_classes(),
152 get_on_click(), get_custom_data(), get_after_link, get_after_edit_icons)
af64bc61 153* The ajaxenabled function has been deprecated and always returns true. All code should be fully functional in Javascript.
52dc1de7 154* count_login_failures() has been deprecated, use user_count_login_failures() instead. Refer MDL-42891 for details.
c4b0d6dc 155
8d1f33e1 156Conditional availability (activities and sections):
157* New conditional availability API in /availability, including new availability
158 condition plugins in /availability/condition. The new API is very similar with
159 regard to checking availability, but any code that modifies availability settings
160 for an activity or section is likely to need substantial changes.
161
5947ab33
AN
162YUI:
163 * The lightbox attribute for moodle-core-notification-dialogue has been
164 deprecated and replaced by the modal attribute. This was actually
165 changed in Moodle 2.2, but has only been marked as deprecated now. It
166 will be removed in Moodle 2.9.
0860dd78
AN
167 * When destroying any type of dialogue based on moodle-core-notification, the relevant content is also removed from
168 the DOM. Previously it was left orphaned.
5947ab33 169
a4582a51
AN
170JavaSript:
171 * The findChildNodes global function has been deprecated. Y.all should
172 be used instead.
1d98ca14
AN
173 * The callback argument to confirm_action and M.util.show_confirm_dialog has been deprecated. If you need to write a
174 confirmation which includes a callback, please use moodle-core-notification-confirmation and attach callbacks to the
175 events provided.
a4582a51 176
9843e5ec 177* New locking api and admin settings to configure the system locking type.
3b635513
DM
178* New "Time spent waiting for the database" performance metric displayed along with the
179 other MDL_PERF vars; the change affects both the error logs and the vars displayed in
180 the page footer.
cc033d48
MN
181* Changes in the tag API. The component and contextid are now saved when assigning tags to an item. Please see
182 tag/upgrade.txt for more information.
9843e5ec 183
9e19a0f0 184=== 2.6 ===
8e8891b7 185
cc8fecb5 186* Use new methods from core_component class instead of get_core_subsystems(), get_plugin_types(),
d0cac8b5
FM
187 get_plugin_list(), get_plugin_list_with_class(), get_plugin_directory(), normalize_component(),
188 get_component_directory() and get_plugin_list_with_file(). The names of the new methods are
189 exactly the same, the only differences are that core_component::get_plugin_types() now always returns
190 full paths and core_component::get_plugin_list() does not accept empty parameter any more.
d534708f 191* Use core_text::* instead of textlib:: and also core_collator::* instead of collatorlib::*.
af578aec 192* Use new function moodleform::mock_submit() to simulate form submission in unit tests (backported).
85b38061 193* New $CFG->localcachedir setting useful for cluster nodes. Admins have to update X-Sendfile aliases if used.
656250de
PS
194* MS SQL Server drivers are now using NVARCHAR(MAX) instead of NTEXT and VARBINARY(MAX) instead of IMAGE,
195 this change should be fully transparent and it should help significantly with add-on compatibility.
598a82c9
PS
196* The string manager classes were renamed. Note that they should not be modified or used directly,
197 always use get_string_manager() to get instance of the string manager.
aae18d2a 198* The ability to use an 'insecure' rc4encrypt/rc4decrypt key has been removed.
96f81ea3
PS
199* Use $CFG->debugdeveloper instead of debugging('', DEBUG_DEVELOPER).
200* Use set_debugging(DEBUG_xxx) when changing debugging level for current request.
d55f05ef 201* Function moveto_module() does not modify $mod argument and instead now returns the new module visibility value.
db5f2d33
DM
202* Use behat_selectors::get_allowed_text_selectors() and behat_selectors::get_allowed_selectors() instead of
203 behat_command::$allowedtextselectors and behat_command::$allowedselectors
ac2b2713 204* Subplugins are supported in admin tools and local plugins.
71ab7e51 205* file_packer/zip_packer API has been modified so that key functions support a new file_progress interface
206 to report progress during long operations. Related to this, zip_archive now supports an estimated_count()
207 function that returns an approximate number of entries in the zip faster than the count() function.
d872881f 208* Class cm_info no longer extends stdClass. All properties are read-only and calculated on first request only.
44ddd2a1 209* Class course_modinfo no longer extends stdClass. All properties are read-only.
64501eee
MG
210* Database fields modinfo and sectioncache in table course are removed. Application cache core/coursemodinfo
211 is used instead. Course cache is still reset, rebuilt and retrieved using function rebuild_course_cache() and
212 get_fast_modinfo(). Purging all caches and every core upgrade purges course modinfo cache as well.
213 If function get_fast_modinfo() is called for multiple courses make sure to include field cacherev in course
214 object.
3bcf6b3c
RT
215* Internal (noreply and support) user support has been added for sending/receiving message.
216 Use core_user::get_noreply_user() and core_user::get_support_user() to get noreply and support user's respectively.
217 Real users can be used as noreply/support users by setting $CFG->noreplyuserid and $CFG->supportuserid
137885b7 218* New function readfile_allow_large() in filelib.php for use when very large files may need sending to user.
e87214bd 219* Use core_plugin_manager::reset_caches() when changing visibility of plugins.
bde002b8
PS
220* Implement new method get_enabled_plugins() method in subplugin info classes.
221* Each plugin should include version information in version.php.
723a6e56 222* Module and block tables do not contain version column any more, use get_config('xx_yy', 'version') instead.
5fed8433 223* $USER->password field is intentionally unset so that session data does not contain password hashes.
38fc0130 224* Use core_shutdown_manager::register_function() instead of register_shutdown_function().
c858655d 225* New file packer for .tar.gz files; obtain by calling get_file_packer('application/x-gzip'). Intended initially
226 for use in backup/restore only, as there are limitations on supported filenames. Also new packer for
227 backups which supports both compression formats; get_file_packer('application/vnd.moodle.backup').
228* New optional parameter to stored_file::get_content_file_handle to open file handle with 'gzopen' instead
229 of 'fopen' to read gzip-compressed files if required.
6c679d15 230* update_internal_user_password() and setnew_password_and_mail() now trigger user_updated event.
b2858b91 231* Add thirdpartylibs.xml file to plugins that bundle any 3rd party libraries.
2dd8e935
DP
232* New class introduced to help auto generate zIndex values for modal dialogues. Class "moodle-has-zindex"
233 should set on any element which uses a non-default zindex and needs to ensure it doesn't show above a
234 dialogue.
0c431257
PS
235* $CFG->filelifetime is now used consistently for most file serving operations, the default was lowered
236 to 6 hours from 24 hours because etags and x-sendfile support should make file serving less expensive.
d61d3e82
RT
237* Date format locale charset for windows server will come from calendar type and for gregorian it will use
238 lang file.
2d5c7d50
FM
239* The library to interact with Box.net (class boxclient) is only compatible with their APIv1 which
240 reaches its end of life on the 14th of Dec. You should migrate your scripts to make usage of the
241 new class boxnet_client(). Note that the method names and return values have changed.
b404b1f4
AG
242* Settings pages are now possible for Calendar type plugins. Calendar type plugins that require a settings page to
243 work properly will need to set their requires version to a number that is equal to or grater than the 2.6.1 release version.
fb16acf2
DP
244* The admin/tool/generator tool was overhauled to use testing data generators and the previous interface to create
245 test data was removed (it was not working correctly anyway). If you were using this tool you will probably need to
246 update your code.
05226d76
DP
247
248DEPRECATIONS:
249Various previously deprecated functions have now been altered to throw DEBUG_DEVELOPER debugging notices
250and will be removed in a future release (target: 2.8), a summary follows:
251
252Accesslib:
c3d2fbf9
SH
253 * get_context_instance() -> context_xxxx::instance()
254 * get_context_instance_by_id() -> context::instance_by_id($id)
255 * get_system_context() -> context_system::instance()
256 * context_moved() -> context::update_moved()
257 * preload_course_contexts() -> context_helper::preload_course()
258 * context_instance_preload() -> context_helper::preload_from_record()
259 * context_instance_preload_sql() -> context_helper::get_preload_record_columns_sql()
260 * get_contextlevel_name() -> context_helper::get_level_name()
261 * create_contexts() -> context_helper::create_instances()
262 * cleanup_contexts() -> context_helper::cleanup_instances()
263 * build_context_path() -> context_helper::build_all_paths()
264 * print_context_name() -> $context->get_context_name()
265 * mark_context_dirty() -> $context->mark_dirty()
266 * delete_context() -> $context->delete_content() or context_helper::delete_instance()
267 * get_context_url() -> $context->get_url()
268 * get_course_context() -> $context->get_course_context()
269 * get_parent_contexts() -> $context->get_parent_context_ids()
270 * get_parent_contextid() -> $context->get_parent_context()
271 * get_child_contexts() -> $context->get_child_contexts()
272 * rebuild_contexts() -> $context->reset_paths()
273 * get_user_courses_bycap() -> enrol_get_users_courses()
274 * get_courseid_from_context() -> $context->get_course_context(false)
275 * get_role_context_caps() -> (no replacement)
276 * load_temp_role() -> (no replacement)
277 * remove_temp_roles() -> (no replacement)
278 * get_related_contexts_string() -> $context->get_parent_context_ids(true)
279 * get_recent_enrolments() -> (no replacement)
05226d76
DP
280
281Enrollment:
c3d2fbf9
SH
282 * get_course_participants() -> get_enrolled_users()
283 * is_course_participant() -> is_enrolled()
05226d76
DP
284
285Output:
c3d2fbf9
SH
286 * current_theme() -> $PAGE->theme->name
287 * skip_main_destination() -> $OUTPUT->skip_link_target()
288 * print_container() -> $OUTPUT->container()
289 * print_container_start() -> $OUTPUT->container_start()
290 * print_container_end() -> $OUTPUT->container_end()
291 * print_continue() -> $OUTPUT->continue_button()
292 * print_header() -> $PAGE methods
293 * print_header_simple() -> $PAGE methods
294 * print_side_block() -> $OUTPUT->block()
295 * print_arrow() -> $OUTPUT->arrow()
296 * print_scale_menu_helpbutton() -> $OUTPUT->help_icon_scale($courseid, $scale)
297 * print_checkbox() -> html_writer::checkbox()
05226d76
DP
298
299Navigation:
c3d2fbf9
SH
300 * print_navigation() -> $OUTPUT->navbar()
301 * build_navigation() -> $PAGE->navbar methods
302 * navmenu() -> (no replacement)
50ae8814
MN
303 * settings_navigation::
304 get_course_modules() -> (no replacement)
05226d76 305
2a68ee0e
MG
306Files and repositories:
307 * stored_file::replace_content_with() -> stored_file::replace_file_with()
308 * stored_file::set_filesize() -> stored_file::replace_file_with()
87355560
MG
309 * stored_file::get_referencelifetime() -> (no replacement)
310 * repository::sync_external_file() -> see repository::sync_reference()
311 * repository::get_file_by_reference() -> repository::sync_reference()
312 * repository::
313 get_reference_file_lifetime() -> (no replacement)
314 * repository::sync_individual_file() -> (no replacement)
315 * repository::reset_caches() -> (no replacement)
2a68ee0e 316
05226d76 317Calendar:
c3d2fbf9
SH
318 * add_event() -> calendar_event::create()
319 * update_event() -> calendar_event->update()
320 * delete_event() -> calendar_event->delete()
321 * hide_event() -> calendar_event->toggle_visibility(false)
322 * show_event() -> calendar_event->toggle_visibility(true)
05226d76
DP
323
324Misc:
c3d2fbf9
SH
325 * filter_text() -> format_text(), format_string()...
326 * httpsrequired() -> $PAGE->https_required()
327 * detect_munged_arguments() -> clean_param([...], PARAM_FILE)
328 * mygroupid() -> groups_get_all_groups()
329 * js_minify() -> core_minify::js_files()
330 * css_minify_css() -> core_minify::css_files()
64501eee 331 * course_modinfo::build_section_cache() -> (no replacement)
3bcf6b3c 332 * generate_email_supportuser() -> core_user::get_support_user()
c3d2fbf9 333
d79d5ac2
PS
334Sessions:
335 * session_get_instance()->xxx() -> \core\session\manager::xxx()
336 * session_kill_all() -> \core\session\manager::kill_all_sessions()
337 * session_touch() -> \core\session\manager::touch_session()
338 * session_kill() -> \core\session\manager::kill_session()
339 * session_kill_user() -> \core\session\manager::kill_user_sessions()
340 * session_gc() -> \core\session\manager::gc()
341 * session_set_user() -> \core\session\manager::set_user()
342 * session_is_loggedinas() -> \core\session\manager::is_loggedinas()
343 * session_get_realuser() -> \core\session\manager::get_realuser()
344 * session_loginas() -> \core\session\manager::loginas()
345
c3d2fbf9
SH
346User-agent related functions:
347 * check_browser_operating_system() -> core_useragent::check_browser_operating_system()
348 * check_browser_version() -> core_useragent::check_browser_version()
349 * get_device_type() -> core_useragent::get_device_type()
350 * get_device_type_list() -> core_useragent::get_device_type_list()
351 * get_selected_theme_for_device_type() -> core_useragent::get_device_type_theme()
352 * get_device_cfg_var_name() -> core_useragent::get_device_type_cfg_var_name()
353 * set_user_device_type() -> core_useragent::set_user_device_type()
354 * get_user_device_type() -> core_useragent::get_user_device_type()
355 * get_browser_version_classes() -> core_useragent::get_browser_version_classes()
9e19a0f0 356
78686995
AN
357YUI:
358 * moodle-core-notification has been deprecated with a recommendation of
73b4c1da 359 using its subclasses instead. This is to allow for reduced page
78686995
AN
360 transport costs. Current subclasses include:
361 * dialogue
362 * alert
363 * confirm
364 * exception
365 * ajaxexception
366
f0f0e1fe
PS
367Event triggering and event handlers:
368 * All existing events and event handlers should be replaced by new
369 event classes and matching new event observers.
370 * See http://docs.moodle.org/dev/Event_2 for more information.
861b0510
FM
371 * The following events will be entirely removed, though they can still
372 be captured using handlers, but they should not be used any more.
373 * groups_members_removed -> \core\event\group_member_removed
374 * groups_groupings_groups_removed -> (no replacement)
375 * groups_groups_deleted -> \core\event\group_deleted
376 * groups_groupings_deleted -> \core\event\grouping_deleted
63deb5c3 377 * edit_module_post_actions() does not trigger events any more.
f0f0e1fe 378
a2602457 379=== 2.5.1 ===
380
381* New get_course() function for use when obtaining the course record from database. Will
382 reuse existing $COURSE or $SITE globals if possible to improve performance.
383
9a36be73
MG
384=== 2.5 ===
385
bae2846c
EL
386* The database drivers (moodle_database and subclasses) aren't using anymore the ::columns property
387 for caching database metadata. MUC (databasemeta) is used instead. Any custom DB driver should
388 apply for that change.
cedc656b
EL
389* The cron output has been changed to include time and memory usage (see cron_trace_time_and_memory()),
390 so any custom utility relying on the old output may require modification.
6b219310
DW
391* Function get_max_file_sizes now returns an option for (for example) "Course limit (500MB)" or
392 "Site limit (200MB)" when appropriate with the option set to 0. This function no longer returns
393 an option for 0 bytes. Existing code that was replacing the 0 option in the return
394 from this function with a more sensible message, can now use the return from this function directly.
9a36be73 395* Functions responsible for output in course/lib.php are deprecated, the code is moved to
b1c2fc65
MG
396 appropriate renderers: print_section(), print_section_add_menus(), get_print_section_cm_text(),
397 make_editing_buttons()
9a36be73
MG
398 See functions' phpdocs in lib/deprecatedlib.php
399* Function get_print_section_cm_text() is deprecated, replaced with methods in cm_info
3cb856c7
PS
400* zip_packer may create empty zip archives, there is a new option to ignore
401 problematic files when creating archive
93cc145f
MN
402* The function delete_course_module was deprecated and has been replaced with
403 course_delete_module. The reason for this was because the function delete_course_module
404 only partially deletes data, so wherever it was called extra code was needed to
405 perform the whole deletion process. The function course_delete_module now takes care
406 of the whole process.
91c8cf99
F
407* curl::setopt() does not accept constant values any more. As it never worked properly,
408 we decided to make the type check stricter. Now, the keys of the array pass must be a string
409 corresponding to the curl constant name.
043f1005
RT
410* Function get_users_listing now return list of users except guest and deleted users. Previously
411 deleted users were excluded by get_users_listing. As guest user is not expected while browsing users,
412 and not included in get_user function, it will not be returned by get_users_listing.
1c14b1c1
DW
413* The add_* functions in course/dnduploadlib.php have been deprecated. Plugins should be using the
414 MODNAME_dndupload_register callback instead.
690a55f6
DM
415* The signature of the add() method of classes implementing the parentable_part_of_admin_tree
416 interface (such as admin_category) has been extended. The new parameter allows the caller
417 to prepend the new node before an existing sibling in the admin tree.
87b6981e
EL
418* condition_info:get_condition_user_fields($formatoptions) now accepts the optional
419 param $formatoptions, that will determine if the field names are processed by
420 format_string() with the passed options.
689096bc 421* remove all references to $CFG->gdversion, GD PHP extension is now required
b45ba7f6
DP
422* Formslib will now throw a developer warning if a PARAM_ type hasn't been set for elements which
423 need it. Please set PARAM_RAW explicitly if you do not want any cleaning.
4e0b6025 424* Functions responsible for managing and accessing course categories are moved to class coursecat
09ae7ee0
MG
425 in lib/coursecatlib.php, functions responsible for rendering courses and categories lists are
426 moved to course/renderer.php. The following global functions are deprecated: make_categories_list(),
6e1d1ee0 427 category_delete_move(), category_delete_full(), move_category(), course_category_hide(),
8db5dcb7 428 course_category_show(), get_course_category(), create_course_category(), get_all_subcategories(),
09ae7ee0
MG
429 get_child_categories(), get_categories(), print_my_moodle(), print_remote_course(),
430 print_remote_host(), print_whole_category_list(), print_category_info(), get_course_category_tree(),
431 print_courses(), print_course(), get_category_courses_array(), get_category_courses_array_recursively(),
432 get_courses_wmanagers()
433 See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
0e2ca62e 434* $core_renderer->block_move_target() changed to support more verbose move-block-here descriptions.
38c1dd19
RT
435* Additional (optional) param $onlyactive has been added to get_enrolled_users, count_enrolled_users
436 functions to get information for only active (excluding suspended enrolments) users. Included two
437 helper functions extract_suspended_users, get_suspended_userids to extract suspended user information.
e87214bd 438* The core_plugin_manager class now provides two new helper methods for getting information
d7d48b40 439 about known plugins: get_plugins_of_type() and get_subplugins_of_plugin().
e87214bd 440* The get_uninstall_url() method of all subclasses of \core\plugininfo\base class is now expected
73658371
DM
441 to always return moodle_url. Subclasses can use the new method is_uninstall_allowed()
442 to control the availability of the 'Uninstall' link at the Plugins overview page (previously
443 they would do it by get_uninstall_url() returning null). By default, URL to a new general plugin
444 uninstall tool is returned. Unless the plugin type needs extra steps that can't be handled by
445 plugininfo_xxx::uninstall() method or xmldb_xxx_uninstall() function, this default URL should
446 satisfy all plugin types.
9a36be73 447
4efcfaa3 448Database (DML) layer:
77a5c093
PS
449* $DB->sql_empty() is deprecated, you have to use sql parameters with empty values instead,
450 please note hardcoding of empty strings in SQL queries breaks execution in Oracle database.
2d97513d
PS
451* Indexes must not be defined on the same columns as keys, this is now reported as fatal problem.
452 Please note that internally we create indexes instead of foreign keys.
9a36be73 453
238b8bc9
ARN
454YUI changes:
455* M.util.help_icon has been deprecated. Code should be updated to use moodle-core-popuphelp
456 instead. To do so, remove any existing JS calls to M.util.help_icon from your PHP and ensure
457 that your help link is placed in a span which has the class 'helplink'.
458
6c2be903
DP
459=== 2.4 ===
460
461* Pagelib: Numerous deprecated functions were removed as classes page_base, page_course
462 and page_generic_activity.
704533fc 463* use $CFG->googlemapkey3 instead of removed $CFG->googlemapkey and migrate to Google Maps API V3
b874d5c6 464* Function settings_navigation::add_course_editing_links() is completely removed
ee7084e9
MG
465* function global_navigation::format_display_course_content() is removed completely (the
466 functionality is moved to course format class)
467* in the function global_navigation::load_generic_course_sections() the argument $courseformat is
468 removed
7881024e
PS
469* New component and itemid columns in groups_members table - this allows plugin to create protected
470 group memberships using 'xx_yy_allow_group_member_remove' callback and there is also a new restore
471 callback 'xx_yy_restore_group_member()'.
472* New general role assignment restore plugin callback 'xx_yy_restore_role_assignment()'.
97960146
MG
473* functions get_generic_section_name(), get_all_sections(), add_mod_to_section(), get_all_mods()
474 are deprecated. See their phpdocs in lib/deprecatedlib.php on how to replace them
ee362526 475
d2a27ab0
ARN
476YUI changes:
477* moodle-enrol-notification has been renamed to moodle-core-notification
3542e01a 478* YUI2 code must now use 2in3, see http://yuilibrary.com/yui/docs/yui/yui-yui2.html
7266bd3e
ARN
479* M.util.init_select_autosubmit() and M.util.init_url_select() have been deprecated. Code using this should be updated
480 to use moodle-core-formautosubmit
d2a27ab0 481
94c9db54
PS
482Unit testing changes:
483* output debugging() is not sent to standard output any more,
484 use $this->assertDebuggingCalled(), $this->assertDebuggingNotCalled(),
485 $this->getDebuggingMessages() or $this->assertResetDebugging() instead.
486
e618cdf3
PS
487=== 2.3 ===
488
489Database layer changes:
490* objects are not allowed in paramters of DML functions, use explicit casting to strings if necessary
491
19526d91
DP
492Note:
493* DDL and DML methods which were deprecated in 2.0 have now been removed, they will no longer produce
494debug messages and will produce fatal errors
e618cdf3 495
796495fe 496API changes:
daefd6eb 497
796495fe 498* send_stored_file() has changed its interface
daefd6eb 499* deleted several resourcelib_embed_* functions from resourcelib.php
796495fe 500
ee362526
PS
501=== 2.2 ===
502
503removed unused libraries:
504* odbc, base32, CodeSniffer, overlib, apd profiling, kses, Smarty, PEAR Console, swfobject, cssshover.htc, md5.js
505
506API changes:
507* new admin/tool plugin type
508* new context API - old API is still available
8e470797 509* deleted users do not have context any more
ee362526
PS
510* removed global search
511
512
513=== 2.1 ===
514
515API changes:
516* basic suport for restore from 1.9
517* new mobile devices API
518* new questions API
519
520
521=== 2.0 ===
522
523API changes:
524* new DML API - http://docs.moodle.org/dev/DML_functions
525* new DDL API - http://docs.moodle.org/dev/DDL_functions
526* new file API - http://docs.moodle.org/dev/File_API
527* new $PAGE and $OUTPUT API
528* new navigation API
529* new theme API - http://docs.moodle.org/dev/Theme_changes_in_2.0
530* new javascript API - http://docs.moodle.org/dev/JavaScript_usage_guide
531* new portfolio API
532* new local plugin type
533* new translation support - http://lang.moodle.org
534* new web service API
535* new cohorts API
536* new messaging API
537* new rating API
538* new comment API
539* new sessions API
540* new enrolment API
541* new backup/restore API
542* new blocks API
543* new filters API
544* improved plugin support (aka Frankenstyle)
545* new registration and hub API
546* new course completion API
547* new plagiarism API
548* changed blog API
549* new text editor API
19526d91 550* new my moodle and profiles API