c58a80139aef68b2bec68cc68729aac453866d71
[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.6 ===
6 * Use new core_component::* plugin listing and component normalisation methods.
7 * Use core_text::* instead of textlib:: and also core_collator::* instead of collatorlib::*.
8 * Use new function moodleform::mock_submit() to simulate form submission in unit tests (backported).
10 DEPRECATIONS:
11 Various previously deprecated functions have now been altered to throw DEBUG_DEVELOPER debugging notices
12 and will be removed in a future release (target: 2.8), a summary follows:
14 Accesslib:
15     * get_context_instance() is deprecated, please use use context_xxxx::instance().
16     * get_context_instance_by_id() is deprecated, please use context::instance_by_id($id).
17     * load_temp_role() and remove_temp_roles() can not be used any more.
18     * get_system_context() is deprecated, please use context_system::instance().
19     * get_parent_contexts() is deprecated, please use $context->get_parent_context_ids().
20     * get_parent_contextid() is deprecated, please use $context->get_parent_context().
21     * get_child_contexts() is deprecated, please use $context->get_child_contexts().
22     * create_contexts() is deprecated, please use context_helper::create_instances().
23     * cleanup_contexts() is deprecated, please use context_helper::cleanup_instances().
24     * build_context_path() is deprecated, please use context_helper::build_all_paths().
25     * rebuild_contexts() is deprecated, please use $context->reset_paths().
26     * preload_course_contexts() is deprecated, please use context_helper::preload_course().
27     * context_moved() is deprecated, please use context::update_moved().
28     * context_instance_preload() is deprecated, please use context_helper::preload_from_record().
29     * get_contextlevel_name() is deprecated, please use context_helper::get_level_name().
30     * print_context_name() is deprecated, please use $context->get_context_name().
31     * mark_context_dirty($context->path) is deprecated, please use $context->mark_dirty().
32     * delete_context() is deprecated, please use $context->delete_content() or context_helper::delete_instance().
33     * get_context_url() is deprecated, please use $context->get_url().
34     * get_course_context() is deprecated, please use $context->get_course_context().
35     * get_user_courses_bycap() is deprecated, please use enrol_get_users_courses().
36     * get_role_context_caps() is deprecated, it is really slow. Don't use it.
37     * get_courseid_from_context() is deprecated, please use $context->get_course_context(false).
39 Enrollment:
40     * get_course_participants() is deprecated, use get_enrolled_users() instead.
41     * is_course_participant() is deprecated, use is_enrolled() instead.
43 Output:
44     * current_theme() is deprecated, please use $PAGE->theme->name instead
45     * skip_main_destination() is deprecated, please use $OUTPUT->skip_link_target() instead.
46     * print_container() is deprecated. Please use $OUTPUT->container() instead.
47     * print_container_start() is deprecated. Please use $OUTPUT->container_start() instead.
48     * print_container_end() is deprecated. Please use $OUTPUT->container_end() instead.
49     * print_continue() is deprecated. Please use $OUTPUT->continue_button() instead.
50     * print_header() is deprecated. Please use $PAGE methods instead.
51     * print_header_simple() is deprecated. Please use $PAGE methods instead.
52     * print_side_block() is deprecated, please use $OUTPUT->block() instead.
53     * print_arrow() is deprecated. Please use $OUTPUT->arrow() instead.
54     * print_scale_menu_helpbutton() is deprecated. Please use $OUTPUT->help_icon_scale($courseid, $scale) instead.
55     * print_checkbox() is deprecated. Please use html_writer::checkbox() instead.
57 Navigation:
58     * print_navigation() is deprecated, please update use $OUTPUT->navbar() instead.
59     * build_navigation() is deprecated, please use $PAGE->navbar methods instead.
60     * navmenu() is deprecated, it is no longer relevant with global navigation.
62 Calendar:
63     * add_event() is deprecated, please use calendar_event::create() instead.
64     * update_event() is deprecated, please use calendar_event->update() instead.
65     * delete_event() is deprecated, please use calendar_event->delete() instead.
66     * hide_event() is deprecated, please use calendar_event->toggle_visibility(false) instead.
67     * show_event() is deprecated, please use calendar_event->toggle_visibility(true) instead.
69 Misc:
70     * filter_text() is deprecated, use format_text(), format_string() etc instead.
71     * httpsrequired() is deprecated use $PAGE->https_required() instead.
72     * detect_munged_arguments() is deprecated, please use clean_param(,PARAM_FILE) instead.
73     * mygroupid() is deprecated, please use groups_get_all_groups() instead.
75 === 2.5.1 ===
77 * New get_course() function for use when obtaining the course record from database. Will
78   reuse existing $COURSE or $SITE globals if possible to improve performance.
80 === 2.5 ===
82 * The database drivers (moodle_database and subclasses) aren't using anymore the ::columns property
83   for caching database metadata. MUC (databasemeta) is used instead. Any custom DB driver should
84   apply for that change.
85 * The cron output has been changed to include time and memory usage (see cron_trace_time_and_memory()),
86   so any custom utility relying on the old output may require modification.
87 * Function get_max_file_sizes now returns an option for (for example) "Course limit (500MB)" or
88   "Site limit (200MB)" when appropriate with the option set to 0. This function no longer returns
89   an option for 0 bytes. Existing code that was replacing the 0 option in the return
90   from this function with a more sensible message, can now use the return from this function directly.
91 * Functions responsible for output in course/lib.php are deprecated, the code is moved to
92   appropriate renderers: print_section(), print_section_add_menus(), get_print_section_cm_text(),
93   make_editing_buttons()
94   See functions' phpdocs in lib/deprecatedlib.php
95 * Function get_print_section_cm_text() is deprecated, replaced with methods in cm_info
96 * zip_packer may create empty zip archives, there is a new option to ignore
97   problematic files when creating archive
98 * The function delete_course_module was deprecated and has been replaced with
99   course_delete_module. The reason for this was because the function delete_course_module
100   only partially deletes data, so wherever it was called extra code was needed to
101   perform the whole deletion process. The function course_delete_module now takes care
102   of the whole process.
103 * curl::setopt() does not accept constant values any more. As it never worked properly,
104   we decided to make the type check stricter. Now, the keys of the array pass must be a string
105   corresponding to the curl constant name.
106 * Function get_users_listing now return list of users except guest and deleted users. Previously
107   deleted users were excluded by get_users_listing. As guest user is not expected while browsing users,
108   and not included in get_user function, it will not be returned by get_users_listing.
109 * The add_* functions in course/dnduploadlib.php have been deprecated. Plugins should be using the
110   MODNAME_dndupload_register callback instead.
111 * The signature of the add() method of classes implementing the parentable_part_of_admin_tree
112   interface (such as admin_category) has been extended. The new parameter allows the caller
113   to prepend the new node before an existing sibling in the admin tree.
114 * condition_info:get_condition_user_fields($formatoptions) now accepts the optional
115   param $formatoptions, that will determine if the field names are processed by
116   format_string() with the passed options.
117 * remove all references to $CFG->gdversion, GD PHP extension is now required
118 * Formslib will now throw a developer warning if a PARAM_ type hasn't been set for elements which
119   need it. Please set PARAM_RAW explicitly if you do not want any cleaning.
120 * Functions responsible for managing and accessing course categories are moved to class coursecat
121   in lib/coursecatlib.php, functions responsible for rendering courses and categories lists are
122   moved to course/renderer.php. The following global functions are deprecated: make_categories_list(),
123   category_delete_move(), category_delete_full(), move_category(), course_category_hide(),
124   course_category_show(), get_course_category(), create_course_category(), get_all_subcategories(),
125   get_child_categories(), get_categories(), print_my_moodle(), print_remote_course(),
126   print_remote_host(), print_whole_category_list(), print_category_info(), get_course_category_tree(),
127   print_courses(), print_course(), get_category_courses_array(), get_category_courses_array_recursively(),
128   get_courses_wmanagers()
129   See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
130 * $core_renderer->block_move_target() changed to support more verbose move-block-here descriptions.
131 * Additional (optional) param $onlyactive has been added to get_enrolled_users, count_enrolled_users
132   functions to get information for only active (excluding suspended enrolments) users. Included two
133   helper functions extract_suspended_users, get_suspended_userids to extract suspended user information.
134 * The plugin_manager class now provides two new helper methods for getting information
135   about known plugins: get_plugins_of_type() and get_subplugins_of_plugin().
136 * The get_uninstall_url() method of all subclasses of plugininfo_base class is now expected
137   to always return moodle_url. Subclasses can use the new method is_uninstall_allowed()
138   to control the availability of the 'Uninstall' link at the Plugins overview page (previously
139   they would do it by get_uninstall_url() returning null). By default, URL to a new general plugin
140   uninstall tool is returned. Unless the plugin type needs extra steps that can't be handled by
141   plugininfo_xxx::uninstall() method or xmldb_xxx_uninstall() function, this default URL should
142   satisfy all plugin types.
144 Database (DML) layer:
145 * $DB->sql_empty() is deprecated, you have to use sql parameters with empty values instead,
146   please note hardcoding of empty strings in SQL queries breaks execution in Oracle database.
147 * Indexes must not be defined on the same columns as keys, this is now reported as fatal problem.
148   Please note that internally we create indexes instead of foreign keys.
150 YUI changes:
151 * M.util.help_icon has been deprecated. Code should be updated to use moodle-core-popuphelp
152   instead. To do so, remove any existing JS calls to M.util.help_icon from your PHP and ensure
153   that your help link is placed in a span which has the class 'helplink'.
155 === 2.4 ===
157 * Pagelib: Numerous deprecated functions were removed as classes page_base, page_course
158   and page_generic_activity.
159 * use $CFG->googlemapkey3 instead of removed $CFG->googlemapkey and migrate to Google Maps API V3
160 * Function settings_navigation::add_course_editing_links() is completely removed
161 * function global_navigation::format_display_course_content() is removed completely (the
162   functionality is moved to course format class)
163 * in the function global_navigation::load_generic_course_sections() the argument $courseformat is
164   removed
165 * New component and itemid columns in groups_members table - this allows plugin to create protected
166   group memberships using 'xx_yy_allow_group_member_remove' callback and there is also a new restore
167   callback 'xx_yy_restore_group_member()'.
168 * New general role assignment restore plugin callback 'xx_yy_restore_role_assignment()'.
169 * functions get_generic_section_name(), get_all_sections(), add_mod_to_section(), get_all_mods()
170   are deprecated. See their phpdocs in lib/deprecatedlib.php on how to replace them
172 YUI changes:
173 * moodle-enrol-notification has been renamed to moodle-core-notification
174 * YUI2 code must now use 2in3, see http://yuilibrary.com/yui/docs/yui/yui-yui2.html
175 * M.util.init_select_autosubmit() and M.util.init_url_select() have been deprecated. Code using this should be updated
176   to use moodle-core-formautosubmit
178 Unit testing changes:
179 * output debugging() is not sent to standard output any more,
180   use $this->assertDebuggingCalled(), $this->assertDebuggingNotCalled(),
181   $this->getDebuggingMessages() or $this->assertResetDebugging() instead.
183 === 2.3 ===
185 Database layer changes:
186 * objects are not allowed in paramters of DML functions, use explicit casting to strings if necessary
188 Note:
189 * DDL and DML methods which were deprecated in 2.0 have now been removed, they will no longer produce
190 debug messages and will produce fatal errors
192 API changes:
194 * send_stored_file() has changed its interface
195 * deleted several resourcelib_embed_* functions from resourcelib.php
197 === 2.2 ===
199 removed unused libraries:
200 * odbc, base32, CodeSniffer, overlib, apd profiling, kses, Smarty, PEAR Console, swfobject, cssshover.htc, md5.js
202 API changes:
203 * new admin/tool plugin type
204 * new context API - old API is still available
205 * deleted users do not have context any more
206 * removed global search
209 === 2.1 ===
211 API changes:
212 * basic suport for restore from 1.9
213 * new mobile devices API
214 * new questions API
217 === 2.0 ===
219 API changes:
220 * new DML API - http://docs.moodle.org/dev/DML_functions
221 * new DDL API - http://docs.moodle.org/dev/DDL_functions
222 * new file API - http://docs.moodle.org/dev/File_API
223 * new $PAGE and $OUTPUT API
224 * new navigation API
225 * new theme API - http://docs.moodle.org/dev/Theme_changes_in_2.0
226 * new javascript API - http://docs.moodle.org/dev/JavaScript_usage_guide
227 * new portfolio API
228 * new local plugin type
229 * new translation support - http://lang.moodle.org
230 * new web service API
231 * new cohorts API
232 * new messaging API
233 * new rating API
234 * new comment API
235 * new sessions API
236 * new enrolment API
237 * new backup/restore API
238 * new blocks API
239 * new filters API
240 * improved plugin support (aka Frankenstyle)
241 * new registration and hub API
242 * new course completion API
243 * new plagiarism API
244 * changed blog API
245 * new text editor API
246 * new my moodle and profiles API