upgrade.txt 3.42 KB
Newer Older
1
2
3
4
This files describes API changes in /mod/* - activity modules,
information provided here is intended especially for developers.


5
6
7
=== 2.3 ===

required changes in code:
8

9
10
* define the capability mod/xxx:addinstance (and the corresponding lang string)
  (unless your mod is a MOD_ARCHETYPE_SYSTEM).
11
12
13
* xxx_pluginfile() is now given the 7th parameter (hopefully the last one) that
  contains additional options for the file serving. The array should be re-passed
  to send_stored_file().
14

15
16
17
* most resourcelib_embed_* functions are replaced with core_media_renderer;
  for an example, see mod/resource/locallib.php, resource_display_embed()

18

19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
=== 2.2 ===

required changes in code:
* fix missing parameter types in optional_param() and required_param()
* use new optional_param_array(), required_param_array() or clean_param_array() when dealing with array parameters
* textlib->asort() replaced by specialized collatorlib::asort()
* use new make_temp_directory() and make_cache_directory()


=== 2.1 ===

required changes in code:
* add new support for basic restore from 1.9


=== 2.0 ===
Petr Skoda's avatar
Petr Skoda committed
35

36
37
required changes in code:
* use new DML syntax everywhere
38
  (http://docs.moodle.org/dev/DML_functions)
39
* use new DDL syntax in db/upgrade.php
40
  (http://docs.moodle.org/dev/DDL_functions)
41
* replace defaults.php by settings.php and db/install.php
Petr Skoda's avatar
Petr Skoda committed
42
* replace STATEMENTS section in db/install.xml with PHP code db/install.php or db/log.php
Petr Skoda's avatar
Petr Skoda committed
43
* move post installation code from lib.php into db/install.php
44
* move uninstallation code from lib.php to db/uninstall.php
Petr Skoda's avatar
Petr Skoda committed
45
46
* new mandatory naming of intro and introformat table fields in module tables,
  the presence of these fields is indicated in xxx_plugin_supports()
47
* completely rewrite file handling
48
  (http://docs.moodle.org/dev/File_API)
49
* rewrite backup/restore
Petr Skoda's avatar
Petr Skoda committed
50
  (not finished yet)
Petr Skoda's avatar
Petr Skoda committed
51
52
* rewrite trusttext support - new db table columns needed
* migrate all module features from mod_edit.php form to lib.php/modulename_supports() function
53
* implement new gradebook support (legacy 1.8.x grading not supported anymore)
Petr Skoda's avatar
Petr Skoda committed
54
55
* migrate custom resource module subtypes into separate modules,
  necessary only for custom plugins in mod/resource/
56
* use new $PAGE and $OUTPUT instead of old weblib functions
57
58
59
* theme changes: move plugin styles into mod/xxx/styles.css and use new css markers for images,
                 move all images into new mod/xxx/pix/ directory and use new outputlib api
                 move module icon to mod/xxx/pix/icon.gif
60
                 old global $THEME is fully replaced by $OUTPUT
Petr Skoda's avatar
Petr Skoda committed
61
                 create plugin renderers
62
  (http://docs.moodle.org/dev/Theme_changes_in_2.0)
Petr Skoda's avatar
Petr Skoda committed
63
* migrate all javascript new coding style using YUI3+YUI2
64
  (http://docs.moodle.org/dev/JavaScript_usage_guide)
Petr Skoda's avatar
Petr Skoda committed
65
66
* remove '_utf8' from lang pack names, use new {a} syntax
* replace helps with new 'xxx_hlp' strings
Petr Skoda's avatar
Petr Skoda committed
67
* please note the $plugin->requires in version.php has to be bigger than 2010000000,
Petr Skoda's avatar
Petr Skoda committed
68
  otherwise the plugin is marked as outdated and upgrade is interrupted
69
70

optional - no changes needed in older code:
71
* settingstree.php replaced by settings.php - just unset the $settings if you want to make custom part of settings admin tree
Petr Skoda's avatar
Petr Skoda committed
72
73
* support for new mforms editor element and embedded files
  (not finished yet)
74
* portfolio support
75
  (http://docs.moodle.org/dev/Portfolio_API)
76
* course completion tracking support
Petr Skoda's avatar
Petr Skoda committed
77
78
* new navigation features
* new comments API
79
  (http://docs.moodle.org/dev/Comments_2.0)
Petr Skoda's avatar
Petr Skoda committed
80
* new ratings API
81
  (http://docs.moodle.org/dev/Ratings_2.0)
82