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