[moodle.git] / mod / upgrade.txt
1 This files describes API changes in /mod/* - activity modules,
2 information provided here is intended especially for developers.
4 === 4.1 ===
6 * The callback get_shortcuts() is now removed. Please use get_course_content_items and get_all_content_items instead.
8 === 4.0 ===
9 * A new API function introduced to handle custom completion logic. Refer to completion/upgrade.txt for additional information.
10 * Modules that extend the settings navigation via '_extend_settings_navigation()' should use the get_page() method from
11   the settings_navigation class in order to obtain the correct moodle_page information associated to the given settings
12   navigation. After the recent changes to the navigation in single activity courses, using the global $PAGE may result
13   in returning inaccurate data in this course format, therefore it is advisable to use $settingsnavigation->get_page().
14 * A new style of icons has been created for activities. When creating an icon in the new style it should be named
15   'monologo' and can site alongside the legacy icon if desired. Only the new logo types will be used.
16 * There is a new callback ..._calculate_question_stats which needs to be implemented by components which want
17   to contribute statistics to the display in the question bank. There is an example implementation in mod_quiz.
18   (Added in 4.0.4 / 4.1.)
20 === 3.9 ===
22 * The callback get_shortcuts() is now deprecated. Please use get_course_content_items and get_all_content_items instead.
23   See source code examples in get_course_content_items() and get_all_content_items() in mod/lti/lib.php for details.
24 * When creating the calendar events and setting the event description to match the module intro description, the filters
25   must not be applied on the passed description text. Doing so leads to loosing some expected text filters features and
26   causes unnecessarily early theme and output initialisation in unit tests. If your activity creates calendar events,
27   you probably have code like:
28     ```
29     $event->description = format_module_intro('quiz', $quiz, $cmid);
30     ```
31   You need to change it to:
32     ```
33     $event->description = format_module_intro('quiz', $quiz, $cmid, false);
34     $event->format = FORMAT_HTML;
35     ```
36   Even this is still technically wrong. Content should normally only be formatted just before it is output. Ideally, we
37   should pass the raw description text, format and have a way to copy the embedded files; or provide another way for the
38   calendar to call the right format_text() later. The calendar API does not allow us to do these things easily at the
39   moment. Therefore, this compromise approach is used. The false parameter added ensures that text filters are not run
40   at this time which is important. And the format must be set to HTML, because otherwise it would use the current user's
41   preferred editor default format.
42 * Related to the above and to help with detecting the problematic places in contributed 3rd party modules, the
43   testing_module_generator::create_instance() now throws coding_exception if creating a module instance initialised the
44   theme and output as a side effect.
46 === 3.8 ===
48 * The final deprecation of xxx_print_overview() callback means that this function will no longer be called.
49 * Activities which define multiple grade items must now describe the mapping of the gradeitem's itemnumber to a
50   meaningful name in a class implementing \core_grades\local\gradeitem\itemnumber_mapping located in
51   \mod_name\grades\gradeitems (located in mod/[mod_name]/classes/grades/gradeitems.php).
53 === 3.6 ===
55 * The final deprecation of xxx_get_types() callback means that this function will no longer be called.
56   Please use get_shortcuts() instead.
57 * lti_get_shortcuts has been deprecated. Please use get_shortcuts() instead to add items to the activity chooser.
58 * Now, when mod_<modname>_core_calendar_is_event_visible or mod_<modname>_core_calendar_provide_event_action callback functions
59   are called, the userid of the requesting user is also passed to them.
60 * The following functions have been finally deprecated and can not be used anymore:
61     - update_module_button()
62 * The final deprecation of xxx_delete_course callback means that this function will no longer be called.
63   Please use the observer for event \core\event\course_content_deleted instead.
65 === 3.5 ===
67 * There is a new privacy API that every subsystem and plugin has to implement so that the site can become GDPR
68   compliant. Activity modules use this API to report what information they store or process regarding users, and provide
69   ability to export and delete personal data. See https://docs.moodle.org/dev/Privacy_API for guidelines on how to
70   implement the privacy API in your activity module.
71 * Backup directory now can be outside of temp directory. Use make_backup_temp_directory($name) instead of
72   make_temp_directory('/backup/'.$name)
73 * Modules that provide their own interactive content and call cm_info::set_content() from [MODULENAME]_cm_info_view()
74   callback should format all user input and call set_content() with parameter $isformatted=true . Otherwise
75   scripts will be cleaned on the course page in case of $CFG->forceclean=1. See example in mod_folder.
77 === 3.4 ===
79 * Navigation between activities via a previous and next link was added to Boost, Clean and Bootstrapbase. This
80   was made possible by a new function core_renderer->activity_navigation(). However, there was an issue when linking
81   to the mod_resource and mod_url view.php pages where it would automatically download the file, or redirect to
82   the URL. It was noticed that this was not the case when editing the module and clicking 'Save and display' which would
83   take you to the pages without downloading the file or redirecting to a link. The reason this worked was because of the
84   hard-coded check 'if (strpos(get_local_referer(false), 'modedit.php') === false) {' in the view.php files. This check
85   has been removed in favour of an optional_param('forceview'). If you are using the above hard-coded check in your
86   plugin it is recommended to remove it and use the optional param as it will prevent the navigation from working as
87   expected.
89 === 3.3 ===
91 * External functions that were returning file information now return the following additional file fields:
92   - mimetype (the file mime type)
93   - isexternalfile (if is a file reference to a external repository)
94   - repositorytype (the repository name in case is a external file)
95   Those fields are VALUE_OPTIONAL for backwards compatibility.
96 * The block_course_overview has been removed and the related core module
97 *_print_overview functions have been deprecated.
98 * The block_myoverview has replaced block_course_overview to provide better information to students. To support this,
99   actions can now be attached to calendar events. Documentation for the following new API callbacks introduced in
100   MDL-55611 can be found at https://docs.moodle.org/dev/Calendar_API. The 3 new callbacks are:
101   - mod_<modname>_core_calendar_is_event_visible
102   - mod_<modname>_core_calendar_provide_event_action
103   - mod_<modname>_core_calendar_event_action_shows_item_count
104 * Changes to the moodleform_mod class and its usage (MDL-58138):
105   - the get_data() method has been overriden. The implementation calls parent::get_data() and a new data_postprocessing() method
106   - new data_postprocessing() method added. Mods can override this in their mod_form subclass to modify the submit data. Previously
107     mods could only modify submitted data by overriding get_data() in the mod_form subclass. data_postprocessing() is now the way to
108     do this correctly.
109   - completion: \core_completion\manager calls the overriden mod_x_mod_form->data_postprocessing() to allow mods to modify their
110     completion data before saving the bulk completion form. If you've overriden get_data() to modify submit data for completion in
111     the past, you should now override the data_postprocessing() method in your mod_form and move your code there, so bulk completion
112     editing will be properly supported for your plugin.
113 === 3.2 ===
115 * Callback delete_course is deprecated and should be replaced with observer for event \core\event\course_content_deleted
116 * update_module_button() and core_renderer::update_module_button() have been deprecated and should not be used anymore.
117   Activity modules should not add the edit module button, the link is already available in the Administration block.
118   Themes can choose to display the link in the buttons row consistently for all module types.
119 * New callback check_updates_since available. Check if the module has any update that affects the current user since the given time.
120   Please refer to mod/assign/lib.php, mod/forum/lib.php or mod/quiz/lib.php for sample code.
122 === 3.1 ===
124 * Old /mod/MODULENAME/pix/icon.gif and enrol/paypal/pix/icon.gif GIF icons have been removed. Please use pix_icon
125   renderable instead.
126 * Callback get_types() is deprecated, instead activity modules can define callback get_shortcuts().
127   See source code for get_module_metadata().
129 === 3.0 ===
131 * Dropped support for the $module in mod/xxx/version.php files (deprecated
132   since 2.7). All activity modules must use the $plugin syntax now. See
133   https://docs.moodle.org/dev/version.php for details (MDL-43896).
134 * Modules using rating component must implement a callback mod_x_rating_can_see_item_ratings(). Refer
135   to mod_forum_rating_can_see_item_ratings() for example.
137 === 2.9 ===
139 * Added Grade to pass field to mod_form for activities that support grading.
140 * The method moodleform_mod::add_intro_editor() used in mod_form.php form
141   definitions has been deprecated. Replace it with the new
142   moodleform_mod::standard_intro_elements() method that takes the new site
143   configuration requiremodintro into account (MDL-49101).
145 === 2.8 ===
147 * Constant FEATURE_GROUPMEMBERSONLY is deprecated. Modules should remove this
148   constant from their module_supports() API function.
149 * $CFG->enablegroupmembersonly no longer exists.
151 === 2.7 ===
153 * modgrade form element has been redesigned and allows setting the maximum grade point higher than 100.
154 * The usage of $module in mod/xxx/version.php files is now deprecated. Please use
155   $plugin instead. The support for the legacy notation will be dropped in Moodle 2.10.
156 * xxx_get_view_actions() and xxx_get_post_actions() will be ignored by new logging system for
157   participation report. view_action and post_action will be detected by event's crud and edulevel.
158 * The functions xxx_user_outline() and xxx_user_complete() have been removed from the majority of core modules (see MDL-41286),
159   except for those that require unique functionality. These functions are used by the outline report, but now if they no longer
160   exist, the default behaviour is chosen, which supports the legacy and standard log storages introduced in 2.7 (see MDL-41266).
161   It is highly recommended you remove these functions from your module if they are simply performing the default behaviour.
163 === 2.6 ===
165 * Modules using the question bank MUST now declare their use of it with the xxx_supports()
167 * xxx_get_types() module callback can now return subtypes that have
168   a custom help text set. Also instead of array it can now return
169   MOD_SUBTYPE_NO_CHILDREN. This is optional and still defaults to prior
170   behavior. See get_module_metadata() in course/lib.php for details.
171 * shift_course_mod_dates() has been modified to accept optional mod instance id. If mod instance id is passed then
172   dates changed will happen only on specific module instance and not on all instances of that module in course.
174 === 2.5 ===
176 * support for 'mod/*' filters was removed
178 === 2.4 ===
180 new features:
182 * mod/xxx/adminlib.php may now include 'plugininfo_yoursubplugintype' class definition
183   used by plugin_manager; it is recommended to store extra admin settings classes in this file
185 optional - no changes needed:
187 * mod_lesson_renderer::header() now accepts an additional parameter $extrapagetitle
189 * mod/data/lib.php data_get_all_recordids() now has two new optional variables:  $selectdata and $params.
191 === 2.3 ===
193 required changes in code:
195 * define the capability mod/xxx:addinstance (and the corresponding lang string)
196   (unless your mod is a MOD_ARCHETYPE_SYSTEM).
197 * xxx_pluginfile() is now given the 7th parameter (hopefully the last one) that
198   contains additional options for the file serving. The array should be re-passed
199   to send_stored_file().
201 * most resourcelib_embed_* functions are replaced with core_media_renderer;
202   for an example, see mod/resource/locallib.php, resource_display_embed()
204 optional - no changes needed:
206 * add support for handling course drag and drop types - functions
207   xxx_dndupload_register() and xxx_dndupload_handle($uploadinfo) see:
208   http://docs.moodle.org/dev/Implementing_Course_drag_and_drop_upload_support_in_a_module
210 === 2.2 ===
212 required changes in code:
213 * fix missing parameter types in optional_param() and required_param()
214 * use new optional_param_array(), required_param_array() or clean_param_array() when dealing with array parameters
215 * core_text::asort() replaced by specialized core_collator::asort()
216 * use new make_temp_directory() and make_cache_directory()
219 === 2.1 ===
221 required changes in code:
222 * add new support for basic restore from 1.9
225 === 2.0 ===
227 required changes in code:
228 * use new DML syntax everywhere
229   (http://docs.moodle.org/dev/DML_functions)
230 * use new DDL syntax in db/upgrade.php
231   (http://docs.moodle.org/dev/DDL_functions)
232 * replace defaults.php by settings.php and db/install.php
233 * replace STATEMENTS section in db/install.xml with PHP code db/install.php or db/log.php
234 * move post installation code from lib.php into db/install.php
235 * move uninstallation code from lib.php to db/uninstall.php
236 * new mandatory naming of intro and introformat table fields in module tables,
237   the presence of these fields is indicated in xxx_plugin_supports()
238 * completely rewrite file handling
239   (http://docs.moodle.org/dev/File_API)
240 * rewrite backup/restore
241   (not finished yet)
242 * rewrite trusttext support - new db table columns needed
243 * migrate all module features from mod_edit.php form to lib.php/modulename_supports() function
244 * implement new gradebook support (legacy 1.8.x grading not supported anymore)
245 * migrate custom resource module subtypes into separate modules,
246   necessary only for custom plugins in mod/resource/
247 * use new $PAGE and $OUTPUT instead of old weblib functions
248 * theme changes: move plugin styles into mod/xxx/styles.css and use new css markers for images,
249                  move all images into new mod/xxx/pix/ directory and use new outputlib api
250                  move module icon to mod/xxx/pix/icon.gif
251                  old global $THEME is fully replaced by $OUTPUT
252                  create plugin renderers
253   (http://docs.moodle.org/dev/Theme_changes_in_2.0)
254 * migrate all javascript new coding style using YUI3+YUI2
255   (http://docs.moodle.org/dev/JavaScript_usage_guide)
256 * remove '_utf8' from lang pack names, use new {a} syntax
257 * replace helps with new 'xxx_hlp' strings
258 * please note the $plugin->requires in version.php has to be bigger than 2010000000,
259   otherwise the plugin is marked as outdated and upgrade is interrupted
261 optional - no changes needed in older code:
262 * settingstree.php replaced by settings.php - just unset the $settings if you want to make custom part of settings admin tree
263 * support for new mforms editor element and embedded files
264   (not finished yet)
265 * portfolio support
266   (http://docs.moodle.org/dev/Portfolio_API)
267 * course completion tracking support
268 * new navigation features
269 * new comments API
270   (http://docs.moodle.org/dev/Comments_2.0)
271 * new ratings API
272   (http://docs.moodle.org/dev/Ratings_2.0)