MDL-58399 webservice: Add missing upgrade.txt information
[moodle.git] / mod / upgrade.txt
1 This files describes API changes in /mod/* - activity modules,
2 information provided here is intended especially for developers.
4 === 3.3 ===
6  * External functions that were returning file information now return the following additional file fields:
7    - mimetype (the file mime type)
8    - isexternalfile (if is a file reference to a external repository)
9    - repositorytype (the repository name in case is a external file)
10    Those fields are VALUE_OPTIONAL for backwards compatibility.
12 === 3.2 ===
14 * Callback delete_course is deprecated and should be replaced with observer for event \core\event\course_content_deleted
15 * update_module_button() and core_renderer::update_module_button() have been deprecated and should not be used anymore.
16   Activity modules should not add the edit module button, the link is already available in the Administration block.
17   Themes can choose to display the link in the buttons row consistently for all module types.
18 * New callback check_updates_since available. Check if the module has any update that affects the current user since the given time.
19   Please refer to mod/assign/lib.php, mod/forum/lib.php or mod/quiz/lib.php for sample code.
21 === 3.1 ===
23 * Old /mod/MODULENAME/pix/icon.gif and enrol/paypal/pix/icon.gif GIF icons have been removed. Please use pix_icon
24   renderable instead.
25 * Callback get_types() is deprecated, instead activity modules can define callback get_shortcuts().
26   See source code for get_module_metadata().
28 === 3.0 ===
30 * Dropped support for the $module in mod/xxx/version.php files (deprecated
31   since 2.7). All activity modules must use the $plugin syntax now. See
32   https://docs.moodle.org/dev/version.php for details (MDL-43896).
33 * Modules using rating component must implement a callback mod_x_rating_can_see_item_ratings(). Refer
34   to mod_forum_rating_can_see_item_ratings() for example.
36 === 2.9 ===
38 * Added Grade to pass field to mod_form for activities that support grading.
39 * The method moodleform_mod::add_intro_editor() used in mod_form.php form
40   definitions has been deprecated. Replace it with the new
41   moodleform_mod::standard_intro_elements() method that takes the new site
42   configuration requiremodintro into account (MDL-49101).
44 === 2.8 ===
46 * Constant FEATURE_GROUPMEMBERSONLY is deprecated. Modules should remove this
47   constant from their module_supports() API function.
48 * $CFG->enablegroupmembersonly no longer exists.
50 === 2.7 ===
52 * modgrade form element has been redesigned and allows setting the maximum grade point higher than 100.
53 * The usage of $module in mod/xxx/version.php files is now deprecated. Please use
54   $plugin instead. The support for the legacy notation will be dropped in Moodle 2.10.
55 * xxx_get_view_actions() and xxx_get_post_actions() will be ignored by new logging system for
56   participation report. view_action and post_action will be detected by event's crud and edulevel.
57 * The functions xxx_user_outline() and xxx_user_complete() have been removed from the majority of core modules (see MDL-41286),
58   except for those that require unique functionality. These functions are used by the outline report, but now if they no longer
59   exist, the default behaviour is chosen, which supports the legacy and standard log storages introduced in 2.7 (see MDL-41266).
60   It is highly recommended you remove these functions from your module if they are simply performing the default behaviour.
62 === 2.6 ===
64 * Modules using the question bank MUST now declare their use of it with the xxx_supports()
65   flag FEATURE_USES_QUESTIONS.
66 * xxx_get_types() module callback can now return subtypes that have
67   a custom help text set. Also instead of array it can now return
68   MOD_SUBTYPE_NO_CHILDREN. This is optional and still defaults to prior
69   behavior. See get_module_metadata() in course/lib.php for details.
70 * shift_course_mod_dates() has been modified to accept optional mod instance id. If mod instance id is passed then
71   dates changed will happen only on specific module instance and not on all instances of that module in course.
73 === 2.5 ===
75 * support for 'mod/*' filters was removed
77 === 2.4 ===
79 new features:
81 * mod/xxx/adminlib.php may now include 'plugininfo_yoursubplugintype' class definition
82   used by plugin_manager; it is recommended to store extra admin settings classes in this file
84 optional - no changes needed:
86 * mod_lesson_renderer::header() now accepts an additional parameter $extrapagetitle
88 * mod/data/lib.php data_get_all_recordids() now has two new optional variables:  $selectdata and $params.
90 === 2.3 ===
92 required changes in code:
94 * define the capability mod/xxx:addinstance (and the corresponding lang string)
95   (unless your mod is a MOD_ARCHETYPE_SYSTEM).
96 * xxx_pluginfile() is now given the 7th parameter (hopefully the last one) that
97   contains additional options for the file serving. The array should be re-passed
98   to send_stored_file().
100 * most resourcelib_embed_* functions are replaced with core_media_renderer;
101   for an example, see mod/resource/locallib.php, resource_display_embed()
103 optional - no changes needed:
105 * add support for handling course drag and drop types - functions
106   xxx_dndupload_register() and xxx_dndupload_handle($uploadinfo) see:
107   http://docs.moodle.org/dev/Implementing_Course_drag_and_drop_upload_support_in_a_module
109 === 2.2 ===
111 required changes in code:
112 * fix missing parameter types in optional_param() and required_param()
113 * use new optional_param_array(), required_param_array() or clean_param_array() when dealing with array parameters
114 * core_text::asort() replaced by specialized core_collator::asort()
115 * use new make_temp_directory() and make_cache_directory()
118 === 2.1 ===
120 required changes in code:
121 * add new support for basic restore from 1.9
124 === 2.0 ===
126 required changes in code:
127 * use new DML syntax everywhere
128   (http://docs.moodle.org/dev/DML_functions)
129 * use new DDL syntax in db/upgrade.php
130   (http://docs.moodle.org/dev/DDL_functions)
131 * replace defaults.php by settings.php and db/install.php
132 * replace STATEMENTS section in db/install.xml with PHP code db/install.php or db/log.php
133 * move post installation code from lib.php into db/install.php
134 * move uninstallation code from lib.php to db/uninstall.php
135 * new mandatory naming of intro and introformat table fields in module tables,
136   the presence of these fields is indicated in xxx_plugin_supports()
137 * completely rewrite file handling
138   (http://docs.moodle.org/dev/File_API)
139 * rewrite backup/restore
140   (not finished yet)
141 * rewrite trusttext support - new db table columns needed
142 * migrate all module features from mod_edit.php form to lib.php/modulename_supports() function
143 * implement new gradebook support (legacy 1.8.x grading not supported anymore)
144 * migrate custom resource module subtypes into separate modules,
145   necessary only for custom plugins in mod/resource/
146 * use new $PAGE and $OUTPUT instead of old weblib functions
147 * theme changes: move plugin styles into mod/xxx/styles.css and use new css markers for images,
148                  move all images into new mod/xxx/pix/ directory and use new outputlib api
149                  move module icon to mod/xxx/pix/icon.gif
150                  old global $THEME is fully replaced by $OUTPUT
151                  create plugin renderers
152   (http://docs.moodle.org/dev/Theme_changes_in_2.0)
153 * migrate all javascript new coding style using YUI3+YUI2
154   (http://docs.moodle.org/dev/JavaScript_usage_guide)
155 * remove '_utf8' from lang pack names, use new {a} syntax
156 * replace helps with new 'xxx_hlp' strings
157 * please note the $plugin->requires in version.php has to be bigger than 2010000000,
158   otherwise the plugin is marked as outdated and upgrade is interrupted
160 optional - no changes needed in older code:
161 * settingstree.php replaced by settings.php - just unset the $settings if you want to make custom part of settings admin tree
162 * support for new mforms editor element and embedded files
163   (not finished yet)
164 * portfolio support
165   (http://docs.moodle.org/dev/Portfolio_API)
166 * course completion tracking support
167 * new navigation features
168 * new comments API
169   (http://docs.moodle.org/dev/Comments_2.0)
170 * new ratings API
171   (http://docs.moodle.org/dev/Ratings_2.0)