mod/upgrade.txt

   1 This files describes API changes in /mod/* - activity modules,
   2 information provided here is intended especially for developers.
   3
   4
   5 === 2.4 ===
   6
   7 new features:
   8
   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:
  13
  14 * mod_lesson_renderer::header() now accepts an additional parameter $extrapagetitle
  15
  16 * mod/data/lib.php data_get_all_recordids() now has two new optional variables:  $selectdata and $params.
  17
  18 === 2.3 ===
  19
  20 required changes in code:
  21
  22 * define the capability mod/xxx:addinstance (and the corresponding lang string)
  23   (unless your mod is a MOD_ARCHETYPE_SYSTEM).
  24 * xxx_pluginfile() is now given the 7th parameter (hopefully the last one) that
  25   contains additional options for the file serving. The array should be re-passed
  26   to send_stored_file().
  27
  28 * most resourcelib_embed_* functions are replaced with core_media_renderer;
  29   for an example, see mod/resource/locallib.php, resource_display_embed()
  30
  31 optional - no changes needed:
  32
  33 * add support for handling course drag and drop types - functions
  34   xxx_dndupload_register() and xxx_dndupload_handle($uploadinfo) see:
  35   http://docs.moodle.org/dev/Implementing_Course_drag_and_drop_upload_support_in_a_module
  36
  37 === 2.2 ===
  38
  39 required changes in code:
  40 * fix missing parameter types in optional_param() and required_param()
  41 * use new optional_param_array(), required_param_array() or clean_param_array() when dealing with array parameters
  42 * textlib->asort() replaced by specialized collatorlib::asort()
  43 * use new make_temp_directory() and make_cache_directory()
  44
  45
  46 === 2.1 ===
  47
  48 required changes in code:
  49 * add new support for basic restore from 1.9
  50
  51
  52 === 2.0 ===
  53
  54 required changes in code:
  55 * use new DML syntax everywhere
  56   (http://docs.moodle.org/dev/DML_functions)
  57 * use new DDL syntax in db/upgrade.php
  58   (http://docs.moodle.org/dev/DDL_functions)
  59 * replace defaults.php by settings.php and db/install.php
  60 * replace STATEMENTS section in db/install.xml with PHP code db/install.php or db/log.php
  61 * move post installation code from lib.php into db/install.php
  62 * move uninstallation code from lib.php to db/uninstall.php
  63 * new mandatory naming of intro and introformat table fields in module tables,
  64   the presence of these fields is indicated in xxx_plugin_supports()
  65 * completely rewrite file handling
  66   (http://docs.moodle.org/dev/File_API)
  67 * rewrite backup/restore
  68   (not finished yet)
  69 * rewrite trusttext support - new db table columns needed
  70 * migrate all module features from mod_edit.php form to lib.php/modulename_supports() function
  71 * implement new gradebook support (legacy 1.8.x grading not supported anymore)
  72 * migrate custom resource module subtypes into separate modules,
  73   necessary only for custom plugins in mod/resource/
  74 * use new $PAGE and $OUTPUT instead of old weblib functions
  75 * theme changes: move plugin styles into mod/xxx/styles.css and use new css markers for images,
  76                  move all images into new mod/xxx/pix/ directory and use new outputlib api
  77                  move module icon to mod/xxx/pix/icon.gif
  78                  old global $THEME is fully replaced by $OUTPUT
  79                  create plugin renderers
  80   (http://docs.moodle.org/dev/Theme_changes_in_2.0)
  81 * migrate all javascript new coding style using YUI3+YUI2
  82   (http://docs.moodle.org/dev/JavaScript_usage_guide)
  83 * remove '_utf8' from lang pack names, use new {a} syntax
  84 * replace helps with new 'xxx_hlp' strings
  85 * please note the $plugin->requires in version.php has to be bigger than 2010000000,
  86   otherwise the plugin is marked as outdated and upgrade is interrupted
  87
  88 optional - no changes needed in older code:
  89 * settingstree.php replaced by settings.php - just unset the $settings if you want to make custom part of settings admin tree
  90 * support for new mforms editor element and embedded files
  91   (not finished yet)
  92 * portfolio support
  93   (http://docs.moodle.org/dev/Portfolio_API)
  94 * course completion tracking support
  95 * new navigation features
  96 * new comments API
  97   (http://docs.moodle.org/dev/Comments_2.0)
  98 * new ratings API
  99   (http://docs.moodle.org/dev/Ratings_2.0)
 100