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

4
5
6
7
=== 3.2 ===

* Callback delete_course is deprecated and should be replaced with observer for event \core\event\course_content_deleted

8
9
10
11
=== 3.1 ===

* Old /mod/MODULENAME/pix/icon.gif and enrol/paypal/pix/icon.gif GIF icons have been removed. Please use pix_icon
  renderable instead.
12
13
* Callback get_types() is deprecated, instead activity modules can define callback get_shortcuts().
  See source code for get_module_metadata().
14

15
16
=== 3.0 ===

17
18
19
* Dropped support for the $module in mod/xxx/version.php files (deprecated
  since 2.7). All activity modules must use the $plugin syntax now. See
  https://docs.moodle.org/dev/version.php for details (MDL-43896).
20
21
* Modules using rating component must implement a callback mod_x_rating_can_see_item_ratings(). Refer
  to mod_forum_rating_can_see_item_ratings() for example.
22

23
=== 2.9 ===
24

25
* Added Grade to pass field to mod_form for activities that support grading.
26
27
28
29
* The method moodleform_mod::add_intro_editor() used in mod_form.php form
  definitions has been deprecated. Replace it with the new
  moodleform_mod::standard_intro_elements() method that takes the new site
  configuration requiremodintro into account (MDL-49101).
30

31
32
33
34
35
36
=== 2.8 ===

* Constant FEATURE_GROUPMEMBERSONLY is deprecated. Modules should remove this
  constant from their module_supports() API function.
* $CFG->enablegroupmembersonly no longer exists.

37
38
39
=== 2.7 ===

* modgrade form element has been redesigned and allows setting the maximum grade point higher than 100.
40
41
* The usage of $module in mod/xxx/version.php files is now deprecated. Please use
  $plugin instead. The support for the legacy notation will be dropped in Moodle 2.10.
42
43
* xxx_get_view_actions() and xxx_get_post_actions() will be ignored by new logging system for
  participation report. view_action and post_action will be detected by event's crud and edulevel.
44
45
46
47
* The functions xxx_user_outline() and xxx_user_complete() have been removed from the majority of core modules (see MDL-41286),
  except for those that require unique functionality. These functions are used by the outline report, but now if they no longer
  exist, the default behaviour is chosen, which supports the legacy and standard log storages introduced in 2.7 (see MDL-41266).
  It is highly recommended you remove these functions from your module if they are simply performing the default behaviour.
48

49
50
=== 2.6 ===

51
52
* Modules using the question bank MUST now declare their use of it with the xxx_supports()
  flag FEATURE_USES_QUESTIONS.
53
54
55
56
* xxx_get_types() module callback can now return subtypes that have
  a custom help text set. Also instead of array it can now return
  MOD_SUBTYPE_NO_CHILDREN. This is optional and still defaults to prior
  behavior. See get_module_metadata() in course/lib.php for details.
57
58
* shift_course_mod_dates() has been modified to accept optional mod instance id. If mod instance id is passed then
  dates changed will happen only on specific module instance and not on all instances of that module in course.
59

60
61
62
63
=== 2.5 ===

* support for 'mod/*' filters was removed

64
65
66
67
68
69
=== 2.4 ===

new features:

* mod/xxx/adminlib.php may now include 'plugininfo_yoursubplugintype' class definition
  used by plugin_manager; it is recommended to store extra admin settings classes in this file
70

71
72
73
optional - no changes needed:

* mod_lesson_renderer::header() now accepts an additional parameter $extrapagetitle
74

75
76
* mod/data/lib.php data_get_all_recordids() now has two new optional variables:  $selectdata and $params.

77
78
79
=== 2.3 ===

required changes in code:
80

81
82
* define the capability mod/xxx:addinstance (and the corresponding lang string)
  (unless your mod is a MOD_ARCHETYPE_SYSTEM).
83
84
85
* 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().
86

87
88
89
* most resourcelib_embed_* functions are replaced with core_media_renderer;
  for an example, see mod/resource/locallib.php, resource_display_embed()

90
91
92
93
94
optional - no changes needed:

* add support for handling course drag and drop types - functions
  xxx_dndupload_register() and xxx_dndupload_handle($uploadinfo) see:
  http://docs.moodle.org/dev/Implementing_Course_drag_and_drop_upload_support_in_a_module
95

96
97
98
99
100
=== 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
101
* core_text::asort() replaced by specialized core_collator::asort()
102
103
104
105
106
107
108
109
110
111
* 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
112

113
114
required changes in code:
* use new DML syntax everywhere
115
  (http://docs.moodle.org/dev/DML_functions)
116
* use new DDL syntax in db/upgrade.php
117
  (http://docs.moodle.org/dev/DDL_functions)
118
* replace defaults.php by settings.php and db/install.php
Petr Skoda's avatar
Petr Skoda committed
119
* replace STATEMENTS section in db/install.xml with PHP code db/install.php or db/log.php
Petr Skoda's avatar
Petr Skoda committed
120
* move post installation code from lib.php into db/install.php
121
* move uninstallation code from lib.php to db/uninstall.php
Petr Skoda's avatar
Petr Skoda committed
122
123
* new mandatory naming of intro and introformat table fields in module tables,
  the presence of these fields is indicated in xxx_plugin_supports()
124
* completely rewrite file handling
125
  (http://docs.moodle.org/dev/File_API)
126
* rewrite backup/restore
Petr Skoda's avatar
Petr Skoda committed
127
  (not finished yet)
Petr Skoda's avatar
Petr Skoda committed
128
129
* rewrite trusttext support - new db table columns needed
* migrate all module features from mod_edit.php form to lib.php/modulename_supports() function
130
* implement new gradebook support (legacy 1.8.x grading not supported anymore)
Petr Skoda's avatar
Petr Skoda committed
131
132
* migrate custom resource module subtypes into separate modules,
  necessary only for custom plugins in mod/resource/
133
* use new $PAGE and $OUTPUT instead of old weblib functions
134
135
136
* 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
137
                 old global $THEME is fully replaced by $OUTPUT
Petr Skoda's avatar
Petr Skoda committed
138
                 create plugin renderers
139
  (http://docs.moodle.org/dev/Theme_changes_in_2.0)
Petr Skoda's avatar
Petr Skoda committed
140
* migrate all javascript new coding style using YUI3+YUI2
141
  (http://docs.moodle.org/dev/JavaScript_usage_guide)
Petr Skoda's avatar
Petr Skoda committed
142
143
* remove '_utf8' from lang pack names, use new {a} syntax
* replace helps with new 'xxx_hlp' strings
Petr Skoda's avatar
Petr Skoda committed
144
* please note the $plugin->requires in version.php has to be bigger than 2010000000,
Petr Skoda's avatar
Petr Skoda committed
145
  otherwise the plugin is marked as outdated and upgrade is interrupted
146
147

optional - no changes needed in older code:
148
* 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
149
150
* support for new mforms editor element and embedded files
  (not finished yet)
151
* portfolio support
152
  (http://docs.moodle.org/dev/Portfolio_API)
153
* course completion tracking support
Petr Skoda's avatar
Petr Skoda committed
154
155
* new navigation features
* new comments API
156
  (http://docs.moodle.org/dev/Comments_2.0)
Petr Skoda's avatar
Petr Skoda committed
157
* new ratings API
158
  (http://docs.moodle.org/dev/Ratings_2.0)
159