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