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