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