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