Merge branch 'MDL-33398b' of git://github.com/srynot4sale/moodle
[moodle.git] / lib / completion / completion_criteria_activity.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * This file contains the activity completion criteria type class and any
20  * supporting functions it may require.
21  *
22  * @package core_completion
23  * @category completion
24  * @copyright 2009 Catalyst IT Ltd
25  * @author Aaron Barnes <aaronb@catalyst.net.nz>
26  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27  */
29 defined('MOODLE_INTERNAL') || die();
31 /**
32  * Course completion critieria - completion on activity completion
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_activity extends completion_criteria {
42     /* @var int Criteria [COMPLETION_CRITERIA_TYPE_ACTIVITY] */
43     public $criteriatype = COMPLETION_CRITERIA_TYPE_ACTIVITY;
45     /**
46      * Finds and returns a data_object instance based on params.
47      *
48      * @param array $params associative arrays varname=>value
49      * @return completion_criteria_activity data_object instance or false if none found.
50      */
51     public static function fetch($params) {
52         $params['criteriatype'] = COMPLETION_CRITERIA_TYPE_ACTIVITY;
53         return self::fetch_helper('course_completion_criteria', __CLASS__, $params);
54     }
56     /**
57      * Add appropriate form elements to the critieria form
58      *
59      * @param moodleform $mform  Moodle forms object
60      * @param stdClass $data details of various modules
61      */
62     public function config_form_display(&$mform, $data = null) {
63         $mform->addElement('checkbox', 'criteria_activity['.$data->id.']', ucfirst(self::get_mod_name($data->module)).' - '.$data->name);
65         if ($this->id) {
66             $mform->setDefault('criteria_activity['.$data->id.']', 1);
67         }
68     }
70     /**
71      * Update the criteria information stored in the database
72      *
73      * @param stdClass $data Form data
74      */
75     public function update_config(&$data) {
76         global $DB;
78         if (!empty($data->criteria_activity) && is_array($data->criteria_activity)) {
80             $this->course = $data->id;
82             foreach (array_keys($data->criteria_activity) as $activity) {
84                 $module = $DB->get_record('course_modules', array('id' => $activity));
85                 $this->module = self::get_mod_name($module->module);
86                 $this->moduleinstance = $activity;
87                 $this->id = NULL;
88                 $this->insert();
89             }
90         }
91     }
93     /**
94      * Get module instance module type
95      *
96      * @param int $type Module type id
97      * @return string
98      */
99     public static function get_mod_name($type) {
100         static $types;
102         if (!is_array($types)) {
103             global $DB;
104             $types = $DB->get_records('modules');
105         }
107         return $types[$type]->name;
108     }
110     /**
111      * Gets the module instance from the database and returns it.
112      * If no module instance exists this function returns false.
113      *
114      * @return stdClass|bool
115      */
116     public function get_mod_instance() {
117         global $DB;
119         return $DB->get_record_sql(
120             "
121                 SELECT
122                     m.*
123                 FROM
124                     {{$this->module}} m
125                 INNER JOIN
126                     {course_modules} cm
127                  ON cm.id = {$this->moduleinstance}
128                 AND m.id = cm.instance
129             "
130         );
131     }
133     /**
134      * Review this criteria and decide if the user has completed
135      *
136      * @param completion_completion $completion     The user's completion record
137      * @param bool $mark Optionally set false to not save changes to database
138      * @return bool
139      */
140     public function review($completion, $mark = true) {
141         global $DB;
143         $course = $DB->get_record('course', array('id' => $completion->course));
144         $cm = $DB->get_record('course_modules', array('id' => $this->moduleinstance));
145         $info = new completion_info($course);
147         $data = $info->get_data($cm, false, $completion->userid);
149         // If the activity is complete
150         if (in_array($data->completionstate, array(COMPLETION_COMPLETE, COMPLETION_COMPLETE_PASS))) {
151             if ($mark) {
152                 $completion->mark_complete();
153             }
155             return true;
156         }
158         return false;
159     }
161     /**
162      * Return criteria title for display in reports
163      *
164      * @return string
165      */
166     public function get_title() {
167         return get_string('activitiescompleted', 'completion');
168     }
170     /**
171      * Return a more detailed criteria title for display in reports
172      *
173      * @return  string
174      */
175     public function get_title_detailed() {
176         global $DB;
177         $module = $DB->get_record('course_modules', array('id' => $this->moduleinstance));
178         $activity = $DB->get_record($this->module, array('id' => $module->instance));
180         return shorten_text(urldecode($activity->name));
181     }
183     /**
184      * Return criteria type title for display in reports
185      *
186      * @return  string
187      */
188     public function get_type_title() {
189         return get_string('activities', 'completion');
190     }
192     /**
193      * Find users who have completed this criteria and mark them accordingly
194      */
195     public function cron() {
196         global $DB;
198         // Get all users who meet this criteria
199         $sql = '
200             SELECT DISTINCT
201                 c.id AS course,
202                 cr.id AS criteriaid,
203                 ra.userid AS userid,
204                 mc.timemodified AS timecompleted
205             FROM
206                 {course_completion_criteria} cr
207             INNER JOIN
208                 {course} c
209              ON cr.course = c.id
210             INNER JOIN
211                 {context} con
212              ON con.instanceid = c.id
213             INNER JOIN
214                 {role_assignments} ra
215               ON ra.contextid = con.id
216             INNER JOIN
217                 {course_modules_completion} mc
218              ON mc.coursemoduleid = cr.moduleinstance
219             AND mc.userid = ra.userid
220             LEFT JOIN
221                 {course_completion_crit_compl} cc
222              ON cc.criteriaid = cr.id
223             AND cc.userid = ra.userid
224             WHERE
225                 cr.criteriatype = '.COMPLETION_CRITERIA_TYPE_ACTIVITY.'
226             AND con.contextlevel = '.CONTEXT_COURSE.'
227             AND c.enablecompletion = 1
228             AND cc.id IS NULL
229             AND (
230                 mc.completionstate = '.COMPLETION_COMPLETE.'
231              OR mc.completionstate = '.COMPLETION_COMPLETE_PASS.'
232                 )
233         ';
235         // Loop through completions, and mark as complete
236         $rs = $DB->get_recordset_sql($sql);
237         foreach ($rs as $record) {
238             $completion = new completion_criteria_completion((array) $record, DATA_OBJECT_FETCH_BY_KEY);
239             $completion->mark_complete($record->timecompleted);
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         global $DB, $CFG;
254         // Get completion info
255         $course = new stdClass();
256         $course->id = $completion->course;
257         $info = new completion_info($course);
259         $module = $DB->get_record('course_modules', array('id' => $this->moduleinstance));
260         $data = $info->get_data($module, false, $completion->userid);
262         $activity = $DB->get_record($this->module, array('id' => $module->instance));
264         $details = array();
265         $details['type'] = $this->get_title();
266         $details['criteria'] = '<a href="'.$CFG->wwwroot.'/mod/'.$this->module.'/view.php?id='.$this->moduleinstance.'">'.$activity->name.'</a>';
268         // Build requirements
269         $details['requirement'] = array();
271         if ($module->completion == 1) {
272             $details['requirement'][] = get_string('markingyourselfcomplete', 'completion');
273         } elseif ($module->completion == 2) {
274             if ($module->completionview) {
275                 $details['requirement'][] = get_string('viewingactivity', 'completion', $this->module);
276             }
278             if (!is_null($module->completiongradeitemnumber)) {
279                 $details['requirement'][] = get_string('achievinggrade', 'completion');
280             }
281         }
283         $details['requirement'] = implode($details['requirement'], ', ');
285         $details['status'] = '';
287         return $details;
288     }