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