MDL-61876 mod_data: call format_text on template before replacement
[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
ef844148
MS
4=== 3.5 ===
5
6Required changes in code:
7* use new make_backup_temp_directory()
8
1678181a
MN
9=== 3.4 ===
10
11* Navigation between activities via a previous and next link was added to Boost, Clean and Bootstrapbase. This
12 was made possible by a new function core_renderer->activity_navigation(). However, there was an issue when linking
13 to the mod_resource and mod_url view.php pages where it would automatically download the file, or redirect to
14 the URL. It was noticed that this was not the case when editing the module and clicking 'Save and display' which would
15 take you to the pages without downloading the file or redirecting to a link. The reason this worked was because of the
16 hard-coded check 'if (strpos(get_local_referer(false), 'modedit.php') === false) {' in the view.php files. This check
17 has been removed in favour of an optional_param('forceview'). If you are using the above hard-coded check in your
18 plugin it is recommended to remove it and use the optional param as it will prevent the navigation from working as
19 expected.
20
dbc404de
JL
21=== 3.3 ===
22
59391e80
MN
23* External functions that were returning file information now return the following additional file fields:
24 - mimetype (the file mime type)
25 - isexternalfile (if is a file reference to a external repository)
26 - repositorytype (the repository name in case is a external file)
27 Those fields are VALUE_OPTIONAL for backwards compatibility.
28* The block_course_overview has been removed and the related core module *_print_overview functions have been deprecated.
29* The block_myoverview has replaced block_course_overview to provide better information to students. To support this,
30 actions can now be attached to calendar events. Documentation for the following new API callbacks introduced in
31 MDL-55611 can be found at https://docs.moodle.org/dev/Calendar_API. The 3 new callbacks are:
32 - mod_<modname>_core_calendar_is_event_visible
33 - mod_<modname>_core_calendar_provide_event_action
34 - mod_<modname>_core_calendar_event_action_show_items_acount
273d3106
JD
35* Changes to the moodleform_mod class and its usage (MDL-58138):
36 - the get_data() method has been overriden. The implementation calls parent::get_data() and a new data_postprocessing() method
37 - new data_postprocessing() method added. Mods can override this in their mod_form subclass to modify the submit data. Previously
38 mods could only modify submitted data by overriding get_data() in the mod_form subclass. data_postprocessing() is now the way to
39 do this correctly.
40 - completion: \core_completion\manager calls the overriden mod_x_mod_form->data_postprocessing() to allow mods to modify their
41 completion data before saving the bulk completion form. If you've overriden get_data() to modify submit data for completion in
42 the past, you should now override the data_postprocessing() method in your mod_form and move your code there, so bulk completion
43 editing will be properly supported for your plugin.
8fef061d
MG
44=== 3.2 ===
45
46* Callback delete_course is deprecated and should be replaced with observer for event \core\event\course_content_deleted
d3932d2b
JP
47* update_module_button() and core_renderer::update_module_button() have been deprecated and should not be used anymore.
48 Activity modules should not add the edit module button, the link is already available in the Administration block.
49 Themes can choose to display the link in the buttons row consistently for all module types.
02a73d76
JL
50* New callback check_updates_since available. Check if the module has any update that affects the current user since the given time.
51 Please refer to mod/assign/lib.php, mod/forum/lib.php or mod/quiz/lib.php for sample code.
8fef061d 52
88acc87d
DM
53=== 3.1 ===
54
55* Old /mod/MODULENAME/pix/icon.gif and enrol/paypal/pix/icon.gif GIF icons have been removed. Please use pix_icon
56 renderable instead.
9ca0420e
MG
57* Callback get_types() is deprecated, instead activity modules can define callback get_shortcuts().
58 See source code for get_module_metadata().
88acc87d 59
0b9fc18b
JL
60=== 3.0 ===
61
01889f01
DM
62* Dropped support for the $module in mod/xxx/version.php files (deprecated
63 since 2.7). All activity modules must use the $plugin syntax now. See
64 https://docs.moodle.org/dev/version.php for details (MDL-43896).
731c2712
AA
65* Modules using rating component must implement a callback mod_x_rating_can_see_item_ratings(). Refer
66 to mod_forum_rating_can_see_item_ratings() for example.
0b9fc18b 67
8164fad4 68=== 2.9 ===
f7a84c63 69
8164fad4 70* Added Grade to pass field to mod_form for activities that support grading.
f7a84c63
DM
71* The method moodleform_mod::add_intro_editor() used in mod_form.php form
72 definitions has been deprecated. Replace it with the new
73 moodleform_mod::standard_intro_elements() method that takes the new site
74 configuration requiremodintro into account (MDL-49101).
8164fad4 75
061e6b28 76=== 2.8 ===
77
78* Constant FEATURE_GROUPMEMBERSONLY is deprecated. Modules should remove this
79 constant from their module_supports() API function.
80* $CFG->enablegroupmembersonly no longer exists.
81
59766233
JM
82=== 2.7 ===
83
84* modgrade form element has been redesigned and allows setting the maximum grade point higher than 100.
09027084
DM
85* The usage of $module in mod/xxx/version.php files is now deprecated. Please use
86 $plugin instead. The support for the legacy notation will be dropped in Moodle 2.10.
b2b4ec30
RT
87* xxx_get_view_actions() and xxx_get_post_actions() will be ignored by new logging system for
88 participation report. view_action and post_action will be detected by event's crud and edulevel.
70279746
MN
89* The functions xxx_user_outline() and xxx_user_complete() have been removed from the majority of core modules (see MDL-41286),
90 except for those that require unique functionality. These functions are used by the outline report, but now if they no longer
91 exist, the default behaviour is chosen, which supports the legacy and standard log storages introduced in 2.7 (see MDL-41266).
92 It is highly recommended you remove these functions from your module if they are simply performing the default behaviour.
59766233 93
50ae8814
MN
94=== 2.6 ===
95
b07ef13b
DP
96* Modules using the question bank MUST now declare their use of it with the xxx_supports()
97 flag FEATURE_USES_QUESTIONS.
50ae8814
MN
98* xxx_get_types() module callback can now return subtypes that have
99 a custom help text set. Also instead of array it can now return
100 MOD_SUBTYPE_NO_CHILDREN. This is optional and still defaults to prior
101 behavior. See get_module_metadata() in course/lib.php for details.
fb032ccb
DP
102* shift_course_mod_dates() has been modified to accept optional mod instance id. If mod instance id is passed then
103 dates changed will happen only on specific module instance and not on all instances of that module in course.
9c82ff2a 104
0662bd67
PS
105=== 2.5 ===
106
107* support for 'mod/*' filters was removed
108
7d59d8da
PS
109=== 2.4 ===
110
111new features:
112
113* mod/xxx/adminlib.php may now include 'plugininfo_yoursubplugintype' class definition
114 used by plugin_manager; it is recommended to store extra admin settings classes in this file
76fb0443 115
27affa26
AA
116optional - no changes needed:
117
118* mod_lesson_renderer::header() now accepts an additional parameter $extrapagetitle
7d59d8da 119
76fb0443
AG
120* mod/data/lib.php data_get_all_recordids() now has two new optional variables: $selectdata and $params.
121
0f0c0228
TH
122=== 2.3 ===
123
124required changes in code:
daefd6eb 125
0f0c0228
TH
126* define the capability mod/xxx:addinstance (and the corresponding lang string)
127 (unless your mod is a MOD_ARCHETYPE_SYSTEM).
261cbbac
DM
128* xxx_pluginfile() is now given the 7th parameter (hopefully the last one) that
129 contains additional options for the file serving. The array should be re-passed
130 to send_stored_file().
0f0c0228 131
daefd6eb 132* most resourcelib_embed_* functions are replaced with core_media_renderer;
133 for an example, see mod/resource/locallib.php, resource_display_embed()
134
652cc648
DS
135optional - no changes needed:
136
137* add support for handling course drag and drop types - functions
138 xxx_dndupload_register() and xxx_dndupload_handle($uploadinfo) see:
139 http://docs.moodle.org/dev/Implementing_Course_drag_and_drop_upload_support_in_a_module
0f0c0228 140
ee362526
PS
141=== 2.2 ===
142
143required changes in code:
144* fix missing parameter types in optional_param() and required_param()
145* use new optional_param_array(), required_param_array() or clean_param_array() when dealing with array parameters
2f1e464a 146* core_text::asort() replaced by specialized core_collator::asort()
ee362526
PS
147* use new make_temp_directory() and make_cache_directory()
148
149
150=== 2.1 ===
151
152required changes in code:
153* add new support for basic restore from 1.9
154
155
156=== 2.0 ===
44f2977c 157
9c82ff2a 158required changes in code:
159* use new DML syntax everywhere
728ebac7 160 (http://docs.moodle.org/dev/DML_functions)
9c82ff2a 161* use new DDL syntax in db/upgrade.php
728ebac7 162 (http://docs.moodle.org/dev/DDL_functions)
9c82ff2a 163* replace defaults.php by settings.php and db/install.php
847400a7 164* replace STATEMENTS section in db/install.xml with PHP code db/install.php or db/log.php
9cb56578 165* move post installation code from lib.php into db/install.php
56f7ff74 166* move uninstallation code from lib.php to db/uninstall.php
8026a943
PS
167* new mandatory naming of intro and introformat table fields in module tables,
168 the presence of these fields is indicated in xxx_plugin_supports()
9c82ff2a 169* completely rewrite file handling
728ebac7 170 (http://docs.moodle.org/dev/File_API)
9c82ff2a 171* rewrite backup/restore
44f2977c 172 (not finished yet)
9cb56578
PS
173* rewrite trusttext support - new db table columns needed
174* migrate all module features from mod_edit.php form to lib.php/modulename_supports() function
398a160d 175* implement new gradebook support (legacy 1.8.x grading not supported anymore)
44f2977c
PS
176* migrate custom resource module subtypes into separate modules,
177 necessary only for custom plugins in mod/resource/
af34490a 178* use new $PAGE and $OUTPUT instead of old weblib functions
78946b9b
PS
179* theme changes: move plugin styles into mod/xxx/styles.css and use new css markers for images,
180 move all images into new mod/xxx/pix/ directory and use new outputlib api
181 move module icon to mod/xxx/pix/icon.gif
cbcc9852 182 old global $THEME is fully replaced by $OUTPUT
8026a943 183 create plugin renderers
728ebac7 184 (http://docs.moodle.org/dev/Theme_changes_in_2.0)
b7534190 185* migrate all javascript new coding style using YUI3+YUI2
728ebac7 186 (http://docs.moodle.org/dev/JavaScript_usage_guide)
2b0e098e
PS
187* remove '_utf8' from lang pack names, use new {a} syntax
188* replace helps with new 'xxx_hlp' strings
7070ca36 189* please note the $plugin->requires in version.php has to be bigger than 2010000000,
dae88219 190 otherwise the plugin is marked as outdated and upgrade is interrupted
9c82ff2a 191
192optional - no changes needed in older code:
dbf9e4ba 193* settingstree.php replaced by settings.php - just unset the $settings if you want to make custom part of settings admin tree
ff3ad2d9
PS
194* support for new mforms editor element and embedded files
195 (not finished yet)
9c82ff2a 196* portfolio support
728ebac7 197 (http://docs.moodle.org/dev/Portfolio_API)
9c82ff2a 198* course completion tracking support
8026a943
PS
199* new navigation features
200* new comments API
728ebac7 201 (http://docs.moodle.org/dev/Comments_2.0)
8026a943 202* new ratings API
728ebac7 203 (http://docs.moodle.org/dev/Ratings_2.0)
9c82ff2a 204