-
Notifications
You must be signed in to change notification settings - Fork 9
/
lib.php
165 lines (144 loc) · 4.68 KB
/
lib.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
<?php
// This file is part of a plugin for 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/>.
/**
* Moodle interface functions for activity modules
*
* @package mod_groupmembers
* @copyright 2017 Dennis M. Riehle, WWU Münster
* @copyright 2017 Jan C. Dageförde, WWU Münster
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
/**
* Define some constants
*/
define('GROUPMEMBERS_SHOWGROUPS_ALL', 0);
define('GROUPMEMBERS_SHOWGROUPS_OWN', 1);
define('GROUPMEMBERS_SHOWEMAIL_NO', 0);
define('GROUPMEMBERS_SHOWEMAIL_OWNGROUP', 1);
define('GROUPMEMBERS_SHOWEMAIL_ALLGROUPS', 2);
define('GROUPMEMBERS_SHOWFIELD_NO', 0);
define('GROUPMEMBERS_SHOWFIELD_OWNGROUP', 1);
define('GROUPMEMBERS_SHOWFIELD_ALLGROUPS', 2);
/**
* List of features supported in groupmembers module
* @param string $feature FEATURE_xx constant for requested feature
* @return mixed True if module supports feature, false if not, null if doesn't know
*/
function groupmembers_supports($feature) {
if (defined('FEATURE_MOD_PURPOSE')) {
if ($feature == FEATURE_MOD_PURPOSE) {
return MOD_PURPOSE_ADMINISTRATION;
}
}
switch($feature) {
case FEATURE_MOD_ARCHETYPE:
return MOD_ARCHETYPE_RESOURCE;
case FEATURE_GROUPS:
return false;
case FEATURE_GROUPINGS:
return false;
case FEATURE_MOD_INTRO:
return true;
case FEATURE_COMPLETION_TRACKS_VIEWS:
return true;
case FEATURE_GRADE_HAS_GRADE:
return false;
case FEATURE_GRADE_OUTCOMES:
return false;
case FEATURE_BACKUP_MOODLE2:
return true;
case FEATURE_SHOW_DESCRIPTION:
return true;
default:
return null;
}
}
/**
* Add groupmembers instance.
* @param stdClass $data
* @param mod_groupmembers_mod_form $mform
* @return int new groupmembers instance id
*/
function groupmembers_add_instance(stdClass $data, mod_groupmembers_mod_form $mform) {
global $DB;
$data->timemodified = time();
$data->id = $DB->insert_record('groupmembers', $data);
return $data->id;
}
/**
* Update groupmembers instance.
* @param stdClass $data
* @param mod_groupmembers_mod_form $mform
* @return bool true
*/
function groupmembers_update_instance($data, $mform) {
global $DB;
$data->timemodified = time();
$data->id = $data->instance;
$DB->update_record('groupmembers', $data);
return true;
}
/**
* Delete groupmembers instance.
* @param int $id
* @return bool true
*/
function groupmembers_delete_instance($id) {
global $DB;
if (!$groupmembers = $DB->get_record('groupmembers', ['id' => $id])) {
return false;
}
// Note: all context files are deleted automatically.
$DB->delete_records('groupmembers', ['id' => $groupmembers->id ]);
return true;
}
/**
* Gets a full groupmembers record
*
* @param int $groupmembersid
* @return stdClass|bool The groupmembers or false
*/
function groupmembers_get_groupmembers($groupmembersid) {
global $DB;
if ($groupmembers = $DB->get_record('groupmembers', ['id' => $groupmembersid])) {
return $groupmembers;
}
return false;
}
/**
* Mark the activity completed (if required) and trigger the course_module_viewed event.
*
* @param stdClass $groupmembers groupmembers object
* @param stdClass $course course object
* @param stdClass $cm course module object
* @param stdClass $context context object
* @since Moodle 3.0
*/
function groupmembers_view($groupmembers, $course, $cm, $context) {
// Trigger course_module_viewed event.
$params = [
'context' => $context,
'objectid' => $groupmembers->id,
];
$event = \mod_groupmembers\event\course_module_viewed::create($params);
$event->add_record_snapshot('course_modules', $cm);
$event->add_record_snapshot('course', $course);
$event->add_record_snapshot('groupmembers', $groupmembers);
$event->trigger();
// Completion.
$completion = new completion_info($course);
$completion->set_module_viewed($cm);
}