| 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_forum\completion;
|
|
|
20 |
|
|
|
21 |
use core_completion\activity_custom_completion;
|
|
|
22 |
|
|
|
23 |
/**
|
|
|
24 |
* Activity custom completion subclass for the forum activity.
|
|
|
25 |
*
|
|
|
26 |
* Class for defining mod_forum's custom completion rules and fetching the completion statuses
|
|
|
27 |
* of the custom completion rules for a given forum instance and a user.
|
|
|
28 |
*
|
|
|
29 |
* @package mod_forum
|
|
|
30 |
* @copyright Simey Lameze <simey@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 |
$userid = $this->userid;
|
|
|
47 |
$forumid = $this->cm->instance;
|
|
|
48 |
|
|
|
49 |
if (!$forum = $DB->get_record('forum', ['id' => $forumid])) {
|
|
|
50 |
throw new \moodle_exception('Unable to find forum with id ' . $forumid);
|
|
|
51 |
}
|
|
|
52 |
|
|
|
53 |
$postcountparams = ['userid' => $userid, 'forumid' => $forumid];
|
|
|
54 |
$postcountsql = "SELECT COUNT(*)
|
|
|
55 |
FROM {forum_posts} fp
|
|
|
56 |
JOIN {forum_discussions} fd ON fp.discussion = fd.id
|
|
|
57 |
WHERE fp.userid = :userid
|
|
|
58 |
AND fd.forum = :forumid";
|
|
|
59 |
|
|
|
60 |
if ($rule == 'completiondiscussions') {
|
|
|
61 |
$status = $forum->completiondiscussions <=
|
|
|
62 |
$DB->count_records('forum_discussions', ['forum' => $forumid, 'userid' => $userid]);
|
|
|
63 |
} else if ($rule == 'completionreplies') {
|
|
|
64 |
$status = $forum->completionreplies <=
|
|
|
65 |
$DB->get_field_sql($postcountsql . ' AND fp.parent <> 0', $postcountparams);
|
|
|
66 |
} else if ($rule == 'completionposts') {
|
|
|
67 |
$status = $forum->completionposts <= $DB->get_field_sql($postcountsql, $postcountparams);
|
|
|
68 |
}
|
|
|
69 |
|
|
|
70 |
return $status ? COMPLETION_COMPLETE : COMPLETION_INCOMPLETE;
|
|
|
71 |
}
|
|
|
72 |
|
|
|
73 |
/**
|
|
|
74 |
* Fetch the list of custom completion rules that this module defines.
|
|
|
75 |
*
|
|
|
76 |
* @return array
|
|
|
77 |
*/
|
|
|
78 |
public static function get_defined_custom_rules(): array {
|
|
|
79 |
return [
|
|
|
80 |
'completiondiscussions',
|
|
|
81 |
'completionreplies',
|
|
|
82 |
'completionposts',
|
|
|
83 |
];
|
|
|
84 |
}
|
|
|
85 |
|
|
|
86 |
/**
|
|
|
87 |
* Returns an associative array of the descriptions of custom completion rules.
|
|
|
88 |
*
|
|
|
89 |
* @return array
|
|
|
90 |
*/
|
|
|
91 |
public function get_custom_rule_descriptions(): array {
|
|
|
92 |
$completiondiscussions = $this->cm->customdata['customcompletionrules']['completiondiscussions'] ?? 0;
|
|
|
93 |
$completionreplies = $this->cm->customdata['customcompletionrules']['completionreplies'] ?? 0;
|
|
|
94 |
$completionposts = $this->cm->customdata['customcompletionrules']['completionposts'] ?? 0;
|
|
|
95 |
|
|
|
96 |
return [
|
|
|
97 |
'completiondiscussions' => get_string('completiondetail:discussions', 'forum', $completiondiscussions),
|
|
|
98 |
'completionreplies' => get_string('completiondetail:replies', 'forum', $completionreplies),
|
|
|
99 |
'completionposts' => get_string('completiondetail:posts', 'forum', $completionposts),
|
|
|
100 |
];
|
|
|
101 |
}
|
|
|
102 |
|
|
|
103 |
/**
|
|
|
104 |
* Returns an array of all completion rules, in the order they should be displayed to users.
|
|
|
105 |
*
|
|
|
106 |
* @return array
|
|
|
107 |
*/
|
|
|
108 |
public function get_sort_order(): array {
|
|
|
109 |
return [
|
|
|
110 |
'completionview',
|
|
|
111 |
'completiondiscussions',
|
|
|
112 |
'completionreplies',
|
|
|
113 |
'completionposts',
|
|
|
114 |
'completionusegrade',
|
|
|
115 |
'completionpassgrade',
|
|
|
116 |
];
|
|
|
117 |
}
|
|
|
118 |
}
|