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