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