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