1 |
efrain |
1 |
This files describes API changes in /grade/report/*,
|
|
|
2 |
information provided here is intended especially for developers.
|
|
|
3 |
|
|
|
4 |
=== 4.4 ===
|
|
|
5 |
* Method grader_report_grader::get_right_avg_row() has been deprecated. Please use grade_report::calculate_average() instead.
|
|
|
6 |
* The method grade_report::ungraded_counts() now has 2 parameters - group ID and includehidden. First is needed since
|
|
|
7 |
for grader report we calculate averages for overall and for a group at same time. Second is used to decide if we want
|
|
|
8 |
to include hidden items in the count or not (For grader and summary reports they are included, for user report - not).
|
|
|
9 |
|
|
|
10 |
=== 4.3 ===
|
|
|
11 |
* The load_users() method in the gradereport_singleview\local\screen class has been deprecated. Please use
|
|
|
12 |
grade_report::get_gradable_users() instead.
|
|
|
13 |
* The \gradereport_singleview\local\screen\select has been deprecated. This class generates the output for the initial
|
|
|
14 |
view to select the single view item type (user or grade item) which is no longer actively used as we do not provide
|
|
|
15 |
direct links to it.
|
|
|
16 |
* The following reports now use the combobox search PHP & JS rather than defining their own:
|
|
|
17 |
- gradereport_grader
|
|
|
18 |
- gradereport_singleview
|
|
|
19 |
- gradereport_user
|
|
|
20 |
Each of these reports extend the base user, grade or group JS class in either core or core_grades so that they can define how their clickable links are generated.
|
|
|
21 |
Any special handling of the search dropdowns should be done in the JS class "closest" to your plugin rather than in core_grades or the base search class itself.
|
|
|
22 |
|
|
|
23 |
=== 4.2 ===
|
|
|
24 |
* 'Show calculations' setting has been removed from grader report (link is moved to grade action menu)
|
|
|
25 |
* 'Show activity icons' setting has been removed from grader report
|
|
|
26 |
* The grade_report_grader:get_icons(), grade_report_grader:get_left_icons_row()
|
|
|
27 |
and grade_report_grader:get_right_icons_row() functions have been deprecated and are not used anymore.
|
|
|
28 |
* 'Show grade analysis icon' setting has been removed from grader report (link is moved to grade action menu)
|
|
|
29 |
* 'Show locks' setting has been removed from grader report (link is moved to grade action menu)
|
|
|
30 |
* 'Show show/hide icons' setting has been removed from grader report (link is moved to grade action menu)
|
|
|
31 |
* 'Enable AJAX' interface has been deprecated for grader report
|
|
|
32 |
* 'Quick feedback' interface has been deprecated for grader report
|
|
|
33 |
* A new method grade_report::get_additional_context() is created to obtain links to other grade plugins report pages.
|
|
|
34 |
It loops through all installed grade report plugins and checks if callback function gradereport_*_get_report_link
|
|
|
35 |
is implemented in for given grade report plugin in the corresponding lib.php
|
|
|
36 |
* The setting $CFG->grade_report_studentsperpage has been completely removed because it's not required anymore. This setting
|
|
|
37 |
was used to set the default number of students displayed per page in the grader report. Now the default is set to
|
|
|
38 |
20.
|
|
|
39 |
* The get_grade_item_id() function in behat_gradereport_grader.php has been deprecated. Please use
|
|
|
40 |
behat_grades::get_grade_item_id() instead.
|
|
|
41 |
* The grade_report::get_lang_string() has been deprecated. Please use get_string() instead.
|
|
|
42 |
|
|
|
43 |
=== 3.6 ===
|
|
|
44 |
* External function gradereport_user_external::get_grade_items now return the following information (only for course managers).
|
|
|
45 |
- locked: Whether the grade item is locked.
|
|
|
46 |
- gradeislocked: Whether the user grade is locked.
|
|
|
47 |
- gradeisoverridden: Whether the user grade is overridden.
|
|
|
48 |
|
|
|
49 |
=== 3.2 ===
|
|
|
50 |
* External function gradereport_user_external::get_grades_table now has an optional groupid parameter.
|
|
|
51 |
Is recommended to use this parameter in courses with separate groups or when the user requesting the report is in more than one group.
|
|
|
52 |
|
|
|
53 |
=== 2.9 ===
|
|
|
54 |
* Deprecating grade_report_grader:get_collapsing_icon.
|
|
|
55 |
* 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.
|
|
|
56 |
|
|
|
57 |
=== 2.8.2 ===
|
|
|
58 |
* gradereport_singleview::__construct doesn't need groupid parameter anymore, so it was renamed to $unused.
|
|
|
59 |
|
|
|
60 |
=== 2.6.5, 2.7.2 ===
|
|
|
61 |
|
|
|
62 |
* The callback function grade_report_*_profilereport now takes one more parameter $viewasuser. This parameter
|
|
|
63 |
is set to true when the report must be viewed as the user whose grades are being displayed. For instance,
|
|
|
64 |
when a mentor/parent is viewing the report, they should see the same grades, not more, not less. When the
|
|
|
65 |
setting is set to false (default), the capability checks, visibility and access levels are using the
|
|
|
66 |
currently logged in user.
|
|
|
67 |
|
|
|
68 |
=== 2.6 ===
|
|
|
69 |
* grade_report_grader::get_toggles_html() and grade_report_grader::print_toggle()
|
|
|
70 |
can not be used any more
|
|
|
71 |
* class grade_report get_numusers($groups = true, $users = false)
|
|
|
72 |
An extra parameter has been added to restrict count to those users being
|
|
|
73 |
displayed
|
|
|
74 |
* class grade_report_grader get_left_rows($displayaverages)
|
|
|
75 |
A parameter has been added to indicate whether averages are applicable and
|
|
|
76 |
should be displayed on the report
|
|
|
77 |
* class grade_report_grader get_right_rows($displayaverages)
|
|
|
78 |
A parameter has been added to indicate whether averages are applicable and
|
|
|
79 |
should be displayed on the report
|
|
|
80 |
* class grade_report_grader get_grade_table($displayaverages = false)
|
|
|
81 |
A parameter has been added to indicate whether averages are applicable and
|
|
|
82 |
should be displayed on the report
|
|
|
83 |
|
|
|
84 |
=== 2.3.5, 2.4.2 ===
|
|
|
85 |
* class_grade_report::showtotalsifcontainhidden has been switched from a single integer value to an array.
|
|
|
86 |
The array keys are course IDs while the array values are the value of the course setting "report_overview_showtotalsifcontainhidden".
|