Merge branch 'MDL-33398b' of git://github.com/srynot4sale/moodle
[moodle.git] / lib / completion / completion_criteria_duration.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 after specific duration from course enrolment
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();
29 /**
30  * Course completion critieria - completion after specific duration from course enrolment
31  *
32  * @package core_completion
33  * @category completion
34  * @copyright 2009 Catalyst IT Ltd
35  * @author Aaron Barnes <aaronb@catalyst.net.nz>
36  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37  */
38 class completion_criteria_duration extends completion_criteria {
40     /* @var int Criteria type constant [COMPLETION_CRITERIA_TYPE_DURATION] */
41     public $criteriatype = COMPLETION_CRITERIA_TYPE_DURATION;
43     /**
44      * Finds and returns a data_object instance based on params.
45      *
46      * @param array $params associative arrays varname=>value
47      * @return data_object data_object instance or false if none found.
48      */
49     public static function fetch($params) {
50         $params['criteriatype'] = COMPLETION_CRITERIA_TYPE_DURATION;
51         return self::fetch_helper('course_completion_criteria', __CLASS__, $params);
52     }
54     /**
55      * Add appropriate form elements to the critieria form
56      *
57      * @param moodleform $mform Moodle forms object
58      * @param stdClass $data not used
59      */
60     public function config_form_display(&$mform, $data = null) {
62         $mform->addElement('checkbox', 'criteria_duration', get_string('enable'));
64         $thresholdmenu=array();
65         for ($i=1; $i<=30; $i++) {
66             $seconds = $i * 86400;
67             $thresholdmenu[$seconds] = get_string('numdays', '', $i);
68         }
69         $mform->addElement('select', 'criteria_duration_days', get_string('daysafterenrolment', 'completion'), $thresholdmenu);
71         if ($this->id) {
72             $mform->setDefault('criteria_duration', 1);
73             $mform->setDefault('criteria_duration_days', $this->enrolperiod);
74         }
75     }
77     /**
78      * Update the criteria information stored in the database
79      *
80      * @param stdClass $data Form data
81      */
82     public function update_config(&$data) {
83         if (!empty($data->criteria_duration)) {
84             $this->course = $data->id;
85             $this->enrolperiod = $data->criteria_duration_days;
86             $this->insert();
87         }
88     }
90     /**
91      * Get the time this user was enroled
92      *
93      * @param completion_completion $completion
94      * @return int
95      */
96     private function get_timeenrolled($completion) {
97         global $DB;
99         return $DB->get_field_sql('
100             SELECT eu.timestart
101               FROM {user_enrolments} eu
102               JOIN {enrol} e ON eu.enrolid = e.id
103              WHERE e.courseid = ?
104                AND eu.userid = ?', array($this->course, $completion->userid));
105     }
107     /**
108      * Review this criteria and decide if the user has completed
109      *
110      * @param completion_completion $completion The user's completion record
111      * @param bool $mark Optionally set false to not save changes to database
112      * @return bool
113      */
114     public function review($completion, $mark = true) {
115         $timeenrolled = $this->get_timeenrolled($completion);
117         // If duration since enrollment has passed
118         if (!$this->enrolperiod || !$timeenrolled) {
119             return false;
120         }
122         if (time() > ($timeenrolled + $this->enrolperiod)) {
123             if ($mark) {
124                 $completion->mark_complete();
125             }
127             return true;
128         }
130         return false;
131     }
133     /**
134      * Return criteria title for display in reports
135      *
136      * @return string
137      */
138     public function get_title() {
139         return get_string('enrolmentduration', 'completion');
140     }
142     /**
143      * Return a more detailed criteria title for display in reports
144      *
145      * @return string
146      */
147     public function get_title_detailed() {
148         return ceil($this->enrolperiod / (60 * 60 * 24)) . ' days';
149     }
151     /**
152      * Return criteria type title for display in reports
153      *
154      * @return string
155      */
156     public function get_type_title() {
157         return get_string('days', 'completion');
158     }
160     /**
161      * Return criteria status text for display in reports
162      *
163      * @param completion_completion $completion The user's completion record
164      * @return string
165      */
166     public function get_status($completion) {
167         $timeenrolled = $this->get_timeenrolled($completion);
168         $timeleft = $timeenrolled + $this->enrolperiod - time();
169         $enrolperiod = ceil($this->enrolperiod / (60 * 60 * 24));
171         $daysleft = ceil($timeleft / (60 * 60 * 24));
173         return ($daysleft > 0 ? $daysleft : 0).' of '.$enrolperiod;
174     }
176     /**
177      * Find user's who have completed this criteria
178      */
179     public function cron() {
180         global $DB;
182         /*
183          * Get all users who match meet this criteria
184          *
185          * We can safely ignore duplicate enrolments for
186          * a user in a course here as we only care if
187          * one of the enrolments has passed the set
188          * duration.
189          */
190         $sql = '
191             SELECT
192                 c.id AS course,
193                 cr.id AS criteriaid,
194                 u.id AS userid,
195                 ue.timestart AS otimestart,
196                 (ue.timestart + cr.enrolperiod) AS ctimestart,
197                 ue.timecreated AS otimeenrolled,
198                 (ue.timecreated + cr.enrolperiod) AS ctimeenrolled
199             FROM
200                 {user} u
201             INNER JOIN
202                 {user_enrolments} ue
203              ON ue.userid = u.id
204             INNER JOIN
205                 {enrol} e
206              ON e.id = ue.enrolid
207             INNER JOIN
208                 {course} c
209              ON c.id = e.courseid
210             INNER JOIN
211                 {course_completion_criteria} cr
212              ON c.id = cr.course
213             LEFT JOIN
214                 {course_completion_crit_compl} cc
215              ON cc.criteriaid = cr.id
216             AND cc.userid = u.id
217             WHERE
218                 cr.criteriatype = '.COMPLETION_CRITERIA_TYPE_DURATION.'
219             AND c.enablecompletion = 1
220             AND cc.id IS NULL
221             AND
222             (
223                 ue.timestart > 0 AND ue.timestart + cr.enrolperiod < ?
224              OR ue.timecreated > 0 AND ue.timecreated + cr.enrolperiod < ?
225             )
226         ';
228         // Loop through completions, and mark as complete
229         $now = time();
230         $rs = $DB->get_recordset_sql($sql, array($now, $now));
231         foreach ($rs as $record) {
232             $completion = new completion_criteria_completion((array) $record, DATA_OBJECT_FETCH_BY_KEY);
234             // Use time start if not 0, otherwise use timeenrolled
235             if ($record->otimestart) {
236                 $completion->mark_complete($record->ctimestart);
237             } else {
238                 $completion->mark_complete($record->ctimeenrolled);
239             }
240         }
241         $rs->close();
242     }
244     /**
245      * Return criteria progress details for display in reports
246      *
247      * @param completion_completion $completion The user's completion record
248      * @return array An array with the following keys:
249      *     type, criteria, requirement, status
250      */
251     public function get_details($completion) {
252         $details = array();
253         $details['type'] = get_string('periodpostenrolment', 'completion');
254         $details['criteria'] = get_string('remainingenroledfortime', 'completion');
255         $details['requirement'] = get_string('xdays', 'completion', ceil($this->enrolperiod / (60*60*24)));
257         // Get status
258         $timeenrolled = $this->get_timeenrolled($completion);
259         $timepassed = time() - $timeenrolled;
260         $details['status'] = get_string('xdays', 'completion', floor($timepassed / (60*60*24)));
262         return $details;
263     }