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