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