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