forked from xAPI-vle/moodle-logstore_xapi
-
Notifications
You must be signed in to change notification settings - Fork 1
/
settings.php
224 lines (184 loc) · 9.34 KB
/
settings.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
223
224
<?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/>.
/**
* Settings file.
*
* @package logstore_xapi
* @copyright Jerret Fowler <[email protected]>
* Ryan Smith <https://www.linkedin.com/in/ryan-smith-uk/>
* David Pesce <[email protected]>
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
use logstore_xapi\admin;
require_once(__DIR__ . '/src/autoload.php');
require_once($CFG->dirroot . '/admin/tool/log/store/xapi/lib.php');
if ($hassiteconfig) {
// Endpoint.
$settings->add(new admin_setting_configtext('logstore_xapi/endpoint',
get_string('endpoint', 'logstore_xapi'), '',
'', PARAM_URL));
// Username.
$settings->add(new admin_setting_configtext('logstore_xapi/username',
get_string('username', 'logstore_xapi'), '', '', PARAM_TEXT));
// Key or password.
$settings->add(new admin_setting_configtext('logstore_xapi/password',
get_string('password', 'logstore_xapi'), '', '', PARAM_TEXT));
// Switch background batch mode on.
$settings->add(new admin_setting_configcheckbox('logstore_xapi/backgroundmode',
get_string('backgroundmode', 'logstore_xapi'),
get_string('backgroundmode_desc', 'logstore_xapi'), 1));
$settings->add(new admin_setting_configtext('logstore_xapi/maxbatchsize',
get_string('maxbatchsize', 'logstore_xapi'),
get_string('maxbatchsize_desc', 'logstore_xapi'), 30, PARAM_INT));
// Maximum batch size for failed records being replayed.
$settings->add(new admin_setting_configtext('logstore_xapi/maxbatchsizeforfailed',
get_string('maxbatchsizeforfailed', 'logstore_xapi'),
get_string('maxbatchsizeforfailed_desc', 'logstore_xapi'), 15, PARAM_INT));
// Maximum batch size for historical records.
$settings->add(new admin_setting_configtext('logstore_xapi/maxbatchsizeforhistorical',
get_string('maxbatchsizeforhistorical', 'logstore_xapi'),
get_string('maxbatchsizeforhistorical_desc', 'logstore_xapi'), 30, PARAM_INT));
$settings->add(new admin_setting_configcheckbox('logstore_xapi/resendfailedbatches',
get_string('resendfailedbatches', 'logstore_xapi'),
get_string('resendfailedbatches_desc', 'logstore_xapi'), 0));
$settings->add(new admin_setting_configcheckbox('logstore_xapi/mbox',
get_string('mbox', 'logstore_xapi'),
get_string('mbox_desc', 'logstore_xapi'), 0));
// optional hashing of email address
$settings->add(new admin_setting_configcheckbox('logstore_xapi/hashmbox',
get_string('hashmbox', 'logstore_xapi'),
get_string('hashmbox_desc', 'logstore_xapi'), 1));
$settings->add(new admin_setting_configcheckbox('logstore_xapi/shortcourseid',
get_string('shortcourseid', 'logstore_xapi'),
get_string('shortcourseid_desc', 'logstore_xapi'), 0));
$settings->add(new admin_setting_configcheckbox('logstore_xapi/sendidnumber',
get_string('sendidnumber', 'logstore_xapi'),
get_string('sendidnumber_desc', 'logstore_xapi'), 0));
$settings->add(new admin_setting_configcheckbox('logstore_xapi/send_username',
get_string('send_username', 'logstore_xapi'),
get_string('send_username_desc', 'logstore_xapi'), 0));
$settings->add(new admin_setting_configcheckbox('logstore_xapi/send_name',
get_string('send_name', 'logstore_xapi'),
get_string('send_name_desc', 'logstore_xapi'), 1));
$settings->add(new admin_setting_configcheckbox('logstore_xapi/send_jisc_data',
get_string('send_jisc_data', 'logstore_xapi'),
get_string('send_jisc_data_desc', 'logstore_xapi'), 0));
$settings->add(new admin_setting_configcheckbox('logstore_xapi/sendresponsechoices',
get_string('send_response_choices', 'logstore_xapi'),
get_string('send_response_choices_desc', 'logstore_xapi'), 0));
// Exclude users.
$settings->add(new \logstore_xapi\admin\admin_setting_userselection('logstore_xapi/excludeusers',
get_string('excludeusers', 'logstore_xapi'),
get_string('excludeusers_desc', 'logstore_xapi'),''));
// Control sending notifications.
$settings->add(new admin_setting_configcheckbox('logstore_xapi/enablesendingnotifications',
get_string('enablesendingnotifications', 'logstore_xapi'),
get_string('enablesendingnotifications_desc', 'logstore_xapi'), 1));
// Set threshold for sending notifications.
$settings->add(new admin_setting_configtext('logstore_xapi/errornotificationtrigger',
get_string('errornotificationtrigger', 'logstore_xapi'),
get_string('errornotificationtrigger_desc', 'logstore_xapi'), 10, PARAM_INT));
// Cohorts.
$settings->add(new admin_setting_heading('cohorts',
get_string('cohorts', 'logstore_xapi'),
get_string('cohorts_help', 'logstore_xapi')));
$cohorts = logstore_xapi_get_cohorts();
$arrcohorts = array();
foreach ($cohorts as $cohort) {
$arrcohorts[$cohort->id] = $cohort->name;
}
// If there are no cohorts then do not display this option,
// especially when displaying the settings page for the first time after an upgrade.
if (count($arrcohorts) != 0) {
$settings->add(new admin_setting_configmulticheckbox('logstore_xapi/cohorts',
get_string('includecohorts', 'logstore_xapi'), '', '', $arrcohorts));
}
// Additional email addresses.
$settings->add(new admin_setting_configtext('logstore_xapi/send_additional_email_addresses',
get_string('send_additional_email_addresses', 'logstore_xapi'),
get_string('send_additional_email_addresses_desc', 'logstore_xapi'), '', PARAM_TEXT));
// Filters.
$settings->add(new admin_setting_heading('filters',
get_string('filters', 'logstore_xapi'),
get_string('filters_help', 'logstore_xapi')));
$settings->add(new admin_setting_configcheckbox('logstore_xapi/logguests',
get_string('logguests', 'logstore_xapi'), '', '0'));
$menuroutes = [];
$eventfunctionmap = \src\transformer\get_event_function_map();
foreach (array_keys($eventfunctionmap) as $eventname) {
$menuroutes[$eventname] = $eventname;
}
$settings->add(new admin_setting_configmulticheckbox('logstore_xapi/routes',
get_string('routes', 'logstore_xapi'), '', $menuroutes, $menuroutes));
// Resend in background task.
$settings->add(new admin_setting_heading('resendtask',
get_string('resendtask', 'logstore_xapi'),
get_string('resendtask_help', 'logstore_xapi')));
$settings->add(new admin_setting_configduration('logstore_xapi/resendtaskruntime',
get_string('resendtaskruntime', 'logstore_xapi'),
get_string('resendtaskruntime_help', 'logstore_xapi'),
get_config('core', 'task_scheduled_max_runtime'),
PARAM_INT
));
$settings->add(new admin_setting_configtext('logstore_xapi/resendtaskerrortype',
get_string('resendtaskerrortype', 'logstore_xapi'),
get_string('resendtaskerrortype_help', 'logstore_xapi'),
'',
PARAM_TEXT
));
$settings->add(new admin_setting_configtextarea('logstore_xapi/resendeventname',
get_string('resendeventname', 'logstore_xapi'),
get_string('resendeventname_help', 'logstore_xapi'),
'',
PARAM_TEXT
));
$settings->add(new admin_setting_configtext('logstore_xapi/resenddatefrom',
get_string('resenddatefrom', 'logstore_xapi'),
get_string('resenddatefrom_help', 'logstore_xapi'),
'',
PARAM_INT
));
$settings->add(new admin_setting_configtext('logstore_xapi/resenddateto',
get_string('resenddateto', 'logstore_xapi'),
get_string('resenddateto_help', 'logstore_xapi'),
'',
PARAM_INT
));
$settings->add(new admin_setting_configtext('logstore_xapi/resendbatch',
get_string('resendbatch', 'logstore_xapi'),
get_string('resendbatch_help', 'logstore_xapi'),
12500,
PARAM_INT
));
$PAGE->requires->js_call_amd('logstore_xapi/settings', 'init');
// The xAPI Error Log page.
$errorreport = new admin_externalpage(
'logstorexapierrorlog',
get_string('logstorexapierrorlog', 'logstore_xapi'),
new moodle_url('/admin/tool/log/store/xapi/report.php', array('id' => XAPI_REPORT_ID_ERROR)),
array('logstore/xapi:viewerrorlog')
);
$ADMIN->add('logging', $errorreport);
// The xAPI Historic Log page.
$historicreport = new admin_externalpage(
'logstorexapihistoriclog',
get_string('logstorexapihistoriclog', 'logstore_xapi'),
new moodle_url('/admin/tool/log/store/xapi/report.php', array('id' => XAPI_REPORT_ID_HISTORIC)),
array('logstore/xapi:managehistoric')
);
$ADMIN->add('logging', $historicreport);
}