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