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