cd9e4393e163e3d9a03899fcc02424b333304e6f
[moodle.git] / grade / report / singleview / classes / local / screen / user.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  * The user screen.
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 namespace gradereport_singleview\local\screen;
27 use grade_seq;
28 use gradereport_singleview;
29 use moodle_url;
30 use pix_icon;
31 use html_writer;
32 use gradereport_singleview\local\ui\range;
33 use gradereport_singleview\local\ui\bulk_insert;
34 use grade_item;
35 use grade_grade;
36 use stdClass;
38 defined('MOODLE_INTERNAL') || die;
40 /**
41  * The user screen.
42  *
43  * @package   gradereport_singleview
44  * @copyright 2014 Moodle Pty Ltd (http://moodle.com)
45  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
46  */
47 class user extends tablelike implements selectable_items {
49     /** @var array $categories A cache for grade_item categories */
50     private $categories = array();
52     /** @var int $requirespaging Do we have more items than the paging limit? */
53     private $requirespaging = true;
55     /**
56      * Get the description for the screen.
57      *
58      * @return string
59      */
60     public function description() {
61         return get_string('gradeitems', 'grades');
62     }
64     /**
65      * Convert the list of items to a list of options.
66      *
67      * @return array
68      */
69     public function options() {
70         $result = array();
71         foreach ($this->items as $itemid => $item) {
72             $result[$itemid] = $item->get_name();
73         }
74         return $result;
75     }
77     /**
78      * Get the type of items on this screen.
79      *
80      * @return string
81      */
82     public function item_type() {
83         return 'grade';
84     }
86     /**
87      * Should we show the group selector on this screen?
88      *
89      * @return bool
90      */
91     public function display_group_selector() {
92         return false;
93     }
95     /**
96      * Init the screen
97      *
98      * @param bool $selfitemisempty Have we selected an item yet?
99      */
100     public function init($selfitemisempty = false) {
101         global $DB;
103         if (!$selfitemisempty) {
104             $this->item = $DB->get_record('user', array('id' => $this->itemid));
105         }
107         $params = array('courseid' => $this->courseid);
109         $seq = new grade_seq($this->courseid, true);
110         foreach ($seq->items as $key => $item) {
111             if (isset($item->itemmodule)) {
112                 list($courseid, $cmid) = get_course_and_cm_from_instance($item->iteminstance, $item->itemmodule);
113                 $seq->items[$key]->cmid = $cmid->id;
114             }
115         }
117         $this->items = array();
118         foreach ($seq->items as $itemid => $item) {
119             if (grade::filter($item)) {
120                 $this->items[$itemid] = $item;
121             }
122         }
124         $this->requirespaging = count($this->items) > $this->perpage;
126         $this->setup_structure();
128         $this->definition = array(
129             'finalgrade', 'feedback', 'override', 'exclude'
130         );
131         $this->set_headers($this->original_headers());
132     }
134     /**
135      * Get the list of headers for the table.
136      *
137      * @return array List of headers
138      */
139     public function original_headers() {
140         return array(
141             '', // For filter icon.
142             '', // For activity icon.
143             get_string('assessmentname', 'gradereport_singleview'),
144             get_string('gradecategory', 'grades'),
145             get_string('range', 'grades'),
146             get_string('grade', 'grades'),
147             get_string('feedback', 'grades'),
148             $this->make_toggle_links('override'),
149             $this->make_toggle_links('exclude')
150         );
151     }
153     /**
154      * Format each row of the table.
155      *
156      * @param grade_item $item
157      * @return string
158      */
159     public function format_line($item) {
160         global $OUTPUT;
162         $grade = $this->fetch_grade_or_default($item, $this->item->id);
163         $lockicon = '';
165         $lockeditem = $lockeditemgrade = 0;
166         if (!empty($grade->locked)) {
167             $lockeditem = 1;
168         }
169         if (!empty($grade->grade_item->locked)) {
170             $lockeditemgrade = 1;
171         }
172         // Check both grade and grade item.
173         if ($lockeditem || $lockeditemgrade) {
174              $lockicon = $OUTPUT->pix_icon('t/locked', 'grade is locked');
175         }
177         $realmodid = '';
178         if (isset($item->cmid)) {
179             $realmodid = $item->cmid;
180         }
182         $iconstring = get_string('filtergrades', 'gradereport_singleview', $item->get_name());
184         // Create a fake gradetreeitem so we can call get_element_header().
185         // The type logic below is from grade_category->_get_children_recursion().
186         $gradetreeitem = array();
187         if (in_array($item->itemtype, array('course', 'category'))) {
188             $gradetreeitem['type'] = $item->itemtype.'item';
189         } else {
190             $gradetreeitem['type'] = 'item';
191         }
192         $gradetreeitem['object'] = $item;
193         $gradetreeitem['userid'] = $this->item->id;
195         $itemlabel = $this->structure->get_element_header($gradetreeitem, true, false);
196         $grade->label = $item->get_name();
198         $itemlabel = $item->get_name();
199         if (!empty($realmodid)) {
200             $url = new moodle_url('/mod/' . $item->itemmodule . '/view.php', array('id' => $realmodid));
201             $itemlabel = html_writer::link($url, $item->get_name());
202         }
204         $line = array(
205             $OUTPUT->action_icon($this->format_link('grade', $item->id), new pix_icon('t/editstring', $iconstring)),
206             $this->format_icon($item) . $lockicon, $itemlabel, $this->category($item), (new range($item))
207         );
208         return $this->format_definition($line, $grade);
209     }
211     /**
212      * Helper to get the icon for an item.
213      *
214      * @param grade_item $item
215      * @return string
216      */
217     private function format_icon($item) {
218         $element = array('type' => 'item', 'object' => $item);
219         return $this->structure->get_element_icon($element);
220     }
222     /**
223      * Helper to get the category for an item.
224      *
225      * @param grade_item $item
226      * @return grade_category
227      */
228     private function category($item) {
229         global $DB;
231         if (empty($item->categoryid)) {
233             if ($item->itemtype == 'course') {
234                 return $this->course->fullname;
235             }
237             $params = array('id' => $item->iteminstance);
238             $elem = $DB->get_record('grade_categories', $params);
240             return $elem->fullname;
241         }
243         if (!isset($this->categories[$item->categoryid])) {
244             $category = $item->get_parent_category();
246             $this->categories[$category->id] = $category;
247         }
249         return $this->categories[$item->categoryid]->get_name();
250     }
252     /**
253      * Get the heading for the page.
254      *
255      * @return string
256      */
257     public function heading() {
258         return fullname($this->item);
259     }
261     /**
262      * Default pager
263      *
264      * @return string
265      */
266     public function pager() {
267         global $OUTPUT;
269         if (!$this->supports_paging()) {
270             return '';
271         }
273         return $OUTPUT->paging_bar(
274             count($this->items), $this->page, $this->perpage,
275             new moodle_url('/grade/report/singleview/index.php', array(
276                 'perpage' => $this->perpage,
277                 'id' => $this->courseid,
278                 'groupid' => $this->groupid,
279                 'itemid' => $this->itemid,
280                 'item' => 'user'
281             ))
282         );
283     }
285     /**
286      * Does this page require paging?
287      *
288      * @return bool
289      */
290     public function supports_paging() {
291         return $this->requirespaging;
292     }
295     /**
296      * Process the data from the form.
297      *
298      * @param array $data
299      * @return array of warnings
300      */
301     public function process($data) {
302         $bulk = new bulk_insert($this->item);
303         // Bulk insert messages the data to be passed in
304         // ie: for all grades of empty grades apply the specified value.
305         if ($bulk->is_applied($data)) {
306             $filter = $bulk->get_type($data);
307             $insertvalue = $bulk->get_insert_value($data);
308             // Appropriately massage data that may not exist.
310             $userid = $this->item->id;
311             foreach ($this->items as $gradeitemid => $gradeitem) {
312                 $null = $gradeitem->gradetype == GRADE_TYPE_SCALE ? -1 : '';
313                 $field = "finalgrade_{$gradeitem->id}_{$gradeitemid}";
314                 if (isset($data->$field)) {
315                     continue;
316                 }
318                 $grade = grade_grade::fetch(array(
319                     'itemid' => $gradeitem->id,
320                     'userid' => $userid
321                 ));
323                 $data->$field = empty($grade) ? $null : $grade->finalgrade;
324                 $data->{"old$field"} = $data->$field;
325             }
327             foreach ($data as $varname => $value) {
328                 if (!preg_match('/^finalgrade_(\d+)_/', $varname, $matches)) {
329                     continue;
330                 }
332                 $gradeitem = grade_item::fetch(array(
333                     'courseid' => $this->courseid,
334                     'id' => $matches[1]
335                 ));
337                 $isscale = ($gradeitem->gradetype == GRADE_TYPE_SCALE);
339                 $empties = (trim($value) === '' or ($isscale and $value == -1));
341                 if ($filter == 'all' or $empties) {
342                     $data->$varname = ($isscale and empty($insertvalue)) ?
343                         -1 : $insertvalue;
344                 }
345             }
346         }
348         return parent::process($data);
349     }