Merge branch 'MDL-70114-310' of git:// into MOODLE_310_STABLE
[moodle.git] / grade / report / upgrade.txt
1 This files describes API changes in /grade/report/*,
2 information provided here is intended especially for developers.
4 === 3.6 ===
5 * External function gradereport_user_external::get_grade_items now return the following information (only for course managers).
6   - locked: Whether the grade item is locked.
7   - gradeislocked: Whether the user grade is locked.
8   - gradeisoverridden: Whether the user grade is overridden.
10 === 3.2 ===
11 * External function gradereport_user_external::get_grades_table now has an optional groupid parameter.
12 Is recommended to use this parameter in courses with separate groups or when the user requesting the report is in more than one group.
14 === 2.9 ===
15 * Deprecating grade_report_grader:get_collapsing_icon.
16 * A new web service function gradereport_user_get_grades_table has been added which will allow external system to retrieve grade information ready to be formatted as a table similar to the gradebook user report one.
18 === 2.8.2 ===
19 * gradereport_singleview::__construct doesn't need groupid parameter anymore, so it was renamed to $unused.
21 === 2.6.5, 2.7.2 ===
23 * The callback function grade_report_*_profilereport now takes one more parameter $viewasuser. This parameter
24   is set to true when the report must be viewed as the user whose grades are being displayed. For instance,
25   when a mentor/parent is viewing the report, they should see the same grades, not more, not less. When the
26   setting is set to false (default), the capability checks, visibility and access levels are using the
27   currently logged in user.
29 === 2.6 ===
30 * grade_report_grader::get_toggles_html() and grade_report_grader::print_toggle()
31   can not be used any more
32 * class grade_report get_numusers($groups = true, $users = false)
33   An extra parameter has been added to restrict count to those users being
34 displayed
35 * class grade_report_grader get_left_rows($displayaverages)
36   A parameter has been added to indicate whether averages are applicable and
37 should be displayed on the report
38 * class grade_report_grader get_right_rows($displayaverages)
39   A parameter has been added to indicate whether averages are applicable and
40 should be displayed on the report
41 * class grade_report_grader get_grade_table($displayaverages = false)
42   A parameter has been added to indicate whether averages are applicable and
43 should be displayed on the report
45 === 2.3.5, 2.4.2 ===
46 * class_grade_report::showtotalsifcontainhidden has been switched from a single integer value to an array.
47 The array keys are course IDs while the array values are the value of the course setting "report_overview_showtotalsifcontainhidden".