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