forked from vtos/moodle-mod_adaptivequiz
-
Notifications
You must be signed in to change notification settings - Fork 0
/
renderer.php
1245 lines (1051 loc) · 50.5 KB
/
renderer.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
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?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/>.
/**
* Contains definition of the renderer class for the plugin.
*
* @package mod_adaptivequiz
* @copyright 2013 Remote-Learner {@link http://www.remote-learner.ca/}
* @copyright 2022 onwards Vitaly Potenko <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
use core\output\notification;
use mod_adaptivequiz\form\requiredpassword;
use mod_adaptivequiz\local\attempt\attempt_state;
use mod_adaptivequiz\local\catalgorithm\catalgo;
use mod_adaptivequiz\output\ability_measure;
use mod_adaptivequiz\output\attempt_progress;
use mod_adaptivequiz\output\report\individual_user_attempts\individual_user_attempt_action;
use mod_adaptivequiz\output\report\individual_user_attempts\individual_user_attempt_actions;
use mod_adaptivequiz\output\user_attempt_summary;
/**
* The renderer class for the plugin.
*
* @package mod_adaptivequiz
*/
class mod_adaptivequiz_renderer extends plugin_renderer_base {
/** @var string $sortdir the sorting direction being used */
protected $sortdir = '';
/** @var moodle_url $sorturl the current base url used for keeping the table sorted */
protected $sorturl = '';
/** @var int $groupid variable used to reference the groupid that is currently being used to filter by */
public $groupid = 0;
/** @var array options that should be used for opening the secure popup. */
protected static $popupoptions = array(
'left' => 0,
'top' => 0,
'fullscreen' => true,
'scrollbars' => false,
'resizeable' => false,
'directories' => false,
'toolbar' => false,
'titlebar' => false,
'location' => false,
'status' => false,
'menubar' => false
);
/**
* Displays either the button to start the quiz or a notification if an attempt cannot be started/continued.
*/
public function attempt_controls_or_notification(
int $cmid,
bool $attemptallowed,
string $activityavailabilitynotification,
bool $browsersecurityenabled
): string {
if ($activityavailabilitynotification) {
return $this->notification($activityavailabilitynotification, notification::NOTIFY_WARNING);
}
if (!$attemptallowed) {
return html_writer::div(get_string('noattemptsallowed', 'adaptivequiz'), 'alert alert-info text-center');
}
if ($browsersecurityenabled) {
return $this->display_start_attempt_form_secured($cmid);
}
return $this->render(new single_button(
new moodle_url('/mod/adaptivequiz/attempt.php', ['cmid' => $cmid, 'sesskey' => sesskey()]),
get_string('startattemptbtn', 'adaptivequiz'),
'post',
true
));
}
/**
* This function sets up the javascript required by the page
* @return array a standard jsmodule structure.
*/
public function adaptivequiz_get_js_module() {
return array(
'name' => 'mod_adaptivequiz',
'fullpath' => '/mod/adaptivequiz/module.js',
'requires' => array('base', 'dom', 'event-delegate', 'event-key', 'core_question_engine',
'moodle-core-formchangechecker'),
'strings' => array(array('cancel', 'moodle'), array('changesmadereallygoaway', 'moodle'),
array('functiondisabledbysecuremode', 'adaptivequiz'))
);
}
/**
* This function generates the HTML markup to render the submission form.
*
* @param int $cmid
* @param question_usage_by_activity $quba
* @param int $slot Slot number of the question to be displayed.
* @param int $level Difficulty level of question.
* @param int $questionnumber The order number of question in the quiz.
*/
public function question_submit_form($cmid, $quba, $slot, $level, int $questionnumber): string {
$output = '';
$processurl = new moodle_url('/mod/adaptivequiz/attempt.php');
// Start the form.
$attr = array('action' => $processurl, 'method' => 'post', 'enctype' => 'multipart/form-data', 'accept-charset' => 'utf-8',
'id' => 'responseform');
$output .= html_writer::start_tag('form', $attr);
$output .= html_writer::start_tag('div');
// Print the question.
$options = new question_display_options();
$options->hide_all_feedback();
$options->flags = question_display_options::HIDDEN;
$options->marks = question_display_options::HIDDEN;
$output .= $quba->render_question($slot, $options, $questionnumber);
$output .= html_writer::start_tag('div', ['class' => 'submitbtns adaptivequizbtn mdl-align']);
$output .= html_writer::empty_tag('input', ['type' => 'submit', 'name' => 'submitanswer',
'value' => get_string('submitanswer', 'mod_adaptivequiz'), 'class' => 'btn btn-primary']);
$output .= html_writer::end_tag('div');
// Some hidden fields to track what is going on.
$output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'cmid', 'value' => $cmid));
$output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'uniqueid', 'value' => $quba->get_id()));
$output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'sesskey', 'value' => sesskey()));
$output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'slots', 'value' => $slot));
$output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'dl', 'value' => $level));
// Finish the form.
$output .= html_writer::end_tag('div');
$output .= html_writer::end_tag('form');
return $output;
}
/**
* This function initializing the metadata that needs to be included in the page header
* before the page is rendered.
* @param question_usage_by_activity $quba a question usage by activity object
* @param int|array $slots slot number of the question to be displayed or an array of slot numbers
* @return string HTML header information for displaying the question
*/
public function init_metadata($quba, $slots) {
$meta = '';
if (is_array($slots)) {
foreach ($slots as $slot) {
$meta .= $quba->render_question_head_html($slot);
}
} else {
$meta .= $quba->render_question_head_html($slots);
}
$meta .= question_engine::initialise_js();
return $meta;
}
/**
* @throws coding_exception
*/
public function attempt_feedback(string $attemptfeedback, int $cmid, ?ability_measure $abilitymeasure,
bool $popup = false): string {
$output = html_writer::start_div('text-center');
$url = new moodle_url('/mod/adaptivequiz/view.php');
$attr = ['action' => $url, 'method' => 'post', 'id' => 'attemptfeedback'];
$output .= html_writer::start_tag('form', $attr);
if (empty(trim($attemptfeedback))) {
$attemptfeedback = get_string('attemptfeedbackdefaulttext', 'adaptivequiz');
}
$output .= html_writer::tag('p', s($attemptfeedback), ['class' => 'submitbtns adaptivequizfeedback']);
if ($abilitymeasure) {
$output .= $this->render($abilitymeasure);
}
if (empty($popup)) {
$attr = ['type' => 'submit', 'name' => 'attemptfinished', 'value' => get_string('continue'),
'class' => 'btn btn-primary'];
$output .= html_writer::empty_tag('input', $attr);
} else {
// In a 'secure' popup window.
$this->page->requires->js_init_call('M.mod_adaptivequiz.secure_window.init_close_button', [$url],
$this->adaptivequiz_get_js_module());
$output .= html_writer::empty_tag('input', ['type' => 'button', 'value' => get_string('continue'),
'id' => 'secureclosebutton', 'class' => 'btn btn-primary']);
}
$output .= html_writer::empty_tag('input', ['type' => 'hidden', 'name' => 'id', 'value' => $cmid]);
$output .= html_writer::end_tag('form');
$output .= html_writer::end_div();
return $output;
}
/**
* Output a page with an optional message, and JavaScript code to close the
* current window and redirect the parent window to a new URL.
* @param moodle_url $url the URL to redirect the parent window to.
* @param string $message message to display before closing the window. (optional)
* @return string HTML to output.
*/
public function close_attempt_popup($url, $message = '') {
$output = '';
$output .= $this->header();
$output .= $this->box_start();
if ($message) {
$output .= html_writer::tag('p', $message);
$output .= html_writer::tag('p', get_string('windowclosing', 'quiz'));
$delay = 5;
} else {
$output .= html_writer::tag('p', get_string('pleaseclose', 'quiz'));
$delay = 0;
}
$this->page->requires->js_init_call('M.mod_quiz.secure_window.close',
array($url, $delay), false, adaptivequiz_get_js_module());
$output .= $this->box_end();
$output .= $this->footer();
return $output;
}
/**
* This function returns page header information to be printed to the page
* @return string HTML markup for header inforation
*/
public function print_header() {
return $this->header();
}
/**
* This function returns page footer information to be printed to the page
* @return string HTML markup for footer inforation
*/
public function print_footer() {
return $this->footer();
}
/**
* This function creates the table header links that will be used to allow instructor to sort the data
* @param stdClass $cm a course module object set to the instance of the activity
* @param string $sort the column the the table is to be sorted by
* @param string $sortdir the direction of the sort
* @return array an array of column headers (firstname / lastname, number of attempts, standard error)
*/
public function format_report_table_headers($cm, $sort, $sortdir) {
$firstname = '';
$lastname = '';
$email = '';
$numofattempts = '';
$measure = '';
$standarderror = '';
$timemodified = '';
/* Determine the next sorting direction and icon to display */
switch ($sortdir) {
case 'ASC':
$imageparam = array('src' => $this->image_url('t/down'), 'alt' => '');
$columnicon = html_writer::empty_tag('img', $imageparam);
$newsortdir = 'DESC';
break;
default:
$imageparam = array('src' => $this->image_url('t/up'), 'alt' => '');
$columnicon = html_writer::empty_tag('img', $imageparam);
$newsortdir = 'ASC';
break;
}
/* Set the sort direction class variable */
$this->sortdir = $sortdir;
/* Create header links */
$param = array('cmid' => $cm->id, 'sort' => 'firstname', 'sortdir' => 'ASC', 'group' => $this->groupid);
$firstnameurl = new moodle_url('/mod/adaptivequiz/viewreport.php', $param);
$param['sort'] = 'lastname';
$lastnameurl = new moodle_url('/mod/adaptivequiz/viewreport.php', $param);
$param['sort'] = 'email';
$emailurl = new moodle_url('/mod/adaptivequiz/viewreport.php', $param);
$param['sort'] = 'attempts';
$numofattemptsurl = new moodle_url('/mod/adaptivequiz/viewreport.php', $param);
$param['sort'] = 'measure';
$measureurl = new moodle_url('/mod/adaptivequiz/viewreport.php', $param);
$param['sort'] = 'stderror';
$standarderrorurl = new moodle_url('/mod/adaptivequiz/viewreport.php', $param);
$param['sort'] = 'timemodified';
$timemodifiedurl = new moodle_url('/mod/adaptivequiz/viewreport.php', $param);
/* Update column header links with a sorting directional icon */
switch ($sort) {
case 'firstname':
$firstnameurl->params(array('sortdir' => $newsortdir));
$this->sorturl = $firstnameurl;
$firstname .= ' '.$columnicon;
break;
case 'lastname':
$lastnameurl->params(array('sortdir' => $newsortdir));
$this->sorturl = $lastnameurl;
$lastname .= ' '.$columnicon;
break;
case 'email':
$emailurl->params(array('sortdir' => $newsortdir));
$this->sorturl = $emailurl;
$email .= ' '.$columnicon;
break;
case 'attempts':
$numofattemptsurl->params(array('sortdir' => $newsortdir));
$this->sorturl = $numofattemptsurl;
$numofattempts .= ' '.$columnicon;
break;
case 'measure':
$measureurl->params(array('sortdir' => $newsortdir));
$this->sorturl = $measureurl;
$measure .= ' '.$columnicon;
break;
case 'stderror':
$standarderrorurl->params(array('sortdir' => $newsortdir));
$this->sorturl = $standarderrorurl;
$standarderror .= ' '.$columnicon;
break;
case 'timemodified':
$timemodifiedurl->params(array('sortdir' => $newsortdir));
$this->sorturl = $timemodifiedurl;
$timemodified .= ' '.$columnicon;
break;
}
// Create header HTML markup.
$firstname = html_writer::link($firstnameurl, get_string('firstname')).$firstname;
$lastname = html_writer::link($lastnameurl, get_string('lastname')).$lastname;
$email = html_writer::link($emailurl, get_string('email')).$email;
$numofattempts = html_writer::link($numofattemptsurl, get_string('numofattemptshdr', 'adaptivequiz')).$numofattempts;
$measure = html_writer::link($measureurl, get_string('bestscore', 'adaptivequiz')).$measure;
$standarderror = html_writer::link($standarderrorurl, get_string('bestscorestderror', 'adaptivequiz')).$standarderror;
$timemodified = html_writer::link($timemodifiedurl, get_string('attemptfinishedtimestamp', 'adaptivequiz')).$timemodified;
return array($firstname.' / '.$lastname, $email, $numofattempts, $measure, $standarderror, $timemodified);
}
/**
* This function adds rows to the html_table object
* @param stdClass $records adaptivequiz_attempt records
* @param stdClass $cm course module object set to the instance of the activity
* @param html_table $table an instance of the html_table class
*/
protected function get_report_table_rows($records, $cm, $table) {
foreach ($records as $record) {
$attemptlink = new moodle_url('/mod/adaptivequiz/viewattemptreport.php',
array('userid' => $record->id, 'cmid' => $cm->id));
$link = html_writer::link($attemptlink, $record->attempts);
$measure = $this->format_measure($record);
if ($record->uniqueid) {
$attemptlink = new moodle_url('/mod/adaptivequiz/reviewattempt.php',
array('userid' => $record->id, 'uniqueid' => $record->uniqueid, 'cmid' => $cm->id));
$measure = html_writer::link($attemptlink, $measure);
}
$stderror = $this->format_standard_error($record);
if (intval($record->timemodified)) {
$timemodified = userdate(intval($record->timemodified));
} else {
$timemodified = get_string('na', 'adaptivequiz');
}
$profileurl = new moodle_url('/user/profile.php', array('id' => $record->id));
$name = $record->firstname.' '.$record->lastname;
$namelink = html_writer::link($profileurl, $name);
$emaillink = html_writer::link('mailto:'.$record->email, $record->email);
$row = array($namelink, $emaillink, $link, $measure, $stderror, $timemodified);
$table->data[] = $row;
$table->rowclasses[] = 'studentattempt';
}
}
/**
* This function prints paging information
* @param int $totalrecords the total number of records returned
* @param int $page the current page the user is on
* @param int $perpage the number of records displayed on one page
* @return string HTML markup
*/
public function print_paging_bar($totalrecords, $page, $perpage) {
$baseurl = $this->sorturl;
/* Set the currently set group filter and sort dir */
$baseurl->params(array('group' => $this->groupid, 'sortdir' => $this->sortdir));
$output = '';
$output .= $this->paging_bar($totalrecords, $page, $perpage, $baseurl);
return $output;
}
/**
* This function prints a grouping selector
* @param stdClass $cm course module object set to the instance of the activity
* @param stdClass $course a data record for the current course
* @param stdClass $context the context instance for the activity
* @param int $userid the current user id
* @return string HTML markup
*/
public function print_groups_selector($cm, $course, $context, $userid) {
$output = '';
$groupmode = groups_get_activity_groupmode($cm, $course);
if (0 != $groupmode) {
$baseurl = new moodle_url('/mod/adaptivequiz/viewreport.php', array('cmid' => $cm->id));
$output = groups_print_activity_menu($cm, $baseurl, true);
}
return $output;
}
/**
* Initialize secure browsing mode.
*/
public function init_browser_security($disablejsfeatures = true) {
$this->page->set_popup_notification_allowed(false); // Prevent message notifications.
$this->page->set_cacheable(false);
$this->page->set_pagelayout('popup');
if ($disablejsfeatures) {
$this->page->add_body_class('quiz-secure-window');
$this->page->requires->js_init_call('M.mod_adaptivequiz.secure_window.init',
null, false, $this->adaptivequiz_get_js_module());
}
}
/**
* This function displays a form for users to enter a password before entering the attempt
* @param int $cmid course module id
* @return requiredpassword instance of a formslib object
*/
public function display_password_form($cmid): requiredpassword {
$url = new moodle_url('/mod/adaptivequiz/attempt.php');
return new requiredpassword($url->out_omit_querystring(),
array('hidden' => array('cmid' => $cmid, 'uniqueid' => 0)));
}
/**
* This function prints a form and a button that is centered on the page, then the user clicks on the button the user is taken
* to the url
* @param moodle_url $url a url
* @param string $buttontext button caption
* @return string - HTML markup displaying the description and form with a submit button
*/
public function print_form_and_button($url, $buttontext) {
$html = '';
$attributes = array('method' => 'POST', 'action' => $url);
$html .= html_writer::start_tag('form', $attributes);
$html .= html_writer::empty_tag('br');
$html .= html_writer::empty_tag('br');
$html .= html_writer::start_tag('center');
$params = array('type' => 'submit', 'value' => $buttontext, 'class' => 'submitbtns adaptivequizbtn');
$html .= html_writer::empty_tag('input', $params);
$html .= html_writer::end_tag('center');
$html .= html_writer::end_tag('form');
return $html;
}
/**
* This function formats the ability measure into a user friendly format
* @param stdClass an object with the following properties: measure, highestlevel, lowestlevel and stderror. The values must
* come from the activty instance and the user's
* attempt record
* @return string a user friendly format of the ability measure. Ability measure is rounded to the nearest decimal.
*/
public function format_measure($record) {
if (is_null($record->measure)) {
return 'n/a';
}
return round(catalgo::map_logit_to_scale($record->measure, $record->highestlevel, $record->lowestlevel), 1);
}
/**
* This function formats the standard error into a user friendly format
* @param stdClass an object with the following properties: measure, highestlevel, lowestlevel and stderror. The values must
* come from the activty instance and the user's
* attempt record
* @return string a user friendly format of the standard error. Standard error is
* rounded to the nearest one hundredth then multiplied by 100
*/
public function format_standard_error($record) {
if (is_null($record->stderror) || $record->stderror == 0.0) {
return 'n/a';
}
$percent = round(catalgo::convert_logit_to_percent($record->stderror), 2) * 100;
return '± '.$percent.'%';
}
/**
* This function formats the standard error and ability measure into a user friendly format
* @param stdClass an object with the following properties: measure, highestlevel, lowestlevel and stderror. The values must
* come from the activty instance and the user's
* attempt record
* @return string a user friendly format of the ability measure and standard error. Ability measure is rounded to the nearest
* decimal. Standard error is rounded to the
* nearest one hundredth then multiplied by 100
*/
protected function format_measure_and_standard_error($record) {
if (is_null($record->measure) || is_null($record->stderror) || $record->stderror == 0.0) {
return 'n/a';
}
$measure = round(catalgo::map_logit_to_scale($record->measure, $record->highestlevel, $record->lowestlevel), 1);
$percent = round(catalgo::convert_logit_to_percent($record->stderror), 2) * 100;
$format = $measure.' ± '.$percent.'%';
return $format;
}
/**
* Answer the summery information about an attempt
*
* @param stdClass $adaptivequiz See {@link mod_adaptivequiz_renderer::attempt_report_page_by_tab()}.
* @param stdClass $attempt See {@link mod_adaptivequiz_renderer::attempt_report_page_by_tab()}.
* @param stdClass $user The user who took the quiz that created the attempt.
* @return string
* @throws coding_exception
*/
public function attempt_summary_listing(stdClass $adaptivequiz, stdClass $attempt, stdClass $user): string {
$table = new html_table();
$table->attributes['class'] = 'generaltable attemptsummarytable';
$row = new html_table_row();
$headercell = new html_table_cell(get_string('attempt_user', 'adaptivequiz'));
$headercell->header = true;
$datacell = new html_table_cell(fullname($user) . ' (' . $user->email . ')');
$row->cells = [$headercell, $datacell];
$table->data[] = $row;
$row = new html_table_row();
$headercell = new html_table_cell(get_string('attempt_state', 'adaptivequiz'));
$headercell->header = true;
$datacell = new html_table_cell($attempt->attemptstate);
$row->cells = [$headercell, $datacell];
$table->data[] = $row;
$row = new html_table_row();
$headercell = new html_table_cell(get_string('score', 'adaptivequiz'));
$headercell->header = true;
$abilityfraction = 1 / ( 1 + exp( (-1 * $attempt->measure) ) );
$ability = (($adaptivequiz->highestlevel - $adaptivequiz->lowestlevel) * $abilityfraction) + $adaptivequiz->lowestlevel;
$stderror = catalgo::convert_logit_to_percent($attempt->standarderror);
$score = ($stderror > 0)
? round($ability, 2)." ± ".round($stderror * 100, 1)."%"
: 'n/a';
$datacell = new html_table_cell($score);
$row->cells = [$headercell, $datacell];
$table->data[] = $row;
$row = new html_table_row();
$headercell = new html_table_cell(get_string('attemptstarttime', 'adaptivequiz'));
$headercell->header = true;
$datacell = new html_table_cell(userdate($attempt->timecreated));
$row->cells = [$headercell, $datacell];
$table->data[] = $row;
$row = new html_table_row();
$headercell = new html_table_cell(get_string('attemptfinishedtimestamp', 'adaptivequiz'));
$headercell->header = true;
$datacell = new html_table_cell(userdate($attempt->timemodified));
$row->cells = [$headercell, $datacell];
$table->data[] = $row;
$row = new html_table_row();
$headercell = new html_table_cell(get_string('attempttotaltime', 'adaptivequiz'));
$headercell->header = true;
$totaltime = $attempt->timemodified - $attempt->timecreated;
$hours = floor($totaltime / 3600);
$remainder = $totaltime - ($hours * 3600);
$minutes = floor($remainder / 60);
$seconds = $remainder - ($minutes * 60);
$cellcontent = sprintf('%02d', $hours).":".sprintf('%02d', $minutes).":".sprintf('%02d', $seconds);
$datacell = new html_table_cell($cellcontent);
$row->cells = [$headercell, $datacell];
$table->data[] = $row;
$row = new html_table_row();
$headercell = new html_table_cell(get_string('attemptstopcriteria', 'adaptivequiz'));
$headercell->header = true;
$datacell = new html_table_cell($attempt->attemptstopcriteria);
$row->cells = [$headercell, $datacell];
$table->data[] = $row;
return html_writer::table($table);
}
public function attempt_review_tabs(moodle_url $pageurl, string $selected): string {
$tabs = [];
$attemptsummarytaburl = clone($pageurl);
$attemptsummarytaburl->param('tab', 'attemptsummary');
$tabs[] = new tabobject('attemptsummary', $attemptsummarytaburl,
get_string('reportattemptsummarytab', 'adaptivequiz'));
$attemptgraphtaburl = clone($pageurl);
$attemptgraphtaburl->param('tab', 'attemptgraph');
$tabs[] = new tabobject('attemptgraph', $attemptgraphtaburl,
get_string('reportattemptgraphtab', 'adaptivequiz'));
$answerdistributiontaburl = clone($pageurl);
$answerdistributiontaburl->param('tab', 'answerdistribution');
$tabs[] = new tabobject('answerdistribution', $answerdistributiontaburl,
get_string('reportattemptanswerdistributiontab', 'adaptivequiz'));
$questionsdetailstaburl = clone($pageurl);
$questionsdetailstaburl->param('tab', 'questionsdetails');
$tabs[] = new tabobject('questionsdetails', $questionsdetailstaburl,
get_string('reportattemptquestionsdetailstab', 'adaptivequiz'));
return $this->tabtree($tabs, $selected);
}
/**
* @param string $tabid
* @param stdClass $adaptivequiz A record from {adaptivequiz}. The expected fields are 'lowestlevel' and 'highestlevel'.
* @param stdClass $attempt A record from {adaptivequiz_attempt}. The expected fields are: 'attemptstate', 'measure',
* 'highestlevel', 'lowestlevel', 'standarderror', 'timecreated', 'timemodified', 'attemptstopcriteria' and 'uniqueid'.
* @param stdClass $user A record from {user}. The expected fields are: 'id', 'email' and those required for {@link fullname()}
* call.
* @param question_usage_by_activity $quba
* @param int $cmid
* @param moodle_url $pageurl
* @param int $page
* @return string
* @throws coding_exception
* @throws moodle_exception
*/
public function attempt_report_page_by_tab(
string $tabid,
stdClass $adaptivequiz,
stdClass $attempt,
stdClass $user,
question_usage_by_activity $quba,
int $cmid,
moodle_url $pageurl,
int $page
): string {
if ($tabid == 'attemptgraph') {
$return = $this->attempt_graph($attempt->uniqueid, $cmid, $user->id);
$return .= html_writer::empty_tag('br');
$return .= $this->attempt_scoring_table($adaptivequiz, $quba);
return $return;
}
if ($tabid == 'answerdistribution') {
$return = $this->attempt_answer_distribution_graph($attempt->uniqueid, $cmid, $user->id);
$return .= html_writer::empty_tag('br');
$return .= $this->attempt_answer_distribution_table($adaptivequiz, $quba);
return $return;
}
if ($tabid == 'questionsdetails') {
return $this->attempt_questions_review($quba, $pageurl, $page);
}
return $this->attempt_summary_listing($adaptivequiz, $attempt, $user);
}
public function reset_users_attempts_filter_action(moodle_url $url): string {
return html_writer::link($url, get_string('reportattemptsresetfilter', 'adaptivequiz'));
}
/**
* A wrapper method to call rendering of attempt progress, accepts minimum parameters to base rendering on.
*/
public function attempt_progress(string $questionsanswered, string $maximumquestions): string {
return $this->render_attempt_progress(attempt_progress::with_defaults($questionsanswered, $maximumquestions));
}
/**
* Renders an attempt progress object, to be overridden by a theme if required.
*/
protected function render_attempt_progress(attempt_progress $progress): string {
$progress = $progress->with_help_icon_content($this->help_icon('attemptquestionsprogress', 'adaptivequiz'));
return $this->render_from_template('mod_adaptivequiz/attempt_progress', $progress->export_for_template($this));
}
/**
* Outputs available action links for an attempt in the user's attempts report.
*
* @param stdClass $attempt A record from {adaptivequiz_attempt}.
*/
public function individual_user_attempt_actions(stdClass $attempt): string {
$actions = new individual_user_attempt_actions();
$actions->add(
new individual_user_attempt_action(
new moodle_url('/mod/adaptivequiz/reviewattempt.php', ['attempt' => $attempt->id]),
new pix_icon('i/search', ''),
get_string('reviewattempt', 'adaptivequiz')
)
);
if ($attempt->attemptstate !== attempt_state::COMPLETED) {
$actions->add(
new individual_user_attempt_action(
new moodle_url('/mod/adaptivequiz/closeattempt.php', ['attempt' => $attempt->id]),
new pix_icon('t/stop', ''),
get_string('closeattempt', 'adaptivequiz')
)
);
}
$actions->add(
new individual_user_attempt_action(
new moodle_url('/mod/adaptivequiz/delattempt.php', ['attempt' => $attempt->id]),
new pix_icon('t/delete', ''),
get_string('deleteattemp', 'adaptivequiz')
)
);
return $this->render($actions);
}
/**
* Renders the renderable actions object, intended to be overridden by the theme if needed.
*
* @param individual_user_attempt_actions $actions
*/
protected function render_individual_user_attempt_actions(individual_user_attempt_actions $actions): string {
return $this->render_from_template(
'mod_adaptivequiz/report/individual_user_attempt_actions',
$actions->export_for_template($this)
);
}
/**
*
* @param int $uniqueid See {@link mod_adaptivequiz_renderer::attempt_report_page_by_tab()}.
* @param int $cmid
* @param int $userid
* @return string
* @throws moodle_exception
*/
protected function attempt_graph(int $uniqueid, int $cmid, int $userid): string {
$graphurl = new moodle_url('/mod/adaptivequiz/attemptgraph.php',
['uniqueid' => $uniqueid, 'cmid' => $cmid, 'userid' => $userid]);
$params = ['src' => $graphurl, 'class' => 'adaptivequiz-attemptgraph'];
$output = html_writer::start_div('mdl-align');
$output .= html_writer::empty_tag('img', $params);
$output .= html_writer::end_div('mdl-align');
return $output;
}
/**
* Produces a table of the question difficulties and the intermediate scores throughout the attempt.
*
* @param stdClass $adaptivequiz See {@link mod_adaptivequiz_renderer::attempt_report_page_by_tab()}.
* @param question_usage_by_activity $quba The questions used in this attempt.
* @return string
* @throws coding_exception
*/
protected function attempt_scoring_table(stdClass $adaptivequiz, question_usage_by_activity $quba): string {
$table = new html_table();
$num = get_string('attemptquestion_num', 'adaptivequiz');
$level = get_string('attemptquestion_level', 'adaptivequiz');
$rightwrong = get_string('attemptquestion_rightwrong', 'adaptivequiz');
$ability = get_string('attemptquestion_ability', 'adaptivequiz');
$error = get_string('attemptquestion_error', 'adaptivequiz');
$table->head = [$num, $level, $rightwrong, $ability, $error];
$table->align = ['center', 'center', 'center', 'center', 'center'];
$table->size = ['', '', '', '', '', ''];
$table->data = [];
$numattempted = 0;
$difficultysum = 0;
$sumcorrect = 0;
$sumincorrect = 0;
foreach ($quba->get_slots() as $slot) {
$question = $quba->get_question($slot);
$tags = core_tag_tag::get_item_tags_array('core_question', 'question', $question->id);
$qdifficulty = adaptivequiz_get_difficulty_from_tags($tags);
$qdifficultylogits = catalgo::convert_linear_to_logit($qdifficulty, $adaptivequiz->lowestlevel,
$adaptivequiz->highestlevel);
$correct = ($quba->get_question_mark($slot) > 0);
$numattempted++;
$difficultysum = $difficultysum + $qdifficultylogits;
if ($correct) {
$sumcorrect++;
} else {
$sumincorrect++;
}
$abilitylogits = catalgo::estimate_measure($difficultysum, $numattempted, $sumcorrect, $sumincorrect);
$abilityfraction = 1 / ( 1 + exp( (-1 * $abilitylogits) ) );
$ability = (($adaptivequiz->highestlevel - $adaptivequiz->lowestlevel) * $abilityfraction) + $adaptivequiz->lowestlevel;
$stderrorlogits = catalgo::estimate_standard_error($numattempted, $sumcorrect, $sumincorrect);
$stderror = catalgo::convert_logit_to_percent($stderrorlogits);
$table->data[] = [$slot, $qdifficulty, ($correct ? 'r' : 'w'), round($ability, 2),
round($stderror * 100, 1)."%"];
}
$return = $this->heading(get_string('reportattemptgraphtabletitle', 'adaptivequiz'), '4', 'mdl-align');
$return .= html_writer::table($table);
return $return;
}
/**
* @param int $uniqueid Attempt unique id.
* @param int $cmid
* @param int $userid
* @return string
* @throws moodle_exception
*/
protected function attempt_answer_distribution_graph(int $uniqueid, int $cmid, int $userid): string {
$graphurl = new moodle_url('/mod/adaptivequiz/answerdistributiongraph.php',
['uniqueid' => $uniqueid, 'cmid' => $cmid, 'userid' => $userid]);
$params = ['src' => $graphurl, 'class' => 'adaptivequiz-answerdistributiongraph'];
$output = html_writer::start_div('mdl-align');
$output .= html_writer::empty_tag('img', $params);
$output .= html_writer::end_div('mdl-align');
return $output;
}
/**
* Produces a table of the question difficulties and the number of questions answered right and wrong for each
* difficulty.
*
* @param stdClass $adaptivequiz See {@link mod_adaptivequiz_renderer::attempt_report_page_by_tab()}.
* @param question_usage_by_activity $quba The questions used in this attempt.
* @return string
* @throws coding_exception
*/
protected function attempt_answer_distribution_table(
stdClass $adaptivequiz,
question_usage_by_activity $quba
): string {
$table = new html_table();
$level = get_string('attemptquestion_level', 'adaptivequiz');
$numright = get_string('numright', 'adaptivequiz');
$numwrong = get_string('numwrong', 'adaptivequiz');
$table->head = [$level, $numright, $numwrong];
$table->align = ['center', 'center', 'center'];
$table->size = ['', '', '' ];
$table->data = [];
// Set up our data arrays.
$qdifficulties = [];
$rightanswers = [];
$wronganswers = [];
for ($i = $adaptivequiz->lowestlevel; $i <= $adaptivequiz->highestlevel; $i++) {
$qdifficulties[] = intval($i);
$rightanswers[] = 0;
$wronganswers[] = 0;
}
foreach ($quba->get_slots() as $i => $slot) {
$question = $quba->get_question($slot);
$tags = core_tag_tag::get_item_tags_array('core_question', 'question', $question->id);
$qdifficulty = adaptivequiz_get_difficulty_from_tags($tags);
$correct = ($quba->get_question_mark($slot) > 0);
$position = array_search($qdifficulty, $qdifficulties);
if ($correct) {
$rightanswers[$position]++;
} else {
$wronganswers[$position]++;
}
}
foreach ($qdifficulties as $key => $val) {
$table->data[] = [
$val,
$rightanswers[$key],
$wronganswers[$key],
];
}
$return = $this->heading(get_string('reportattemptanswerdistributiontabletitle', 'adaptivequiz'), '4',
'mdl-align');
$return .= html_writer::table($table);
return $return;
}
/**
* This function returns HTML markup of questions and student's responses.
* See {@link mod_adaptivequiz_renderer::attempt_report_page_by_tab} for partial parameters description.
*
* @param moodle_url $pageurl
* @param question_usage_by_activity $quba
* @param int $offset An offset used to determine which question to start processing from.
* @return string
* @throws coding_exception
* @throws moodle_exception
*/
protected function attempt_questions_review(
question_usage_by_activity $quba,
moodle_url $pageurl,
int $offset
): string {
$pager = $this->attempt_questions_review_pager($quba, $pageurl, $offset);
$questslots = $quba->get_slots();
$attr = ['class' => 'questiontags'];
$offset *= ADAPTIVEQUIZ_REV_QUEST_PER_PAGE;
$output = $pager;
// Take a portion of the array of question slots for display.
$pageqslots = array_slice($questslots, $offset, ADAPTIVEQUIZ_REV_QUEST_PER_PAGE);
// Setup display options.
$options = new question_display_options();
$options->readonly = true;
$options->flags = question_display_options::HIDDEN;
$options->marks = question_display_options::MAX_ONLY;
$options->rightanswer = question_display_options::VISIBLE;
$options->correctness = question_display_options::VISIBLE;
$options->numpartscorrect = question_display_options::VISIBLE;
// Setup quesiton header metadata.
$output .= $this->init_metadata($quba, $pageqslots);
foreach ($pageqslots as $slot) {
$label = html_writer::tag('label', get_string('questionnumber', 'adaptivequiz'));
$output .= html_writer::tag('div', $label.': '.format_string($slot));
// Retrieve question attempt object.
$questattempt = $quba->get_question_attempt($slot);
// Get question definition object.
$questdef = $questattempt->get_question();
// Retrieve the tags associated with this question.
$qtags = core_tag_tag::get_item_tags_array('core_question', 'question', $questdef->id);
$label = html_writer::tag('label', get_string('attemptquestion_level', 'adaptivequiz'));
$output .= html_writer::tag('div', $label.': '.format_string(adaptivequiz_get_difficulty_from_tags($qtags)));
$label = html_writer::tag('label', get_string('tags'));
$output .= html_writer::tag('div', $label.': '.format_string(implode(' ', $qtags)), $attr);
$output .= $quba->render_question($slot, $options);
$output .= html_writer::empty_tag('hr');
}
$output .= html_writer::empty_tag('br');
$output .= $pager;