MDL-43081 upgrade.txt: note generator change
[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 core_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.
44 * Use core_shutdown_manager::register_function() instead of register_shutdown_function().
45 * New file packer for .tar.gz files; obtain by calling get_file_packer('application/x-gzip'). Intended initially
46   for use in backup/restore only, as there are limitations on supported filenames. Also new packer for
47   backups which supports both compression formats; get_file_packer('application/vnd.moodle.backup').
48 * New optional parameter to stored_file::get_content_file_handle to open file handle with 'gzopen' instead
49   of 'fopen' to read gzip-compressed files if required.
50 * update_internal_user_password() and setnew_password_and_mail() now trigger user_updated event.
51 * Add thirdpartylibs.xml file to plugins that bundle any 3rd party libraries.
52 * New class introduced to help auto generate zIndex values for modal dialogues. Class "moodle-has-zindex"
53   should set on any element which uses a non-default zindex and needs to ensure it doesn't show above a
54   dialogue.
55 * $CFG->filelifetime is now used consistently for most file serving operations, the default was lowered
56   to 6 hours from 24 hours because etags and x-sendfile support should make file serving less expensive.
57 * Date format locale charset for windows server will come from calendar type and for gregorian it will use
58   lang file.
59 * The library to interact with Box.net (class boxclient) is only compatible with their APIv1 which
60   reaches its end of life on the 14th of Dec. You should migrate your scripts to make usage of the
61   new class boxnet_client(). Note that the method names and return values have changed.
62 * The admin/tool/generator tool was overhauled to use testing data generators and the previous interface to create
63   test data was removed (it was not working correctly anyway). If you were using this tool you will probably need to
64   update your code.
66 DEPRECATIONS:
67 Various previously deprecated functions have now been altered to throw DEBUG_DEVELOPER debugging notices
68 and will be removed in a future release (target: 2.8), a summary follows:
70 Accesslib:
71     * get_context_instance()                ->  context_xxxx::instance()
72     * get_context_instance_by_id()          ->  context::instance_by_id($id)
73     * get_system_context()                  ->  context_system::instance()
74     * context_moved()                       ->  context::update_moved()
75     * preload_course_contexts()             ->  context_helper::preload_course()
76     * context_instance_preload()            ->  context_helper::preload_from_record()
77     * context_instance_preload_sql()        ->  context_helper::get_preload_record_columns_sql()
78     * get_contextlevel_name()               ->  context_helper::get_level_name()
79     * create_contexts()                     ->  context_helper::create_instances()
80     * cleanup_contexts()                    ->  context_helper::cleanup_instances()
81     * build_context_path()                  ->  context_helper::build_all_paths()
82     * print_context_name()                  ->  $context->get_context_name()
83     * mark_context_dirty()                  ->  $context->mark_dirty()
84     * delete_context()                      ->  $context->delete_content() or context_helper::delete_instance()
85     * get_context_url()                     ->  $context->get_url()
86     * get_course_context()                  ->  $context->get_course_context()
87     * get_parent_contexts()                 ->  $context->get_parent_context_ids()
88     * get_parent_contextid()                ->  $context->get_parent_context()
89     * get_child_contexts()                  ->  $context->get_child_contexts()
90     * rebuild_contexts()                    ->  $context->reset_paths()
91     * get_user_courses_bycap()              ->  enrol_get_users_courses()
92     * get_courseid_from_context()           ->  $context->get_course_context(false)
93     * get_role_context_caps()               ->  (no replacement)
94     * load_temp_role()                      ->  (no replacement)
95     * remove_temp_roles()                   ->  (no replacement)
96     * get_related_contexts_string()         ->  $context->get_parent_context_ids(true)
97     * get_recent_enrolments()               ->  (no replacement)
99 Enrollment:
100     * get_course_participants()             -> get_enrolled_users()
101     * is_course_participant()               -> is_enrolled()
103 Output:
104     * current_theme()                       -> $PAGE->theme->name
105     * skip_main_destination()               -> $OUTPUT->skip_link_target()
106     * print_container()                     -> $OUTPUT->container()
107     * print_container_start()               -> $OUTPUT->container_start()
108     * print_container_end()                 -> $OUTPUT->container_end()
109     * print_continue()                      -> $OUTPUT->continue_button()
110     * print_header()                        -> $PAGE methods
111     * print_header_simple()                 -> $PAGE methods
112     * print_side_block()                    -> $OUTPUT->block()
113     * print_arrow()                         -> $OUTPUT->arrow()
114     * print_scale_menu_helpbutton()         -> $OUTPUT->help_icon_scale($courseid, $scale)
115     * print_checkbox()                      -> html_writer::checkbox()
117 Navigation:
118     * print_navigation()                    -> $OUTPUT->navbar()
119     * build_navigation()                    -> $PAGE->navbar methods
120     * navmenu()                             -> (no replacement)
121     * settings_navigation::
122           get_course_modules()              -> (no replacement)
124 Files and repositories:
125     * stored_file::replace_content_with()   -> stored_file::replace_file_with()
126     * stored_file::set_filesize()           -> stored_file::replace_file_with()
127     * stored_file::get_referencelifetime()  -> (no replacement)
128     * repository::sync_external_file()      -> see repository::sync_reference()
129     * repository::get_file_by_reference()   -> repository::sync_reference()
130     * repository::
131           get_reference_file_lifetime()     -> (no replacement)
132     * repository::sync_individual_file()    -> (no replacement)
133     * repository::reset_caches()            -> (no replacement)
135 Calendar:
136     * add_event()                           -> calendar_event::create()
137     * update_event()                        -> calendar_event->update()
138     * delete_event()                        -> calendar_event->delete()
139     * hide_event()                          -> calendar_event->toggle_visibility(false)
140     * show_event()                          -> calendar_event->toggle_visibility(true)
142 Misc:
143     * filter_text()                         -> format_text(), format_string()...
144     * httpsrequired()                       -> $PAGE->https_required()
145     * detect_munged_arguments()             -> clean_param([...], PARAM_FILE)
146     * mygroupid()                           -> groups_get_all_groups()
147     * js_minify()                           -> core_minify::js_files()
148     * css_minify_css()                      -> core_minify::css_files()
149     * course_modinfo::build_section_cache() -> (no replacement)
150     * generate_email_supportuser()          -> core_user::get_support_user()
152 Sessions:
153     * session_get_instance()->xxx()         -> \core\session\manager::xxx()
154     * session_kill_all()                    -> \core\session\manager::kill_all_sessions()
155     * session_touch()                       -> \core\session\manager::touch_session()
156     * session_kill()                        -> \core\session\manager::kill_session()
157     * session_kill_user()                   -> \core\session\manager::kill_user_sessions()
158     * session_gc()                          -> \core\session\manager::gc()
159     * session_set_user()                    -> \core\session\manager::set_user()
160     * session_is_loggedinas()               -> \core\session\manager::is_loggedinas()
161     * session_get_realuser()                -> \core\session\manager::get_realuser()
162     * session_loginas()                     -> \core\session\manager::loginas()
164 User-agent related functions:
165     * check_browser_operating_system()      -> core_useragent::check_browser_operating_system()
166     * check_browser_version()               -> core_useragent::check_browser_version()
167     * get_device_type()                     -> core_useragent::get_device_type()
168     * get_device_type_list()                -> core_useragent::get_device_type_list()
169     * get_selected_theme_for_device_type()  -> core_useragent::get_device_type_theme()
170     * get_device_cfg_var_name()             -> core_useragent::get_device_type_cfg_var_name()
171     * set_user_device_type()                -> core_useragent::set_user_device_type()
172     * get_user_device_type()                -> core_useragent::get_user_device_type()
173     * get_browser_version_classes()         -> core_useragent::get_browser_version_classes()
175 YUI:
176     * moodle-core-notification has been deprecated with a recommendation of
177       using its subclasses instead. This is to allow for reduced page
178       transport costs. Current subclasses include:
179       * dialogue
180       * alert
181       * confirm
182       * exception
183       * ajaxexception
185 Event triggering and event handlers:
186     * All existing events and event handlers should be replaced by new
187       event classes and matching new event observers.
188     * See http://docs.moodle.org/dev/Event_2 for more information.
189     * The following events will be entirely removed, though they can still
190       be captured using handlers, but they should not be used any more.
191       * groups_members_removed          -> \core\event\group_member_removed
192       * groups_groupings_groups_removed -> (no replacement)
193       * groups_groups_deleted           -> \core\event\group_deleted
194       * groups_groupings_deleted        -> \core\event\grouping_deleted
195     * edit_module_post_actions() does not trigger events any more.
197 === 2.5.1 ===
199 * New get_course() function for use when obtaining the course record from database. Will
200   reuse existing $COURSE or $SITE globals if possible to improve performance.
202 === 2.5 ===
204 * The database drivers (moodle_database and subclasses) aren't using anymore the ::columns property
205   for caching database metadata. MUC (databasemeta) is used instead. Any custom DB driver should
206   apply for that change.
207 * The cron output has been changed to include time and memory usage (see cron_trace_time_and_memory()),
208   so any custom utility relying on the old output may require modification.
209 * Function get_max_file_sizes now returns an option for (for example) "Course limit (500MB)" or
210   "Site limit (200MB)" when appropriate with the option set to 0. This function no longer returns
211   an option for 0 bytes. Existing code that was replacing the 0 option in the return
212   from this function with a more sensible message, can now use the return from this function directly.
213 * Functions responsible for output in course/lib.php are deprecated, the code is moved to
214   appropriate renderers: print_section(), print_section_add_menus(), get_print_section_cm_text(),
215   make_editing_buttons()
216   See functions' phpdocs in lib/deprecatedlib.php
217 * Function get_print_section_cm_text() is deprecated, replaced with methods in cm_info
218 * zip_packer may create empty zip archives, there is a new option to ignore
219   problematic files when creating archive
220 * The function delete_course_module was deprecated and has been replaced with
221   course_delete_module. The reason for this was because the function delete_course_module
222   only partially deletes data, so wherever it was called extra code was needed to
223   perform the whole deletion process. The function course_delete_module now takes care
224   of the whole process.
225 * curl::setopt() does not accept constant values any more. As it never worked properly,
226   we decided to make the type check stricter. Now, the keys of the array pass must be a string
227   corresponding to the curl constant name.
228 * Function get_users_listing now return list of users except guest and deleted users. Previously
229   deleted users were excluded by get_users_listing. As guest user is not expected while browsing users,
230   and not included in get_user function, it will not be returned by get_users_listing.
231 * The add_* functions in course/dnduploadlib.php have been deprecated. Plugins should be using the
232   MODNAME_dndupload_register callback instead.
233 * The signature of the add() method of classes implementing the parentable_part_of_admin_tree
234   interface (such as admin_category) has been extended. The new parameter allows the caller
235   to prepend the new node before an existing sibling in the admin tree.
236 * condition_info:get_condition_user_fields($formatoptions) now accepts the optional
237   param $formatoptions, that will determine if the field names are processed by
238   format_string() with the passed options.
239 * remove all references to $CFG->gdversion, GD PHP extension is now required
240 * Formslib will now throw a developer warning if a PARAM_ type hasn't been set for elements which
241   need it. Please set PARAM_RAW explicitly if you do not want any cleaning.
242 * Functions responsible for managing and accessing course categories are moved to class coursecat
243   in lib/coursecatlib.php, functions responsible for rendering courses and categories lists are
244   moved to course/renderer.php. The following global functions are deprecated: make_categories_list(),
245   category_delete_move(), category_delete_full(), move_category(), course_category_hide(),
246   course_category_show(), get_course_category(), create_course_category(), get_all_subcategories(),
247   get_child_categories(), get_categories(), print_my_moodle(), print_remote_course(),
248   print_remote_host(), print_whole_category_list(), print_category_info(), get_course_category_tree(),
249   print_courses(), print_course(), get_category_courses_array(), get_category_courses_array_recursively(),
250   get_courses_wmanagers()
251   See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
252 * $core_renderer->block_move_target() changed to support more verbose move-block-here descriptions.
253 * Additional (optional) param $onlyactive has been added to get_enrolled_users, count_enrolled_users
254   functions to get information for only active (excluding suspended enrolments) users. Included two
255   helper functions extract_suspended_users, get_suspended_userids to extract suspended user information.
256 * The core_plugin_manager class now provides two new helper methods for getting information
257   about known plugins: get_plugins_of_type() and get_subplugins_of_plugin().
258 * The get_uninstall_url() method of all subclasses of \core\plugininfo\base class is now expected
259   to always return moodle_url. Subclasses can use the new method is_uninstall_allowed()
260   to control the availability of the 'Uninstall' link at the Plugins overview page (previously
261   they would do it by get_uninstall_url() returning null). By default, URL to a new general plugin
262   uninstall tool is returned. Unless the plugin type needs extra steps that can't be handled by
263   plugininfo_xxx::uninstall() method or xmldb_xxx_uninstall() function, this default URL should
264   satisfy all plugin types.
266 Database (DML) layer:
267 * $DB->sql_empty() is deprecated, you have to use sql parameters with empty values instead,
268   please note hardcoding of empty strings in SQL queries breaks execution in Oracle database.
269 * Indexes must not be defined on the same columns as keys, this is now reported as fatal problem.
270   Please note that internally we create indexes instead of foreign keys.
272 YUI changes:
273 * M.util.help_icon has been deprecated. Code should be updated to use moodle-core-popuphelp
274   instead. To do so, remove any existing JS calls to M.util.help_icon from your PHP and ensure
275   that your help link is placed in a span which has the class 'helplink'.
277 === 2.4 ===
279 * Pagelib: Numerous deprecated functions were removed as classes page_base, page_course
280   and page_generic_activity.
281 * use $CFG->googlemapkey3 instead of removed $CFG->googlemapkey and migrate to Google Maps API V3
282 * Function settings_navigation::add_course_editing_links() is completely removed
283 * function global_navigation::format_display_course_content() is removed completely (the
284   functionality is moved to course format class)
285 * in the function global_navigation::load_generic_course_sections() the argument $courseformat is
286   removed
287 * New component and itemid columns in groups_members table - this allows plugin to create protected
288   group memberships using 'xx_yy_allow_group_member_remove' callback and there is also a new restore
289   callback 'xx_yy_restore_group_member()'.
290 * New general role assignment restore plugin callback 'xx_yy_restore_role_assignment()'.
291 * functions get_generic_section_name(), get_all_sections(), add_mod_to_section(), get_all_mods()
292   are deprecated. See their phpdocs in lib/deprecatedlib.php on how to replace them
294 YUI changes:
295 * moodle-enrol-notification has been renamed to moodle-core-notification
296 * YUI2 code must now use 2in3, see http://yuilibrary.com/yui/docs/yui/yui-yui2.html
297 * M.util.init_select_autosubmit() and M.util.init_url_select() have been deprecated. Code using this should be updated
298   to use moodle-core-formautosubmit
300 Unit testing changes:
301 * output debugging() is not sent to standard output any more,
302   use $this->assertDebuggingCalled(), $this->assertDebuggingNotCalled(),
303   $this->getDebuggingMessages() or $this->assertResetDebugging() instead.
305 === 2.3 ===
307 Database layer changes:
308 * objects are not allowed in paramters of DML functions, use explicit casting to strings if necessary
310 Note:
311 * DDL and DML methods which were deprecated in 2.0 have now been removed, they will no longer produce
312 debug messages and will produce fatal errors
314 API changes:
316 * send_stored_file() has changed its interface
317 * deleted several resourcelib_embed_* functions from resourcelib.php
319 === 2.2 ===
321 removed unused libraries:
322 * odbc, base32, CodeSniffer, overlib, apd profiling, kses, Smarty, PEAR Console, swfobject, cssshover.htc, md5.js
324 API changes:
325 * new admin/tool plugin type
326 * new context API - old API is still available
327 * deleted users do not have context any more
328 * removed global search
331 === 2.1 ===
333 API changes:
334 * basic suport for restore from 1.9
335 * new mobile devices API
336 * new questions API
339 === 2.0 ===
341 API changes:
342 * new DML API - http://docs.moodle.org/dev/DML_functions
343 * new DDL API - http://docs.moodle.org/dev/DDL_functions
344 * new file API - http://docs.moodle.org/dev/File_API
345 * new $PAGE and $OUTPUT API
346 * new navigation API
347 * new theme API - http://docs.moodle.org/dev/Theme_changes_in_2.0
348 * new javascript API - http://docs.moodle.org/dev/JavaScript_usage_guide
349 * new portfolio API
350 * new local plugin type
351 * new translation support - http://lang.moodle.org
352 * new web service API
353 * new cohorts API
354 * new messaging API
355 * new rating API
356 * new comment API
357 * new sessions API
358 * new enrolment API
359 * new backup/restore API
360 * new blocks API
361 * new filters API
362 * improved plugin support (aka Frankenstyle)
363 * new registration and hub API
364 * new course completion API
365 * new plagiarism API
366 * changed blog API
367 * new text editor API
368 * new my moodle and profiles API