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