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