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