MDL-38744 completion: add missing setType and properly allow float
[moodle.git] / completion / criteria / completion_criteria_grade.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  * Course completion critieria - completion on achieving course grade
19  *
20  * @package core_completion
21  * @category completion
22  * @copyright 2009 Catalyst IT Ltd
23  * @author Aaron Barnes <aaronb@catalyst.net.nz>
24  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 defined('MOODLE_INTERNAL') || die();
28 require_once $CFG->dirroot.'/grade/lib.php';
29 require_once $CFG->dirroot.'/grade/querylib.php';
31 /**
32  * Course completion critieria - completion on achieving course grade
33  *
34  * @package core_completion
35  * @category completion
36  * @copyright 2009 Catalyst IT Ltd
37  * @author Aaron Barnes <aaronb@catalyst.net.nz>
38  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
39  */
40 class completion_criteria_grade extends completion_criteria {
42     /* @var int Criteria type constant [COMPLETION_CRITERIA_TYPE_GRADE] */
43     public $criteriatype = COMPLETION_CRITERIA_TYPE_GRADE;
45     /**
46      * Finds and returns a data_object instance based on params.
47      *
48      * @param array $params associative array varname => value of various
49      * parameters used to fetch data_object
50      * @return data_object data_object instance or false if none found.
51      */
52     public static function fetch($params) {
53         $params['criteriatype'] = COMPLETION_CRITERIA_TYPE_GRADE;
54         return self::fetch_helper('course_completion_criteria', __CLASS__, $params);
55     }
57     /**
58      * Add appropriate form elements to the critieria form
59      *
60      * @param moodle_form $mform Moodle forms object
61      * @param stdClass $data containing default values to be set in the form
62      */
63     public function config_form_display(&$mform, $data = null) {
64         $mform->addElement('checkbox', 'criteria_grade', get_string('enable'));
65         $mform->addElement('text', 'criteria_grade_value', get_string('graderequired', 'completion'));
66         $mform->setType('criteria_grade_value', PARAM_RAW); // Uses unformat_float.
67         $mform->setDefault('criteria_grade_value', format_float($data));
68         $mform->addElement('static', 'criteria_grade_value_note', '', get_string('criteriagradenote', 'completion'));
70         if ($this->id) {
71             $mform->setDefault('criteria_grade', 1);
72             $mform->setDefault('criteria_grade_value', format_float($this->gradepass));
73         }
74     }
76     /**
77      * Update the criteria information stored in the database
78      *
79      * @param stdClass $data Form data
80      */
81     public function update_config(&$data) {
83         $formatedgrade = unformat_float($data->criteria_grade_value);
84         // TODO validation
85         if (!empty($formatedgrade) && is_numeric($formatedgrade)) {
86             $this->course = $data->id;
87             $this->gradepass = $formatedgrade;
88             $this->insert();
89         }
90     }
92     /**
93      * Get user's course grade in this course
94      *
95      * @param completion_completion $completion an instance of completion_completion class
96      * @return float
97      */
98     private function get_grade($completion) {
99         $grade = grade_get_course_grade($completion->userid, $this->course);
100         return $grade->grade;
101     }
103     /**
104      * Review this criteria and decide if the user has completed
105      *
106      * @param completion_completion $completion The user's completion record
107      * @param bool $mark Optionally set false to not save changes to database
108      * @return bool
109      */
110     public function review($completion, $mark = true) {
111         // Get user's course grade
112         $grade = $this->get_grade($completion);
114         // If user's current course grade is higher than the required pass grade
115         if ($this->gradepass && $this->gradepass <= $grade) {
116             if ($mark) {
117                 $completion->gradefinal = $grade;
118                 $completion->mark_complete();
119             }
121             return true;
122         }
124         return false;
125     }
127     /**
128      * Return criteria title for display in reports
129      *
130      * @return  string
131      */
132     public function get_title() {
133         return get_string('coursegrade', 'completion');
134     }
136     /**
137      * Return a more detailed criteria title for display in reports
138      *
139      * @return string
140      */
141     public function get_title_detailed() {
142         $graderequired = round($this->gradepass, 2).'%';
143         return get_string('gradexrequired', 'completion', $graderequired);
144     }
146     /**
147      * Return criteria type title for display in reports
148      *
149      * @return string
150      */
151     public function get_type_title() {
152         return get_string('grade');
153     }
155     /**
156      * Return criteria status text for display in reports
157      *
158      * @param completion_completion $completion The user's completion record
159      * @return string
160      */
161     public function get_status($completion) {
162         $grade = $this->get_grade($completion);
163         $graderequired = $this->get_title_detailed();
165         if ($grade) {
166             $grade = round($grade, 2).'%';
167         } else {
168             $grade = get_string('nograde');
169         }
171         return $grade.' ('.$graderequired.')';
172     }
174     /**
175      * Find user's who have completed this criteria
176      */
177     public function cron() {
178         global $DB;
180         // Get all users who meet this criteria
181         $sql = '
182             SELECT DISTINCT
183                 c.id AS course,
184                 cr.id AS criteriaid,
185                 ra.userid AS userid,
186                 gg.finalgrade AS gradefinal,
187                 gg.timemodified AS timecompleted
188             FROM
189                 {course_completion_criteria} cr
190             INNER JOIN
191                 {course} c
192              ON cr.course = c.id
193             INNER JOIN
194                 {context} con
195              ON con.instanceid = c.id
196             INNER JOIN
197                 {role_assignments} ra
198               ON ra.contextid = con.id
199             INNER JOIN
200                 {grade_items} gi
201              ON gi.courseid = c.id
202             AND gi.itemtype = \'course\'
203             INNER JOIN
204                 {grade_grades} gg
205              ON gg.itemid = gi.id
206             AND gg.userid = ra.userid
207             LEFT JOIN
208                 {course_completion_crit_compl} cc
209              ON cc.criteriaid = cr.id
210             AND cc.userid = ra.userid
211             WHERE
212                 cr.criteriatype = '.COMPLETION_CRITERIA_TYPE_GRADE.'
213             AND con.contextlevel = '.CONTEXT_COURSE.'
214             AND c.enablecompletion = 1
215             AND cc.id IS NULL
216             AND gg.finalgrade >= cr.gradepass
217         ';
219         // Loop through completions, and mark as complete
220         $rs = $DB->get_recordset_sql($sql);
221         foreach ($rs as $record) {
222             $completion = new completion_criteria_completion((array) $record, DATA_OBJECT_FETCH_BY_KEY);
223             $completion->mark_complete($record->timecompleted);
224         }
225         $rs->close();
226     }
228     /**
229      * Return criteria progress details for display in reports
230      *
231      * @param completion_completion $completion The user's completion record
232      * @return array An array with the following keys:
233      *     type, criteria, requirement, status
234      */
235     public function get_details($completion) {
236         $details = array();
237         $details['type'] = get_string('coursegrade', 'completion');
238         $details['criteria'] = get_string('graderequired', 'completion');
239         $details['requirement'] = round($this->gradepass, 2).'%';
240         $details['status'] = '';
242         $grade = round($this->get_grade($completion), 2);
243         if ($grade) {
244             $details['status'] = $grade.'%';
245         }
247         return $details;
248     }