MDL-49324 grades: Create helper function for regrading on report view
[moodle.git] / grade / report / singleview / index.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Displays the Single view
19  *
20  * @package   gradereport_singleview
21  * @copyright 2014 Moodle Pty Ltd (http://moodle.com)
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 require_once('../../../config.php');
26 require_once($CFG->dirroot.'/lib/gradelib.php');
27 require_once($CFG->dirroot.'/grade/lib.php');
28 require_once($CFG->dirroot.'/grade/report/singleview/lib.php');
30 $courseid = required_param('id', PARAM_INT);
31 $groupid  = optional_param('group', null, PARAM_INT);
33 // Making this work with profile reports.
34 $userid   = optional_param('userid', null, PARAM_INT);
36 $defaulttype = $userid ? 'user' : 'select';
38 $itemid = optional_param('itemid', null, PARAM_INT);
39 $itemtype = optional_param('item', $defaulttype, PARAM_TEXT);
40 $page = optional_param('page', 0, PARAM_INT);
41 $perpage = optional_param('perpage', 100, PARAM_INT);
43 if (empty($itemid)) {
44     $itemid = $userid;
45     $itemtype = $defaulttype;
46 }
48 $courseparams = array('id' => $courseid);
49 $PAGE->set_url(new moodle_url('/grade/report/singleview/index.php', $courseparams));
50 $PAGE->set_pagelayout('incourse');
52 if (!$course = $DB->get_record('course', $courseparams)) {
53     print_error('nocourseid');
54 }
56 require_login($course);
58 if (!in_array($itemtype, gradereport_singleview::valid_screens())) {
59     print_error('notvalid', 'gradereport_singleview', '', $itemtype);
60 }
62 $context = context_course::instance($course->id);
64 // This is the normal requirements.
65 require_capability('gradereport/singleview:view', $context);
66 require_capability('moodle/grade:viewall', $context);
67 require_capability('moodle/grade:edit', $context);
69 $gpr = new grade_plugin_return(array(
70     'type' => 'report',
71     'plugin' => 'singleview',
72     'courseid' => $courseid
73 ));
75 // Last selected report session tracking.
76 if (!isset($USER->grade_last_report)) {
77     $USER->grade_last_report = array();
78 }
79 $USER->grade_last_report[$course->id] = 'singleview';
81 // First make sure we have proper final grades.
82 grade_regrade_final_grades_if_required($course);
84 $report = new gradereport_singleview($courseid, $gpr, $context, $itemtype, $itemid);
86 $reportname = $report->screen->heading();
88 $pluginname = get_string('pluginname', 'gradereport_singleview');
90 $pageparams = array(
91     'id' => $courseid,
92     'itemid' => $itemid,
93     'item' => $itemtype,
94     'userid' => $userid,
95     'group' => $groupid,
96     'page' => $page,
97     'perpage' => $perpage
98 );
100 $currentpage = new moodle_url('/grade/report/singleview/index.php', $pageparams);
102 if ($data = data_submitted()) {
103     $PAGE->set_pagelayout('redirect');
104     $PAGE->set_title(get_string('savegrades', 'gradereport_singleview'));
105     echo $OUTPUT->header();
107     require_sesskey(); // Must have a sesskey for all actions.
108     $result = $report->process_data($data);
110     if (!empty($result->warnings)) {
111         foreach ($result->warnings as $warning) {
112             echo $OUTPUT->notification($warning);
113         }
114     }
115     echo $OUTPUT->notification(get_string('savegradessuccess', 'gradereport_singleview', count ((array)$result->changecount)));
116     echo $OUTPUT->continue_button($currentpage);
117     echo $OUTPUT->footer();
118     die();
121 $PAGE->set_pagelayout('report');
122 if ($itemtype == 'user') {
123     print_grade_page_head($course->id, 'report', 'singleview', $reportname, false, false, true, null, null, $report->screen->item);
124 } else {
125     print_grade_page_head($course->id, 'report', 'singleview', $reportname);
128 $graderrightnav = $graderleftnav = null;
130 $options = $report->screen->options();
132 if (!empty($options)) {
134     $optionkeys = array_keys($options);
135     $optionitemid = array_shift($optionkeys);
137     $relreport = new gradereport_singleview(
138                 $courseid, $gpr, $context,
139                 $report->screen->item_type(), $optionitemid
140     );
141     $reloptions = $relreport->screen->options();
142     $reloptionssorting = array_keys($relreport->screen->options());
144     $i = array_search($itemid, $reloptionssorting);
145     $navparams = array('item' => $itemtype, 'id' => $courseid, 'group' => $groupid);
146     if ($i > 0) {
147         $navparams['itemid'] = $reloptionssorting[$i - 1];
148         $link = new moodle_url('/grade/report/singleview/index.php', $navparams);
149         $navprev = html_writer::link($link, $OUTPUT->larrow() . ' ' . $reloptions[$reloptionssorting[$i - 1]]);
150         $graderleftnav = html_writer::tag('div', $navprev, array('class' => 'itemnav previtem'));
151     }
152     if ($i < count($reloptionssorting) - 1) {
153         $navparams['itemid'] = $reloptionssorting[$i + 1];
154         $link = new moodle_url('/grade/report/singleview/index.php', $navparams);
155         $navnext = html_writer::link($link, $reloptions[$reloptionssorting[$i + 1]] . ' ' . $OUTPUT->rarrow());
156         $graderrightnav = html_writer::tag('div', $navnext, array('class' => 'itemnav nextitem'));
157     }
160 if (!is_null($graderleftnav)) {
161     echo $graderleftnav;
163 if (!is_null($graderrightnav)) {
164     echo $graderrightnav;
167 if ($report->screen->supports_paging()) {
168     echo $report->screen->pager();
171 if ($report->screen->display_group_selector()) {
172     echo $report->group_selector;
175 echo $report->output();
177 if ($report->screen->supports_paging()) {
178     echo $report->screen->pager();
181 if (!is_null($graderleftnav)) {
182     echo $graderleftnav;
184 if (!is_null($graderrightnav)) {
185     echo $graderrightnav;
188 $event = \gradereport_singleview\event\grade_report_viewed::create(
189     array(
190         'context' => $context,
191         'courseid' => $courseid,
192         'relateduserid' => $USER->id,
193     )
194 );
195 $event->trigger();
197 echo $OUTPUT->footer();