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