68e12387be9c533167a10df86dda446401ccd595
[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.
21 * Function moveto_module() does not modify $mod argument and instead now returns the new module visibility value.
22 * Use behat_selectors::get_allowed_text_selectors() and behat_selectors::get_allowed_selectors() instead of
23   behat_command::$allowedtextselectors and behat_command::$allowedselectors
24 * Subplugins are supported in admin tools and local plugins.
25 * file_packer/zip_packer API has been modified so that key functions support a new file_progress interface
26   to report progress during long operations. Related to this, zip_archive now supports an estimated_count()
27   function that returns an approximate number of entries in the zip faster than the count() function.
28 * Class cm_info no longer extends stdClass. All properties are read-only and calculated on first request only.
29 * Class course_modinfo no longer extends stdClass. All properties are read-only.
30 * Database fields modinfo and sectioncache in table course are removed. Application cache core/coursemodinfo
31   is used instead. Course cache is still reset, rebuilt and retrieved using function rebuild_course_cache() and
32   get_fast_modinfo(). Purging all caches and every core upgrade purges course modinfo cache as well.
33   If function get_fast_modinfo() is called for multiple courses make sure to include field cacherev in course
34   object.
35 * Internal (noreply and support) user support has been added for sending/receiving message.
36   Use core_user::get_noreply_user() and core_user::get_support_user() to get noreply and support user's respectively.
37   Real users can be used as noreply/support users by setting $CFG->noreplyuserid and $CFG->supportuserid
38 * New function readfile_allow_large() in filelib.php for use when very large files may need sending to user.
39 * Use plugin_manager::reset_caches() when changing visibility of plugins.
40 * Implement new method get_enabled_plugins() method in subplugin info classes.
41 * Each plugin should include version information in version.php.
42 * Module and block tables do not contain version column any more, use get_config('xx_yy', 'version') instead.
43 * $USER->password field is intentionally unset so that session data does not contain password hashes.
45 DEPRECATIONS:
46 Various previously deprecated functions have now been altered to throw DEBUG_DEVELOPER debugging notices
47 and will be removed in a future release (target: 2.8), a summary follows:
49 Accesslib:
50     * get_context_instance()                ->  context_xxxx::instance()
51     * get_context_instance_by_id()          ->  context::instance_by_id($id)
52     * get_system_context()                  ->  context_system::instance()
53     * context_moved()                       ->  context::update_moved()
54     * preload_course_contexts()             ->  context_helper::preload_course()
55     * context_instance_preload()            ->  context_helper::preload_from_record()
56     * context_instance_preload_sql()        ->  context_helper::get_preload_record_columns_sql()
57     * get_contextlevel_name()               ->  context_helper::get_level_name()
58     * create_contexts()                     ->  context_helper::create_instances()
59     * cleanup_contexts()                    ->  context_helper::cleanup_instances()
60     * build_context_path()                  ->  context_helper::build_all_paths()
61     * print_context_name()                  ->  $context->get_context_name()
62     * mark_context_dirty()                  ->  $context->mark_dirty()
63     * delete_context()                      ->  $context->delete_content() or context_helper::delete_instance()
64     * get_context_url()                     ->  $context->get_url()
65     * get_course_context()                  ->  $context->get_course_context()
66     * get_parent_contexts()                 ->  $context->get_parent_context_ids()
67     * get_parent_contextid()                ->  $context->get_parent_context()
68     * get_child_contexts()                  ->  $context->get_child_contexts()
69     * rebuild_contexts()                    ->  $context->reset_paths()
70     * get_user_courses_bycap()              ->  enrol_get_users_courses()
71     * get_courseid_from_context()           ->  $context->get_course_context(false)
72     * get_role_context_caps()               ->  (no replacement)
73     * load_temp_role()                      ->  (no replacement)
74     * remove_temp_roles()                   ->  (no replacement)
75     * get_related_contexts_string()         ->  $context->get_parent_context_ids(true)
76     * get_recent_enrolments()               ->  (no replacement)
78 Enrollment:
79     * get_course_participants()             -> get_enrolled_users()
80     * is_course_participant()               -> is_enrolled()
82 Output:
83     * current_theme()                       -> $PAGE->theme->name
84     * skip_main_destination()               -> $OUTPUT->skip_link_target()
85     * print_container()                     -> $OUTPUT->container()
86     * print_container_start()               -> $OUTPUT->container_start()
87     * print_container_end()                 -> $OUTPUT->container_end()
88     * print_continue()                      -> $OUTPUT->continue_button()
89     * print_header()                        -> $PAGE methods
90     * print_header_simple()                 -> $PAGE methods
91     * print_side_block()                    -> $OUTPUT->block()
92     * print_arrow()                         -> $OUTPUT->arrow()
93     * print_scale_menu_helpbutton()         -> $OUTPUT->help_icon_scale($courseid, $scale)
94     * print_checkbox()                      -> html_writer::checkbox()
96 Navigation:
97     * print_navigation()                    -> $OUTPUT->navbar()
98     * build_navigation()                    -> $PAGE->navbar methods
99     * navmenu()                             -> (no replacement)
101 Calendar:
102     * add_event()                           -> calendar_event::create()
103     * update_event()                        -> calendar_event->update()
104     * delete_event()                        -> calendar_event->delete()
105     * hide_event()                          -> calendar_event->toggle_visibility(false)
106     * show_event()                          -> calendar_event->toggle_visibility(true)
108 Misc:
109     * filter_text()                         -> format_text(), format_string()...
110     * httpsrequired()                       -> $PAGE->https_required()
111     * detect_munged_arguments()             -> clean_param([...], PARAM_FILE)
112     * mygroupid()                           -> groups_get_all_groups()
113     * js_minify()                           -> core_minify::js_files()
114     * css_minify_css()                      -> core_minify::css_files()
115     * course_modinfo::build_section_cache() -> (no replacement)
116     * generate_email_supportuser()          -> core_user::get_support_user()
118 Sessions:
119     * session_get_instance()->xxx()         -> \core\session\manager::xxx()
120     * session_kill_all()                    -> \core\session\manager::kill_all_sessions()
121     * session_touch()                       -> \core\session\manager::touch_session()
122     * session_kill()                        -> \core\session\manager::kill_session()
123     * session_kill_user()                   -> \core\session\manager::kill_user_sessions()
124     * session_gc()                          -> \core\session\manager::gc()
125     * session_set_user()                    -> \core\session\manager::set_user()
126     * session_is_loggedinas()               -> \core\session\manager::is_loggedinas()
127     * session_get_realuser()                -> \core\session\manager::get_realuser()
128     * session_loginas()                     -> \core\session\manager::loginas()
130 User-agent related functions:
131     * check_browser_operating_system()      -> core_useragent::check_browser_operating_system()
132     * check_browser_version()               -> core_useragent::check_browser_version()
133     * get_device_type()                     -> core_useragent::get_device_type()
134     * get_device_type_list()                -> core_useragent::get_device_type_list()
135     * get_selected_theme_for_device_type()  -> core_useragent::get_device_type_theme()
136     * get_device_cfg_var_name()             -> core_useragent::get_device_type_cfg_var_name()
137     * set_user_device_type()                -> core_useragent::set_user_device_type()
138     * get_user_device_type()                -> core_useragent::get_user_device_type()
139     * get_browser_version_classes()         -> core_useragent::get_browser_version_classes()
141 YUI:
142     * moodle-core-notification has been deprecated with a recommendation of
143       using its subclasses instead. This is to allow for reduced page
144       transport costs. Current subclasses include:
145       * dialogue
146       * alert
147       * confirm
148       * exception
149       * ajaxexception
151 Event triggering and event handlers:
152     * All existing events and event handlers should be replaced by new
153       event classes and matching new event observers.
154     * See http://docs.moodle.org/dev/Event_2 for more information.
155     * The following events will be entirely removed, though they can still
156       be captured using handlers, but they should not be used any more.
157       * groups_members_removed          -> \core\event\group_member_removed
158       * groups_groupings_groups_removed -> (no replacement)
159       * groups_groups_deleted           -> \core\event\group_deleted
160       * groups_groupings_deleted        -> \core\event\grouping_deleted
161     * edit_module_post_actions() does not trigger events any more.
163 === 2.5.1 ===
165 * New get_course() function for use when obtaining the course record from database. Will
166   reuse existing $COURSE or $SITE globals if possible to improve performance.
168 === 2.5 ===
170 * The database drivers (moodle_database and subclasses) aren't using anymore the ::columns property
171   for caching database metadata. MUC (databasemeta) is used instead. Any custom DB driver should
172   apply for that change.
173 * The cron output has been changed to include time and memory usage (see cron_trace_time_and_memory()),
174   so any custom utility relying on the old output may require modification.
175 * Function get_max_file_sizes now returns an option for (for example) "Course limit (500MB)" or
176   "Site limit (200MB)" when appropriate with the option set to 0. This function no longer returns
177   an option for 0 bytes. Existing code that was replacing the 0 option in the return
178   from this function with a more sensible message, can now use the return from this function directly.
179 * Functions responsible for output in course/lib.php are deprecated, the code is moved to
180   appropriate renderers: print_section(), print_section_add_menus(), get_print_section_cm_text(),
181   make_editing_buttons()
182   See functions' phpdocs in lib/deprecatedlib.php
183 * Function get_print_section_cm_text() is deprecated, replaced with methods in cm_info
184 * zip_packer may create empty zip archives, there is a new option to ignore
185   problematic files when creating archive
186 * The function delete_course_module was deprecated and has been replaced with
187   course_delete_module. The reason for this was because the function delete_course_module
188   only partially deletes data, so wherever it was called extra code was needed to
189   perform the whole deletion process. The function course_delete_module now takes care
190   of the whole process.
191 * curl::setopt() does not accept constant values any more. As it never worked properly,
192   we decided to make the type check stricter. Now, the keys of the array pass must be a string
193   corresponding to the curl constant name.
194 * Function get_users_listing now return list of users except guest and deleted users. Previously
195   deleted users were excluded by get_users_listing. As guest user is not expected while browsing users,
196   and not included in get_user function, it will not be returned by get_users_listing.
197 * The add_* functions in course/dnduploadlib.php have been deprecated. Plugins should be using the
198   MODNAME_dndupload_register callback instead.
199 * The signature of the add() method of classes implementing the parentable_part_of_admin_tree
200   interface (such as admin_category) has been extended. The new parameter allows the caller
201   to prepend the new node before an existing sibling in the admin tree.
202 * condition_info:get_condition_user_fields($formatoptions) now accepts the optional
203   param $formatoptions, that will determine if the field names are processed by
204   format_string() with the passed options.
205 * remove all references to $CFG->gdversion, GD PHP extension is now required
206 * Formslib will now throw a developer warning if a PARAM_ type hasn't been set for elements which
207   need it. Please set PARAM_RAW explicitly if you do not want any cleaning.
208 * Functions responsible for managing and accessing course categories are moved to class coursecat
209   in lib/coursecatlib.php, functions responsible for rendering courses and categories lists are
210   moved to course/renderer.php. The following global functions are deprecated: make_categories_list(),
211   category_delete_move(), category_delete_full(), move_category(), course_category_hide(),
212   course_category_show(), get_course_category(), create_course_category(), get_all_subcategories(),
213   get_child_categories(), get_categories(), print_my_moodle(), print_remote_course(),
214   print_remote_host(), print_whole_category_list(), print_category_info(), get_course_category_tree(),
215   print_courses(), print_course(), get_category_courses_array(), get_category_courses_array_recursively(),
216   get_courses_wmanagers()
217   See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
218 * $core_renderer->block_move_target() changed to support more verbose move-block-here descriptions.
219 * Additional (optional) param $onlyactive has been added to get_enrolled_users, count_enrolled_users
220   functions to get information for only active (excluding suspended enrolments) users. Included two
221   helper functions extract_suspended_users, get_suspended_userids to extract suspended user information.
222 * The plugin_manager class now provides two new helper methods for getting information
223   about known plugins: get_plugins_of_type() and get_subplugins_of_plugin().
224 * The get_uninstall_url() method of all subclasses of plugininfo_base class is now expected
225   to always return moodle_url. Subclasses can use the new method is_uninstall_allowed()
226   to control the availability of the 'Uninstall' link at the Plugins overview page (previously
227   they would do it by get_uninstall_url() returning null). By default, URL to a new general plugin
228   uninstall tool is returned. Unless the plugin type needs extra steps that can't be handled by
229   plugininfo_xxx::uninstall() method or xmldb_xxx_uninstall() function, this default URL should
230   satisfy all plugin types.
232 Database (DML) layer:
233 * $DB->sql_empty() is deprecated, you have to use sql parameters with empty values instead,
234   please note hardcoding of empty strings in SQL queries breaks execution in Oracle database.
235 * Indexes must not be defined on the same columns as keys, this is now reported as fatal problem.
236   Please note that internally we create indexes instead of foreign keys.
238 YUI changes:
239 * M.util.help_icon has been deprecated. Code should be updated to use moodle-core-popuphelp
240   instead. To do so, remove any existing JS calls to M.util.help_icon from your PHP and ensure
241   that your help link is placed in a span which has the class 'helplink'.
243 === 2.4 ===
245 * Pagelib: Numerous deprecated functions were removed as classes page_base, page_course
246   and page_generic_activity.
247 * use $CFG->googlemapkey3 instead of removed $CFG->googlemapkey and migrate to Google Maps API V3
248 * Function settings_navigation::add_course_editing_links() is completely removed
249 * function global_navigation::format_display_course_content() is removed completely (the
250   functionality is moved to course format class)
251 * in the function global_navigation::load_generic_course_sections() the argument $courseformat is
252   removed
253 * New component and itemid columns in groups_members table - this allows plugin to create protected
254   group memberships using 'xx_yy_allow_group_member_remove' callback and there is also a new restore
255   callback 'xx_yy_restore_group_member()'.
256 * New general role assignment restore plugin callback 'xx_yy_restore_role_assignment()'.
257 * functions get_generic_section_name(), get_all_sections(), add_mod_to_section(), get_all_mods()
258   are deprecated. See their phpdocs in lib/deprecatedlib.php on how to replace them
260 YUI changes:
261 * moodle-enrol-notification has been renamed to moodle-core-notification
262 * YUI2 code must now use 2in3, see http://yuilibrary.com/yui/docs/yui/yui-yui2.html
263 * M.util.init_select_autosubmit() and M.util.init_url_select() have been deprecated. Code using this should be updated
264   to use moodle-core-formautosubmit
266 Unit testing changes:
267 * output debugging() is not sent to standard output any more,
268   use $this->assertDebuggingCalled(), $this->assertDebuggingNotCalled(),
269   $this->getDebuggingMessages() or $this->assertResetDebugging() instead.
271 === 2.3 ===
273 Database layer changes:
274 * objects are not allowed in paramters of DML functions, use explicit casting to strings if necessary
276 Note:
277 * DDL and DML methods which were deprecated in 2.0 have now been removed, they will no longer produce
278 debug messages and will produce fatal errors
280 API changes:
282 * send_stored_file() has changed its interface
283 * deleted several resourcelib_embed_* functions from resourcelib.php
285 === 2.2 ===
287 removed unused libraries:
288 * odbc, base32, CodeSniffer, overlib, apd profiling, kses, Smarty, PEAR Console, swfobject, cssshover.htc, md5.js
290 API changes:
291 * new admin/tool plugin type
292 * new context API - old API is still available
293 * deleted users do not have context any more
294 * removed global search
297 === 2.1 ===
299 API changes:
300 * basic suport for restore from 1.9
301 * new mobile devices API
302 * new questions API
305 === 2.0 ===
307 API changes:
308 * new DML API - http://docs.moodle.org/dev/DML_functions
309 * new DDL API - http://docs.moodle.org/dev/DDL_functions
310 * new file API - http://docs.moodle.org/dev/File_API
311 * new $PAGE and $OUTPUT API
312 * new navigation API
313 * new theme API - http://docs.moodle.org/dev/Theme_changes_in_2.0
314 * new javascript API - http://docs.moodle.org/dev/JavaScript_usage_guide
315 * new portfolio API
316 * new local plugin type
317 * new translation support - http://lang.moodle.org
318 * new web service API
319 * new cohorts API
320 * new messaging API
321 * new rating API
322 * new comment API
323 * new sessions API
324 * new enrolment API
325 * new backup/restore API
326 * new blocks API
327 * new filters API
328 * improved plugin support (aka Frankenstyle)
329 * new registration and hub API
330 * new course completion API
331 * new plagiarism API
332 * changed blog API
333 * new text editor API
334 * new my moodle and profiles API