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