MDL-38497 Add the info about the method signature change into upgrade.txt
[moodle.git] / lib / upgrade.txt
1 This files describes API changes in core libraries and APIs,
2 information provided here is intended especially for developers.
4 === 2.5 ===
6 * The cron output has been changed to include time and memory usage (see cron_trace_time_and_memory()),
7   so any custom utility relying on the old output may require modification.
8 * Function get_max_file_sizes now returns an option for (for example) "Course limit (500MB)" or
9   "Site limit (200MB)" when appropriate with the option set to 0. This function no longer returns
10   an option for 0 bytes. Existing code that was replacing the 0 option in the return
11   from this function with a more sensible message, can now use the return from this function directly.
12 * Functions responsible for output in course/lib.php are deprecated, the code is moved to
13   appropriate renderers: print_section_add_menus()
14   See functions' phpdocs in lib/deprecatedlib.php
15 * Function get_print_section_cm_text() is deprecated, replaced with methods in cm_info
16 * zip_packer may create empty zip archives, there is a new option to ignore
17   problematic files when creating archive
18 * The function delete_course_module was deprecated and has been replaced with
19   course_delete_module. The reason for this was because the function delete_course_module
20   only partially deletes data, so wherever it was called extra code was needed to
21   perform the whole deletion process. The function course_delete_module now takes care
22   of the whole process.
23 * curl::setopt() does not accept constant values any more. As it never worked properly,
24   we decided to make the type check stricter. Now, the keys of the array pass must be a string
25   corresponding to the curl constant name.
26 * Function get_users_listing now return list of users except guest and deleted users. Previously
27   deleted users were excluded by get_users_listing. As guest user is not expected while browsing users,
28   and not included in get_user function, it will not be returned by get_users_listing.
29 * The signature of the add() method of classes implementing the parentable_part_of_admin_tree
30   interface (such as admin_category) has been extended. The new parameter allows the caller
31   to prepend the new node before an existing sibling in the admin tree.
33 YUI changes:
34 * M.util.help_icon has been deprecated. Code should be updated to use moodle-core-popuphelp
35   instead. To do so, remove any existing JS calls to M.util.help_icon from your PHP and ensure
36   that your help link is placed in a span which has the class 'helplink'.
38 === 2.4 ===
40 * Pagelib: Numerous deprecated functions were removed as classes page_base, page_course
41   and page_generic_activity.
42 * use $CFG->googlemapkey3 instead of removed $CFG->googlemapkey and migrate to Google Maps API V3
43 * Function settings_navigation::add_course_editing_links() is completely removed
44 * function global_navigation::format_display_course_content() is removed completely (the
45   functionality is moved to course format class)
46 * in the function global_navigation::load_generic_course_sections() the argument $courseformat is
47   removed
48 * New component and itemid columns in groups_members table - this allows plugin to create protected
49   group memberships using 'xx_yy_allow_group_member_remove' callback and there is also a new restore
50   callback 'xx_yy_restore_group_member()'.
51 * New general role assignment restore plugin callback 'xx_yy_restore_role_assignment()'.
52 * functions get_generic_section_name(), get_all_sections(), add_mod_to_section(), get_all_mods()
53   are deprecated. See their phpdocs in lib/deprecatedlib.php on how to replace them
55 YUI changes:
56 * moodle-enrol-notification has been renamed to moodle-core-notification
57 * YUI2 code must now use 2in3, see http://yuilibrary.com/yui/docs/yui/yui-yui2.html
58 * M.util.init_select_autosubmit() and M.util.init_url_select() have been deprecated. Code using this should be updated
59   to use moodle-core-formautosubmit
61 Unit testing changes:
62 * output debugging() is not sent to standard output any more,
63   use $this->assertDebuggingCalled(), $this->assertDebuggingNotCalled(),
64   $this->getDebuggingMessages() or $this->assertResetDebugging() instead.
66 === 2.3 ===
68 Database layer changes:
69 * objects are not allowed in paramters of DML functions, use explicit casting to strings if necessary
71 Note:
72 * DDL and DML methods which were deprecated in 2.0 have now been removed, they will no longer produce
73 debug messages and will produce fatal errors
75 API changes:
77 * send_stored_file() has changed its interface
78 * deleted several resourcelib_embed_* functions from resourcelib.php
80 === 2.2 ===
82 removed unused libraries:
83 * odbc, base32, CodeSniffer, overlib, apd profiling, kses, Smarty, PEAR Console, swfobject, cssshover.htc, md5.js
85 API changes:
86 * new admin/tool plugin type
87 * new context API - old API is still available
88 * deleted users do not have context any more
89 * removed global search
92 === 2.1 ===
94 API changes:
95 * basic suport for restore from 1.9
96 * new mobile devices API
97 * new questions API
100 === 2.0 ===
102 API changes:
103 * new DML API - http://docs.moodle.org/dev/DML_functions
104 * new DDL API - http://docs.moodle.org/dev/DDL_functions
105 * new file API - http://docs.moodle.org/dev/File_API
106 * new $PAGE and $OUTPUT API
107 * new navigation API
108 * new theme API - http://docs.moodle.org/dev/Theme_changes_in_2.0
109 * new javascript API - http://docs.moodle.org/dev/JavaScript_usage_guide
110 * new portfolio API
111 * new local plugin type
112 * new translation support - http://lang.moodle.org
113 * new web service API
114 * new cohorts API
115 * new messaging API
116 * new rating API
117 * new comment API
118 * new sessions API
119 * new enrolment API
120 * new backup/restore API
121 * new blocks API
122 * new filters API
123 * improved plugin support (aka Frankenstyle)
124 * new registration and hub API
125 * new course completion API
126 * new plagiarism API
127 * changed blog API
128 * new text editor API
129 * new my moodle and profiles API