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