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