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