forked from vfremaux/moodle-mod_flashcard
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathlocallib.php
405 lines (347 loc) · 12.9 KB
/
locallib.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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
<?php
/* @var $DB mysqli_native_moodle_database */
/* @var $OUTPUT core_renderer */
/* @var $PAGE moodle_page */
?>
<?php
/**
* internal library of functions and constants for module flashcard
* @package mod-flashcard
* @category mod
* @author Gustav Delius
* @contributors Valery Fremaux
* @version Moodle 2.0
*/
/**
* Includes and requires
*/
/**
*
*/
define('FLASHCARD_MEDIA_TEXT', 0);
define('FLASHCARD_MEDIA_IMAGE', 1);
define('FLASHCARD_MEDIA_SOUND', 2);
define('FLASHCARD_MEDIA_IMAGE_AND_SOUND', 3);
define('FLASHCARD_MEDIA_VIDEO', 4);
/**
* computes the last accessed date for a deck as the oldest card being in the deck
* @param reference $flashcard the flashcard object
* @param int $deck the deck number
* @param int $userid the user the deck belongs to
* @uses $USER for setting default user
* @uses $CFG, $DB
*/
function flashcard_get_lastaccessed(&$flashcard, $deck, $userid = 0){
global $USER, $CFG, $DB;
if ($userid == 0) $userid = $USER->id;
$sql = "
SELECT
MIN(lastaccessed) as lastaccessed
FROM
{flashcard_card}
WHERE
flashcardid = ? AND
userid = ? AND
deck = ?
";
$rec = $DB->get_record_sql($sql, array($flashcard->id, $userid, $deck));
return $rec->lastaccessed;
}
/**
* initialize decks for a given user. The initialization is soft as it will
* be able to add new subquestions
* @param reference $flashcard
* @param int $userid
* @ues $DB
*/
function flashcard_initialize(&$flashcard, $userid){
global $DB;
// get all cards (all decks)
$cards = $DB->get_records_select('flashcard_card', 'flashcardid = ? AND userid = ?', array($flashcard->id, $userid));
$registered = array();
if (!empty($cards)){
foreach($cards as $card){
$registered[] = $card->entryid;
}
}
// get all subquestions
if ($subquestions = $DB->get_records('flashcard_deckdata', array('flashcardid' => $flashcard->id), '', 'id,id')){
foreach($subquestions as $subquestion){
if (in_array($subquestion->id, $registered)) continue;
$card = new StdClass();
$card->userid = $userid;
$card->flashcardid = $flashcard->id;
$card->lastaccessed = time() - ($flashcard->deck1_delay * HOURSECS);
$card->deck = 1;
$card->entryid = $subquestion->id;
if (! $DB->insert_record('flashcard_card', $card)){
print_error('dbcouldnotinsert', 'flashcard');
}
}
} else {
return false;
}
return true;
}
/**
* imports data into the deck from a matching question. This allows making a quiz with questions
* then importing data to form a card deck.
* @param reference $flashcard
* @uses $DB
* @return void
*/
function flashcard_import(&$flashcard){
global $DB;
$question = $DB->get_record('question', array('id' => $flashcard->questionid));
if ($question->qtype != 'match'){
notice("Not a match question. Internal error");
return;
}
$options = $DB->get_record('question_match', array('question' => $question->id));
list($usql, $params) = $DB->get_in_or_equal(explode(",",$options->subquestions));
if ($subquestions = $DB->get_records_select('question_match_sub', "id $usql AND answertext != '' AND questiontext != ''", $params)){
// cleanup the flashcard
$DB->delete_records('flashcard_card', array('flashcardid' => $flashcard->id));
$DB->delete_records('flashcard_deckdata', array('flashcardid' => $flashcard->id));
// transfer data
foreach($subquestions as $subquestion){
$deckdata->flashcardid = $flashcard->id;
$deckdata->questiontext = $subquestion->questiontext;
$deckdata->answertext = $subquestion->answertext;
$deckdata->lastaccessed = 0;
$DB->insert_record('flashcard_deckdata', $deckdata);
}
}
return true;
}
/**
* get count, last access time and reactivability for all decks
* @param reference $flashcard
* @param int $userid
* @uses $USER
* @uses $DB
*/
function flashcard_get_deck_status(&$flashcard, $userid = 0){
global $USER, $DB;
if ($userid == 0) $userid = $USER->id;
unset($status);
$dk3 = 0;
$dk4 = 0;
$dk1 = $DB->count_records('flashcard_card', array('flashcardid' => $flashcard->id, 'userid' => $userid, 'deck' => 1));
$status = new StdClass();
$status->decks[0] = new StdClass();
$status->decks[0]->count = $dk1;
$status->decks[0]->deckid = 1;
$dk2 = $DB->count_records('flashcard_card', array('flashcardid' => $flashcard->id, 'userid' => $userid, 'deck' => 2));
$status->decks[1] = new StdClass();
$status->decks[1]->count = $dk2;
$status->decks[1]->deckid = 2;
if ($flashcard->decks >= 3){
$dk3 = $DB->count_records('flashcard_card', array('flashcardid' => $flashcard->id, 'userid'=> $userid, 'deck' => 3));
$status->decks[2] = new StdClass();
$status->decks[2]->count = $dk3;
$status->decks[2]->deckid = 3;
}
if ($flashcard->decks >= 4){
$dk4 = $DB->count_records('flashcard_card', array('flashcardid' => $flashcard->id, 'userid' => $userid, 'deck' => 4));
$status->decks[3] = new StdClass();
$status->decks[3]->count = $dk4;
$status->decks[3]->deckid = 4;
}
// not initialized for this user
if ($dk1 + $dk2 + $dk3 + $dk4 == 0){
return null;
}
if ($dk1 > 0){
$status->decks[0]->lastaccess = flashcard_get_lastaccessed($flashcard, 1, $userid);
$status->decks[0]->reactivate = (time() > ($status->decks[0]->lastaccess + $flashcard->deck1_delay * HOURSECS));
}
if ($dk2 > 0){
$status->decks[1]->lastaccess = flashcard_get_lastaccessed($flashcard, 2, $userid);
$status->decks[1]->reactivate = (time() > ($status->decks[1]->lastaccess + $flashcard->deck2_delay * HOURSECS));
}
if ($flashcard->decks >= 3 && $dk3 > 0){
$status->decks[2]->lastaccess = flashcard_get_lastaccessed($flashcard, 3, $userid);
$status->decks[2]->reactivate = (time() > ($status->decks[2]->lastaccess + $flashcard->deck3_delay * HOURSECS));
}
if ($flashcard->decks >= 4 && $dk4 > 0){
$status->decks[3]->lastaccess = flashcard_get_lastaccessed($flashcard, 4, $userid);
$status->decks[3]->reactivate = (time() > ($status->decks[3]->lastaccess + $flashcard->deck4_delay));
}
return $status;
}
/**
* get card status structure
* @param reference $flashcard
* @uses $CFG
* @uses $DB
*/
function flashcard_get_card_status(&$flashcard){
global $CFG, $DB;
// get decks by card
$sql = "
SELECT
dd.questiontext,
COUNT(c.id) as amount,
c.deck AS deck
FROM
{flashcard_deckdata} dd
LEFT JOIN
{flashcard_card} c
ON
c.entryid = dd.id
WHERE
c.flashcardid = ?
GROUP BY
c.entryid,
c.deck
";
$recs = $DB->get_records_sql($sql, array($flashcard->id));
// get accessed by card
$sql = "
SELECT
dd.questiontext,
SUM(accesscount) AS accessed
FROM
{flashcard_deckdata} dd
LEFT JOIN
{flashcard_card} c
ON
c.entryid = dd.id
WHERE
c.flashcardid = ?
GROUP BY
c.entryid
";
$accesses = $DB->get_records_sql($sql, array($flashcard->id));
$cards = array();
foreach($recs as $question => $rec){
if ($rec->deck == 1)
$cards[$question]->deck[0] = $rec->amount;
if ($rec->deck == 2)
$cards[$question]->deck[1] = $rec->amount;
if ($rec->deck == 3)
$cards[$question]->deck[2] = $rec->amount;
if ($rec->deck == 4)
$cards[$question]->deck[3] = $rec->amount;
$cards[$question]->accesscount = $accesses[$question]->accessed;
}
return $cards;
}
/**
* prints a graphical represnetation of decks, proportionnaly to card count
* @param reference $flashcard
* @param object $card
* @param boolean $return
* @uses $CFG
*/
function flashcard_print_cardcounts(&$flashcard, $card, $return=false){
global $CFG, $OUTPUT;
$str = '';
$topenabledpixurl = $OUTPUT->pix_url('topenabled', 'flashcard');
$strs[] = "<td><img src=\"{$topenabledpixurl}\" /> (1) </td><td>".'<div class="bar" style="height: 10px; width: '.(1 + @$card->deck[0]).'px"></div></td>';
$strs[] = "<td><img src=\"{$topenabledpixurl}\" /> (2) </td><td>".'<div class="bar" style="height: 10px; width: '.(1 + @$card->deck[1]).'px"></div></td>';
if ($flashcard->decks >= 3){
$strs[] = "<td><img src=\"{$topenabledpixurl}\" /> (3) </td><td>".'<div class="bar" style="height: 10px; width: '.(1 + @$card->deck[2]).'px"></div></td>';
}
if ($flashcard->decks >= 4){
$strs[] = "<td><img src=\"{$topenabledpixurl}\" /> (4) </td><td>".'<div class="bar" style="height: 10px; width: '.(1 + @$card->deck[3]).'px"></div></td>';
}
$str = "<table cellspacing=\"2\"><tr valign\"middle\">".implode("</tr><tr valign=\"middle\">", $strs)."</tr></table>";
if ($return) return $str;
echo $str;
}
/**
* new media renderers cannot be used because not tunable in autoplay
*
*/
function flashcard_mp3_player(&$flashcard, $url, $htmlid) {
global $CFG, $THEME;
$audiostart = ($flashcard->audiostart) ? 'no' : 'yes&autoPlay=yes' ;
$c = 'bgColour=000000&btnColour=ffffff&btnBorderColour=cccccc&iconColour=000000&'.
'iconOverColour=00cc00&trackColour=cccccc&handleColour=ffffff&loaderColour=ffffff&'.
'waitForPlay='.$audiostart;
static $count = 0;
$count++;
$id = ($htmlid) ? $htmlid : 'flashcard_filter_mp3_'.time().$count ; //we need something unique because it might be stored in text cache
$url = addslashes_js($url);
return '<span class="mediaplugin mediaplugin_mp3" id="'.$id.'_player">('.'mp3audio'.')</span>
<script type="text/javascript">
//<![CDATA[
var FO = { movie:"'.$CFG->wwwroot.'/mod/flashcard/players/mp3player.swf?src='.$url.'",
width:"90", height:"15", majorversion:"6", build:"40", flashvars:"'.$c.'", quality: "high" };
UFO.create(FO, "'.$id.'_player");
//]]>
</script>';
}
function flashcard_delete_attached_files(&$cm, &$flashcard, $card){
$fs = get_file_storage();
$context = context_module::instance($cm->id);
switch($flashcard->questionsmediatype){
case FLASHCARD_MEDIA_TEXT :
break;
case FLASHCARD_MEDIA_SOUND :
$fs->delete_area_files($context->id, 'flashcard', 'questionsoundfile', $card->id);
break;
case FLASHCARD_MEDIA_IMAGE :
$fs->delete_area_files($context->id, 'flashcard', 'questionimagefile', $card->id);
break;
case FLASHCARD_MEDIA_VIDEO :
$fs->delete_area_files($context->id, 'flashcard', 'questionvideofile', $card->id);
break;
case FLASHCARD_MEDIA_IMAGE_AND_SOUND :
$fs->delete_area_files($context->id, 'flashcard', 'questionimagefile', $card->id);
$fs->delete_area_files($context->id, 'flashcard', 'questionsoundfile', $card->id);
break;
}
switch($flashcard->answersmediatype){
case FLASHCARD_MEDIA_TEXT :
break;
case FLASHCARD_MEDIA_SOUND :
$fs->delete_area_files($context->id, 'flashcard', 'answersoundfile', $card->id);
break;
case FLASHCARD_MEDIA_IMAGE :
$fs->delete_area_files($context->id, 'flashcard', 'answerimagefile', $card->id);
break;
case FLASHCARD_MEDIA_VIDEO :
$fs->delete_area_files($context->id, 'flashcard', 'answervideofile', $card->id);
break;
case FLASHCARD_MEDIA_IMAGE_AND_SOUND :
$fs->delete_area_files($context->id, 'flashcard', 'answersoundfile', $card->id);
$fs->delete_area_files($context->id, 'flashcard', 'answerimagefile', $card->id);
break;
}
}
function flashcard_save_draft_customimage(&$flashcard, $customimage){
global $USER;
$usercontext = context_user::instance($USER->id);
$context = context_module::instance($flashcard->coursemodule);
$filepickeritemid = optional_param($customimage, 0, PARAM_INT);
if (!$filepickeritemid) return;
$fs = get_file_storage();
$flashcard->$customimage = 0;
if (!$fs->is_area_empty($usercontext->id, 'user', 'draft', $filepickeritemid, true)){
$filearea = str_replace('fileid', '', $customimage);
file_save_draft_area_files($filepickeritemid, $context->id, 'mod_flashcard', $filearea, 0);
$savedfiles = $fs->get_area_files($context->id, 'mod_flashcard', $filearea, 0);
$savedfile = array_pop($savedfiles);
$flashcard->$customimage = $savedfile->get_id();
}
}
/**
* this initializes a draft copy of the actual stored file
*
*/
/*
function flashcard_get_initialized_draft_zone($fileid){
global $USER;
$fs = get_file_storage();
$usercontext = context_user::instance($USER->id);
$fr->contextid = $usercontext->id;
$fr->component = 'user';
$fr->filearea = 'draft';
$fr->itemid = file_get_unused_draft_itemid();
create_file_from_storedfile($fr, $fileid);
return $fr->itemid;
}
*/