-
Notifications
You must be signed in to change notification settings - Fork 0
/
lib.php
222 lines (182 loc) · 6.25 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
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
<?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/>.
/**
* Affiliations
*
* This plugin is designed to work with Moodle 3.2+ and allows students to select
* which entities they would like to be affiliated with. The student will be placed
* into the corresponding cohort.
*
* @package local
* @subpackage affiliations
* @copyright 2018 Saylor Academy
* @author John Azinheira
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*
*/
defined('MOODLE_INTERNAL') || die();
/**
* Add nodes to myprofile page.
*
* @param \core_user\output\myprofile\tree $tree Tree object
* @param stdClass $user user object
* @param bool $iscurrentuser
* @param stdClass $course Course object
*
* @return bool
*/
function local_affiliations_myprofile_navigation(core_user\output\myprofile\tree $tree, $user, $iscurrentuser, $course) {
global $PAGE, $USER;
$systemcontext = context_system::instance();
$title = get_string('manageaffiliations', 'local_affiliations');
// For now, requiring a session key in index.php. This means that users can only manage their affiliations through this link.
$url = new moodle_url('/local/affiliations/index.php', array('sesskey'=>sesskey()));
// Should be the same capability checks as editing your own profile in myprofile lib.
if ((isloggedin() && !isguestuser($user) && !is_mnet_remote_user($user)) && $iscurrentuser && has_capability('moodle/user:editownprofile', $systemcontext)) {
$node = new core_user\output\myprofile\node('miscellaneous', 'affiliations', $title, null,
$url);
$tree->add_node($node);
return true;
}
return false;
}
/**
* Get the list of affiliates and info.
*
*
* @return array of affiliates
*/
function local_affiliations_get_affiliates() {
global $DB;
// Get all the affiliates and load into an array.
$affiliates = $DB->get_records('local_affiliations_affiliate');
//foreach ($affiliates as $affiliate) {
// $data[] = array('id' => $affiliate->id,
// 'cohortid' => $affiliate->cohortid,
// 'fullname' => $affiliate->fullname,
// 'shortname' => $affiliate->shortname);
//}
return $affiliates;
}
/**
* Check whether the supplied affiliate name and code are already in use.
*
* @param string $name
* @param string $code
*
* @return bool
*/
function local_affiliations_check_current_affiliates($name, $code) {
$pass = true;
$affiliates = local_affiliations_get_affiliates();
foreach ($affiliates as $affiliate) {
if ($affiliate->fullname == $name) {
$pass = false;
break;
}
if ($affiliate->shortname == $code) {
$pass = false;
break;
}
}
return $pass;
}
/**
* Check whether the user is a member of the supplied affiliate's cohort.
*
* @param int $userid
* @param int $affiliateid
*
* @return bool
*/
function local_affiliations_is_member($userid, $affiliateid) {
require_once(__DIR__ . '/../../cohort/lib.php');
global $DB;
$ismember = false;
$affiliate = $DB->get_record('local_affiliations_affiliate', array('id' => $affiliateid), '*', MUST_EXIST);
$ismember = cohort_is_member($affiliate->cohortid, $userid);
return $ismember;
}
/**
* Determine which affiliations the user has removed.
*
* @param int $userid
* @param array $submittedaffiliations
*
* @return array | null
*/
function local_affiliations_get_removed_affiliations($userid, $submittedaffiliations) {
require_once(__DIR__ . '/../../cohort/lib.php');
global $DB;
$removedaffiliations = array();
foreach ($submittedaffiliations as $affiliateid => $submittedaffiliation) {
$ismember = local_affiliations_is_member($userid, $affiliateid);
if ($ismember == true && $submittedaffiliation == false) {
// User has removed this affiliation, add to array.
$removedaffiliations[] = $affiliateid;
}
}
return $removedaffiliations;
}
/**
* Determine which affiliations the user has added.
*
* @param int $userid
* @param array $submittedaffiliations
*
* @return array | null
*/
function local_affiliations_get_added_affiliations($userid, $submittedaffiliations) {
require_once(__DIR__ . '/../../cohort/lib.php');
global $DB;
$addedaffiliations = array();
foreach ($submittedaffiliations as $affiliateid => $submittedaffiliation) {
$ismember = local_affiliations_is_member($userid, $affiliateid);
if ($ismember == false && $submittedaffiliation == true) {
// User has removed this affiliation, add to array.
$addedaffiliations[] = $affiliateid;
}
}
return $addedaffiliations;
}
/**
* Add a user to the cohort of the supplied affiliate.
*
* @param int $userid
* @param int $affiliateid
*
* @return void
*/
function local_affiliations_add_affiliation($userid, $affiliateid) {
require_once(__DIR__ . '/../../cohort/lib.php');
global $DB;
$affiliate = $DB->get_record('local_affiliations_affiliate', array('id' => $affiliateid), '*', MUST_EXIST);
cohort_add_member($affiliate->cohortid, $userid);
}
/**
* Remove a user from the cohort of the supplied affiliate.
*
* @param int $userid
* @param int $affiliateid
*
* @return void
*/
function local_affiliations_remove_affiliation($userid, $affiliateid) {
require_once(__DIR__ . '/../../cohort/lib.php');
global $DB;
$affiliate = $DB->get_record('local_affiliations_affiliate', array('id' => $affiliateid), '*', MUST_EXIST);
cohort_remove_member($affiliate->cohortid, $userid);
}