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