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