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