report/upgrade.txt

   1 This files describes API changes in /report/* - plugins,
   2 information provided here is intended especially for developers.
   3
   4 === 3.11 ===
   5
   6 * The new report plugin's can have drop down, which can be included by calling static
   7   methods save_selected_report and print_report_selector in lib/classes/report_helper.php.
   8   The save_selected_report helps to remember the most recently accessed report plugin.
   9   print_report_selector would help to show the dropdown, on the report page. Make sure
  10   to call print_report_selector after the header is printed/echoed.
  11
  12 === 3.6 ===
  13
  14 * The final deprecation of xxx_delete_course callback means that this function will no longer be called.
  15   Please use the observer for event \core\event\course_content_deleted instead.
  16
  17 === 3.2 ===
  18 * Callback delete_course is deprecated and should be replaced with observer for event \core\event\course_content_deleted
  19 * The report_log_print_graph signature and behaviour has changed to generate charts using
  20   the new Chart API. The third argument has been renamed to $typeormode and it accepts
  21   the type (usercourse.png, userday.png) or the mode (today, all).
  22
  23 === 2.7 ===
  24 * How to migrate reports accessing table 'log':
  25   http://docs.moodle.org/dev/Migrating_log_access_in_reports
  26 * All reports that use logstores must implement a callback report_reportname_supports_logstore($storeinstance) in lib.php of the
  27   report. Refer MDL-44596 for details.
  28
  29 === 2.2 ===
  30
  31 API changes:
  32 * reports were moved from /admin/report/ to /report/
  33 * new support for report settings
  34
  35
  36 How to migrate existing admin reports:
  37 # move all files to new /report/yourplugin/ location
  38 # if settings.php exists add $settings=null;
  39 # if settings.php does not exist create it and link the report, index.php is not linked automatically any more
  40 # update require('../../config.php'); - remove one ../
  41 # update all others includes and requires
  42 # update all links to report pages by removing /admin/ or /$CFG->admin/
  43 # add language pack with at least 'pluginname' string
  44 # update CSS selectors
  45
  46 How to migrate existing course reports (optional):
  47 # move all files to new /report/yourplugin/ location
  48 # update require('../../config.php'); - remove one ../
  49 # update all others includes and requires
  50 # update all links to report pages by removing /course/ part
  51 # update all language strings (use 'report_yourplugin' instead of 'coursereport_yourplugin') - use AMOS hints in commit message
  52 # update all capability names
  53 # grep the plugin codebase and look for any remaining 'coursereport' occurrences
  54 # add new navigation hooks in lib.php - ex: report_stats_extend_navigation_course(), report_stats_extend_navigation_user()
  55 # add new page types in lib.php
  56 # create db/install.php migration script - delete old settings and capabilities (see converted plugins for examples)
  57 # update CSS selectors
  58
  59 See http://docs.moodle.org/dev/General_report_plugins for more details and explanation.