-
Notifications
You must be signed in to change notification settings - Fork 2
/
lib.php
executable file
·94 lines (74 loc) · 2.73 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
<?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/>.
/**
* Library of interface functions and constants for module local_cohort_automation
*
* @package local_cohort_automation
* @copyright 2014 NetSpot Pty Ltd
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
/**
* Function to be run periodically according to the moodle cron
*
* Identify users not in the configured cohorts and add them as required
*
* @return boolean
**/
function local_cohort_automation_cron () {
global $DB;
// Check to ensure regex is supported.
if (!$DB->sql_regex_supported()) {
mtrace('Unable to run as regex is not supported by this database');
return;
}
require_once('locallib.php');
require_once(dirname(__FILE__) . '/../../cohort/lib.php');
// Get a list of mappings.
$mappings = get_cohort_mappings();
if (count($mappings) > 0) {
// Loop through each mapping.
foreach ($mappings as $mapping) {
$userrecords = get_users_not_in_cohort($mapping->cohortid, $mapping->profilefieldid, $mapping->regex);
if ($userrecords->valid()) {
$count = 0;
// Users were found that need to be added to the cohort.
foreach ($userrecords as $userrecord) {
// Add the user to the cohort.
cohort_add_member($mapping->cohortid, $userrecord->id);
$count++;
}
// Output some useful info.
mtrace('Found ' . $count . ' records that were updated for mapping ' . $mapping->id);
}
$userrecords->close();
}
}
return true;
}
/**
* Function to handle the delete cohort event
*
* @param $eventdata the data related to the event
*
* @return boolean the result of handling the event
*/
function local_cohort_automation_event_delete($eventdata) {
global $DB;
// Play nice and attempt to tidy up mappings table.
$DB->delete_records('local_cohort_automation', array('cohortid' => $eventdata->id));
return true;
}