a4127db67be89a9be21d2bdbd4ac03b34fc76b5f
[moodle.git] / badges / criteria / award_criteria.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  * Badge award criteria
19  *
20  * @package    core
21  * @subpackage badges
22  * @copyright  2012 onwards Totara Learning Solutions Ltd {@link http://www.totaralms.com/}
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  * @author     Yuliya Bozhko <yuliya.bozhko@totaralms.com>
25  */
27 defined('MOODLE_INTERNAL') || die();
29 /*
30  * Role completion criteria type
31  * Criteria type constant, primarily for storing criteria type in the database.
32  */
33 define('BADGE_CRITERIA_TYPE_OVERALL', 0);
35 /*
36  * Activity completion criteria type
37  * Criteria type constant, primarily for storing criteria type in the database.
38  */
39 define('BADGE_CRITERIA_TYPE_ACTIVITY', 1);
41 /*
42  * Duration completion criteria type
43  * Criteria type constant, primarily for storing criteria type in the database.
44  */
45 define('BADGE_CRITERIA_TYPE_MANUAL', 2);
47 /*
48  * Grade completion criteria type
49  * Criteria type constant, primarily for storing criteria type in the database.
50  */
51 define('BADGE_CRITERIA_TYPE_SOCIAL', 3);
53 /*
54  * Course completion criteria type
55  * Criteria type constant, primarily for storing criteria type in the database.
56 */
57 define('BADGE_CRITERIA_TYPE_COURSE', 4);
59 /*
60  * Courseset completion criteria type
61  * Criteria type constant, primarily for storing criteria type in the database.
62  */
63 define('BADGE_CRITERIA_TYPE_COURSESET', 5);
65 /*
66  * Course completion criteria type
67  * Criteria type constant, primarily for storing criteria type in the database.
68  */
69 define('BADGE_CRITERIA_TYPE_PROFILE', 6);
71 /*
72  * Criteria type constant to class name mapping
73  */
74 global $BADGE_CRITERIA_TYPES;
75 $BADGE_CRITERIA_TYPES = array(
76     BADGE_CRITERIA_TYPE_OVERALL   => 'overall',
77     BADGE_CRITERIA_TYPE_ACTIVITY  => 'activity',
78     BADGE_CRITERIA_TYPE_MANUAL    => 'manual',
79     BADGE_CRITERIA_TYPE_SOCIAL    => 'social',
80     BADGE_CRITERIA_TYPE_COURSE    => 'course',
81     BADGE_CRITERIA_TYPE_COURSESET => 'courseset',
82     BADGE_CRITERIA_TYPE_PROFILE   => 'profile'
83 );
85 /**
86  * Award criteria abstract definition
87  *
88  */
89 abstract class award_criteria {
91     /**
92      * ID of the criterion.
93      * @var integer
94      */
95     public $id;
97     /**
98      * Aggregation method [BADGE_CRITERIA_AGGREGATION_ANY, BADGE_CRITERIA_AGGREGATION_ALL].
99      * @var integer
100      */
101     public $method;
103     /**
104      * ID of a badge this criterion belongs to.
105      * @var integer
106      */
107     public $badgeid;
109     /**
110      * Criterion HTML/plain text description.
111      * @var string
112      */
113     public $description;
115     /**
116      * Any additional parameters.
117      * @var array
118      */
119     public $params = array();
121     /**
122      * The base constructor
123      *
124      * @param array $params
125      */
126     public function __construct($params) {
127         $this->id = isset($params['id']) ? $params['id'] : 0;
128         $this->method = isset($params['method']) ? $params['method'] : BADGE_CRITERIA_AGGREGATION_ANY;
129         $this->badgeid = $params['badgeid'];
130         $this->description = isset($params['description']) ? $params['description'] : '';
131         if (isset($params['id'])) {
132             $this->params = $this->get_params($params['id']);
133         }
134     }
136     /**
137      * Factory method for creating criteria class object
138      *
139      * @param array $params associative arrays varname => value
140      * @return award_criteria
141      */
142     public static function build($params) {
143         global $CFG, $BADGE_CRITERIA_TYPES;
145         if (!isset($params['criteriatype']) || !isset($BADGE_CRITERIA_TYPES[$params['criteriatype']])) {
146             print_error('error:invalidcriteriatype', 'badges');
147         }
149         $class = 'award_criteria_' . $BADGE_CRITERIA_TYPES[$params['criteriatype']];
150         require_once($CFG->dirroot . '/badges/criteria/' . $class . '.php');
152         return new $class($params);
153     }
155     /**
156      * Return criteria title
157      *
158      * @return string
159      */
160     public function get_title() {
161         return get_string('criteria_' . $this->criteriatype, 'badges');
162     }
164     /**
165      * Get criteria details for displaying to users
166      *
167      * @param string $short Print short version of criteria
168      * @return string
169      */
170     abstract public function get_details($short = '');
172     /**
173      * Add appropriate criteria options to the form
174      *
175      */
176     abstract public function get_options(&$mform);
178     /**
179      * Add appropriate parameter elements to the criteria form
180      *
181      */
182     public function config_options(&$mform, $param) {
183         global $OUTPUT;
184         $prefix = $this->required_param . '_';
186         if ($param['error']) {
187             $parameter[] =& $mform->createElement('advcheckbox', $prefix . $param['id'], '',
188                     $OUTPUT->error_text($param['name']), null, array(0, $param['id']));
189             $mform->addGroup($parameter, 'param_' . $prefix . $param['id'], '', array(' '), false);
190         } else {
191             $parameter[] =& $mform->createElement('advcheckbox', $prefix . $param['id'], '', $param['name'], null, array(0, $param['id']));
192             $parameter[] =& $mform->createElement('static', 'break_start_' . $param['id'], null, '<div style="margin-left: 3em;">');
194             if (in_array('grade', $this->optional_params)) {
195                 $parameter[] =& $mform->createElement('static', 'mgrade_' . $param['id'], null, get_string('mingrade', 'badges'));
196                 $parameter[] =& $mform->createElement('text', 'grade_' . $param['id'], '', array('size' => '5'));
197                 $mform->setType('grade_' . $param['id'], PARAM_INT);
198             }
200             if (in_array('bydate', $this->optional_params)) {
201                 $parameter[] =& $mform->createElement('static', 'complby_' . $param['id'], null, get_string('bydate', 'badges'));
202                 $parameter[] =& $mform->createElement('date_selector', 'bydate_' . $param['id'], "", array('optional' => true));
203             }
205             $parameter[] =& $mform->createElement('static', 'break_end_' . $param['id'], null, '</div>');
206             $mform->addGroup($parameter, 'param_' . $prefix . $param['id'], '', array(' '), false);
207             if (in_array('grade', $this->optional_params)) {
208                 $mform->addGroupRule('param_' . $prefix . $param['id'], array(
209                     'grade_' . $param['id'] => array(array(get_string('err_numeric', 'form'), 'numeric', '', 'client'))));
210             }
211             $mform->disabledIf('bydate_' . $param['id'] . '[day]', 'bydate_' . $param['id'] . '[enabled]', 'notchecked');
212             $mform->disabledIf('bydate_' . $param['id'] . '[month]', 'bydate_' . $param['id'] . '[enabled]', 'notchecked');
213             $mform->disabledIf('bydate_' . $param['id'] . '[year]', 'bydate_' . $param['id'] . '[enabled]', 'notchecked');
214             $mform->disabledIf('param_' . $prefix . $param['id'], $prefix . $param['id'], 'notchecked');
215         }
217         // Set default values.
218         $mform->setDefault($prefix . $param['id'], $param['checked']);
219         if (isset($param['bydate'])) {
220             $mform->setDefault('bydate_' . $param['id'], $param['bydate']);
221         }
222         if (isset($param['grade'])) {
223             $mform->setDefault('grade_' . $param['id'], $param['grade']);
224         }
225     }
227     /**
228      * Add appropriate criteria elements
229      *
230      * @param stdClass $data details of various criteria
231      */
232     public function config_form_criteria($data) {
233         global $OUTPUT;
234         $agg = $data->get_aggregation_methods();
236         $editurl = new moodle_url('/badges/criteria_settings.php',
237                 array('badgeid' => $this->badgeid, 'edit' => true, 'type' => $this->criteriatype, 'crit' => $this->id));
238         $deleteurl = new moodle_url('/badges/criteria_action.php',
239                 array('badgeid' => $this->badgeid, 'delete' => true, 'type' => $this->criteriatype));
240         $editaction = $OUTPUT->action_icon($editurl, new pix_icon('t/edit', get_string('edit')), null, array('class' => 'criteria-action'));
241         $deleteaction = $OUTPUT->action_icon($deleteurl, new pix_icon('t/delete', get_string('delete')), null, array('class' => 'criteria-action'));
243         echo $OUTPUT->box_start();
244         if (!$data->is_locked() && !$data->is_active()) {
245             echo $OUTPUT->box($deleteaction . $editaction, array('criteria-header'));
246         }
247         echo $OUTPUT->heading($this->get_title() . $OUTPUT->help_icon('criteria_' . $this->criteriatype, 'badges'), 3, 'main help');
249         if (!empty($this->description)) {
250             $badge = new badge($this->badgeid);
251             echo $OUTPUT->box(
252                 format_text($this->description, FORMAT_HTML, array('context' => $badge->get_context())),
253                 'criteria-description'
254                 );
255         }
257         if (!empty($this->params)) {
258             if (count($this->params) > 1) {
259                 echo $OUTPUT->box(get_string('criteria_descr_' . $this->criteriatype, 'badges',
260                         core_text::strtoupper($agg[$data->get_aggregation_method($this->criteriatype)])), array('clearfix'));
261             } else {
262                 echo $OUTPUT->box(get_string('criteria_descr_single_' . $this->criteriatype , 'badges'), array('clearfix'));
263             }
264             echo $OUTPUT->box($this->get_details(), array('clearfix'));
265         }
266         echo $OUTPUT->box_end();
267     }
269     /**
270      * Review this criteria and decide if the user has completed
271      *
272      * @param int $userid User whose criteria completion needs to be reviewed.
273      * @param bool $filtered An additional parameter indicating that user list
274      *        has been reduced and some expensive checks can be skipped.
275      *
276      * @return bool Whether criteria is complete
277      */
278     abstract public function review($userid, $filtered = false);
280     /**
281      * Returns array with sql code and parameters returning all ids
282      * of users who meet this particular criterion.
283      *
284      * @return array list($join, $where, $params)
285      */
286     abstract public function get_completed_criteria_sql();
288     /**
289      * Mark this criteria as complete for a user
290      *
291      * @param int $userid User whose criteria is completed.
292      */
293     public function mark_complete($userid) {
294         global $DB;
295         $obj = array();
296         $obj['critid'] = $this->id;
297         $obj['userid'] = $userid;
298         $obj['datemet'] = time();
299         if (!$DB->record_exists('badge_criteria_met', array('critid' => $this->id, 'userid' => $userid))) {
300             $DB->insert_record('badge_criteria_met', $obj);
301         }
302     }
304     /**
305      * Return criteria parameters
306      *
307      * @param int $critid Criterion ID
308      * @return array
309      */
310     public function get_params($cid) {
311         global $DB;
312         $params = array();
314         $records = $DB->get_records('badge_criteria_param', array('critid' => $cid));
315         foreach ($records as $rec) {
316             $arr = explode('_', $rec->name);
317             $params[$arr[1]][$arr[0]] = $rec->value;
318         }
320         return $params;
321     }
323     /**
324      * Delete this criterion
325      *
326      */
327     public function delete() {
328         global $DB;
330         // Remove any records if it has already been met.
331         $DB->delete_records('badge_criteria_met', array('critid' => $this->id));
333         // Remove all parameters records.
334         $DB->delete_records('badge_criteria_param', array('critid' => $this->id));
336         // Finally remove criterion itself.
337         $DB->delete_records('badge_criteria', array('id' => $this->id));
338     }
340     /**
341      * Saves intial criteria records with required parameters set up.
342      *
343      * @param array $params Values from the form or any other array.
344      */
345     public function save($params = array()) {
346         global $DB;
348         // Figure out criteria description.
349         // If it is coming from the form editor, it is an array(text, format).
350         $description = '';
351         if (isset($params['description']['text'])) {
352             $description = $params['description']['text'];
353         } else if (isset($params['description'])) {
354             $description = $params['description'];
355         }
357         $fordb = new stdClass();
358         $fordb->criteriatype = $this->criteriatype;
359         $fordb->method = isset($params['agg']) ? $params['agg'] : BADGE_CRITERIA_AGGREGATION_ALL;
360         $fordb->badgeid = $this->badgeid;
361         $fordb->description = $description;
362         $t = $DB->start_delegated_transaction();
364         // Pick only params that are required by this criterion.
365         // Filter out empty values first.
366         $params = array_filter((array)$params);
367         // Find out which param matches optional and required ones.
368         $match = array_merge($this->optional_params, array($this->required_param));
369         $regex = implode('|', array_map(create_function('$a', 'return $a . "_";'), $match));
370         $requiredkeys = preg_grep('/^(' . $regex . ').*$/', array_keys($params));
372         if ($this->id !== 0) {
373             $cid = $this->id;
375             // Update criteria before doing anything with parameters.
376             $fordb->id = $cid;
377             $DB->update_record('badge_criteria', $fordb, true);
379             $existing = $DB->get_fieldset_select('badge_criteria_param', 'name', 'critid = ?', array($cid));
380             $todelete = array_diff($existing, $requiredkeys);
382             if (!empty($todelete)) {
383                 // A workaround to add some disabled elements that are still being submitted from the form.
384                 foreach ($todelete as $del) {
385                     $name = explode('_', $del);
386                     if ($name[0] == $this->required_param) {
387                         foreach ($this->optional_params as $opt) {
388                             $todelete[] = $opt . '_' . $name[1];
389                         }
390                     }
391                 }
392                 $todelete = array_unique($todelete);
393                 list($sql, $sqlparams) = $DB->get_in_or_equal($todelete, SQL_PARAMS_NAMED, 'd', true);
394                 $sqlparams = array_merge(array('critid' => $cid), $sqlparams);
395                 $DB->delete_records_select('badge_criteria_param', 'critid = :critid AND name ' . $sql, $sqlparams);
396             }
398             foreach ($requiredkeys as $key) {
399                 if (in_array($key, $existing)) {
400                     $updp = $DB->get_record('badge_criteria_param', array('name' => $key, 'critid' => $cid));
401                     $updp->value = $params[$key];
402                     $DB->update_record('badge_criteria_param', $updp, true);
403                 } else {
404                     $newp = new stdClass();
405                     $newp->critid = $cid;
406                     $newp->name = $key;
407                     $newp->value = $params[$key];
408                     $DB->insert_record('badge_criteria_param', $newp);
409                 }
410             }
411         } else {
412             $cid = $DB->insert_record('badge_criteria', $fordb, true);
413             if ($cid) {
414                 foreach ($requiredkeys as $key) {
415                     $newp = new stdClass();
416                     $newp->critid = $cid;
417                     $newp->name = $key;
418                     $newp->value = $params[$key];
419                     $DB->insert_record('badge_criteria_param', $newp, false, true);
420                 }
421             }
422         }
423         $t->allow_commit();
424     }
426     /**
427      * Saves intial criteria records with required parameters set up.
428      */
429     public function make_clone($newbadgeid) {
430         global $DB;
432         $fordb = new stdClass();
433         $fordb->criteriatype = $this->criteriatype;
434         $fordb->method = $this->method;
435         $fordb->badgeid = $newbadgeid;
436         $fordb->description = $this->description;
437         if (($newcrit = $DB->insert_record('badge_criteria', $fordb, true)) && isset($this->params)) {
438             foreach ($this->params as $k => $param) {
439                 foreach ($param as $key => $value) {
440                     $paramdb = new stdClass();
441                     $paramdb->critid = $newcrit;
442                     $paramdb->name = $key . '_' . $k;
443                     $paramdb->value = $value;
444                     $DB->insert_record('badge_criteria_param', $paramdb);
445                 }
446             }
447         }
448     }