-
Notifications
You must be signed in to change notification settings - Fork 3
/
renderer.php
1802 lines (1521 loc) · 68.4 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/>.
/**
* Renderer for Open Badge Factory -plugin
*
* @package local_obf
* @copyright 2013-2021, Open Badge Factory Oy
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
use classes\criterion\obf_criterion;
use classes\criterion\obf_criterion_item;
use classes\obf_assertion;
use classes\obf_backpack;
use classes\obf_badge;
use classes\obf_client;
use classes\obf_issue_event;
use classes\obf_issuer;
use classes\obf_assertion_collection;
defined('MOODLE_INTERNAL') || die();
require_once($CFG->libdir . '/tablelib.php');
require_once(__DIR__ . '/form/issuance.php');
require_once(__DIR__ . '/classes/criterion/obf_criterion.php');
require_once(__DIR__ . '/form/emailtemplate.php');
require_once(__DIR__ . '/form/coursecriterion.php');
require_once(__DIR__ . '/classes/backpack.php');
/**
* HTML output renderer for local_obf-plugin
*
* @package local_obf
* @copyright 2013-2020, Open Badge Factory Oy
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class local_obf_renderer extends plugin_renderer_base {
/**
* @var int tiny badge image.
*/
const BADGE_IMAGE_SIZE_TINY = 22;
/**
* @var int small badge image.
*/
const BADGE_IMAGE_SIZE_SMALL = 32;
/**
* @var int normal badge image.
*/
const BADGE_IMAGE_SIZE_NORMAL = 100;
/**
* Render the list of backpack providers for backpack config -page.
*
* @param type $backpacks
*/
public function render_backpack_provider_list($backpacks) {
$content = '';
$table = new html_table();
$table->id = 'obf-backpackproviders';
$table->attributes = array('class' => 'local-obf generaltable');
$table->head =
array(get_string('backpackprovidershortname', 'local_obf'), get_string('backpackproviderfullname', 'local_obf'),
get_string('backpackproviderurl', 'local_obf'), get_string('backpackprovideremailconfigureable', 'local_obf'),
get_string('backpackprovideractions', 'local_obf'));
foreach ($backpacks as $backpack) {
$row = new html_table_row();
$editurl =
new moodle_url('/local/obf/backpackconfig.php', array('action' => 'edit', 'id' => $backpack->get_provider()));
$links = html_writer::link($editurl, get_string('edit'));
$actionscell = new html_table_cell($links);
$row->cells = array($backpack->get_providershortname(), $backpack->get_providerfullname(), $backpack->get_apiurl(),
$backpack->requires_email_verification() ? get_string('yes') : '', $actionscell);
$table->data[] = $row;
}
$content .= html_writer::table($table);
$createurl = new moodle_url('/local/obf/backpackconfig.php', array('action' => 'create'));
$content .= html_writer::div(html_writer::link($createurl, get_string('create'), array('class' => 'btn btn-default')),
'pull-right');
return $content;
}
/**
* Renders the list of badges in course context
*
* @param obf_badge[] $badges
* @param bool $hasissuecapability
* @param context $context
* @param string $message
* @return string
*/
public function render_badgelist_course($badges, $hasissuecapability, context $context, $message = '') {
$html = '';
if (!empty($message)) {
$html .= $this->output->notification($message, 'notifysuccess');
}
$html .= $this->render_badge_categories($badges);
$badgesincourse = obf_badge::get_badges_in_course($context->instanceid, $this->get_client_id());
$html .= $this->print_heading('coursebadgelisttitle', 2);
$errormsg = $this->output->notification(get_string('nobadgesincourse', 'local_obf'));
if (count($badgesincourse) == 0) {
$html .= $errormsg;
} else {
$validbadges = array();
foreach ($badgesincourse as $badge) {
// Badge is deleted from OBF, but there are still rules in the
// database. It shouldn't happen in practice, but in theory
// it's possible. We should handle it better.
if ($badge->has_name()) {
$validbadges[] = $badge;
}
}
$html .= count($validbadges) > 0 ? $this->render_badges($validbadges, $hasissuecapability, $context) : $errormsg;
}
$html .= $this->print_heading('badgelisttitle', 2);
$html .= $this->render_badges($badges, $hasissuecapability, $context);
return $html;
}
/**
* Renders the list of badges.
*
* @param obf_badge[] $badges
* @param bool $hasissuecapability
* @param context $context
* @param string $message
* @return string
*/
public function render_badgelist($badges, $hasissuecapability, context $context, $message = '') {
$html = $this->print_heading('badgelisttitle', 2);
if (!empty($message)) {
$html .= $this->output->notification($message, 'notifysuccess');
}
$html .= $this->render_badge_categories($badges);
$html .= $this->render_badges($badges, $hasissuecapability, $context);
return $html;
}
/**
* Render all available badge categories.
*
* @param obf_badge[] $badges
* @return string
*/
public function render_badge_categories($badges) {
global $COURSE, $DB;
$html = '';
$categories = array();
$items = array();
$availablecategories = obf_badge::get_available_categories();
$filtercategories = count($availablecategories) > 0;
foreach ($badges as $badge) {
foreach ($badge->get_categories() as $category) {
if (!in_array($category, $categories) && (!$filtercategories || in_array($category, $availablecategories))) {
$anyrulesdefinesql = "SELECT badgecategoriename FROM {local_obf_rulescateg} WHERE coursecategorieid = ?";
$anyrules = $DB->get_records_sql($anyrulesdefinesql, [$COURSE->category]);
if ((!empty($anyrules) && key_exists($category, $anyrules)) || empty($anyrules)) {
$items[] = html_writer::tag('button', s($category), array('class' => ''));
$categories[] = $category;
}
}
}
}
if (count($items) > 0) {
$html .= local_obf_html::div(local_obf_html::div(html_writer::tag('p', get_string('showcategories', 'local_obf')) .
html_writer::tag('button', get_string('resetfilter', 'local_obf'), array('class' => 'obf-reset-filter')),
'obf-category-reset-wrapper') . html_writer::alist($items, array('class' => 'obf-categories')),
'obf-category-wrapper');
$this->page->requires->yui_module('moodle-local_obf-badgecategorizer', 'M.local_obf.init_badgecategorizer');
}
return $html;
}
/**
* Render assertions for user.
*
* @param obf_assertion_collection $assertions
* @param stdClass $user
* @param bool $large
* @return string
*/
public function render_user_assertions(obf_assertion_collection $assertions, $user = null, $large = false) {
global $USER, $DB;
$html = '';
$items = '';
if (is_numeric($user)) {
$userid = $user;
$user = $DB->get_record('user', array('id' => $userid));
} else if ($user instanceof stdClass) {
$userid = $user->id;
} else if (empty($userid)) {
$userid = $USER->id;
$user = $DB->get_record('user', array('id' => $userid));
}
$jsassertions = array();
for ($i = 0; $i < count($assertions); $i++) {
$assertion = $assertions->get_assertion($i);
if ($assertion->is_revoked_for_user($user)) {
continue;
}
$badge = $assertion->get_badge();
$aid = $userid . '-' . $i;
$jsassertions[$aid] = $assertion->toarray();
$attributes = array('id' => $aid);
$attributes['class'] = '';
if ($assertion->badge_has_expired()) {
$attributes['class'] = 'expired-assertion';
}
$items .= html_writer::tag('li', $this->render_single_simple_assertion($assertion, $large), $attributes);
}
$ulid = uniqid('badgelist');
$html .= html_writer::tag('ul', $items, array('class' => 'badgelist', 'id' => $ulid));
$params = $this->get_displayer_params($jsassertions, $ulid, $userid);
$this->page->requires->yui_module('moodle-local_obf-courseuserbadgedisplayer', 'M.local_obf.init_badgedisplayer',
array($params));
$this->page->requires->string_for_js('closepopup', 'local_obf');
$this->page->requires->string_for_js('blacklistbadge', 'local_obf');
return $html;
}
/**
* Render one assertion.
*
* @param obf_assertion $assertion
* @param bool $large Use large style? Default: false.
* @return string HTML of one badge assertion.
*/
public function render_single_simple_assertion($assertion, $large = false) {
$badge = $assertion->get_badge();
$badgeimage = $this->print_badge_image($badge, -1);
$badgename = html_writer::tag('p', s($badge->get_name()), array('class' => 'badgename'));
$badgedescription = html_writer::tag('p', s($badge->get_description()), array('class' => 'description'));
$extra = '';
$divclass = 'obf-badge';
if ($assertion->badge_has_expired()) {
$divclass .= ' expired-assertion';
$extra = html_writer::tag('div', get_string('expired', 'local_obf'), array('class' => 'expired-info'));
}
if ($large) {
$divclass .= ' large';
}
$html = local_obf_html::div($extra . $badgeimage . local_obf_html::div($badgename . $badgedescription, 'body'), $divclass);
return $html;
}
/**
* Renders a single badge assertion.
*
* @param obf_assertion $assertion
* @param bool $printheading
* @param obf_revoke_form $revokeform
* @param bool $modal
* @return string
*/
public function render_assertion(obf_assertion $assertion, $printheading = true, $revokeform = null, $modal = false) {
$html = '';
$badge = $assertion->get_badge();
$collection = new obf_assertion_collection(array($assertion));
$issuedon = $assertion->get_issuedon();
$issuedon = is_numeric($issuedon) ? userdate($issuedon, get_string('dateformatdate', 'local_obf')) : $issuedon;
$users = $collection->get_assertion_users($assertion);
$assertionitems = array(get_string('badgename', 'local_obf') => s($badge->get_name()),
get_string('badgedescription', 'local_obf') => s($badge->get_description()),
get_string('issuedon', 'local_obf') => $issuedon);
$expiresby = $assertion->get_expires();
$assertionitems = array_merge($assertionitems, array(get_string('badgeexpiresby', 'local_obf') => $expiresby));
if (count($assertion->get_recipients()) > 0) {
if (!is_null($revokeform)) {
$list = $revokeform->render();
} else {
$list = html_writer::alist(array_map(function($user) {
if ($user instanceof stdClass) {
return fullname($user);
}
return $user;
}, $users));
}
$assertionitems[get_string('recipients', 'local_obf')] = $list;
}
if ($printheading) {
$html .= $this->print_heading('issuancedetails', 2);
}
if ($modal) {
$html .= $this->render_badge_modal($badge, $assertion);
} else {
$html .= local_obf_html::div(local_obf_html::div(html_writer::empty_tag('img', array('src' => $badge->get_image())),
'image-wrapper') . local_obf_html::div(local_obf_html::div($this->print_heading('badgedetails') .
$this->render_definition_list($assertionitems), 'badge-details') .
local_obf_html::div($this->print_heading('issuerdetails') . $this->render_issuer_details($badge->get_issuer()),
'issuer-details'), 'assertion-details'), 'obf-assertion');
}
return $html;
}
/**
* Render details used in badge/assertion displayed in a modal.
*
* @param obf_badge $badge
* @param obf_assertion $assertion
* @return string HTML-string.
*/
public function render_badge_modal($badge, $assertion) {
$issuer = $badge->get_issuer();
$issuerdetails = html_writer::tag('label', get_string('issuer', 'local_obf'));
$issuerurl = $issuer->get_url();
if (!empty($issuerurl)) {
$issuerdetails .= html_writer::link($issuer->get_url(), s($issuer->get_name()), array('class' => 'issuer-url'));
} else {
$issuerdetails .= s($issuer->get_name());
}
$issuerdetails .= ' / ' . html_writer::link('mailto:' . $issuer->get_email(), s($issuer->get_email()));
$issuedon = $assertion->get_issuedon();
$assertionitems = array(get_string('issuedon', 'local_obf') => $issuedon,
get_string('badgeexpiresby', 'local_obf') => $assertion->get_expires());
$assertiondetails = html_writer::tag('h1', s($badge->get_name()), array('class' => 'badgename'));
foreach ($assertionitems as $key => $value) {
$assertiondetails .= html_writer::tag('div', html_writer::tag('label', $key) . $value);
}
$html = local_obf_html::div(local_obf_html::div(html_writer::empty_tag('img', array('src' => $badge->get_image())),
'image-wrapper') . local_obf_html::div(local_obf_html::div($assertiondetails, 'assertion-details') .
local_obf_html::div($issuerdetails, 'issuer-details') .
local_obf_html::div(s($badge->get_description()), 'badge-details') .
local_obf_html::div(html_writer::link($badge->get_criteria_url() . '#',
get_string('showbadgecriteria', 'local_obf'),
array('class' => 'view-criteria', 'data-id' => $badge->get_id(),
'data-url' => $badge->get_criteria_url())) .
html_writer::tag('div', $badge->get_criteria_html(), array('class' => 'criteria-area')), 'criteria'),
'details-area'), 'obf-assertion-modal');
return $html;
}
/**
* Renders a definition list.
*
* @param array $items An array of items to render (key-value -pairs)
* @return string Returns the html-markup
*/
public function render_definition_list(array $items) {
$arr = array();
foreach ($items as $name => $value) {
$arr[] = html_writer::tag('dt', $name) . html_writer::tag('dd', $value);
}
return html_writer::tag('dl', implode('', $arr), array('class' => 'obf-definition-list'));
}
/**
* Renders the page with the badge details.
*
* @param obf_client $client
* @param obf_badge $badge
* @param context $context
* @param string $tab
* @param int $page
* @param string $message
* @return string
*/
public function page_badgedetails(obf_client $client, obf_badge $badge, context $context, $tab = 'details', $page = 0,
$message = '', $onlydetailstab = null) {
$methodprefix = 'print_badge_info_';
$rendererfunction = $methodprefix . $tab;
$html = '';
if (!method_exists($this, $rendererfunction)) {
$html .= $this->output->notification(get_string('invalidtab', 'local_obf'));
} else {
if (!empty($message)) {
$html .= $this->output->notification($message, 'notifysuccess');
}
$html .= $this->print_badge_tabs($badge, $context, $tab, $onlydetailstab);
$html .= call_user_func(array($this, $rendererfunction), $client, $badge, $context, $page);
}
return $html;
}
/**
* @param obf_badge $badge
* @param context|null $context
* @param string $label
* @return string
* @throws coding_exception
* @throws moodle_exception
*/
public function issue_button(obf_badge $badge, context $context = null) {
$issueurl = new moodle_url('/local/obf/issue.php', array('id' => $badge->get_id(), 'clientid' => $this->get_client_id()));
if ($context instanceof context_course) {
$issueurl->param('courseid', $context->instanceid);
}
$button = $this->output->single_button($issueurl, get_string('issue', 'local_obf'), 'get');
return local_obf_html::div($button);
}
/**
* @param obf_badge $badge
* @param context|null $context
* @return string
* @throws coding_exception
* @throws moodle_exception
*/
public function csv_button(obf_badge $badge, context $context = null) {
$csvurl = new moodle_url('/local/obf/badge.php',
array('id' => $badge->get_id(), 'clientid' => $this->get_client_id(), 'action' => 'historycsv'));
$button = $this->output->single_button($csvurl, get_string('createcsv', 'local_obf'), 'get');
return local_obf_html::div($button);
}
/**
* Renders the heading element in badge-details -page.
*
* @param obf_badge $badge
* @param context $context
* @return string HTML
*/
public function render_badge_heading(obf_badge $badge, context $context) {
$heading = $this->output->heading($this->print_badge_image($badge) . ' ' . s($badge->get_name()));
$issueurl = new moodle_url('/local/obf/issue.php', array('id' => $badge->get_id()));
if ($context instanceof context_course) {
$issueurl->param('courseid', $context->instanceid);
}
return local_obf_html::div($heading, 'badgeheading');
}
/**
* Renders the criterion-form.
*
* @param obf_criterion_form $form
* @return string HTML.
*/
protected function render_obf_criterion_form(obf_criterion_form $form) {
$criterion = $form->get_criterion();
$badge = $criterion->get_badge();
$html = $this->output->header();
$html .= $this->output->heading($this->print_badge_image($badge) . ' ' . s($badge->get_name()));
$html .= $form->render();
$html .= $this->output->footer();
return $html;
}
/**
* Renders the criterion deletion form.
*
* @param obf_criterion_deletion_form $form
* @return string HTML.
*/
protected function render_obf_criterion_deletion_form(obf_criterion_deletion_form $form) {
$html = $this->output->header();
$html .= $form->render();
$html .= $this->output->footer();
return $html;
}
/**
* Renders the OBF-badges.
*
* @param obf_badge[] $badges
* @param bool $hasissuecapability
* @param context $context
* @return string HTML
*/
protected function render_badges($badges, $hasissuecapability, context $context) {
$html = '';
if (count($badges) === 0) {
$html .= $this->output->notification(get_string('nobadges', 'local_obf'), 'notifynotice');
} else {
$items = '';
foreach ($badges as $badge) {
$name = s($badge->get_name());
$badgeimage = $this->print_badge_image($badge, -1);
$badgename = html_writer::tag('p', $name, array('class' => 'badgename'));
$url = new moodle_url('/local/obf/badge.php',
array('clientid' => $this->get_client_id(), 'id' => $badge->get_id(), 'action' => 'show'));
if ($context instanceof context_course) {
$url->param('courseid', $context->instanceid);
}
$items .= html_writer::tag('li',
local_obf_html::div(html_writer::link($url, $badgeimage . $badgename, array('title' => $name)), 'obf-badge'),
array('data-categories' => json_encode($badge->get_categories())));
}
$html .= html_writer::tag('ul', $items, array('class' => 'badgelist'));
}
return $html;
}
/**
* Generates the HTML for the badge image.
*
* @param obf_badge $badge The badge object
* @param int $width The width of the image
* @return string The img-tag
*/
public function print_badge_image(obf_badge $badge, $width = self::BADGE_IMAGE_SIZE_SMALL) {
$params = array("src" => $badge->get_image(), "alt" => s($badge->get_name()));
if ($width > 0) {
$params['width'] = $width;
}
return html_writer::empty_tag("img", $params);
}
/**
* Generates the HTML for a heading.
*
* @param string $id The string id in the module's language file.
* @param int $level The heading level.
* @return string The hX-tag
*/
public function print_heading($id, $level = 3) {
return $this->output->heading(get_string($id, 'local_obf'), $level);
}
/**
* Renders the badge and issuer details.
*
* @param obf_client $client
* @param obf_badge $badge
* @param context $context
* @return string HTML
*/
public function print_badge_info_details(obf_client $client, obf_badge $badge, context $context) {
$html = '';
$badgeimage = $this->print_badge_image($badge, self::BADGE_IMAGE_SIZE_NORMAL);
$createdon = $badge->get_created();
$badgecreated = empty($createdon) ? '&' : userdate($createdon, get_string('dateformatdate', 'local_obf'));
$boxes = local_obf_html::div($badgeimage, 'obf-badgeimage');
$badgedetails = $this->print_heading('badgedetails');
$definitions = array(get_string('badgename', 'local_obf') => s($badge->get_name()),
get_string('badgedescription', 'local_obf') => s($badge->get_description()),
get_string('badgecreated', 'local_obf') => $badgecreated);
if ($badge->has_criteria_url()) {
$definitions[get_string('badgecriteriaurl', 'local_obf')] =
html_writer::link($badge->get_criteria_url(), s($badge->get_criteria_url()));
}
if (count($badge->get_tags()) > 0) {
$definitions[get_string('badgetags', 'local_obf')] = implode(', ', array_map('s', $badge->get_tags()));
}
$definitions[get_string('badgecriteriahtml', 'local_obf')] = $badge->get_criteria_html();
$badgedetails .= $this->render_definition_list($definitions);
$issuer = $badge->get_issuer();
// Issuer details table.
$badgedetails .= $this->print_heading('issuerdetails');
$badgedetails .= $this->render_issuer_details($issuer);
$boxes .= local_obf_html::div($badgedetails, 'obf-badgedetails');
$html .= local_obf_html::div($boxes, 'obf-badgewrapper');
return $html;
}
/**
* Render issuer details.
*
* @param obf_issuer $issuer
* @return string HTML
*/
public function render_issuer_details(obf_issuer $issuer) {
$url = $issuer->get_url();
$description = $issuer->get_description();
$issuerurl = empty($url) ? '' : html_writer::link($url, s($url));
$html = $this->render_definition_list(array(get_string('issuername', 'local_obf') => s($issuer->get_name()),
get_string('issuerurl', 'local_obf') => $issuerurl,
get_string('issuerdescription', 'local_obf') => empty($description) ? '-' : s($description),
get_string('issueremail', 'local_obf') => s($issuer->get_email())));
return $html;
}
/**
* Renders the badge criteria page.
*
* @param obf_client $client
* @param obf_badge $badge
* @param context $context
* @return string HTML
*/
public function print_badge_info_criteria(obf_client $client, obf_badge $badge, context $context) {
$html = '';
if ($context instanceof context_course) {
$html .= $this->render_badge_criteria_course($badge, $context->instanceid);
} else {
$html .= $this->render_badge_criteria_site($badge);
}
return $html;
}
/**
* Renders the form for modifying the criteria of a single course
*
* @param obf_badge $badge
* @param int $courseid
* @return string HTML
*/
public function render_badge_criteria_course(obf_badge $badge, $courseid) {
$html = '';
$criteria = $badge->get_completion_criteria();
$coursewithcriterion = null;
$criterioncourseid = null;
$courseincriterion = false;
$error = '';
$url = new moodle_url('/local/obf/badge.php',
array('clientid' => $this->get_client_id(), 'id' => $badge->get_id(), 'action' => 'show', 'show' => 'criteria',
'courseid' => $courseid));
// Show edit form if there aren't any criteria related to this badge or
// there is only one which hasn't been met yet by any user.
foreach ($criteria as $criterion) {
$courses = $criterion->get_items(true);
$courseincriterion = $criterion->has_course($courseid);
// If the course is already related to a criterion containing other courses also,
// the criterion cannot be modified in course context.
if ($courseincriterion) {
$coursewithcriterion = $criterion;
if (count($courses) > 1) {
$error = 'coursealreadyincriterion';
} else if ($criterion->is_met()) {
$error = 'cannoteditcriterion';
} else {
$criterioncourseid = $courses[0]->get_id();
}
break;
}
}
$canedit = !is_null($criterioncourseid) || !$courseincriterion;
$course = get_course($courseid);
$completionenabled = !empty($course) ? $course->enablecompletion : false;
// The criteria cannot be modified or added -> show a message to user.
if (!$canedit) {
if (!is_null($coursewithcriterion) && $coursewithcriterion->is_met()) {
$items = $coursewithcriterion->get_items();
$html .= html_writer::tag('p', get_string('badgeissuedwhen', 'local_obf'));
foreach ($criteria as $id => $criterion) {
$criterionhtml = '';
$attributelist = array();
$criterionitems = $criterion->get_items();
$courseincriterion = $criterion->has_course($courseid); /* fixit */
if (!$courseincriterion) {
continue;
}
if (count($criterionitems) == 1) {
$criteriontype = obf_criterion_item::get_criterion_type_text($criterionitems[0]->get_criteriatype());
}
$groupname = get_string('criteriatype' . $criteriontype, 'local_obf');
if ($criterionitems[0]->get_criteriatype() == obf_criterion_item::CRITERIA_TYPE_TOTARA_CERTIF) {
$groupname = get_string('criteriatypetotaracertif', 'local_obf');
}
foreach ($criterionitems as $item) {
$attributelist = array_merge($attributelist, $item->get_text_array());
}
// The criterion can be edited if the criterion hasn't already been met.
$canedit = !$criterion->is_met();
$heading = $groupname;
// If the criterion can be edited, show the edit-icon.
if ($canedit) {
$editurl = new moodle_url($file,
array('badgeid' => $badge->get_id(), 'clientid' => $this->get_client_id(), 'action' => 'edit',
'id' => $id));
$heading .= local_obf_html::icon($editurl, 't/edit', 'edit');
}
$deleteurl = new moodle_url('/local/obf/badge.php',
array('id' => $badge->get_id(), 'clientid' => $this->get_client_id(), 'action' => 'deletecriterion',
'courseid' => $courseid, 'criterionid' => $id, 'sesskey' => sesskey()));
$deleteicon = new pix_icon('t/delete', get_string('delete'));
$heading .= ' ' . $this->output->action_icon($deleteurl, $deleteicon,
new confirm_action(get_string('confirmcriteriondeletion', 'local_obf')));
$criterionhtml .= $this->output->heading(local_obf_html::div($heading), 3);
if (!$criterion->is_valid()) {
$criterionhtml .= $this->output->notification(get_string('invalidcriterion', 'local_obf'));
}
if (!$canedit) {
$criterionhtml .= $this->output->notification(get_string('cannoteditcriterion', 'local_obf'));
}
if (count($criterionitems) > 1) {
$method = $criterion->get_completion_method() == obf_criterion::CRITERIA_COMPLETION_ALL ? 'all' : 'any';
$criterionhtml .= html_writer::tag('p', get_string('criteriacompletedwhen' . $method, 'local_obf'));
}
$criterionhtml .= html_writer::alist($attributelist);
$html .= $this->output->box($criterionhtml, 'generalbox service');
}
} else {
if (!is_null($coursewithcriterion)) {
$html .= html_writer::tag('p', get_string('criteriapartofcourseset', 'local_obf'));
}
}
} else if (!$completionenabled) {
$courseediturl = new moodle_url('/course/edit.php', array('id' => $courseid));
$html .= $this->output->notification(get_string('coursecompletionnotenabled', 'local_obf', (string) $courseediturl));
} else { // Show the course criteria form.
$params = array('criteriatype' => optional_param('criteriatype', obf_criterion_item::CRITERIA_TYPE_UNKNOWN, PARAM_INT),
'courseid' => optional_param('courseid', null, PARAM_INT));
if (!is_null($coursewithcriterion)) {
$params = array_merge($params, array('obf_criterion_id' => $coursewithcriterion->get_id()));
}
if (is_null($criterioncourseid)) {
$criterioncourse = obf_criterion_item::build($params);
} else {
$criterioncourse = obf_criterion_item::get_instance($criterioncourseid);
}
$criterionform = new obf_coursecriterion_form($url, array('criterioncourse' => $criterioncourse));
// Deleting the rule is done via cancel-button.
if ($criterionform->is_cancelled()) {
$criterioncourse->delete();
redirect(new moodle_url('/local/obf/badge.php',
array('clientid' => $this->get_client_id(), 'id' => $badge->get_id(), 'action' => 'show', 'show' => 'criteria',
'courseid' => $courseid, 'msg' => get_string('criteriondeleted', 'local_obf'))));
}
if (!is_null($data = $criterionform->get_data())) {
if (!$criterioncourse->exists()) {
$criterion = new obf_criterion();
$criterion->set_badge($badge);
$criterion->set_clientid($this->get_client_id());
$criterion->set_completion_method(obf_criterion::CRITERIA_COMPLETION_ALL);
$criterion->set_items($criterioncourse);
}
if (isset($data->criteriaaddendum)) {
$criterion->set_criteria_addendum($data->criteriaaddendum);
}
if (isset($data->addcriteriaaddendum)) {
$criterion->set_use_addendum($data->addcriteriaaddendum);
}
if (!is_null($courseid)) {
$criterioncourse->set_courseid((int) $courseid);
}
$pickingtype = ((!$criterioncourse->exists() && !$criterioncourse->is_createable_with_params($_REQUEST)) ||
$criterioncourse->get_criteriatype() == obf_criterion_item::CRITERIA_TYPE_UNKNOWN ||
property_exists($data, 'picktype') && $data->picktype === 'yes');
if ($pickingtype) {
if (!is_null($courseid)) {
$criterionform = new obf_coursecriterion_form($url, array('criterioncourse' => $criterioncourse));
}
} else { // Saving the rule.
if (!$criterioncourse->exists()) {
// Update or insert criterion course
// Object doesn't exist yet, let's create the criterion.
$criterion->save();
$criterioncourse->set_criterionid($criterion->get_id());
}
$midgrades = property_exists($data, 'mingrade') ? $data->mingrade : array();
$grade = null;
$completedby = null;
foreach ($midgrades as $key => $value) {
$grade = (int) $data->mingrade[$key];
if (property_exists($data, 'completedby_' . $key)) {
$completedby = (int) $data->{'completedby_' . $key};
}
}
$criterioncourse->set_grade($grade);
$criterioncourse->set_completedby($completedby);
$criterioncourse->save_params($data);
$redirecturl = new moodle_url('/local/obf/badge.php',
array('clientid' => $this->get_client_id(), 'id' => $badge->get_id(), 'action' => 'show',
'show' => 'criteria', 'courseid' => $courseid, 'msg' => get_string('criterionsaved', 'local_obf')));
if (property_exists($data, 'reviewaftersave') && $data->reviewaftersave) {
$crit = $criterioncourse->get_criterion();
if ($crit) {
$recipientcount = $crit->review_previous_completions();
} else {
$recipientcount = 0;
}
$redirecturl->param('msg', get_string('badgewasautomaticallyissued', 'local_obf', $recipientcount));
}
redirect($redirecturl);
}
}
$html .= $criterionform->render();
}
return $html;
}
/**
* Renders the badge criteria in site context.
*
* @param obf_badge $badge
* @return string HTML
*/
public function render_badge_criteria_site(obf_badge $badge) {
$html = '';
$file = '/local/obf/criterion.php';
$url = new moodle_url($file, array('clientid' => $this->get_client_id(), 'badgeid' => $badge->get_id(), 'action' => 'new'));
$options = array();
$criteria = $badge->get_completion_criteria();
if (count($criteria) === 0) {
$html .= $this->output->notification(get_string('nocriteriayet', 'local_obf'));
}
if (count($criteria) > 0) {
$html .= html_writer::tag('p', get_string('badgeissuedwhen', 'local_obf'));
}
foreach ($criteria as $id => $criterion) {
$criterionhtml = '';
$attributelist = array();
$criteriontype = 'courseset';
$criterionitems = $criterion->get_items();
$multiplecourseactivities = 0;
if (count($criterionitems) == 1) {
$criteriontype = obf_criterion_item::get_criterion_type_text($criterionitems[0]->get_criteriatype());
}
// If activities from multiple courses.
if (count($criterionitems) > 1 && get_class($criterionitems[0]) == "obf_criterion_activity") {
$criteriontype = obf_criterion_item::get_criterion_type_text($criterionitems[0]->get_criteriatype());
$multiplecourseactivities = 1;
}
$groupname = get_string('criteriatype' . $criteriontype, 'local_obf');
if ($criterionitems[0]->get_criteriatype() == obf_criterion_item::CRITERIA_TYPE_TOTARA_CERTIF) {
$groupname = get_string('criteriatypetotaracertif', 'local_obf');
}
if ($multiplecourseactivities) {
$attributelist = $criterionitems[0]->get_text_array();
} else {
foreach ($criterionitems as $item) {
$attributelist = array_merge($attributelist, $item->get_text_array());
}
}
// The criterion can be edited if the criterion hasn't already been met.
$canedit = !$criterion->is_met();
$heading = $groupname;
$deleteurl = new moodle_url($file,
array('clientid' => $this->get_client_id(), 'badgeid' => $badge->get_id(), 'action' => 'delete', 'id' => $id));
$heading .= local_obf_html::icon($deleteurl, 't/delete', 'delete');
// If the criterion can be edited, show the edit-icon.
if ($canedit) {
$editurl = new moodle_url($file,
array('badgeid' => $badge->get_id(), 'clientid' => $this->get_client_id(), 'action' => 'edit', 'id' => $id));
$heading .= local_obf_html::icon($editurl, 't/edit', 'edit');
}
$criterionhtml .= $this->output->heading(local_obf_html::div($heading), 3);
if ($multiplecourseactivities) {
global $DB;
foreach ($criterionitems as $item) {
$course = $DB->get_record('course', array('id' => $courseid = $item->get_courseid()));
$criterionhtml .= $this->output->heading(local_obf_html::div($course->fullname), 5);
}
} else if ($criteriontype == "activity") {
global $DB;
$course = $DB->get_record('course', array('id' => $courseid = $item->get_courseid()));
$criterionhtml .= $this->output->heading(local_obf_html::div($course->fullname), 5);
}
if (!$canedit) {
$criterionhtml .= $this->output->notification(get_string('cannoteditcriterion', 'local_obf'));
}
if (count($criterionitems) > 1 && !$multiplecourseactivities) {
$method = $criterion->get_completion_method() == obf_criterion::CRITERIA_COMPLETION_ALL ? 'all' : 'any';
$criterionhtml .= html_writer::tag('p', get_string('criteriacompletedwhen' . $method, 'local_obf'));
}
$criterionhtml .= html_writer::alist($attributelist);
$html .= $this->output->box($criterionhtml, 'generalbox service');
}
$html .= $this->output->single_button($url, get_string('addcriteria', 'local_obf'));
return $html;
}
/**
* Renders the OBF settings form
* NOT USED BUT DO NOT REMOVE THIS IS AOTOMATICALLY LOAD
*
* @param obf_settings_form $form
* @return string HTML
*/
public function render_obf_settings_form(obf_settings_form $form): string {
$html = $this->print_heading('settings', 2);
$html .= $form->render();
return $html;
}
/**