MDL-34954 prevent false IDE code inspection errors
[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
9c82ff2a 4
0f0c0228
TH
5=== 2.3 ===
6
7required changes in code:
daefd6eb 8
0f0c0228
TH
9* define the capability mod/xxx:addinstance (and the corresponding lang string)
10 (unless your mod is a MOD_ARCHETYPE_SYSTEM).
261cbbac
DM
11* xxx_pluginfile() is now given the 7th parameter (hopefully the last one) that
12 contains additional options for the file serving. The array should be re-passed
13 to send_stored_file().
0f0c0228 14
daefd6eb 15* most resourcelib_embed_* functions are replaced with core_media_renderer;
16 for an example, see mod/resource/locallib.php, resource_display_embed()
17
652cc648
DS
18optional - no changes needed:
19
20* add support for handling course drag and drop types - functions
21 xxx_dndupload_register() and xxx_dndupload_handle($uploadinfo) see:
22 http://docs.moodle.org/dev/Implementing_Course_drag_and_drop_upload_support_in_a_module
0f0c0228 23
ee362526
PS
24=== 2.2 ===
25
26required changes in code:
27* fix missing parameter types in optional_param() and required_param()
28* use new optional_param_array(), required_param_array() or clean_param_array() when dealing with array parameters
29* textlib->asort() replaced by specialized collatorlib::asort()
30* use new make_temp_directory() and make_cache_directory()
31
32
33=== 2.1 ===
34
35required changes in code:
36* add new support for basic restore from 1.9
37
38
39=== 2.0 ===
44f2977c 40
9c82ff2a 41required changes in code:
42* use new DML syntax everywhere
728ebac7 43 (http://docs.moodle.org/dev/DML_functions)
9c82ff2a 44* use new DDL syntax in db/upgrade.php
728ebac7 45 (http://docs.moodle.org/dev/DDL_functions)
9c82ff2a 46* replace defaults.php by settings.php and db/install.php
847400a7 47* replace STATEMENTS section in db/install.xml with PHP code db/install.php or db/log.php
9cb56578 48* move post installation code from lib.php into db/install.php
56f7ff74 49* move uninstallation code from lib.php to db/uninstall.php
8026a943
PS
50* new mandatory naming of intro and introformat table fields in module tables,
51 the presence of these fields is indicated in xxx_plugin_supports()
9c82ff2a 52* completely rewrite file handling
728ebac7 53 (http://docs.moodle.org/dev/File_API)
9c82ff2a 54* rewrite backup/restore
44f2977c 55 (not finished yet)
9cb56578
PS
56* rewrite trusttext support - new db table columns needed
57* migrate all module features from mod_edit.php form to lib.php/modulename_supports() function
398a160d 58* implement new gradebook support (legacy 1.8.x grading not supported anymore)
44f2977c
PS
59* migrate custom resource module subtypes into separate modules,
60 necessary only for custom plugins in mod/resource/
af34490a 61* use new $PAGE and $OUTPUT instead of old weblib functions
78946b9b
PS
62* theme changes: move plugin styles into mod/xxx/styles.css and use new css markers for images,
63 move all images into new mod/xxx/pix/ directory and use new outputlib api
64 move module icon to mod/xxx/pix/icon.gif
cbcc9852 65 old global $THEME is fully replaced by $OUTPUT
8026a943 66 create plugin renderers
728ebac7 67 (http://docs.moodle.org/dev/Theme_changes_in_2.0)
b7534190 68* migrate all javascript new coding style using YUI3+YUI2
728ebac7 69 (http://docs.moodle.org/dev/JavaScript_usage_guide)
2b0e098e
PS
70* remove '_utf8' from lang pack names, use new {a} syntax
71* replace helps with new 'xxx_hlp' strings
7070ca36 72* please note the $plugin->requires in version.php has to be bigger than 2010000000,
dae88219 73 otherwise the plugin is marked as outdated and upgrade is interrupted
9c82ff2a 74
75optional - no changes needed in older code:
dbf9e4ba 76* settingstree.php replaced by settings.php - just unset the $settings if you want to make custom part of settings admin tree
ff3ad2d9
PS
77* support for new mforms editor element and embedded files
78 (not finished yet)
9c82ff2a 79* portfolio support
728ebac7 80 (http://docs.moodle.org/dev/Portfolio_API)
9c82ff2a 81* course completion tracking support
8026a943
PS
82* new navigation features
83* new comments API
728ebac7 84 (http://docs.moodle.org/dev/Comments_2.0)
8026a943 85* new ratings API
728ebac7 86 (http://docs.moodle.org/dev/Ratings_2.0)
9c82ff2a 87