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