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