Merge branch 'MDL-47918-master' of git://github.com/andrewnicols/moodle
[moodle.git] / grade / report / singleview / classes / local / ui / finalgrade.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  * UI element representing the finalgrade column.
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\ui;
27 defined('MOODLE_INTERNAL') || die;
29 use stdClass;
30 /**
31  * UI element representing the finalgrade column.
32  *
33  * @package   gradereport_singleview
34  * @copyright 2014 Moodle Pty Ltd (http://moodle.com)
35  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
37 class finalgrade extends grade_attribute_format implements unique_value, be_disabled {
39     /** @var string $name Name of this input */
40     public $name = 'finalgrade';
42     /**
43      * Get the value for this input.
44      *
45      * @return string The value based on the grade_grade.
46      */
47     public function get_value() {
48         $this->label = $this->grade->grade_item->itemname;
49         // Manual item raw grade support.
50         $val = $this->grade->grade_item->is_manual_item() && (!is_null($this->grade->rawgrade)) ?
51             $this->grade->rawgrade : $this->grade->finalgrade;
53         if ($this->grade->grade_item->scaleid) {
54             return $val ? (int)$val : -1;
55         } else {
56             return $val ? format_float($val, $this->grade->grade_item->get_decimals()) : '';
57         }
58     }
60     /**
61      * Get the label for this input.
62      *
63      * @return string The label for this form input.
64      */
65     public function get_label() {
66         if (!isset($this->grade->label)) {
67             $this->grade->label = '';
68         }
69         return $this->grade->label;
70     }
72     /**
73      * Is this input field disabled.
74      *
75      * @return bool Set disabled on this input or not.
76      */
77     public function is_disabled() {
78         $locked = 0;
79         $gradeitemlocked = 0;
80         $overridden = 0;
82         // Disable editing if grade item or grade score is locked
83         // if any of these items are set,  then we will disable editing
84         // at some point, we might want to show the reason for the lock
85         // this code could be simplified, but its more readable for steve's little mind.
87         if (!empty($this->grade->locked)) {
88             $locked = 1;
89         }
90         if (!empty($this->grade->grade_item->locked)) {
91             $gradeitemlocked = 1;
92         }
93         if ($this->grade->grade_item->is_overridable_item() and !$this->grade->is_overridden()) {
94             $overridden = 1;
95         }
96         return ($locked || $gradeitemlocked || $overridden);
97     }
99     /**
100      * Create the element for this column.
101      *
102      * @return element
103      */
104     public function determine_format() {
105         if ($this->grade->grade_item->load_scale()) {
106             $scale = $this->grade->grade_item->load_scale();
108             $options = array(-1 => get_string('nograde'));
110             foreach ($scale->scale_items as $i => $name) {
111                 $options[$i + 1] = $name;
112             }
114             return new dropdown_attribute(
115                 $this->get_name(),
116                 $options,
117                 $this->get_value(),
118                 $this->get_label(),
119                 $this->is_disabled(),
120                 $this->get_tabindex()
121             );
122         } else {
123             return new text_attribute(
124                 $this->get_name(),
125                 $this->get_value(),
126                 $this->get_label(),
127                 $this->is_disabled(),
128                 $this->get_tabindex()
129             );
130         }
131     }
133     /**
134      * Save the altered value for this field.
135      *
136      * @param string $value The new value.
137      * @return string Any error string
138      */
139     public function set($value) {
140         global $DB;
142         $userid = $this->grade->userid;
143         $gradeitem = $this->grade->grade_item;
145         $feedback = false;
146         $feedbackformat = false;
147         if ($gradeitem->gradetype == GRADE_TYPE_SCALE) {
148             if ($value == -1) {
149                 $finalgrade = null;
150             } else {
151                 $finalgrade = $value;
152             }
153         } else {
154             $finalgrade = unformat_float($value);
155         }
157         $errorstr = '';
158         if ($finalgrade) {
159             $bounded = $gradeitem->bounded_grade($finalgrade);
160             if ($bounded > $finalgrade) {
161                 $errorstr = 'lessthanmin';
162             } else if ($bounded < $finalgrade) {
163                 $errorstr = 'morethanmax';
164             }
165         }
167         if ($errorstr) {
168             $user = $DB->get_record('user', array('id' => $userid), 'id, firstname, alternatename, lastname');
169             $gradestr = new stdClass;
170             if (!empty($user->alternatename)) {
171                 $gradestr->username = $user->alternatename . ' (' . $user->firstname . ') ' . $user->lastname;
172             } else {
173                 $gradestr->username = $user->firstname . ' ' . $user->lastname;
174             }
175             $gradestr->itemname = $this->grade->grade_item->get_name();
176             $errorstr = get_string($errorstr, 'grades', $gradestr);
177         }
179         $gradeitem->update_final_grade($userid, $finalgrade, 'singleview', $feedback, FORMAT_MOODLE);
180         return $errorstr;
181     }