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