54277830528d960a1e48fbc192804a793bb83b33
[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  * Badge completion criteria type
73  * Criteria type constant, primarily for storing criteria type in the database.
74  */
75 define('BADGE_CRITERIA_TYPE_BADGE', 7);
77 /*
78  * Criteria type constant to class name mapping
79  */
80 global $BADGE_CRITERIA_TYPES;
81 $BADGE_CRITERIA_TYPES = array(
82     BADGE_CRITERIA_TYPE_OVERALL   => 'overall',
83     BADGE_CRITERIA_TYPE_ACTIVITY  => 'activity',
84     BADGE_CRITERIA_TYPE_MANUAL    => 'manual',
85     BADGE_CRITERIA_TYPE_SOCIAL    => 'social',
86     BADGE_CRITERIA_TYPE_COURSE    => 'course',
87     BADGE_CRITERIA_TYPE_COURSESET => 'courseset',
88     BADGE_CRITERIA_TYPE_PROFILE   => 'profile',
89     BADGE_CRITERIA_TYPE_BADGE     => 'badge',
90 );
92 /**
93  * Award criteria abstract definition
94  *
95  */
96 abstract class award_criteria {
98     /**
99      * ID of the criterion.
100      * @var integer
101      */
102     public $id;
104     /**
105      * Aggregation method [BADGE_CRITERIA_AGGREGATION_ANY, BADGE_CRITERIA_AGGREGATION_ALL].
106      * @var integer
107      */
108     public $method;
110     /**
111      * ID of a badge this criterion belongs to.
112      * @var integer
113      */
114     public $badgeid;
116     /**
117      * Criterion HTML/plain text description.
118      * @var string
119      */
120     public $description;
122     /**
123      * Format of the criterion description.
124      * @var integer
125      */
126     public $descriptionformat;
128     /**
129      * Any additional parameters.
130      * @var array
131      */
132     public $params = array();
134     /**
135      * The base constructor
136      *
137      * @param array $params
138      */
139     public function __construct($params) {
140         $this->id = isset($params['id']) ? $params['id'] : 0;
141         $this->method = isset($params['method']) ? $params['method'] : BADGE_CRITERIA_AGGREGATION_ANY;
142         $this->badgeid = $params['badgeid'];
143         $this->description = isset($params['description']) ? $params['description'] : '';
144         $this->descriptionformat = isset($params['descriptionformat']) ? $params['descriptionformat'] : FORMAT_HTML;
145         if (isset($params['id'])) {
146             $this->params = $this->get_params($params['id']);
147         }
148     }
150     /**
151      * Factory method for creating criteria class object
152      *
153      * @param array $params associative arrays varname => value
154      * @return award_criteria
155      */
156     public static function build($params) {
157         global $CFG, $BADGE_CRITERIA_TYPES;
159         if (!isset($params['criteriatype']) || !isset($BADGE_CRITERIA_TYPES[$params['criteriatype']])) {
160             print_error('error:invalidcriteriatype', 'badges');
161         }
163         $class = 'award_criteria_' . $BADGE_CRITERIA_TYPES[$params['criteriatype']];
164         require_once($CFG->dirroot . '/badges/criteria/' . $class . '.php');
166         return new $class($params);
167     }
169     /**
170      * Return criteria title
171      *
172      * @return string
173      */
174     public function get_title() {
175         return get_string('criteria_' . $this->criteriatype, 'badges');
176     }
178     /**
179      * Get criteria details for displaying to users
180      *
181      * @param string $short Print short version of criteria
182      * @return string
183      */
184     abstract public function get_details($short = '');
186     /**
187      * Add appropriate criteria options to the form
188      *
189      */
190     abstract public function get_options(&$mform);
192     /**
193      * Add appropriate parameter elements to the criteria form
194      *
195      */
196     public function config_options(&$mform, $param) {
197         global $OUTPUT;
198         $prefix = $this->required_param . '_';
200         if ($param['error']) {
201             $parameter[] =& $mform->createElement('advcheckbox', $prefix . $param['id'], '',
202                     $OUTPUT->error_text($param['name']), null, array(0, $param['id']));
203             $mform->addGroup($parameter, 'param_' . $prefix . $param['id'], '', array(' '), false);
204         } else {
205             $parameter[] =& $mform->createElement('advcheckbox', $prefix . $param['id'], '', $param['name'], null, array(0, $param['id']));
206             $parameter[] =& $mform->createElement('static', 'break_start_' . $param['id'], null, '<div style="margin-left: 3em;">');
208             if (in_array('grade', $this->optional_params)) {
209                 $parameter[] =& $mform->createElement('static', 'mgrade_' . $param['id'], null, get_string('mingrade', 'badges'));
210                 $parameter[] =& $mform->createElement('text', 'grade_' . $param['id'], '', array('size' => '5'));
211                 $mform->setType('grade_' . $param['id'], PARAM_INT);
212             }
214             if (in_array('bydate', $this->optional_params)) {
215                 $parameter[] =& $mform->createElement('static', 'complby_' . $param['id'], null, get_string('bydate', 'badges'));
216                 $parameter[] =& $mform->createElement('date_selector', 'bydate_' . $param['id'], "", array('optional' => true));
217             }
219             $parameter[] =& $mform->createElement('static', 'break_end_' . $param['id'], null, '</div>');
220             $mform->addGroup($parameter, 'param_' . $prefix . $param['id'], '', array(' '), false);
221             if (in_array('grade', $this->optional_params)) {
222                 $mform->addGroupRule('param_' . $prefix . $param['id'], array(
223                     'grade_' . $param['id'] => array(array(get_string('err_numeric', 'form'), 'numeric', '', 'client'))));
224             }
225             $mform->disabledIf('bydate_' . $param['id'] . '[day]', 'bydate_' . $param['id'] . '[enabled]', 'notchecked');
226             $mform->disabledIf('bydate_' . $param['id'] . '[month]', 'bydate_' . $param['id'] . '[enabled]', 'notchecked');
227             $mform->disabledIf('bydate_' . $param['id'] . '[year]', 'bydate_' . $param['id'] . '[enabled]', 'notchecked');
228             $mform->disabledIf('param_' . $prefix . $param['id'], $prefix . $param['id'], 'notchecked');
229         }
231         // Set default values.
232         $mform->setDefault($prefix . $param['id'], $param['checked']);
233         if (isset($param['bydate'])) {
234             $mform->setDefault('bydate_' . $param['id'], $param['bydate']);
235         }
236         if (isset($param['grade'])) {
237             $mform->setDefault('grade_' . $param['id'], $param['grade']);
238         }
239     }
241     /**
242      * Add appropriate criteria elements
243      *
244      * @param stdClass $data details of various criteria
245      */
246     public function config_form_criteria($data) {
247         global $OUTPUT;
248         $agg = $data->get_aggregation_methods();
250         $editurl = new moodle_url('/badges/criteria_settings.php',
251                 array('badgeid' => $this->badgeid, 'edit' => true, 'type' => $this->criteriatype, 'crit' => $this->id));
252         $deleteurl = new moodle_url('/badges/criteria_action.php',
253                 array('badgeid' => $this->badgeid, 'delete' => true, 'type' => $this->criteriatype));
254         $editaction = $OUTPUT->action_icon($editurl, new pix_icon('t/edit', get_string('edit')), null, array('class' => 'criteria-action'));
255         $deleteaction = $OUTPUT->action_icon($deleteurl, new pix_icon('t/delete', get_string('delete')), null, array('class' => 'criteria-action'));
257         echo $OUTPUT->box_start();
258         if (!$data->is_locked() && !$data->is_active()) {
259             echo $OUTPUT->box($deleteaction . $editaction, array('criteria-header'));
260         }
261         echo $OUTPUT->heading($this->get_title() . $OUTPUT->help_icon('criteria_' . $this->criteriatype, 'badges'), 3, 'main help');
263         if (!empty($this->description)) {
264             $badge = new badge($this->badgeid);
265             echo $OUTPUT->box(
266                 format_text($this->description, $this->descriptionformat, array('context' => $badge->get_context())),
267                 'criteria-description'
268                 );
269         }
271         if (!empty($this->params)) {
272             if (count($this->params) > 1) {
273                 echo $OUTPUT->box(get_string('criteria_descr_' . $this->criteriatype, 'badges',
274                         core_text::strtoupper($agg[$data->get_aggregation_method($this->criteriatype)])), array('clearfix'));
275             } else {
276                 echo $OUTPUT->box(get_string('criteria_descr_single_' . $this->criteriatype , 'badges'), array('clearfix'));
277             }
278             echo $OUTPUT->box($this->get_details(), array('clearfix'));
279         }
280         echo $OUTPUT->box_end();
281     }
283     /**
284      * Review this criteria and decide if the user has completed
285      *
286      * @param int $userid User whose criteria completion needs to be reviewed.
287      * @param bool $filtered An additional parameter indicating that user list
288      *        has been reduced and some expensive checks can be skipped.
289      *
290      * @return bool Whether criteria is complete
291      */
292     abstract public function review($userid, $filtered = false);
294     /**
295      * Returns array with sql code and parameters returning all ids
296      * of users who meet this particular criterion.
297      *
298      * @return array list($join, $where, $params)
299      */
300     abstract public function get_completed_criteria_sql();
302     /**
303      * Mark this criteria as complete for a user
304      *
305      * @param int $userid User whose criteria is completed.
306      */
307     public function mark_complete($userid) {
308         global $DB;
309         $obj = array();
310         $obj['critid'] = $this->id;
311         $obj['userid'] = $userid;
312         $obj['datemet'] = time();
313         if (!$DB->record_exists('badge_criteria_met', array('critid' => $this->id, 'userid' => $userid))) {
314             $DB->insert_record('badge_criteria_met', $obj);
315         }
316     }
318     /**
319      * Return criteria parameters
320      *
321      * @param int $critid Criterion ID
322      * @return array
323      */
324     public function get_params($cid) {
325         global $DB;
326         $params = array();
328         $records = $DB->get_records('badge_criteria_param', array('critid' => $cid));
329         foreach ($records as $rec) {
330             $arr = explode('_', $rec->name);
331             $params[$arr[1]][$arr[0]] = $rec->value;
332         }
334         return $params;
335     }
337     /**
338      * Delete this criterion
339      *
340      */
341     public function delete() {
342         global $DB, $PAGE;
344         // Remove any records if it has already been met.
345         $DB->delete_records('badge_criteria_met', array('critid' => $this->id));
347         // Remove all parameters records.
348         $DB->delete_records('badge_criteria_param', array('critid' => $this->id));
350         // Finally remove criterion itself.
351         $DB->delete_records('badge_criteria', array('id' => $this->id));
353         // Trigger event, badge criteria deleted.
354         $eventparams = array('objectid' => $this->id,
355             'context' => $PAGE->context,
356             'other' => array('badgeid' => $this->badgeid));
357         $event = \core\event\badge_criteria_deleted::create($eventparams);
358         $event->trigger();
359     }
361     /**
362      * Saves intial criteria records with required parameters set up.
363      *
364      * @param array $params Values from the form or any other array.
365      */
366     public function save($params = array()) {
367         global $DB, $PAGE;
369         // Figure out criteria description.
370         // If it is coming from the form editor, it is an array(text, format).
371         $description = '';
372         $descriptionformat = FORMAT_HTML;
373         if (isset($params['description']['text'])) {
374             $description = $params['description']['text'];
375             $descriptionformat = $params['description']['format'];
376         } else if (isset($params['description'])) {
377             $description = $params['description'];
378         }
380         $fordb = new stdClass();
381         $fordb->criteriatype = $this->criteriatype;
382         $fordb->method = isset($params['agg']) ? $params['agg'] : BADGE_CRITERIA_AGGREGATION_ALL;
383         $fordb->badgeid = $this->badgeid;
384         $fordb->description = $description;
385         $fordb->descriptionformat = $descriptionformat;
386         $t = $DB->start_delegated_transaction();
388         // Pick only params that are required by this criterion.
389         // Filter out empty values first.
390         $params = array_filter($params);
391         // Find out which param matches optional and required ones.
392         $match = array_merge($this->optional_params, array($this->required_param));
393         $regex = implode('|', array_map(function($a) {
394             return $a . "_";
395         }, $match));
396         $requiredkeys = preg_grep('/^(' . $regex . ').*$/', array_keys($params));
398         if ($this->id !== 0) {
399             $cid = $this->id;
401             // Update criteria before doing anything with parameters.
402             $fordb->id = $cid;
403             $DB->update_record('badge_criteria', $fordb, true);
405             // Trigger event: badge_criteria_updated.
406             $eventparams = array('objectid' => $this->id,
407                 'context' => $PAGE->context,
408                 'other' => array('badgeid' => $this->badgeid));
409             $event = \core\event\badge_criteria_updated::create($eventparams);
410             $event->trigger();
412             $existing = $DB->get_fieldset_select('badge_criteria_param', 'name', 'critid = ?', array($cid));
413             $todelete = array_diff($existing, $requiredkeys);
415             if (!empty($todelete)) {
416                 // A workaround to add some disabled elements that are still being submitted from the form.
417                 foreach ($todelete as $del) {
418                     $name = explode('_', $del);
419                     if ($name[0] == $this->required_param) {
420                         foreach ($this->optional_params as $opt) {
421                             $todelete[] = $opt . '_' . $name[1];
422                         }
423                     }
424                 }
425                 $todelete = array_unique($todelete);
426                 list($sql, $sqlparams) = $DB->get_in_or_equal($todelete, SQL_PARAMS_NAMED, 'd', true);
427                 $sqlparams = array_merge(array('critid' => $cid), $sqlparams);
428                 $DB->delete_records_select('badge_criteria_param', 'critid = :critid AND name ' . $sql, $sqlparams);
429             }
431             foreach ($requiredkeys as $key) {
432                 if (in_array($key, $existing)) {
433                     $updp = $DB->get_record('badge_criteria_param', array('name' => $key, 'critid' => $cid));
434                     $updp->value = $params[$key];
435                     $DB->update_record('badge_criteria_param', $updp, true);
436                 } else {
437                     $newp = new stdClass();
438                     $newp->critid = $cid;
439                     $newp->name = $key;
440                     $newp->value = $params[$key];
441                     $DB->insert_record('badge_criteria_param', $newp);
442                 }
443             }
444         } else {
445             $cid = $DB->insert_record('badge_criteria', $fordb, true);
446             if ($cid) {
447                 foreach ($requiredkeys as $key) {
448                     $newp = new stdClass();
449                     $newp->critid = $cid;
450                     $newp->name = $key;
451                     $newp->value = $params[$key];
452                     $DB->insert_record('badge_criteria_param', $newp, false, true);
453                 }
454             }
455             // Trigger event: badge_criteria_created.
456             $eventparams = array('objectid' => $this->id,
457                 'context' => $PAGE->context,
458                 'other' => array('badgeid' => $this->badgeid));
459             $event = \core\event\badge_criteria_created::create($eventparams);
460             $event->trigger();
461         }
462         $t->allow_commit();
463     }
465     /**
466      * Saves intial criteria records with required parameters set up.
467      */
468     public function make_clone($newbadgeid) {
469         global $DB;
471         $fordb = new stdClass();
472         $fordb->criteriatype = $this->criteriatype;
473         $fordb->method = $this->method;
474         $fordb->badgeid = $newbadgeid;
475         $fordb->description = $this->description;
476         $fordb->descriptionformat = $this->descriptionformat;
477         if (($newcrit = $DB->insert_record('badge_criteria', $fordb, true)) && isset($this->params)) {
478             foreach ($this->params as $k => $param) {
479                 foreach ($param as $key => $value) {
480                     $paramdb = new stdClass();
481                     $paramdb->critid = $newcrit;
482                     $paramdb->name = $key . '_' . $k;
483                     $paramdb->value = $value;
484                     $DB->insert_record('badge_criteria_param', $paramdb);
485                 }
486             }
487         }
488     }