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