MDL-48697 libraries: Use proper path for core_completion
[moodle.git] / lib / upgrade.txt
blob7b170f6c4a043e69f18f76ef3bdc9126364bc009
1 This files describes API changes in core libraries and APIs,
2 information provided here is intended especially for developers.
4 === 2.8.2 ===
6 * \core_component::fetch_subsystems() now returns a valid path for completion component instead of null.
8 === 2.8 ===
10 * Gradebook grade category option "aggregatesubcats" has been removed completely.
11   This means that the database column is removed, the admin settings are removed and
12   the properties from the grade_category object have been removed. If any courses were
13   found to be using this setting, a warning to check the grades will be shown in the
14   course grader report after upgrading the site. The same warning will be shown on
15   courses restored from backup that had this setting enabled (see MDL-47503).
16 * lib/excelllib.class.php has been updated. The class MoodleExcelWorkbook will now only produce excel 2007 files.
17 * renderers: We now remove the suffix _renderable when looking for a render method for a renderable.
18   If you have a renderable class named like "blah_renderable" and have a method on a renderer named "render_blah_renderable"
19   you will need to change the name of your render method to "render_blah" instead, as renderable at the end is no longer accepted.
20 * New functions get_course_and_cm_from_cmid($cmorid, $modulename) and
21   get_course_and_cm_from_instance($instanceorid, $modulename) can be used to
22   more efficiently load these basic data objects at the start of a script.
23 * New function cm_info::create($cm) can be used when you need a cm_info
24   object, but have a $cm which might only be a standard database record.
25 * $CFG->enablegroupmembersonly no longer exists.
26 * Scheduled tasks have gained support for syntax to introduce variability when a
27   task will run across installs. When a when hour or minute are defined as 'R'
28   they will be installed with a random hour/minute value.
29 * Several classes grade_edit_tree_column_xxx were removed since grades setup page
30   has been significantly changed. These classes should not be used outside of
31   gradebook or developers can copy them into their plugins from 2.7 branch.
32 * Google APIs Client Library (lib/google/) has been upgraded to 1.0.5-beta and
33   API has changed dramatically without backward compatibility. Any code accessing
34   it must be amended. It does not apply to lib/googleapi.php. See MDL-47297
35 * Added an extra parameter to the function get_formatted_help_string() (default null) which is used to specify
36   additional string parameters.
37 * User settings node and course node in navigation now support callbacks from admin tools.
38 * grade_get_grades() optional parameteres $itemtype, $itemmodule, $iteminstance are now required.
40 DEPRECATIONS:
41 * completion_info->get_incomplete_criteria() is deprecated and will be removed in Moodle 3.0.
42 * grade_category::aggregate_values() is deprecated and will be removed in Moodle 3.0.
43 * groups_filter_users_by_course_module_visible() is deprecated; replace with
44   core_availability\info::filter_user_list. Will be removed in Moodle 3.0.
45 * groups_course_module_visible() is deprecated; replace with $cm->uservisible.
46 * cm_info property $cm->groupmembersonly is deprecated and always returns 0.
47   Use core_availability\info::filter_user_list if trying to determine which
48   other users can see an activity.
49 * cm_info method $cm->is_user_access_restricted_by_group() is deprecated and
50   always returns false. Use $cm->uservisible to determine whether the user can
51   access the activity.
52 * Constant FEATURE_GROUPMEMBERSONLY (used in module _supports functions) is
53   deprecated.
54 * cohort_get_visible_list() is deprecated. There is a better function cohort_get_available_cohorts()
55   that respects user capabilities to view cohorts.
56 * enrol_cohort_get_cohorts() and enrol_cohort_search_cohorts() are deprecated since
57   functionality is removed. Please use cohort_get_available_cohorts()
58 * enrol_cohort_enrol_all_users() is deprecated; enrol_manual is now responsible for this action
59 * enrol_cohort_can_view_cohort() is deprecated; replace with cohort_can_view_cohort()
61 === 2.6.4 / 2.7.1 ===
63 * setnew_password_and_mail() and update_internal_user_password() will trigger
64   \core\event\user_password_updated. Previously they used to generate
65   \core\event\user_updated event.
66 * update_internal_user_password() accepts optional boolean $fasthash for fast
67   hashing.
68 * user_update_user() and user_create_user() api's accept optional param
69   $triggerevent to avoid respective events to be triggred from the api's.
71 === 2.7 ===
73 * PHPUnit cannot be installed via PEAR any more, please use composer package manager instead.
74 * $core_renderer->block_move_target() changed to support more verbose move-block-here descriptions.
76 Events and Logging:
77 * Significant changes in Logging API. For upgrading existing events_trigger() and
78   add_to_log() see http://docs.moodle.org/dev/Migrating_logging_calls_in_plugins
79   For accessing logs from plugins see http://docs.moodle.org/dev/Migrating_log_access_in_reports
80 * The validation of the following events is now stricter (see MDL-45445):
81     - \core\event\blog_entry_created
82     - \core\event\blog_entry_deleted
83     - \core\event\blog_entry_updated
84     - \core\event\cohort_member_added
85     - \core\event\cohort_member_removed
86     - \core\event\course_category_deleted
87     - \core\event\course_completed
88     - \core\event\course_content_deleted
89     - \core\event\course_created
90     - \core\event\course_deleted
91     - \core\event\course_restored
92     - \core\event\course_section_updated (see MDL-45229)
93     - \core\event\email_failed
94     - \core\event\group_member_added
95     - \core\event\group_member_removed
96     - \core\event\note_created
97     - \core\event\note_deleted
98     - \core\event\note_updated
99     - \core\event\role_assigned
100     - \core\event\role_deleted
101     - \core\event\role_unassigned
102     - \core\event\user_graded
103     - \core\event\user_loggedinas
104     - \core\event\user_profile_viewed
105     - \core\event\webservice_token_created
107 DEPRECATIONS:
108 * $module uses in mod/xxx/version.php files is now deprecated. Please use $plugin instead. It will be removed in Moodle 2.10.
109 * Update init methods in all event classes - "level" property was renamed to "edulevel", the level property is now deprecated.
110 * Abstract class \core\event\course_module_instances_list_viewed is deprecated now, use \core\event\instances_list_viewed instead.
111 * Abstract class core\event\content_viewed has been deprecated. Please extend base event or other relevant abstract class.
112 * mod_book\event\instances_list_viewed has been deprecated. Please use mod_book\event\course_module_instance_list_viewed instead.
113 * mod_chat\event\instances_list_viewed has been deprecated. Please use mod_chat\event\course_module_instance_list_viewed instead.
114 * mod_choice\event\instances_list_viewed has been deprecated. Please use mod_choice\event\course_module_instance_list_viewed instead.
115 * mod_feedback\event\instances_list_viewed has been deprecated. Please use mod_feedback\event\course_module_instance_list_viewed instead.
116 * mod_page\event\instances_list_viewed has been deprecated. Please use mod_page\event\course_module_instance_list_viewed instead.
117 * The constants FRONTPAGECOURSELIST, FRONTPAGETOPICONLY & FRONTPAGECOURSELIMIT have been removed.
118 * Conditional availability API has moved and changed. The condition_info class is
119   replaced by \core_availability\info_module, and condition_info_section by
120   \core_availability\info_section. (Code that uses the old classes will generally
121   still work.)
122 * coursemodule_visible_for_user() has been deprecated but still works - replaced
123   by a new static function \core_availability\info_module::is_user_visible()
124 * cm_info::is_user_access_restricted_by_conditional_access has been deprecated
125   but still works (it has never done what its name suggests, and is
126   unnecessary).
127 * cm_info and section_info property showavailability has been deprecated, but
128   still works (with the caveat that this information is now per-user).
129 * cm_info and section_info properties availablefrom and availableuntil have been
130   deprecated and always return zero (underlying data doesn't have these values).
131 * section_info property groupingid has been deprecated and always returns zero,
132   same deal.
133 * Various cm_info methods have been deprecated in favour of their read-only properties (get_url(), get_content(), get_extra_classes(),
134   get_on_click(), get_custom_data(), get_after_link, get_after_edit_icons)
135 * The ajaxenabled function has been deprecated and always returns true. All code should be fully functional in Javascript.
136 * count_login_failures() has been deprecated, use user_count_login_failures() instead. Refer MDL-42891 for details.
138 Conditional availability (activities and sections):
139 * New conditional availability API in /availability, including new availability
140   condition plugins in /availability/condition. The new API is very similar with
141   regard to checking availability, but any code that modifies availability settings
142   for an activity or section is likely to need substantial changes.
144 YUI:
145   * The lightbox attribute for moodle-core-notification-dialogue has been
146     deprecated and replaced by the modal attribute. This was actually
147     changed in Moodle 2.2, but has only been marked as deprecated now. It
148     will be removed in Moodle 2.9.
149   * When destroying any type of dialogue based on moodle-core-notification, the relevant content is also removed from
150     the DOM. Previously it was left orphaned.
152 JavaSript:
153     * The findChildNodes global function has been deprecated. Y.all should
154       be used instead.
155     * The callback argument to confirm_action and M.util.show_confirm_dialog has been deprecated. If you need to write a
156       confirmation which includes a callback, please use moodle-core-notification-confirmation and attach callbacks to the
157       events provided.
159 * New locking api and admin settings to configure the system locking type.
160 * New "Time spent waiting for the database" performance metric displayed along with the
161   other MDL_PERF vars; the change affects both the error logs and the vars displayed in
162   the page footer.
163 * Changes in the tag API. The component and contextid are now saved when assigning tags to an item. Please see
164   tag/upgrade.txt for more information.
166 === 2.6 ===
168 * Use new methods from core_component class instead of get_core_subsystems(), get_plugin_types(),
169   get_plugin_list(), get_plugin_list_with_class(), get_plugin_directory(), normalize_component(),
170   get_component_directory() and get_plugin_list_with_file(). The names of the new methods are
171   exactly the same, the only differences are that core_component::get_plugin_types() now always returns
172   full paths and core_component::get_plugin_list() does not accept empty parameter any more.
173 * Use core_text::* instead of textlib:: and also core_collator::* instead of collatorlib::*.
174 * Use new function moodleform::mock_submit() to simulate form submission in unit tests (backported).
175 * New $CFG->localcachedir setting useful for cluster nodes. Admins have to update X-Sendfile aliases if used.
176 * MS SQL Server drivers are now using NVARCHAR(MAX) instead of NTEXT and VARBINARY(MAX) instead of IMAGE,
177   this change should be fully transparent and it should help significantly with add-on compatibility.
178 * The string manager classes were renamed. Note that they should not be modified or used directly,
179   always use get_string_manager() to get instance of the string manager.
180 * The ability to use an 'insecure' rc4encrypt/rc4decrypt key has been removed.
181 * Use $CFG->debugdeveloper instead of debugging('', DEBUG_DEVELOPER).
182 * Use set_debugging(DEBUG_xxx) when changing debugging level for current request.
183 * Function moveto_module() does not modify $mod argument and instead now returns the new module visibility value.
184 * Use behat_selectors::get_allowed_text_selectors() and behat_selectors::get_allowed_selectors() instead of
185   behat_command::$allowedtextselectors and behat_command::$allowedselectors
186 * Subplugins are supported in admin tools and local plugins.
187 * file_packer/zip_packer API has been modified so that key functions support a new file_progress interface
188   to report progress during long operations. Related to this, zip_archive now supports an estimated_count()
189   function that returns an approximate number of entries in the zip faster than the count() function.
190 * Class cm_info no longer extends stdClass. All properties are read-only and calculated on first request only.
191 * Class course_modinfo no longer extends stdClass. All properties are read-only.
192 * Database fields modinfo and sectioncache in table course are removed. Application cache core/coursemodinfo
193   is used instead. Course cache is still reset, rebuilt and retrieved using function rebuild_course_cache() and
194   get_fast_modinfo(). Purging all caches and every core upgrade purges course modinfo cache as well.
195   If function get_fast_modinfo() is called for multiple courses make sure to include field cacherev in course
196   object.
197 * Internal (noreply and support) user support has been added for sending/receiving message.
198   Use core_user::get_noreply_user() and core_user::get_support_user() to get noreply and support user's respectively.
199   Real users can be used as noreply/support users by setting $CFG->noreplyuserid and $CFG->supportuserid
200 * New function readfile_allow_large() in filelib.php for use when very large files may need sending to user.
201 * Use core_plugin_manager::reset_caches() when changing visibility of plugins.
202 * Implement new method get_enabled_plugins() method in subplugin info classes.
203 * Each plugin should include version information in version.php.
204 * Module and block tables do not contain version column any more, use get_config('xx_yy', 'version') instead.
205 * $USER->password field is intentionally unset so that session data does not contain password hashes.
206 * Use core_shutdown_manager::register_function() instead of register_shutdown_function().
207 * New file packer for .tar.gz files; obtain by calling get_file_packer('application/x-gzip'). Intended initially
208   for use in backup/restore only, as there are limitations on supported filenames. Also new packer for
209   backups which supports both compression formats; get_file_packer('application/vnd.moodle.backup').
210 * New optional parameter to stored_file::get_content_file_handle to open file handle with 'gzopen' instead
211   of 'fopen' to read gzip-compressed files if required.
212 * update_internal_user_password() and setnew_password_and_mail() now trigger user_updated event.
213 * Add thirdpartylibs.xml file to plugins that bundle any 3rd party libraries.
214 * New class introduced to help auto generate zIndex values for modal dialogues. Class "moodle-has-zindex"
215   should set on any element which uses a non-default zindex and needs to ensure it doesn't show above a
216   dialogue.
217 * $CFG->filelifetime is now used consistently for most file serving operations, the default was lowered
218   to 6 hours from 24 hours because etags and x-sendfile support should make file serving less expensive.
219 * Date format locale charset for windows server will come from calendar type and for gregorian it will use
220   lang file.
221 * The library to interact with Box.net (class boxclient) is only compatible with their APIv1 which
222   reaches its end of life on the 14th of Dec. You should migrate your scripts to make usage of the
223   new class boxnet_client(). Note that the method names and return values have changed.
224 * Settings pages are now possible for Calendar type plugins. Calendar type plugins that require a settings page to
225   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.
226 * The admin/tool/generator tool was overhauled to use testing data generators and the previous interface to create
227   test data was removed (it was not working correctly anyway). If you were using this tool you will probably need to
228   update your code.
230 DEPRECATIONS:
231 Various previously deprecated functions have now been altered to throw DEBUG_DEVELOPER debugging notices
232 and will be removed in a future release (target: 2.8), a summary follows:
234 Accesslib:
235     * get_context_instance()                ->  context_xxxx::instance()
236     * get_context_instance_by_id()          ->  context::instance_by_id($id)
237     * get_system_context()                  ->  context_system::instance()
238     * context_moved()                       ->  context::update_moved()
239     * preload_course_contexts()             ->  context_helper::preload_course()
240     * context_instance_preload()            ->  context_helper::preload_from_record()
241     * context_instance_preload_sql()        ->  context_helper::get_preload_record_columns_sql()
242     * get_contextlevel_name()               ->  context_helper::get_level_name()
243     * create_contexts()                     ->  context_helper::create_instances()
244     * cleanup_contexts()                    ->  context_helper::cleanup_instances()
245     * build_context_path()                  ->  context_helper::build_all_paths()
246     * print_context_name()                  ->  $context->get_context_name()
247     * mark_context_dirty()                  ->  $context->mark_dirty()
248     * delete_context()                      ->  $context->delete_content() or context_helper::delete_instance()
249     * get_context_url()                     ->  $context->get_url()
250     * get_course_context()                  ->  $context->get_course_context()
251     * get_parent_contexts()                 ->  $context->get_parent_context_ids()
252     * get_parent_contextid()                ->  $context->get_parent_context()
253     * get_child_contexts()                  ->  $context->get_child_contexts()
254     * rebuild_contexts()                    ->  $context->reset_paths()
255     * get_user_courses_bycap()              ->  enrol_get_users_courses()
256     * get_courseid_from_context()           ->  $context->get_course_context(false)
257     * get_role_context_caps()               ->  (no replacement)
258     * load_temp_role()                      ->  (no replacement)
259     * remove_temp_roles()                   ->  (no replacement)
260     * get_related_contexts_string()         ->  $context->get_parent_context_ids(true)
261     * get_recent_enrolments()               ->  (no replacement)
263 Enrollment:
264     * get_course_participants()             -> get_enrolled_users()
265     * is_course_participant()               -> is_enrolled()
267 Output:
268     * current_theme()                       -> $PAGE->theme->name
269     * skip_main_destination()               -> $OUTPUT->skip_link_target()
270     * print_container()                     -> $OUTPUT->container()
271     * print_container_start()               -> $OUTPUT->container_start()
272     * print_container_end()                 -> $OUTPUT->container_end()
273     * print_continue()                      -> $OUTPUT->continue_button()
274     * print_header()                        -> $PAGE methods
275     * print_header_simple()                 -> $PAGE methods
276     * print_side_block()                    -> $OUTPUT->block()
277     * print_arrow()                         -> $OUTPUT->arrow()
278     * print_scale_menu_helpbutton()         -> $OUTPUT->help_icon_scale($courseid, $scale)
279     * print_checkbox()                      -> html_writer::checkbox()
281 Navigation:
282     * print_navigation()                    -> $OUTPUT->navbar()
283     * build_navigation()                    -> $PAGE->navbar methods
284     * navmenu()                             -> (no replacement)
285     * settings_navigation::
286           get_course_modules()              -> (no replacement)
288 Files and repositories:
289     * stored_file::replace_content_with()   -> stored_file::replace_file_with()
290     * stored_file::set_filesize()           -> stored_file::replace_file_with()
291     * stored_file::get_referencelifetime()  -> (no replacement)
292     * repository::sync_external_file()      -> see repository::sync_reference()
293     * repository::get_file_by_reference()   -> repository::sync_reference()
294     * repository::
295           get_reference_file_lifetime()     -> (no replacement)
296     * repository::sync_individual_file()    -> (no replacement)
297     * repository::reset_caches()            -> (no replacement)
299 Calendar:
300     * add_event()                           -> calendar_event::create()
301     * update_event()                        -> calendar_event->update()
302     * delete_event()                        -> calendar_event->delete()
303     * hide_event()                          -> calendar_event->toggle_visibility(false)
304     * show_event()                          -> calendar_event->toggle_visibility(true)
306 Misc:
307     * filter_text()                         -> format_text(), format_string()...
308     * httpsrequired()                       -> $PAGE->https_required()
309     * detect_munged_arguments()             -> clean_param([...], PARAM_FILE)
310     * mygroupid()                           -> groups_get_all_groups()
311     * js_minify()                           -> core_minify::js_files()
312     * css_minify_css()                      -> core_minify::css_files()
313     * course_modinfo::build_section_cache() -> (no replacement)
314     * generate_email_supportuser()          -> core_user::get_support_user()
316 Sessions:
317     * session_get_instance()->xxx()         -> \core\session\manager::xxx()
318     * session_kill_all()                    -> \core\session\manager::kill_all_sessions()
319     * session_touch()                       -> \core\session\manager::touch_session()
320     * session_kill()                        -> \core\session\manager::kill_session()
321     * session_kill_user()                   -> \core\session\manager::kill_user_sessions()
322     * session_gc()                          -> \core\session\manager::gc()
323     * session_set_user()                    -> \core\session\manager::set_user()
324     * session_is_loggedinas()               -> \core\session\manager::is_loggedinas()
325     * session_get_realuser()                -> \core\session\manager::get_realuser()
326     * session_loginas()                     -> \core\session\manager::loginas()
328 User-agent related functions:
329     * check_browser_operating_system()      -> core_useragent::check_browser_operating_system()
330     * check_browser_version()               -> core_useragent::check_browser_version()
331     * get_device_type()                     -> core_useragent::get_device_type()
332     * get_device_type_list()                -> core_useragent::get_device_type_list()
333     * get_selected_theme_for_device_type()  -> core_useragent::get_device_type_theme()
334     * get_device_cfg_var_name()             -> core_useragent::get_device_type_cfg_var_name()
335     * set_user_device_type()                -> core_useragent::set_user_device_type()
336     * get_user_device_type()                -> core_useragent::get_user_device_type()
337     * get_browser_version_classes()         -> core_useragent::get_browser_version_classes()
339 YUI:
340     * moodle-core-notification has been deprecated with a recommendation of
341       using its subclasses instead. This is to allow for reduced page
342       transport costs. Current subclasses include:
343       * dialogue
344       * alert
345       * confirm
346       * exception
347       * ajaxexception
349 Event triggering and event handlers:
350     * All existing events and event handlers should be replaced by new
351       event classes and matching new event observers.
352     * See http://docs.moodle.org/dev/Event_2 for more information.
353     * The following events will be entirely removed, though they can still
354       be captured using handlers, but they should not be used any more.
355       * groups_members_removed          -> \core\event\group_member_removed
356       * groups_groupings_groups_removed -> (no replacement)
357       * groups_groups_deleted           -> \core\event\group_deleted
358       * groups_groupings_deleted        -> \core\event\grouping_deleted
359     * edit_module_post_actions() does not trigger events any more.
361 === 2.5.1 ===
363 * New get_course() function for use when obtaining the course record from database. Will
364   reuse existing $COURSE or $SITE globals if possible to improve performance.
366 === 2.5 ===
368 * The database drivers (moodle_database and subclasses) aren't using anymore the ::columns property
369   for caching database metadata. MUC (databasemeta) is used instead. Any custom DB driver should
370   apply for that change.
371 * The cron output has been changed to include time and memory usage (see cron_trace_time_and_memory()),
372   so any custom utility relying on the old output may require modification.
373 * Function get_max_file_sizes now returns an option for (for example) "Course limit (500MB)" or
374   "Site limit (200MB)" when appropriate with the option set to 0. This function no longer returns
375   an option for 0 bytes. Existing code that was replacing the 0 option in the return
376   from this function with a more sensible message, can now use the return from this function directly.
377 * Functions responsible for output in course/lib.php are deprecated, the code is moved to
378   appropriate renderers: print_section(), print_section_add_menus(), get_print_section_cm_text(),
379   make_editing_buttons()
380   See functions' phpdocs in lib/deprecatedlib.php
381 * Function get_print_section_cm_text() is deprecated, replaced with methods in cm_info
382 * zip_packer may create empty zip archives, there is a new option to ignore
383   problematic files when creating archive
384 * The function delete_course_module was deprecated and has been replaced with
385   course_delete_module. The reason for this was because the function delete_course_module
386   only partially deletes data, so wherever it was called extra code was needed to
387   perform the whole deletion process. The function course_delete_module now takes care
388   of the whole process.
389 * curl::setopt() does not accept constant values any more. As it never worked properly,
390   we decided to make the type check stricter. Now, the keys of the array pass must be a string
391   corresponding to the curl constant name.
392 * Function get_users_listing now return list of users except guest and deleted users. Previously
393   deleted users were excluded by get_users_listing. As guest user is not expected while browsing users,
394   and not included in get_user function, it will not be returned by get_users_listing.
395 * The add_* functions in course/dnduploadlib.php have been deprecated. Plugins should be using the
396   MODNAME_dndupload_register callback instead.
397 * The signature of the add() method of classes implementing the parentable_part_of_admin_tree
398   interface (such as admin_category) has been extended. The new parameter allows the caller
399   to prepend the new node before an existing sibling in the admin tree.
400 * condition_info:get_condition_user_fields($formatoptions) now accepts the optional
401   param $formatoptions, that will determine if the field names are processed by
402   format_string() with the passed options.
403 * remove all references to $CFG->gdversion, GD PHP extension is now required
404 * Formslib will now throw a developer warning if a PARAM_ type hasn't been set for elements which
405   need it. Please set PARAM_RAW explicitly if you do not want any cleaning.
406 * Functions responsible for managing and accessing course categories are moved to class coursecat
407   in lib/coursecatlib.php, functions responsible for rendering courses and categories lists are
408   moved to course/renderer.php. The following global functions are deprecated: make_categories_list(),
409   category_delete_move(), category_delete_full(), move_category(), course_category_hide(),
410   course_category_show(), get_course_category(), create_course_category(), get_all_subcategories(),
411   get_child_categories(), get_categories(), print_my_moodle(), print_remote_course(),
412   print_remote_host(), print_whole_category_list(), print_category_info(), get_course_category_tree(),
413   print_courses(), print_course(), get_category_courses_array(), get_category_courses_array_recursively(),
414   get_courses_wmanagers()
415   See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
416 * $core_renderer->block_move_target() changed to support more verbose move-block-here descriptions.
417 * Additional (optional) param $onlyactive has been added to get_enrolled_users, count_enrolled_users
418   functions to get information for only active (excluding suspended enrolments) users. Included two
419   helper functions extract_suspended_users, get_suspended_userids to extract suspended user information.
420 * The core_plugin_manager class now provides two new helper methods for getting information
421   about known plugins: get_plugins_of_type() and get_subplugins_of_plugin().
422 * The get_uninstall_url() method of all subclasses of \core\plugininfo\base class is now expected
423   to always return moodle_url. Subclasses can use the new method is_uninstall_allowed()
424   to control the availability of the 'Uninstall' link at the Plugins overview page (previously
425   they would do it by get_uninstall_url() returning null). By default, URL to a new general plugin
426   uninstall tool is returned. Unless the plugin type needs extra steps that can't be handled by
427   plugininfo_xxx::uninstall() method or xmldb_xxx_uninstall() function, this default URL should
428   satisfy all plugin types.
430 Database (DML) layer:
431 * $DB->sql_empty() is deprecated, you have to use sql parameters with empty values instead,
432   please note hardcoding of empty strings in SQL queries breaks execution in Oracle database.
433 * Indexes must not be defined on the same columns as keys, this is now reported as fatal problem.
434   Please note that internally we create indexes instead of foreign keys.
436 YUI changes:
437 * M.util.help_icon has been deprecated. Code should be updated to use moodle-core-popuphelp
438   instead. To do so, remove any existing JS calls to M.util.help_icon from your PHP and ensure
439   that your help link is placed in a span which has the class 'helplink'.
441 === 2.4 ===
443 * Pagelib: Numerous deprecated functions were removed as classes page_base, page_course
444   and page_generic_activity.
445 * use $CFG->googlemapkey3 instead of removed $CFG->googlemapkey and migrate to Google Maps API V3
446 * Function settings_navigation::add_course_editing_links() is completely removed
447 * function global_navigation::format_display_course_content() is removed completely (the
448   functionality is moved to course format class)
449 * in the function global_navigation::load_generic_course_sections() the argument $courseformat is
450   removed
451 * New component and itemid columns in groups_members table - this allows plugin to create protected
452   group memberships using 'xx_yy_allow_group_member_remove' callback and there is also a new restore
453   callback 'xx_yy_restore_group_member()'.
454 * New general role assignment restore plugin callback 'xx_yy_restore_role_assignment()'.
455 * functions get_generic_section_name(), get_all_sections(), add_mod_to_section(), get_all_mods()
456   are deprecated. See their phpdocs in lib/deprecatedlib.php on how to replace them
458 YUI changes:
459 * moodle-enrol-notification has been renamed to moodle-core-notification
460 * YUI2 code must now use 2in3, see http://yuilibrary.com/yui/docs/yui/yui-yui2.html
461 * M.util.init_select_autosubmit() and M.util.init_url_select() have been deprecated. Code using this should be updated
462   to use moodle-core-formautosubmit
464 Unit testing changes:
465 * output debugging() is not sent to standard output any more,
466   use $this->assertDebuggingCalled(), $this->assertDebuggingNotCalled(),
467   $this->getDebuggingMessages() or $this->assertResetDebugging() instead.
469 === 2.3 ===
471 Database layer changes:
472 * objects are not allowed in paramters of DML functions, use explicit casting to strings if necessary
474 Note:
475 * DDL and DML methods which were deprecated in 2.0 have now been removed, they will no longer produce
476 debug messages and will produce fatal errors
478 API changes:
480 * send_stored_file() has changed its interface
481 * deleted several resourcelib_embed_* functions from resourcelib.php
483 === 2.2 ===
485 removed unused libraries:
486 * odbc, base32, CodeSniffer, overlib, apd profiling, kses, Smarty, PEAR Console, swfobject, cssshover.htc, md5.js
488 API changes:
489 * new admin/tool plugin type
490 * new context API - old API is still available
491 * deleted users do not have context any more
492 * removed global search
495 === 2.1 ===
497 API changes:
498 * basic suport for restore from 1.9
499 * new mobile devices API
500 * new questions API
503 === 2.0 ===
505 API changes:
506 * new DML API - http://docs.moodle.org/dev/DML_functions
507 * new DDL API - http://docs.moodle.org/dev/DDL_functions
508 * new file API - http://docs.moodle.org/dev/File_API
509 * new $PAGE and $OUTPUT API
510 * new navigation API
511 * new theme API - http://docs.moodle.org/dev/Theme_changes_in_2.0
512 * new javascript API - http://docs.moodle.org/dev/JavaScript_usage_guide
513 * new portfolio API
514 * new local plugin type
515 * new translation support - http://lang.moodle.org
516 * new web service API
517 * new cohorts API
518 * new messaging API
519 * new rating API
520 * new comment API
521 * new sessions API
522 * new enrolment API
523 * new backup/restore API
524 * new blocks API
525 * new filters API
526 * improved plugin support (aka Frankenstyle)
527 * new registration and hub API
528 * new course completion API
529 * new plagiarism API
530 * changed blog API
531 * new text editor API
532 * new my moodle and profiles API