1 This files describes API changes in /mod/* - activity modules,
2 information provided here is intended especially for developers.
6 * Modules using rating component must implement a callback mod_x_rating_can_see_item_ratings(). Refer
7 to mod_forum_rating_can_see_item_ratings() for example.
11 * Added Grade to pass field to mod_form for activities that support grading.
12 * The method moodleform_mod::add_intro_editor() used in mod_form.php form
13 definitions has been deprecated. Replace it with the new
14 moodleform_mod::standard_intro_elements() method that takes the new site
15 configuration requiremodintro into account (MDL-49101).
19 * Constant FEATURE_GROUPMEMBERSONLY is deprecated. Modules should remove this
20 constant from their module_supports() API function.
21 * $CFG->enablegroupmembersonly no longer exists.
25 * modgrade form element has been redesigned and allows setting the maximum grade point higher than 100.
26 * The usage of $module in mod/xxx/version.php files is now deprecated. Please use
27 $plugin instead. The support for the legacy notation will be dropped in Moodle 2.10.
28 * xxx_get_view_actions() and xxx_get_post_actions() will be ignored by new logging system for
29 participation report. view_action and post_action will be detected by event's crud and edulevel.
30 * The functions xxx_user_outline() and xxx_user_complete() have been removed from the majority of core modules (see MDL-41286),
31 except for those that require unique functionality. These functions are used by the outline report, but now if they no longer
32 exist, the default behaviour is chosen, which supports the legacy and standard log storages introduced in 2.7 (see MDL-41266).
33 It is highly recommended you remove these functions from your module if they are simply performing the default behaviour.
37 * Modules using the question bank MUST now declare their use of it with the xxx_supports()
38 flag FEATURE_USES_QUESTIONS.
39 * xxx_get_types() module callback can now return subtypes that have
40 a custom help text set. Also instead of array it can now return
41 MOD_SUBTYPE_NO_CHILDREN. This is optional and still defaults to prior
42 behavior. See get_module_metadata() in course/lib.php for details.
43 * shift_course_mod_dates() has been modified to accept optional mod instance id. If mod instance id is passed then
44 dates changed will happen only on specific module instance and not on all instances of that module in course.
48 * support for 'mod/*' filters was removed
54 * mod/xxx/adminlib.php may now include 'plugininfo_yoursubplugintype' class definition
55 used by plugin_manager; it is recommended to store extra admin settings classes in this file
57 optional - no changes needed:
59 * mod_lesson_renderer::header() now accepts an additional parameter $extrapagetitle
61 * mod/data/lib.php data_get_all_recordids() now has two new optional variables: $selectdata and $params.
65 required changes in code:
67 * define the capability mod/xxx:addinstance (and the corresponding lang string)
68 (unless your mod is a MOD_ARCHETYPE_SYSTEM).
69 * xxx_pluginfile() is now given the 7th parameter (hopefully the last one) that
70 contains additional options for the file serving. The array should be re-passed
71 to send_stored_file().
73 * most resourcelib_embed_* functions are replaced with core_media_renderer;
74 for an example, see mod/resource/locallib.php, resource_display_embed()
76 optional - no changes needed:
78 * add support for handling course drag and drop types - functions
79 xxx_dndupload_register() and xxx_dndupload_handle($uploadinfo) see:
80 http://docs.moodle.org/dev/Implementing_Course_drag_and_drop_upload_support_in_a_module
84 required changes in code:
85 * fix missing parameter types in optional_param() and required_param()
86 * use new optional_param_array(), required_param_array() or clean_param_array() when dealing with array parameters
87 * core_text::asort() replaced by specialized core_collator::asort()
88 * use new make_temp_directory() and make_cache_directory()
93 required changes in code:
94 * add new support for basic restore from 1.9
99 required changes in code:
100 * use new DML syntax everywhere
101 (http://docs.moodle.org/dev/DML_functions)
102 * use new DDL syntax in db/upgrade.php
103 (http://docs.moodle.org/dev/DDL_functions)
104 * replace defaults.php by settings.php and db/install.php
105 * replace STATEMENTS section in db/install.xml with PHP code db/install.php or db/log.php
106 * move post installation code from lib.php into db/install.php
107 * move uninstallation code from lib.php to db/uninstall.php
108 * new mandatory naming of intro and introformat table fields in module tables,
109 the presence of these fields is indicated in xxx_plugin_supports()
110 * completely rewrite file handling
111 (http://docs.moodle.org/dev/File_API)
112 * rewrite backup/restore
114 * rewrite trusttext support - new db table columns needed
115 * migrate all module features from mod_edit.php form to lib.php/modulename_supports() function
116 * implement new gradebook support (legacy 1.8.x grading not supported anymore)
117 * migrate custom resource module subtypes into separate modules,
118 necessary only for custom plugins in mod/resource/
119 * use new $PAGE and $OUTPUT instead of old weblib functions
120 * theme changes: move plugin styles into mod/xxx/styles.css and use new css markers for images,
121 move all images into new mod/xxx/pix/ directory and use new outputlib api
122 move module icon to mod/xxx/pix/icon.gif
123 old global $THEME is fully replaced by $OUTPUT
124 create plugin renderers
125 (http://docs.moodle.org/dev/Theme_changes_in_2.0)
126 * migrate all javascript new coding style using YUI3+YUI2
127 (http://docs.moodle.org/dev/JavaScript_usage_guide)
128 * remove '_utf8' from lang pack names, use new {a} syntax
129 * replace helps with new 'xxx_hlp' strings
130 * please note the $plugin->requires in version.php has to be bigger than 2010000000,
131 otherwise the plugin is marked as outdated and upgrade is interrupted
133 optional - no changes needed in older code:
134 * settingstree.php replaced by settings.php - just unset the $settings if you want to make custom part of settings admin tree
135 * support for new mforms editor element and embedded files
138 (http://docs.moodle.org/dev/Portfolio_API)
139 * course completion tracking support
140 * new navigation features
142 (http://docs.moodle.org/dev/Comments_2.0)
144 (http://docs.moodle.org/dev/Ratings_2.0)