MDL-40463 libraries: Deprecate get_courseid_from_context()
[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
9e19a0f0 6* Use new core_component::* plugin listing and component normalisation methods.
d534708f 7* Use core_text::* instead of textlib:: and also core_collator::* instead of collatorlib::*.
af578aec 8* Use new function moodleform::mock_submit() to simulate form submission in unit tests (backported).
1b80060f
EL
9* get_context_instance() is deprecated, please use use context_xxxx::instance().
10* get_context_instance_by_id() is deprecated, please use context::instance_by_id($id).
85b2e46f 11* load_temp_role() and remove_temp_roles() can not be used any more.
492ba9de 12* get_system_context() is deprecated, please use context_system::instance().
8e8891b7 13* get_parent_contexts() is deprecated, please use $context->get_parent_context_ids().
7f5b51c4 14* get_parent_contextid() is deprecated, please use $context->get_parent_context().
f9aa8016 15* get_child_contexts() is deprecated, please use $context->get_child_contexts().
9fdbf620 16* create_contexts() is deprecated, please use context_helper::create_instances().
84378a57 17* cleanup_contexts() is deprecated, please use context_helper::cleanup_instances().
79f6b384 18* build_context_path() is deprecated, please use context_helper::build_all_paths().
cc4de415 19* rebuild_contexts() is deprecated, please use $context->reset_paths().
8f7d3d12 20* preload_course_contexts() is deprecated, please use context_helper::preload_course().
2c5b0eb7 21* context_moved() is deprecated, please use context::update_moved().
a439b2f9 22* fetch_context_capabilities() is deprecated, please use $context->get_capabilities().
c5dcd25d 23* context_instance_preload() is deprecated, please use context_helper::preload_from_record().
b4482dfe 24* get_contextlevel_name() is deprecated, please use context_helper::get_level_name().
329846f1 25* print_context_name() is deprecated, please use $context->get_context_name().
c592eea2
RT
26* mark_context_dirty($context->path) is deprecated, please use $context->mark_dirty().
27* delete_context() is deprecated, please use $context->delete_content() or context_helper::delete_instance().
6c89d4e1 28* get_context_url() is deprecated, please use $context->get_url().
dd33f4af 29* get_course_context() is deprecated, please use $context->get_course_context().
6acc54b3 30* get_user_courses_bycap() is deprecated, please use enrol_get_users_courses().
ae38dcb1 31* get_role_context_caps() is deprecated, it is really slow. Don't use it.
b123a543 32* get_courseid_from_context() is deprecated, please use $context->get_course_context(false).
9e19a0f0 33
a2602457 34=== 2.5.1 ===
35
36* New get_course() function for use when obtaining the course record from database. Will
37 reuse existing $COURSE or $SITE globals if possible to improve performance.
38
9a36be73
MG
39=== 2.5 ===
40
bae2846c
EL
41* The database drivers (moodle_database and subclasses) aren't using anymore the ::columns property
42 for caching database metadata. MUC (databasemeta) is used instead. Any custom DB driver should
43 apply for that change.
cedc656b
EL
44* The cron output has been changed to include time and memory usage (see cron_trace_time_and_memory()),
45 so any custom utility relying on the old output may require modification.
6b219310
DW
46* Function get_max_file_sizes now returns an option for (for example) "Course limit (500MB)" or
47 "Site limit (200MB)" when appropriate with the option set to 0. This function no longer returns
48 an option for 0 bytes. Existing code that was replacing the 0 option in the return
49 from this function with a more sensible message, can now use the return from this function directly.
9a36be73 50* Functions responsible for output in course/lib.php are deprecated, the code is moved to
b1c2fc65
MG
51 appropriate renderers: print_section(), print_section_add_menus(), get_print_section_cm_text(),
52 make_editing_buttons()
9a36be73
MG
53 See functions' phpdocs in lib/deprecatedlib.php
54* Function get_print_section_cm_text() is deprecated, replaced with methods in cm_info
3cb856c7
PS
55* zip_packer may create empty zip archives, there is a new option to ignore
56 problematic files when creating archive
93cc145f
MN
57* The function delete_course_module was deprecated and has been replaced with
58 course_delete_module. The reason for this was because the function delete_course_module
59 only partially deletes data, so wherever it was called extra code was needed to
60 perform the whole deletion process. The function course_delete_module now takes care
61 of the whole process.
91c8cf99
F
62* curl::setopt() does not accept constant values any more. As it never worked properly,
63 we decided to make the type check stricter. Now, the keys of the array pass must be a string
64 corresponding to the curl constant name.
043f1005
RT
65* Function get_users_listing now return list of users except guest and deleted users. Previously
66 deleted users were excluded by get_users_listing. As guest user is not expected while browsing users,
67 and not included in get_user function, it will not be returned by get_users_listing.
1c14b1c1
DW
68* The add_* functions in course/dnduploadlib.php have been deprecated. Plugins should be using the
69 MODNAME_dndupload_register callback instead.
690a55f6
DM
70* The signature of the add() method of classes implementing the parentable_part_of_admin_tree
71 interface (such as admin_category) has been extended. The new parameter allows the caller
72 to prepend the new node before an existing sibling in the admin tree.
87b6981e
EL
73* condition_info:get_condition_user_fields($formatoptions) now accepts the optional
74 param $formatoptions, that will determine if the field names are processed by
75 format_string() with the passed options.
689096bc 76* remove all references to $CFG->gdversion, GD PHP extension is now required
b45ba7f6
DP
77* Formslib will now throw a developer warning if a PARAM_ type hasn't been set for elements which
78 need it. Please set PARAM_RAW explicitly if you do not want any cleaning.
4e0b6025 79* Functions responsible for managing and accessing course categories are moved to class coursecat
09ae7ee0
MG
80 in lib/coursecatlib.php, functions responsible for rendering courses and categories lists are
81 moved to course/renderer.php. The following global functions are deprecated: make_categories_list(),
6e1d1ee0 82 category_delete_move(), category_delete_full(), move_category(), course_category_hide(),
8db5dcb7 83 course_category_show(), get_course_category(), create_course_category(), get_all_subcategories(),
09ae7ee0
MG
84 get_child_categories(), get_categories(), print_my_moodle(), print_remote_course(),
85 print_remote_host(), print_whole_category_list(), print_category_info(), get_course_category_tree(),
86 print_courses(), print_course(), get_category_courses_array(), get_category_courses_array_recursively(),
87 get_courses_wmanagers()
88 See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
0e2ca62e 89* $core_renderer->block_move_target() changed to support more verbose move-block-here descriptions.
38c1dd19
RT
90* Additional (optional) param $onlyactive has been added to get_enrolled_users, count_enrolled_users
91 functions to get information for only active (excluding suspended enrolments) users. Included two
92 helper functions extract_suspended_users, get_suspended_userids to extract suspended user information.
d7d48b40
DM
93* The plugin_manager class now provides two new helper methods for getting information
94 about known plugins: get_plugins_of_type() and get_subplugins_of_plugin().
73658371
DM
95* The get_uninstall_url() method of all subclasses of plugininfo_base class is now expected
96 to always return moodle_url. Subclasses can use the new method is_uninstall_allowed()
97 to control the availability of the 'Uninstall' link at the Plugins overview page (previously
98 they would do it by get_uninstall_url() returning null). By default, URL to a new general plugin
99 uninstall tool is returned. Unless the plugin type needs extra steps that can't be handled by
100 plugininfo_xxx::uninstall() method or xmldb_xxx_uninstall() function, this default URL should
101 satisfy all plugin types.
9a36be73 102
4efcfaa3 103Database (DML) layer:
77a5c093
PS
104* $DB->sql_empty() is deprecated, you have to use sql parameters with empty values instead,
105 please note hardcoding of empty strings in SQL queries breaks execution in Oracle database.
2d97513d
PS
106* Indexes must not be defined on the same columns as keys, this is now reported as fatal problem.
107 Please note that internally we create indexes instead of foreign keys.
9a36be73 108
238b8bc9
ARN
109YUI changes:
110* M.util.help_icon has been deprecated. Code should be updated to use moodle-core-popuphelp
111 instead. To do so, remove any existing JS calls to M.util.help_icon from your PHP and ensure
112 that your help link is placed in a span which has the class 'helplink'.
113
6c2be903
DP
114=== 2.4 ===
115
116* Pagelib: Numerous deprecated functions were removed as classes page_base, page_course
117 and page_generic_activity.
704533fc 118* use $CFG->googlemapkey3 instead of removed $CFG->googlemapkey and migrate to Google Maps API V3
b874d5c6 119* Function settings_navigation::add_course_editing_links() is completely removed
ee7084e9
MG
120* function global_navigation::format_display_course_content() is removed completely (the
121 functionality is moved to course format class)
122* in the function global_navigation::load_generic_course_sections() the argument $courseformat is
123 removed
7881024e
PS
124* New component and itemid columns in groups_members table - this allows plugin to create protected
125 group memberships using 'xx_yy_allow_group_member_remove' callback and there is also a new restore
126 callback 'xx_yy_restore_group_member()'.
127* New general role assignment restore plugin callback 'xx_yy_restore_role_assignment()'.
97960146
MG
128* functions get_generic_section_name(), get_all_sections(), add_mod_to_section(), get_all_mods()
129 are deprecated. See their phpdocs in lib/deprecatedlib.php on how to replace them
ee362526 130
d2a27ab0
ARN
131YUI changes:
132* moodle-enrol-notification has been renamed to moodle-core-notification
3542e01a 133* YUI2 code must now use 2in3, see http://yuilibrary.com/yui/docs/yui/yui-yui2.html
7266bd3e
ARN
134* M.util.init_select_autosubmit() and M.util.init_url_select() have been deprecated. Code using this should be updated
135 to use moodle-core-formautosubmit
d2a27ab0 136
94c9db54
PS
137Unit testing changes:
138* output debugging() is not sent to standard output any more,
139 use $this->assertDebuggingCalled(), $this->assertDebuggingNotCalled(),
140 $this->getDebuggingMessages() or $this->assertResetDebugging() instead.
141
e618cdf3
PS
142=== 2.3 ===
143
144Database layer changes:
145* objects are not allowed in paramters of DML functions, use explicit casting to strings if necessary
146
19526d91
DP
147Note:
148* DDL and DML methods which were deprecated in 2.0 have now been removed, they will no longer produce
149debug messages and will produce fatal errors
e618cdf3 150
796495fe 151API changes:
daefd6eb 152
796495fe 153* send_stored_file() has changed its interface
daefd6eb 154* deleted several resourcelib_embed_* functions from resourcelib.php
796495fe 155
ee362526
PS
156=== 2.2 ===
157
158removed unused libraries:
159* odbc, base32, CodeSniffer, overlib, apd profiling, kses, Smarty, PEAR Console, swfobject, cssshover.htc, md5.js
160
161API changes:
162* new admin/tool plugin type
163* new context API - old API is still available
8e470797 164* deleted users do not have context any more
ee362526
PS
165* removed global search
166
167
168=== 2.1 ===
169
170API changes:
171* basic suport for restore from 1.9
172* new mobile devices API
173* new questions API
174
175
176=== 2.0 ===
177
178API changes:
179* new DML API - http://docs.moodle.org/dev/DML_functions
180* new DDL API - http://docs.moodle.org/dev/DDL_functions
181* new file API - http://docs.moodle.org/dev/File_API
182* new $PAGE and $OUTPUT API
183* new navigation API
184* new theme API - http://docs.moodle.org/dev/Theme_changes_in_2.0
185* new javascript API - http://docs.moodle.org/dev/JavaScript_usage_guide
186* new portfolio API
187* new local plugin type
188* new translation support - http://lang.moodle.org
189* new web service API
190* new cohorts API
191* new messaging API
192* new rating API
193* new comment API
194* new sessions API
195* new enrolment API
196* new backup/restore API
197* new blocks API
198* new filters API
199* improved plugin support (aka Frankenstyle)
200* new registration and hub API
201* new course completion API
202* new plagiarism API
203* changed blog API
204* new text editor API
19526d91 205* new my moodle and profiles API