Merge branch 'MDL-62277-master' of git://
[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.5 ===
6 * There is a new privacy API that every subsystem and plugin has to implement so that the site can become GDPR
7   compliant. Activity modules use this API to report what information they store or process regarding users, and provide
8   ability to export and delete personal data. See for guidelines on how to
9   implement the privacy API in your activity module.
10 * Backup directory now can be outside of temp directory. Use make_backup_temp_directory($name) instead of
11   make_temp_directory('/backup/'.$name)
12 * Modules that provide their own interactive content and call cm_info::set_content() from [MODULENAME]_cm_info_view()
13   callback should format all user input and call set_content() with parameter $isformatted=true . Otherwise
14   scripts will be cleaned on the course page in case of $CFG->forceclean=1. See example in mod_folder.
16 === 3.4 ===
18 * Navigation between activities via a previous and next link was added to Boost, Clean and Bootstrapbase. This
19   was made possible by a new function core_renderer->activity_navigation(). However, there was an issue when linking
20   to the mod_resource and mod_url view.php pages where it would automatically download the file, or redirect to
21   the URL. It was noticed that this was not the case when editing the module and clicking 'Save and display' which would
22   take you to the pages without downloading the file or redirecting to a link. The reason this worked was because of the
23   hard-coded check 'if (strpos(get_local_referer(false), 'modedit.php') === false) {' in the view.php files. This check
24   has been removed in favour of an optional_param('forceview'). If you are using the above hard-coded check in your
25   plugin it is recommended to remove it and use the optional param as it will prevent the navigation from working as
26   expected.
28 === 3.3 ===
30 * External functions that were returning file information now return the following additional file fields:
31   - mimetype (the file mime type)
32   - isexternalfile (if is a file reference to a external repository)
33   - repositorytype (the repository name in case is a external file)
34   Those fields are VALUE_OPTIONAL for backwards compatibility.
35 * The block_course_overview has been removed and the related core module *_print_overview functions have been deprecated.
36 * The block_myoverview has replaced block_course_overview to provide better information to students. To support this,
37   actions can now be attached to calendar events. Documentation for the following new API callbacks introduced in
38   MDL-55611 can be found at The 3 new callbacks are:
39   - mod_<modname>_core_calendar_is_event_visible
40   - mod_<modname>_core_calendar_provide_event_action
41   - mod_<modname>_core_calendar_event_action_show_items_acount
42 * Changes to the moodleform_mod class and its usage (MDL-58138):
43   - the get_data() method has been overriden. The implementation calls parent::get_data() and a new data_postprocessing() method
44   - new data_postprocessing() method added. Mods can override this in their mod_form subclass to modify the submit data. Previously
45     mods could only modify submitted data by overriding get_data() in the mod_form subclass. data_postprocessing() is now the way to
46     do this correctly.
47   - completion: \core_completion\manager calls the overriden mod_x_mod_form->data_postprocessing() to allow mods to modify their
48     completion data before saving the bulk completion form. If you've overriden get_data() to modify submit data for completion in
49     the past, you should now override the data_postprocessing() method in your mod_form and move your code there, so bulk completion
50     editing will be properly supported for your plugin.
51 === 3.2 ===
53 * Callback delete_course is deprecated and should be replaced with observer for event \core\event\course_content_deleted
54 * update_module_button() and core_renderer::update_module_button() have been deprecated and should not be used anymore.
55   Activity modules should not add the edit module button, the link is already available in the Administration block.
56   Themes can choose to display the link in the buttons row consistently for all module types.
57 * New callback check_updates_since available. Check if the module has any update that affects the current user since the given time.
58   Please refer to mod/assign/lib.php, mod/forum/lib.php or mod/quiz/lib.php for sample code.
60 === 3.1 ===
62 * Old /mod/MODULENAME/pix/icon.gif and enrol/paypal/pix/icon.gif GIF icons have been removed. Please use pix_icon
63   renderable instead.
64 * Callback get_types() is deprecated, instead activity modules can define callback get_shortcuts().
65   See source code for get_module_metadata().
67 === 3.0 ===
69 * Dropped support for the $module in mod/xxx/version.php files (deprecated
70   since 2.7). All activity modules must use the $plugin syntax now. See
71 for details (MDL-43896).
72 * Modules using rating component must implement a callback mod_x_rating_can_see_item_ratings(). Refer
73   to mod_forum_rating_can_see_item_ratings() for example.
75 === 2.9 ===
77 * Added Grade to pass field to mod_form for activities that support grading.
78 * The method moodleform_mod::add_intro_editor() used in mod_form.php form
79   definitions has been deprecated. Replace it with the new
80   moodleform_mod::standard_intro_elements() method that takes the new site
81   configuration requiremodintro into account (MDL-49101).
83 === 2.8 ===
85 * Constant FEATURE_GROUPMEMBERSONLY is deprecated. Modules should remove this
86   constant from their module_supports() API function.
87 * $CFG->enablegroupmembersonly no longer exists.
89 === 2.7 ===
91 * modgrade form element has been redesigned and allows setting the maximum grade point higher than 100.
92 * The usage of $module in mod/xxx/version.php files is now deprecated. Please use
93   $plugin instead. The support for the legacy notation will be dropped in Moodle 2.10.
94 * xxx_get_view_actions() and xxx_get_post_actions() will be ignored by new logging system for
95   participation report. view_action and post_action will be detected by event's crud and edulevel.
96 * The functions xxx_user_outline() and xxx_user_complete() have been removed from the majority of core modules (see MDL-41286),
97   except for those that require unique functionality. These functions are used by the outline report, but now if they no longer
98   exist, the default behaviour is chosen, which supports the legacy and standard log storages introduced in 2.7 (see MDL-41266).
99   It is highly recommended you remove these functions from your module if they are simply performing the default behaviour.
101 === 2.6 ===
103 * Modules using the question bank MUST now declare their use of it with the xxx_supports()
105 * xxx_get_types() module callback can now return subtypes that have
106   a custom help text set. Also instead of array it can now return
107   MOD_SUBTYPE_NO_CHILDREN. This is optional and still defaults to prior
108   behavior. See get_module_metadata() in course/lib.php for details.
109 * shift_course_mod_dates() has been modified to accept optional mod instance id. If mod instance id is passed then
110   dates changed will happen only on specific module instance and not on all instances of that module in course.
112 === 2.5 ===
114 * support for 'mod/*' filters was removed
116 === 2.4 ===
118 new features:
120 * mod/xxx/adminlib.php may now include 'plugininfo_yoursubplugintype' class definition
121   used by plugin_manager; it is recommended to store extra admin settings classes in this file
123 optional - no changes needed:
125 * mod_lesson_renderer::header() now accepts an additional parameter $extrapagetitle
127 * mod/data/lib.php data_get_all_recordids() now has two new optional variables:  $selectdata and $params.
129 === 2.3 ===
131 required changes in code:
133 * define the capability mod/xxx:addinstance (and the corresponding lang string)
134   (unless your mod is a MOD_ARCHETYPE_SYSTEM).
135 * xxx_pluginfile() is now given the 7th parameter (hopefully the last one) that
136   contains additional options for the file serving. The array should be re-passed
137   to send_stored_file().
139 * most resourcelib_embed_* functions are replaced with core_media_renderer;
140   for an example, see mod/resource/locallib.php, resource_display_embed()
142 optional - no changes needed:
144 * add support for handling course drag and drop types - functions
145   xxx_dndupload_register() and xxx_dndupload_handle($uploadinfo) see:
148 === 2.2 ===
150 required changes in code:
151 * fix missing parameter types in optional_param() and required_param()
152 * use new optional_param_array(), required_param_array() or clean_param_array() when dealing with array parameters
153 * core_text::asort() replaced by specialized core_collator::asort()
154 * use new make_temp_directory() and make_cache_directory()
157 === 2.1 ===
159 required changes in code:
160 * add new support for basic restore from 1.9
163 === 2.0 ===
165 required changes in code:
166 * use new DML syntax everywhere
167   (
168 * use new DDL syntax in db/upgrade.php
169   (
170 * replace defaults.php by settings.php and db/install.php
171 * replace STATEMENTS section in db/install.xml with PHP code db/install.php or db/log.php
172 * move post installation code from lib.php into db/install.php
173 * move uninstallation code from lib.php to db/uninstall.php
174 * new mandatory naming of intro and introformat table fields in module tables,
175   the presence of these fields is indicated in xxx_plugin_supports()
176 * completely rewrite file handling
177   (
178 * rewrite backup/restore
179   (not finished yet)
180 * rewrite trusttext support - new db table columns needed
181 * migrate all module features from mod_edit.php form to lib.php/modulename_supports() function
182 * implement new gradebook support (legacy 1.8.x grading not supported anymore)
183 * migrate custom resource module subtypes into separate modules,
184   necessary only for custom plugins in mod/resource/
185 * use new $PAGE and $OUTPUT instead of old weblib functions
186 * theme changes: move plugin styles into mod/xxx/styles.css and use new css markers for images,
187                  move all images into new mod/xxx/pix/ directory and use new outputlib api
188                  move module icon to mod/xxx/pix/icon.gif
189                  old global $THEME is fully replaced by $OUTPUT
190                  create plugin renderers
191   (
192 * migrate all javascript new coding style using YUI3+YUI2
193   (
194 * remove '_utf8' from lang pack names, use new {a} syntax
195 * replace helps with new 'xxx_hlp' strings
196 * please note the $plugin->requires in version.php has to be bigger than 2010000000,
197   otherwise the plugin is marked as outdated and upgrade is interrupted
199 optional - no changes needed in older code:
200 * settingstree.php replaced by settings.php - just unset the $settings if you want to make custom part of settings admin tree
201 * support for new mforms editor element and embedded files
202   (not finished yet)
203 * portfolio support
204   (
205 * course completion tracking support
206 * new navigation features
207 * new comments API
208   (
209 * new ratings API
210   (