mod/upgrade.txt

   1 This files describes API changes in /mod/* - activity modules,
   2 information provided here is intended especially for developers.
   3
   4 === 4.0 ===
   5 * A new API function introduced to handle custom completion logic. Refer to completion/upgrade.txt for additional information.
   6 * Modules that extend the settings navigation via '_extend_settings_navigation()' should use the get_page() method from
   7   the settings_navigation class in order to obtain the correct moodle_page information associated to the given settings
   8   navigation. After the recent changes to the navigation in single activity courses, using the global $PAGE may result
   9   in returning inaccurate data in this course format, therefore it is advisable to use $settingsnavigation->get_page().
  10 * A new style of icons has been created for activities. When creating an icon in the new style it should be named
  11   'monologo' and can site alongside the legacy icon if desired. Only the new logo types will be used.
  12
  13 === 3.9 ===
  14
  15 * The callback get_shortcuts() is now deprecated. Please use get_course_content_items and get_all_content_items instead.
  16   See source code examples in get_course_content_items() and get_all_content_items() in mod/lti/lib.php for details.
  17 * When creating the calendar events and setting the event description to match the module intro description, the filters
  18   must not be applied on the passed description text. Doing so leads to loosing some expected text filters features and
  19   causes unnecessarily early theme and output initialisation in unit tests. If your activity creates calendar events,
  20   you probably have code like:
  21     ```
  22     $event->description = format_module_intro('quiz', $quiz, $cmid);
  23     ```
  24   You need to change it to:
  25     ```
  26     $event->description = format_module_intro('quiz', $quiz, $cmid, false);
  27     $event->format = FORMAT_HTML;
  28     ```
  29   Even this is still technically wrong. Content should normally only be formatted just before it is output. Ideally, we
  30   should pass the raw description text, format and have a way to copy the embedded files; or provide another way for the
  31   calendar to call the right format_text() later. The calendar API does not allow us to do these things easily at the
  32   moment. Therefore, this compromise approach is used. The false parameter added ensures that text filters are not run
  33   at this time which is important. And the format must be set to HTML, because otherwise it would use the current user's
  34   preferred editor default format.
  35 * Related to the above and to help with detecting the problematic places in contributed 3rd party modules, the
  36   testing_module_generator::create_instance() now throws coding_exception if creating a module instance initialised the
  37   theme and output as a side effect.
  38
  39 === 3.8 ===
  40
  41 * The final deprecation of xxx_print_overview() callback means that this function will no longer be called.
  42 * Activities which define multiple grade items must now describe the mapping of the gradeitem's itemnumber to a
  43   meaningful name in a class implementing \core_grades\local\gradeitem\itemnumber_mapping located in
  44   \mod_name\grades\gradeitems (located in mod/[mod_name]/classes/grades/gradeitems.php).
  45
  46 === 3.6 ===
  47
  48 * The final deprecation of xxx_get_types() callback means that this function will no longer be called.
  49   Please use get_shortcuts() instead.
  50 * lti_get_shortcuts has been deprecated. Please use get_shortcuts() instead to add items to the activity chooser.
  51 * Now, when mod_<modname>_core_calendar_is_event_visible or mod_<modname>_core_calendar_provide_event_action callback functions
  52   are called, the userid of the requesting user is also passed to them.
  53 * The following functions have been finally deprecated and can not be used anymore:
  54     - update_module_button()
  55 * The final deprecation of xxx_delete_course callback means that this function will no longer be called.
  56   Please use the observer for event \core\event\course_content_deleted instead.
  57
  58 === 3.5 ===
  59
  60 * There is a new privacy API that every subsystem and plugin has to implement so that the site can become GDPR
  61   compliant. Activity modules use this API to report what information they store or process regarding users, and provide
  62   ability to export and delete personal data. See https://docs.moodle.org/dev/Privacy_API for guidelines on how to
  63   implement the privacy API in your activity module.
  64 * Backup directory now can be outside of temp directory. Use make_backup_temp_directory($name) instead of
  65   make_temp_directory('/backup/'.$name)
  66 * Modules that provide their own interactive content and call cm_info::set_content() from [MODULENAME]_cm_info_view()
  67   callback should format all user input and call set_content() with parameter $isformatted=true . Otherwise
  68   scripts will be cleaned on the course page in case of $CFG->forceclean=1. See example in mod_folder.
  69
  70 === 3.4 ===
  71
  72 * Navigation between activities via a previous and next link was added to Boost, Clean and Bootstrapbase. This
  73   was made possible by a new function core_renderer->activity_navigation(). However, there was an issue when linking
  74   to the mod_resource and mod_url view.php pages where it would automatically download the file, or redirect to
  75   the URL. It was noticed that this was not the case when editing the module and clicking 'Save and display' which would
  76   take you to the pages without downloading the file or redirecting to a link. The reason this worked was because of the
  77   hard-coded check 'if (strpos(get_local_referer(false), 'modedit.php') === false) {' in the view.php files. This check
  78   has been removed in favour of an optional_param('forceview'). If you are using the above hard-coded check in your
  79   plugin it is recommended to remove it and use the optional param as it will prevent the navigation from working as
  80   expected.
  81
  82 === 3.3 ===
  83
  84 * External functions that were returning file information now return the following additional file fields:
  85   - mimetype (the file mime type)
  86   - isexternalfile (if is a file reference to a external repository)
  87   - repositorytype (the repository name in case is a external file)
  88   Those fields are VALUE_OPTIONAL for backwards compatibility.
  89 * The block_course_overview has been removed and the related core module
  90 *_print_overview functions have been deprecated.
  91 * The block_myoverview has replaced block_course_overview to provide better information to students. To support this,
  92   actions can now be attached to calendar events. Documentation for the following new API callbacks introduced in
  93   MDL-55611 can be found at https://docs.moodle.org/dev/Calendar_API. The 3 new callbacks are:
  94   - mod_<modname>_core_calendar_is_event_visible
  95   - mod_<modname>_core_calendar_provide_event_action
  96   - mod_<modname>_core_calendar_event_action_shows_item_count
  97 * Changes to the moodleform_mod class and its usage (MDL-58138):
  98   - the get_data() method has been overriden. The implementation calls parent::get_data() and a new data_postprocessing() method
  99   - new data_postprocessing() method added. Mods can override this in their mod_form subclass to modify the submit data. Previously
 100     mods could only modify submitted data by overriding get_data() in the mod_form subclass. data_postprocessing() is now the way to
 101     do this correctly.
 102   - completion: \core_completion\manager calls the overriden mod_x_mod_form->data_postprocessing() to allow mods to modify their
 103     completion data before saving the bulk completion form. If you've overriden get_data() to modify submit data for completion in
 104     the past, you should now override the data_postprocessing() method in your mod_form and move your code there, so bulk completion
 105     editing will be properly supported for your plugin.
 106 === 3.2 ===
 107
 108 * Callback delete_course is deprecated and should be replaced with observer for event \core\event\course_content_deleted
 109 * update_module_button() and core_renderer::update_module_button() have been deprecated and should not be used anymore.
 110   Activity modules should not add the edit module button, the link is already available in the Administration block.
 111   Themes can choose to display the link in the buttons row consistently for all module types.
 112 * New callback check_updates_since available. Check if the module has any update that affects the current user since the given time.
 113   Please refer to mod/assign/lib.php, mod/forum/lib.php or mod/quiz/lib.php for sample code.
 114
 115 === 3.1 ===
 116
 117 * Old /mod/MODULENAME/pix/icon.gif and enrol/paypal/pix/icon.gif GIF icons have been removed. Please use pix_icon
 118   renderable instead.
 119 * Callback get_types() is deprecated, instead activity modules can define callback get_shortcuts().
 120   See source code for get_module_metadata().
 121
 122 === 3.0 ===
 123
 124 * Dropped support for the $module in mod/xxx/version.php files (deprecated
 125   since 2.7). All activity modules must use the $plugin syntax now. See
 126   https://docs.moodle.org/dev/version.php for details (MDL-43896).
 127 * Modules using rating component must implement a callback mod_x_rating_can_see_item_ratings(). Refer
 128   to mod_forum_rating_can_see_item_ratings() for example.
 129
 130 === 2.9 ===
 131
 132 * Added Grade to pass field to mod_form for activities that support grading.
 133 * The method moodleform_mod::add_intro_editor() used in mod_form.php form
 134   definitions has been deprecated. Replace it with the new
 135   moodleform_mod::standard_intro_elements() method that takes the new site
 136   configuration requiremodintro into account (MDL-49101).
 137
 138 === 2.8 ===
 139
 140 * Constant FEATURE_GROUPMEMBERSONLY is deprecated. Modules should remove this
 141   constant from their module_supports() API function.
 142 * $CFG->enablegroupmembersonly no longer exists.
 143
 144 === 2.7 ===
 145
 146 * modgrade form element has been redesigned and allows setting the maximum grade point higher than 100.
 147 * The usage of $module in mod/xxx/version.php files is now deprecated. Please use
 148   $plugin instead. The support for the legacy notation will be dropped in Moodle 2.10.
 149 * xxx_get_view_actions() and xxx_get_post_actions() will be ignored by new logging system for
 150   participation report. view_action and post_action will be detected by event's crud and edulevel.
 151 * The functions xxx_user_outline() and xxx_user_complete() have been removed from the majority of core modules (see MDL-41286),
 152   except for those that require unique functionality. These functions are used by the outline report, but now if they no longer
 153   exist, the default behaviour is chosen, which supports the legacy and standard log storages introduced in 2.7 (see MDL-41266).
 154   It is highly recommended you remove these functions from your module if they are simply performing the default behaviour.
 155
 156 === 2.6 ===
 157
 158 * Modules using the question bank MUST now declare their use of it with the xxx_supports()
 159   flag FEATURE_USES_QUESTIONS.
 160 * xxx_get_types() module callback can now return subtypes that have
 161   a custom help text set. Also instead of array it can now return
 162   MOD_SUBTYPE_NO_CHILDREN. This is optional and still defaults to prior
 163   behavior. See get_module_metadata() in course/lib.php for details.
 164 * shift_course_mod_dates() has been modified to accept optional mod instance id. If mod instance id is passed then
 165   dates changed will happen only on specific module instance and not on all instances of that module in course.
 166
 167 === 2.5 ===
 168
 169 * support for 'mod/*' filters was removed
 170
 171 === 2.4 ===
 172
 173 new features:
 174
 175 * mod/xxx/adminlib.php may now include 'plugininfo_yoursubplugintype' class definition
 176   used by plugin_manager; it is recommended to store extra admin settings classes in this file
 177
 178 optional - no changes needed:
 179
 180 * mod_lesson_renderer::header() now accepts an additional parameter $extrapagetitle
 181
 182 * mod/data/lib.php data_get_all_recordids() now has two new optional variables:  $selectdata and $params.
 183
 184 === 2.3 ===
 185
 186 required changes in code:
 187
 188 * define the capability mod/xxx:addinstance (and the corresponding lang string)
 189   (unless your mod is a MOD_ARCHETYPE_SYSTEM).
 190 * xxx_pluginfile() is now given the 7th parameter (hopefully the last one) that
 191   contains additional options for the file serving. The array should be re-passed
 192   to send_stored_file().
 193
 194 * most resourcelib_embed_* functions are replaced with core_media_renderer;
 195   for an example, see mod/resource/locallib.php, resource_display_embed()
 196
 197 optional - no changes needed:
 198
 199 * add support for handling course drag and drop types - functions
 200   xxx_dndupload_register() and xxx_dndupload_handle($uploadinfo) see:
 201   http://docs.moodle.org/dev/Implementing_Course_drag_and_drop_upload_support_in_a_module
 202
 203 === 2.2 ===
 204
 205 required changes in code:
 206 * fix missing parameter types in optional_param() and required_param()
 207 * use new optional_param_array(), required_param_array() or clean_param_array() when dealing with array parameters
 208 * core_text::asort() replaced by specialized core_collator::asort()
 209 * use new make_temp_directory() and make_cache_directory()
 210
 211
 212 === 2.1 ===
 213
 214 required changes in code:
 215 * add new support for basic restore from 1.9
 216
 217
 218 === 2.0 ===
 219
 220 required changes in code:
 221 * use new DML syntax everywhere
 222   (http://docs.moodle.org/dev/DML_functions)
 223 * use new DDL syntax in db/upgrade.php
 224   (http://docs.moodle.org/dev/DDL_functions)
 225 * replace defaults.php by settings.php and db/install.php
 226 * replace STATEMENTS section in db/install.xml with PHP code db/install.php or db/log.php
 227 * move post installation code from lib.php into db/install.php
 228 * move uninstallation code from lib.php to db/uninstall.php
 229 * new mandatory naming of intro and introformat table fields in module tables,
 230   the presence of these fields is indicated in xxx_plugin_supports()
 231 * completely rewrite file handling
 232   (http://docs.moodle.org/dev/File_API)
 233 * rewrite backup/restore
 234   (not finished yet)
 235 * rewrite trusttext support - new db table columns needed
 236 * migrate all module features from mod_edit.php form to lib.php/modulename_supports() function
 237 * implement new gradebook support (legacy 1.8.x grading not supported anymore)
 238 * migrate custom resource module subtypes into separate modules,
 239   necessary only for custom plugins in mod/resource/
 240 * use new $PAGE and $OUTPUT instead of old weblib functions
 241 * theme changes: move plugin styles into mod/xxx/styles.css and use new css markers for images,
 242                  move all images into new mod/xxx/pix/ directory and use new outputlib api
 243                  move module icon to mod/xxx/pix/icon.gif
 244                  old global $THEME is fully replaced by $OUTPUT
 245                  create plugin renderers
 246   (http://docs.moodle.org/dev/Theme_changes_in_2.0)
 247 * migrate all javascript new coding style using YUI3+YUI2
 248   (http://docs.moodle.org/dev/JavaScript_usage_guide)
 249 * remove '_utf8' from lang pack names, use new {a} syntax
 250 * replace helps with new 'xxx_hlp' strings
 251 * please note the $plugin->requires in version.php has to be bigger than 2010000000,
 252   otherwise the plugin is marked as outdated and upgrade is interrupted
 253
 254 optional - no changes needed in older code:
 255 * settingstree.php replaced by settings.php - just unset the $settings if you want to make custom part of settings admin tree
 256 * support for new mforms editor element and embedded files
 257   (not finished yet)
 258 * portfolio support
 259   (http://docs.moodle.org/dev/Portfolio_API)
 260 * course completion tracking support
 261 * new navigation features
 262 * new comments API
 263   (http://docs.moodle.org/dev/Comments_2.0)
 264 * new ratings API
 265   (http://docs.moodle.org/dev/Ratings_2.0)
 266