weekly on-sync release 3.2dev
[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
88acc87d
DM
4=== 3.1 ===
5
6* Old /mod/MODULENAME/pix/icon.gif and enrol/paypal/pix/icon.gif GIF icons have been removed. Please use pix_icon
7 renderable instead.
9ca0420e
MG
8* Callback get_types() is deprecated, instead activity modules can define callback get_shortcuts().
9 See source code for get_module_metadata().
88acc87d 10
0b9fc18b
JL
11=== 3.0 ===
12
01889f01
DM
13* Dropped support for the $module in mod/xxx/version.php files (deprecated
14 since 2.7). All activity modules must use the $plugin syntax now. See
15 https://docs.moodle.org/dev/version.php for details (MDL-43896).
731c2712
AA
16* Modules using rating component must implement a callback mod_x_rating_can_see_item_ratings(). Refer
17 to mod_forum_rating_can_see_item_ratings() for example.
0b9fc18b 18
8164fad4 19=== 2.9 ===
f7a84c63 20
8164fad4 21* Added Grade to pass field to mod_form for activities that support grading.
f7a84c63
DM
22* The method moodleform_mod::add_intro_editor() used in mod_form.php form
23 definitions has been deprecated. Replace it with the new
24 moodleform_mod::standard_intro_elements() method that takes the new site
25 configuration requiremodintro into account (MDL-49101).
8164fad4 26
061e6b28 27=== 2.8 ===
28
29* Constant FEATURE_GROUPMEMBERSONLY is deprecated. Modules should remove this
30 constant from their module_supports() API function.
31* $CFG->enablegroupmembersonly no longer exists.
32
59766233
JM
33=== 2.7 ===
34
35* modgrade form element has been redesigned and allows setting the maximum grade point higher than 100.
09027084
DM
36* The usage of $module in mod/xxx/version.php files is now deprecated. Please use
37 $plugin instead. The support for the legacy notation will be dropped in Moodle 2.10.
b2b4ec30
RT
38* xxx_get_view_actions() and xxx_get_post_actions() will be ignored by new logging system for
39 participation report. view_action and post_action will be detected by event's crud and edulevel.
70279746
MN
40* The functions xxx_user_outline() and xxx_user_complete() have been removed from the majority of core modules (see MDL-41286),
41 except for those that require unique functionality. These functions are used by the outline report, but now if they no longer
42 exist, the default behaviour is chosen, which supports the legacy and standard log storages introduced in 2.7 (see MDL-41266).
43 It is highly recommended you remove these functions from your module if they are simply performing the default behaviour.
59766233 44
50ae8814
MN
45=== 2.6 ===
46
b07ef13b
DP
47* Modules using the question bank MUST now declare their use of it with the xxx_supports()
48 flag FEATURE_USES_QUESTIONS.
50ae8814
MN
49* xxx_get_types() module callback can now return subtypes that have
50 a custom help text set. Also instead of array it can now return
51 MOD_SUBTYPE_NO_CHILDREN. This is optional and still defaults to prior
52 behavior. See get_module_metadata() in course/lib.php for details.
fb032ccb
DP
53* shift_course_mod_dates() has been modified to accept optional mod instance id. If mod instance id is passed then
54 dates changed will happen only on specific module instance and not on all instances of that module in course.
9c82ff2a 55
0662bd67
PS
56=== 2.5 ===
57
58* support for 'mod/*' filters was removed
59
7d59d8da
PS
60=== 2.4 ===
61
62new features:
63
64* mod/xxx/adminlib.php may now include 'plugininfo_yoursubplugintype' class definition
65 used by plugin_manager; it is recommended to store extra admin settings classes in this file
76fb0443 66
27affa26
AA
67optional - no changes needed:
68
69* mod_lesson_renderer::header() now accepts an additional parameter $extrapagetitle
7d59d8da 70
76fb0443
AG
71* mod/data/lib.php data_get_all_recordids() now has two new optional variables: $selectdata and $params.
72
0f0c0228
TH
73=== 2.3 ===
74
75required changes in code:
daefd6eb 76
0f0c0228
TH
77* define the capability mod/xxx:addinstance (and the corresponding lang string)
78 (unless your mod is a MOD_ARCHETYPE_SYSTEM).
261cbbac
DM
79* xxx_pluginfile() is now given the 7th parameter (hopefully the last one) that
80 contains additional options for the file serving. The array should be re-passed
81 to send_stored_file().
0f0c0228 82
daefd6eb 83* most resourcelib_embed_* functions are replaced with core_media_renderer;
84 for an example, see mod/resource/locallib.php, resource_display_embed()
85
652cc648
DS
86optional - no changes needed:
87
88* add support for handling course drag and drop types - functions
89 xxx_dndupload_register() and xxx_dndupload_handle($uploadinfo) see:
90 http://docs.moodle.org/dev/Implementing_Course_drag_and_drop_upload_support_in_a_module
0f0c0228 91
ee362526
PS
92=== 2.2 ===
93
94required changes in code:
95* fix missing parameter types in optional_param() and required_param()
96* use new optional_param_array(), required_param_array() or clean_param_array() when dealing with array parameters
2f1e464a 97* core_text::asort() replaced by specialized core_collator::asort()
ee362526
PS
98* use new make_temp_directory() and make_cache_directory()
99
100
101=== 2.1 ===
102
103required changes in code:
104* add new support for basic restore from 1.9
105
106
107=== 2.0 ===
44f2977c 108
9c82ff2a 109required changes in code:
110* use new DML syntax everywhere
728ebac7 111 (http://docs.moodle.org/dev/DML_functions)
9c82ff2a 112* use new DDL syntax in db/upgrade.php
728ebac7 113 (http://docs.moodle.org/dev/DDL_functions)
9c82ff2a 114* replace defaults.php by settings.php and db/install.php
847400a7 115* replace STATEMENTS section in db/install.xml with PHP code db/install.php or db/log.php
9cb56578 116* move post installation code from lib.php into db/install.php
56f7ff74 117* move uninstallation code from lib.php to db/uninstall.php
8026a943
PS
118* new mandatory naming of intro and introformat table fields in module tables,
119 the presence of these fields is indicated in xxx_plugin_supports()
9c82ff2a 120* completely rewrite file handling
728ebac7 121 (http://docs.moodle.org/dev/File_API)
9c82ff2a 122* rewrite backup/restore
44f2977c 123 (not finished yet)
9cb56578
PS
124* rewrite trusttext support - new db table columns needed
125* migrate all module features from mod_edit.php form to lib.php/modulename_supports() function
398a160d 126* implement new gradebook support (legacy 1.8.x grading not supported anymore)
44f2977c
PS
127* migrate custom resource module subtypes into separate modules,
128 necessary only for custom plugins in mod/resource/
af34490a 129* use new $PAGE and $OUTPUT instead of old weblib functions
78946b9b
PS
130* theme changes: move plugin styles into mod/xxx/styles.css and use new css markers for images,
131 move all images into new mod/xxx/pix/ directory and use new outputlib api
132 move module icon to mod/xxx/pix/icon.gif
cbcc9852 133 old global $THEME is fully replaced by $OUTPUT
8026a943 134 create plugin renderers
728ebac7 135 (http://docs.moodle.org/dev/Theme_changes_in_2.0)
b7534190 136* migrate all javascript new coding style using YUI3+YUI2
728ebac7 137 (http://docs.moodle.org/dev/JavaScript_usage_guide)
2b0e098e
PS
138* remove '_utf8' from lang pack names, use new {a} syntax
139* replace helps with new 'xxx_hlp' strings
7070ca36 140* please note the $plugin->requires in version.php has to be bigger than 2010000000,
dae88219 141 otherwise the plugin is marked as outdated and upgrade is interrupted
9c82ff2a 142
143optional - no changes needed in older code:
dbf9e4ba 144* settingstree.php replaced by settings.php - just unset the $settings if you want to make custom part of settings admin tree
ff3ad2d9
PS
145* support for new mforms editor element and embedded files
146 (not finished yet)
9c82ff2a 147* portfolio support
728ebac7 148 (http://docs.moodle.org/dev/Portfolio_API)
9c82ff2a 149* course completion tracking support
8026a943
PS
150* new navigation features
151* new comments API
728ebac7 152 (http://docs.moodle.org/dev/Comments_2.0)
8026a943 153* new ratings API
728ebac7 154 (http://docs.moodle.org/dev/Ratings_2.0)
9c82ff2a 155