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