| 1 |
efrain |
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/>.
|
|
|
16 |
|
|
|
17 |
declare(strict_types=1);
|
|
|
18 |
|
|
|
19 |
namespace mod_lesson\completion;
|
|
|
20 |
|
|
|
21 |
use core_completion\activity_custom_completion;
|
|
|
22 |
|
|
|
23 |
/**
|
|
|
24 |
* Activity custom completion subclass for the lesson activity.
|
|
|
25 |
*
|
|
|
26 |
* Contains the class for defining mod_lesson's custom completion rules
|
|
|
27 |
* and fetching a lesson instance's completion statuses for a user.
|
|
|
28 |
*
|
|
|
29 |
* @package mod_lesson
|
|
|
30 |
* @copyright Michael Hawkins <michaelh@moodle.com>
|
|
|
31 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
32 |
*/
|
|
|
33 |
class custom_completion extends activity_custom_completion {
|
|
|
34 |
|
|
|
35 |
/**
|
|
|
36 |
* Fetches the completion state for a given completion rule.
|
|
|
37 |
*
|
|
|
38 |
* @param string $rule The completion rule.
|
|
|
39 |
* @return int The completion state.
|
|
|
40 |
*/
|
|
|
41 |
public function get_state(string $rule): int {
|
|
|
42 |
global $DB;
|
|
|
43 |
|
|
|
44 |
$this->validate_rule($rule);
|
|
|
45 |
|
|
|
46 |
switch ($rule) {
|
|
|
47 |
case 'completiontimespent':
|
|
|
48 |
$duration = $DB->get_field_sql(
|
|
|
49 |
"SELECT SUM(lessontime - starttime)
|
|
|
50 |
FROM {lesson_timer}
|
|
|
51 |
WHERE lessonid = :lessonid
|
|
|
52 |
AND userid = :userid",
|
|
|
53 |
['userid' => $this->userid, 'lessonid' => $this->cm->instance]);
|
|
|
54 |
|
|
|
55 |
$status = ($duration && $duration >= $this->cm->customdata['customcompletionrules']['completiontimespent']);
|
|
|
56 |
break;
|
|
|
57 |
case 'completionendreached':
|
|
|
58 |
$status = $DB->record_exists('lesson_timer',
|
|
|
59 |
['lessonid' => $this->cm->instance, 'userid' => $this->userid, 'completed' => 1]);
|
|
|
60 |
break;
|
|
|
61 |
default:
|
|
|
62 |
$status = false;
|
|
|
63 |
break;
|
|
|
64 |
}
|
|
|
65 |
|
|
|
66 |
return $status ? COMPLETION_COMPLETE : COMPLETION_INCOMPLETE;
|
|
|
67 |
}
|
|
|
68 |
|
|
|
69 |
/**
|
|
|
70 |
* Fetch the list of custom completion rules that this module defines.
|
|
|
71 |
*
|
|
|
72 |
* @return array
|
|
|
73 |
*/
|
|
|
74 |
public static function get_defined_custom_rules(): array {
|
|
|
75 |
return [
|
|
|
76 |
'completiontimespent',
|
|
|
77 |
'completionendreached',
|
|
|
78 |
];
|
|
|
79 |
}
|
|
|
80 |
|
|
|
81 |
/**
|
|
|
82 |
* Returns an associative array of the descriptions of custom completion rules.
|
|
|
83 |
*
|
|
|
84 |
* @return array
|
|
|
85 |
*/
|
|
|
86 |
public function get_custom_rule_descriptions(): array {
|
|
|
87 |
$timespent = format_time($this->cm->customdata['customcompletionrules']['completiontimespent'] ?? 0);
|
|
|
88 |
|
|
|
89 |
return [
|
|
|
90 |
'completiontimespent' => get_string('completiondetail:timespent', 'lesson', $timespent),
|
|
|
91 |
'completionendreached' => get_string('completiondetail:reachend', 'lesson'),
|
|
|
92 |
];
|
|
|
93 |
}
|
|
|
94 |
|
|
|
95 |
/**
|
|
|
96 |
* Returns an array of all completion rules, in the order they should be displayed to users.
|
|
|
97 |
*
|
|
|
98 |
* @return array
|
|
|
99 |
*/
|
|
|
100 |
public function get_sort_order(): array {
|
|
|
101 |
return [
|
|
|
102 |
'completionview',
|
|
|
103 |
'completiontimespent',
|
|
|
104 |
'completionendreached',
|
|
|
105 |
'completionusegrade',
|
|
|
106 |
'completionpassgrade',
|
|
|
107 |
];
|
|
|
108 |
}
|
|
|
109 |
}
|