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