MDL-31873 added mod_assign_get_grades web service function
[moodle.git] / mod / upgrade.txt
1 This files describes API changes in /mod/* - activity modules,
2 information provided here is intended especially for developers.
5 === 2.4 ===
7 new features:
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   
12 optional - no changes needed:
14 * mod_lesson_renderer::header() now accepts an additional parameter $extrapagetitle
16 === 2.3 ===
18 required changes in code:
20 * define the capability mod/xxx:addinstance (and the corresponding lang string)
21   (unless your mod is a MOD_ARCHETYPE_SYSTEM).
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().
26 * most resourcelib_embed_* functions are replaced with core_media_renderer;
27   for an example, see mod/resource/locallib.php, resource_display_embed()
29 optional - no changes needed:
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
35 === 2.2 ===
37 required 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()
44 === 2.1 ===
46 required changes in code:
47 * add new support for basic restore from 1.9
50 === 2.0 ===
52 required changes in code:
53 * use new DML syntax everywhere
54   (http://docs.moodle.org/dev/DML_functions)
55 * use new DDL syntax in db/upgrade.php
56   (http://docs.moodle.org/dev/DDL_functions)
57 * replace defaults.php by settings.php and db/install.php
58 * replace STATEMENTS section in db/install.xml with PHP code db/install.php or db/log.php
59 * move post installation code from lib.php into db/install.php
60 * move uninstallation code from lib.php to db/uninstall.php
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()
63 * completely rewrite file handling
64   (http://docs.moodle.org/dev/File_API)
65 * rewrite backup/restore
66   (not finished yet)
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
69 * implement new gradebook support (legacy 1.8.x grading not supported anymore)
70 * migrate custom resource module subtypes into separate modules,
71   necessary only for custom plugins in mod/resource/
72 * use new $PAGE and $OUTPUT instead of old weblib functions
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
76                  old global $THEME is fully replaced by $OUTPUT
77                  create plugin renderers
78   (http://docs.moodle.org/dev/Theme_changes_in_2.0)
79 * migrate all javascript new coding style using YUI3+YUI2
80   (http://docs.moodle.org/dev/JavaScript_usage_guide)
81 * remove '_utf8' from lang pack names, use new {a} syntax
82 * replace helps with new 'xxx_hlp' strings
83 * please note the $plugin->requires in version.php has to be bigger than 2010000000,
84   otherwise the plugin is marked as outdated and upgrade is interrupted
86 optional - no changes needed in older code:
87 * settingstree.php replaced by settings.php - just unset the $settings if you want to make custom part of settings admin tree
88 * support for new mforms editor element and embedded files
89   (not finished yet)
90 * portfolio support
91   (http://docs.moodle.org/dev/Portfolio_API)
92 * course completion tracking support
93 * new navigation features
94 * new comments API
95   (http://docs.moodle.org/dev/Comments_2.0)
96 * new ratings API
97   (http://docs.moodle.org/dev/Ratings_2.0)