report/upgrade.txt

   1 This files describes API changes in /report/* - plugins,
   2 information provided here is intended especially for developers.
   3
   4 === 2.7 ===
   5 * How to migrate reports accessing table 'log':
   6   http://docs.moodle.org/dev/Migrating_log_access_in_reports
   7
   8 === 2.2 ===
   9
  10 API changes:
  11 * reports were moved from /admin/report/ to /report/
  12 * new support for report settings
  13
  14
  15 How to migrate existing admin reports:
  16 # move all files to new /report/yourplugin/ location
  17 # if settings.php exists add $settings=null;
  18 # if settings.php does not exist create it and link the report, index.php is not linked automatically any more
  19 # update require('../../config.php'); - remove one ../
  20 # update all others includes and requires
  21 # update all links to report pages by removing /admin/ or /$CFG->admin/
  22 # add language pack with at least 'pluginname' string
  23 # update CSS selectors
  24
  25 How to migrate existing course reports (optional):
  26 # move all files to new /report/yourplugin/ location
  27 # update require('../../config.php'); - remove one ../
  28 # update all others includes and requires
  29 # update all links to report pages by removing /course/ part
  30 # update all language strings (use 'report_yourplugin' instead of 'coursereport_yourplugin') - use AMOS hints in commit message
  31 # update all capability names
  32 # grep the plugin codebase and look for any remaining 'coursereport' occurrences
  33 # add new navigation hooks in lib.php - ex: report_stats_extend_navigation_course(), report_stats_extend_navigation_user()
  34 # add new page types in lib.php
  35 # create db/install.php migration script - delete old settings and capabilities (see converted plugins for examples)
  36 # update CSS selectors
  37
  38 See http://docs.moodle.org/dev/General_report_plugins for more details and explanation.