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