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