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