/
lib.php
1076 lines (999 loc) · 52.2 KB
/
lib.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
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/>.
/**
* Collapsed Topics Information
*
* A topic based format that solves the issue of the 'Scroll of Death' when a course has many topics. All topics
* except zero have a toggle that displays that topic. One or more topics can be displayed at any given time.
* Toggles are persistent on a per browser session per course basis but can be made to persist longer by a small
* code change. Full installation instructions, code adaptions and credits are included in the 'Readme.txt' file.
*
* @package course/format
* @subpackage topcoll
* @version See the value of '$plugin->version' in below.
* @copyright © 2012-onwards G J Barnard in respect to modifications of standard topics format.
* @author G J Barnard - gjbarnard at gmail dot com and {@link http://moodle.org/user/profile.php?id=442195}
* @link http://docs.moodle.org/en/Collapsed_Topics_course_format
* @license http://www.gnu.org/copyleft/gpl.html GNU Public License
*
*/
require_once($CFG->dirroot . '/course/format/lib.php'); // For format_base.
class format_topcoll extends format_base {
private $settings;
/**
* Creates a new instance of class
*
* Please use {@link course_get_format($courseorid)} to get an instance of the format class
*
* @param string $format
* @param int $courseid
* @return format_topcoll
*/
protected function __construct($format, $courseid) {
if ($courseid === 0) {
global $COURSE;
$courseid = $COURSE->id; // Save lots of global $COURSE as we will never be the site course.
}
parent::__construct($format, $courseid);
}
/**
* Returns the format's settings and gets them if they do not exist.
* @return type The settings as an array.
*/
public function get_settings() {
if (empty($this->settings) == true) {
$this->settings = $this->get_format_options();
}
return $this->settings;
}
/**
* Indicates this format uses sections.
*
* @return bool Returns true
*/
public function uses_sections() {
return true;
}
/**
* Gets the name for the provided section.
*
* @param int|stdClass $section Section object from database or just field section.section
* @return string The section name.
*/
public function get_section_name($section) {
$course = $this->get_course();
// Don't add additional text as called in creating the navigation.
return $this->get_topcoll_section_name($course, $section, false);
}
/**
* Gets the name for the provided course, section and state if need to add addional text.
*
* @param stdClass $course The course entry from DB
* @param int|stdClass $section Section object from database or just field section.section
* @param boolean $additional State to add additional text yes = true or no = false.
* @return string The section name.
*/
public function get_topcoll_section_name($course, $section, $additional) {
$thesection = $this->get_section($section);
if (is_null($thesection)) {
$thesection = new stdClass;
$thesection->name = '';
if (is_object($section)) {
$thesection->section = $section->section;
} else {
$thesection->section = $section;
}
}
$o = '';
$tcsettings = $this->get_settings();
$coursecontext = context_course::instance($course->id);
// We can't add a node without any text.
if ((string) $thesection->name !== '') {
$o .= format_string($thesection->name, true, array('context' => $coursecontext));
if (($thesection->section != 0) && (($tcsettings['layoutstructure'] == 2) ||
($tcsettings['layoutstructure'] == 3) || ($tcsettings['layoutstructure'] == 5))) {
$o .= ' ';
if ($additional == true) { // br tags break backups!
$o .= html_writer::empty_tag('br');
}
$o .= $this->get_section_dates($section, $course, $tcsettings);
}
} else if ($thesection->section == 0) {
$o = get_string('section0name', 'format_topcoll');
} else {
if (($tcsettings['layoutstructure'] == 1) || ($tcsettings['layoutstructure'] == 4)) {
$o = get_string('sectionname', 'format_topcoll') . ' ' . $thesection->section;
} else {
$o = $this->get_section_dates($thesection, $course, $tcsettings);
}
}
/*
* Now done here so that the drag and drop titles will be the correct strings as swapped in format.js.
* But only if we are using toggles which will be if all sections are on one page or we are editing the main page
* when in one section per page which is coded in 'renderer.php/print_multiple_section_page()' when it calls
* 'section_header()' as that gets called from 'format.php' when there is no entry for '$displaysetting' - confused?
* I was, took ages to figure.
*/
if (($additional == true) && ($thesection->section != 0)) {
switch ($tcsettings['layoutelement']) {
case 1:
case 2:
case 3:
case 4:
$o .= ' - ' . get_string('topcolltoggle', 'format_topcoll'); // The word 'Toggle'.
break;
}
}
return $o;
}
public function get_section_dates($section, $course, $tcsettings) {
$dateformat = get_string('strftimedateshort');
$o = '';
if ($tcsettings['layoutstructure'] == 5) {
$day = $this->format_topcoll_get_section_day($section, $course);
$weekday = userdate($day, $dateformat);
$o = $weekday;
} else {
$dates = $this->format_topcoll_get_section_dates($section, $course);
// We subtract 24 hours for display purposes.
$dates->end = ($dates->end - 86400);
$weekday = userdate($dates->start, $dateformat);
$endweekday = userdate($dates->end, $dateformat);
$o = $weekday . ' - ' . $endweekday;
}
return $o;
}
/**
* The URL to use for the specified course (with section)
*
* @param int|stdClass $section Section object from database or just field course_sections.section
* if omitted the course view page is returned
* @param array $options options for view URL. At the moment core uses:
* 'navigation' (bool) if true and section has no separate page, the function returns null
* 'sr' (int) used by multipage formats to specify to which section to return
* @return null|moodle_url
*/
public function get_view_url($section, $options = array()) {
$course = $this->get_course();
$url = new moodle_url('/course/view.php', array('id' => $course->id));
$sr = null;
if (array_key_exists('sr', $options)) {
$sr = $options['sr'];
}
if (is_object($section)) {
$sectionno = $section->section;
} else {
$sectionno = $section;
}
if ($sectionno !== null) {
if ($sr !== null) {
if ($sr) {
$usercoursedisplay = COURSE_DISPLAY_MULTIPAGE;
$sectionno = $sr;
} else {
$usercoursedisplay = COURSE_DISPLAY_SINGLEPAGE;
}
} else {
$usercoursedisplay = $course->coursedisplay;
}
if ($sectionno != 0 && $usercoursedisplay == COURSE_DISPLAY_MULTIPAGE) {
$url->param('section', $sectionno);
} else {
if (!empty($options['navigation'])) {
return null;
}
$url->set_anchor('section-' . $sectionno);
}
}
return $url;
}
/**
* Returns the information about the ajax support in the given source format
*
* The returned object's property (boolean)capable indicates that
* the course format supports Moodle course ajax features.
* The property (array)testedbrowsers can be used as a parameter for {@link ajaxenabled()}.
*
* @return stdClass
*/
public function supports_ajax() {
$ajaxsupport = new stdClass();
$ajaxsupport->capable = true;
$ajaxsupport->testedbrowsers = array('MSIE' => 8.0, 'Gecko' => 20061111, 'Opera' => 9.0, 'Safari' => 531, 'Chrome' => 6.0);
return $ajaxsupport;
}
/**
* Custom action after section has been moved in AJAX mode
*
* Used in course/rest.php
*
* @return array This will be passed in ajax respose
*/
public function ajax_section_move() {
$titles = array();
$current = -1; // MDL-33546.
$weekformat = false;
$tcsettings = $this->get_settings();
if (($tcsettings['layoutstructure'] == 2) || ($tcsettings['layoutstructure'] == 3) ||
($tcsettings['layoutstructure'] == 5)) {
$weekformat = true;
}
$course = $this->get_course();
$modinfo = get_fast_modinfo($course);
if ($sections = $modinfo->get_section_info_all()) {
foreach ($sections as $number => $section) {
$titles[$number] = $this->get_topcoll_section_name($course, $section, true);
if (($weekformat == true) && ($this->is_section_current($section))) {
$current = $number; // Only set if a week based course to keep the current week in the same place.
}
}
}
return array('sectiontitles' => $titles, 'current' => $current, 'action' => 'move');
}
/**
* Returns the list of blocks to be automatically added for the newly created course
*
* @return array of default blocks, must contain two keys BLOCK_POS_LEFT and BLOCK_POS_RIGHT
* each of values is an array of block names (for left and right side columns)
*/
public function get_default_blocks() {
return array(
BLOCK_POS_LEFT => array(),
BLOCK_POS_RIGHT => array('search_forums', 'news_items', 'calendar_upcoming', 'recent_activity')
);
}
/**
* Definitions of the additional options that this course format uses for course
*
* Collapsed Topics format uses the following options (until extras are migrated):
* - coursedisplay
* - numsections
* - hiddensections
*
* @param bool $foreditform
* @return array of options
*/
public function course_format_options($foreditform = false) {
static $courseformatoptions = false;
if ($courseformatoptions === false) {
/* Note: Because 'admin_setting_configcolourpicker' in 'settings.php' needs to use a prefixing '#'
this needs to be stripped off here if it's there for the format's specific colour picker. */
$defaulttgfgcolour = get_config('format_topcoll', 'defaulttgfgcolour');
if ($defaulttgfgcolour[0] == '#') {
$defaulttgfgcolour = substr($defaulttgfgcolour, 1);
}
$defaulttgbgcolour = get_config('format_topcoll', 'defaulttgbgcolour');
if ($defaulttgbgcolour[0] == '#') {
$defaulttgbgcolour = substr($defaulttgbgcolour, 1);
}
$defaulttgbghvrcolour = get_config('format_topcoll', 'defaulttgbghvrcolour');
if ($defaulttgbghvrcolour[0] == '#') {
$defaulttgbghvrcolour = substr($defaulttgbghvrcolour, 1);
}
$courseconfig = get_config('moodlecourse');
$courseformatoptions = array(
'numsections' => array(
'default' => $courseconfig->numsections,
'type' => PARAM_INT,
),
'hiddensections' => array(
'default' => $courseconfig->hiddensections,
'type' => PARAM_INT,
),
'coursedisplay' => array(
'default' => get_config('format_topcoll', 'defaultcoursedisplay'),
'type' => PARAM_INT,
),
'displayinstructions' => array(
'default' => get_config('format_topcoll', 'defaultdisplayinstructions'),
'type' => PARAM_INT,
),
'layoutelement' => array(
'default' => get_config('format_topcoll', 'defaultlayoutelement'),
'type' => PARAM_INT,
),
'layoutstructure' => array(
'default' => get_config('format_topcoll', 'defaultlayoutstructure'),
'type' => PARAM_INT,
),
'layoutcolumns' => array(
'default' => get_config('format_topcoll', 'defaultlayoutcolumns'),
'type' => PARAM_INT,
),
'layoutcolumnorientation' => array(
'default' => get_config('format_topcoll', 'defaultlayoutcolumnorientation'),
'type' => PARAM_INT,
),
'togglealignment' => array(
'default' => get_config('format_topcoll', 'defaulttogglealignment'),
'type' => PARAM_INT,
),
'toggleiconposition' => array(
'default' => get_config('format_topcoll', 'defaulttoggleiconposition'),
'type' => PARAM_INT,
),
'toggleiconset' => array(
'default' => get_config('format_topcoll', 'defaulttoggleiconset'),
'type' => PARAM_ALPHA,
),
'toggleallhover' => array(
'default' => get_config('format_topcoll', 'defaulttoggleallhover'),
'type' => PARAM_INT,
),
'toggleforegroundcolour' => array(
'default' => $defaulttgfgcolour,
'type' => PARAM_ALPHANUM,
),
'togglebackgroundcolour' => array(
'default' => $defaulttgbgcolour,
'type' => PARAM_ALPHANUM,
),
'togglebackgroundhovercolour' => array(
'default' => $defaulttgbghvrcolour,
'type' => PARAM_ALPHANUM,
)
);
}
if ($foreditform && !isset($courseformatoptions['coursedisplay']['label'])) {
/* Note: Because 'admin_setting_configcolourpicker' in 'settings.php' needs to use a prefixing '#'
this needs to be stripped off here if it's there for the format's specific colour picker. */
$defaulttgfgcolour = get_config('format_topcoll', 'defaulttgfgcolour');
if ($defaulttgfgcolour[0] == '#') {
$defaulttgfgcolour = substr($defaulttgfgcolour, 1);
}
$defaulttgbgcolour = get_config('format_topcoll', 'defaulttgbgcolour');
if ($defaulttgbgcolour[0] == '#') {
$defaulttgbgcolour = substr($defaulttgbgcolour, 1);
}
$defaulttgbghvrcolour = get_config('format_topcoll', 'defaulttgbghvrcolour');
if ($defaulttgbghvrcolour[0] == '#') {
$defaulttgbghvrcolour = substr($defaulttgbghvrcolour, 1);
}
$coursecontext = context_course::instance($this->courseid);
$courseconfig = get_config('moodlecourse');
$sectionmenu = array();
for ($i = 0; $i <= $courseconfig->maxsections; $i++) {
$sectionmenu[$i] = "$i";
}
$courseformatoptionsedit = array(
'numsections' => array(
'label' => new lang_string('numbersections', 'format_topcoll'),
'element_type' => 'select',
'element_attributes' => array($sectionmenu),
),
'hiddensections' => array(
'label' => new lang_string('hiddensections'),
'help' => 'hiddensections',
'help_component' => 'moodle',
'element_type' => 'select',
'element_attributes' => array(
array(0 => new lang_string('hiddensectionscollapsed'),
1 => new lang_string('hiddensectionsinvisible')
)
),
),
'coursedisplay' => array(
'label' => new lang_string('coursedisplay'),
'element_type' => 'select',
'element_attributes' => array(
array(
COURSE_DISPLAY_SINGLEPAGE => new lang_string('coursedisplay_single'),
COURSE_DISPLAY_MULTIPAGE => new lang_string('coursedisplay_multi')
)
),
'help' => 'coursedisplay',
'help_component' => 'moodle',
),
'displayinstructions' => array(
'label' => new lang_string('displayinstructions', 'format_topcoll'),
'help' => 'displayinstructions',
'help_component' => 'format_topcoll',
'element_type' => 'select',
'element_attributes' => array(
array(1 => new lang_string('no'),
2 => new lang_string('yes'))
)
)
);
if (has_capability('format/topcoll:changelayout', $coursecontext)) {
$courseformatoptionsedit['layoutelement'] = array(
'label' => new lang_string('setlayoutelements', 'format_topcoll'),
'help' => 'setlayoutelements',
'help_component' => 'format_topcoll',
'element_type' => 'select',
'element_attributes' => array( // In insertion order and not numeric for sorting purposes.
array(1 => new lang_string('setlayout_all', 'format_topcoll'), // Toggle word, toggle section x and section number.
3 => new lang_string('setlayout_toggle_word_section_x', 'format_topcoll'), // Toggle word and toggle section x.
2 => new lang_string('setlayout_toggle_word_section_number', 'format_topcoll'), // Toggle word and section number.
5 => new lang_string('setlayout_toggle_section_x_section_number', 'format_topcoll'), // Toggle section x and section number.
4 => new lang_string('setlayout_toggle_word', 'format_topcoll'), // Toggle word.
8 => new lang_string('setlayout_toggle_section_x', 'format_topcoll'), // Toggle section x.
6 => new lang_string('setlayout_section_number', 'format_topcoll'), // Section number.
7 => new lang_string('setlayout_no_additions', 'format_topcoll')) // No additions.
)
);
$courseformatoptionsedit['layoutstructure'] = array(
'label' => new lang_string('setlayoutstructure', 'format_topcoll'),
'help' => 'setlayoutstructure',
'help_component' => 'format_topcoll',
'element_type' => 'select',
'element_attributes' => array(
array(1 => new lang_string('setlayoutstructuretopic', 'format_topcoll'), // Topic.
2 => new lang_string('setlayoutstructureweek', 'format_topcoll'), // Week.
3 => new lang_string('setlayoutstructurelatweekfirst', 'format_topcoll'), // Latest Week First.
4 => new lang_string('setlayoutstructurecurrenttopicfirst', 'format_topcoll'), // Current Topic First.
5 => new lang_string('setlayoutstructureday', 'format_topcoll')) // Day.
)
);
$courseformatoptionsedit['layoutcolumns'] = array(
'label' => new lang_string('setlayoutcolumns', 'format_topcoll'),
'help' => 'setlayoutcolumns',
'help_component' => 'format_topcoll',
'element_type' => 'select',
'element_attributes' => array(
array(1 => new lang_string('one', 'format_topcoll'), // Default.
2 => new lang_string('two', 'format_topcoll'), // Two.
3 => new lang_string('three', 'format_topcoll'), // Three.
4 => new lang_string('four', 'format_topcoll')) // Four.
)
);
$courseformatoptionsedit['layoutcolumnorientation'] = array(
'label' => new lang_string('setlayoutcolumnorientation', 'format_topcoll'),
'help' => 'setlayoutcolumnorientation',
'help_component' => 'format_topcoll',
'element_type' => 'select',
'element_attributes' => array(
array(1 => new lang_string('columnvertical', 'format_topcoll'),
2 => new lang_string('columnhorizontal', 'format_topcoll')) // Default.
)
);
$courseformatoptionsedit['toggleiconposition'] = array(
'label' => new lang_string('settoggleiconposition', 'format_topcoll'),
'help' => 'settoggleiconposition',
'help_component' => 'format_topcoll',
'element_type' => 'select',
'element_attributes' => array(
array(1 => new lang_string('left', 'format_topcoll'), // Left.
2 => new lang_string('right', 'format_topcoll')) // Right.
)
);
} else {
$courseformatoptionsedit['layoutelement'] =
array('label' => get_config('format_topcoll', 'defaultlayoutelement'), 'element_type' => 'hidden');
$courseformatoptionsedit['layoutstructure'] =
array('label' => get_config('format_topcoll', 'defaultlayoutstructure'), 'element_type' => 'hidden');
$courseformatoptionsedit['layoutcolumns'] =
array('label' => get_config('format_topcoll', 'defaultlayoutcolumns'), 'element_type' => 'hidden');
$courseformatoptionsedit['layoutcolumnorientation'] =
array('label' => get_config('format_topcoll', 'defaultlayoutcolumnorientation'), 'element_type' => 'hidden');
$courseformatoptionsedit['toggleiconposition'] =
array('label' => get_config('format_topcoll', 'defaulttoggleiconposition'), 'element_type' => 'hidden');
}
if (has_capability('format/topcoll:changetogglealignment', $coursecontext)) {
$courseformatoptionsedit['togglealignment'] = array(
'label' => new lang_string('settogglealignment', 'format_topcoll'),
'help' => 'settogglealignment',
'help_component' => 'format_topcoll',
'element_type' => 'select',
'element_attributes' => array(
array(1 => new lang_string('left', 'format_topcoll'), // Left.
2 => new lang_string('center', 'format_topcoll'), // Centre.
3 => new lang_string('right', 'format_topcoll')) // Right.
)
);
} else {
$courseformatoptionsedit['togglealignment'] =
array('label' => get_config('format_topcoll', 'defaulttogglealignment'), 'element_type' => 'hidden');
}
if (has_capability('format/topcoll:changetoggleiconset', $coursecontext)) {
$courseformatoptionsedit['toggleiconset'] = array(
'label' => new lang_string('settoggleiconset', 'format_topcoll'),
'help' => 'settoggleiconset',
'help_component' => 'format_topcoll',
'element_type' => 'select',
'element_attributes' => array(
array(
'arrow' => new lang_string('arrow', 'format_topcoll'), // Arrow icon set.
'bulb' => new lang_string('bulb', 'format_topcoll'), // Bulb icon set.
'cloud' => new lang_string('cloud', 'format_topcoll'), // Cloud icon set.
'eye' => new lang_string('eye', 'format_topcoll'), // Eye icon set.
'led' => new lang_string('led', 'format_topcoll'), // LED icon set.
'point' => new lang_string('point', 'format_topcoll'), // Point icon set.
'power' => new lang_string('power', 'format_topcoll'), // Power icon set.
'radio' => new lang_string('radio', 'format_topcoll'), // Radio icon set.
'smiley' => new lang_string('smiley', 'format_topcoll'), // Smiley icon set.
'square' => new lang_string('square', 'format_topcoll'), // Square icon set.
'sunmoon' => new lang_string('sunmoon', 'format_topcoll'), // Sun / Moon icon set.
'switch' => new lang_string('switch', 'format_topcoll')) // Switch icon set.
)
);
$courseformatoptionsedit['toggleallhover'] = array(
'label' => new lang_string('settoggleallhover', 'format_topcoll'),
'help' => 'settoggleallhover',
'help_component' => 'format_topcoll',
'element_type' => 'select',
'element_attributes' => array(
array(1 => new lang_string('no'),
2 => new lang_string('yes'))
)
);
} else {
$courseformatoptionsedit['toggleiconset'] =
array('label' => get_config('format_topcoll', 'defaulttoggleiconset'), 'element_type' => 'hidden');
$courseformatoptionsedit['toggleallhover'] =
array('label' => get_config('format_topcoll', 'defaulttoggleallhover'), 'element_type' => 'hidden');
}
if (has_capability('format/topcoll:changecolour', $coursecontext)) {
$courseformatoptionsedit['toggleforegroundcolour'] = array(
'label' => new lang_string('settoggleforegroundcolour', 'format_topcoll'),
'help' => 'settoggleforegroundcolour',
'help_component' => 'format_topcoll',
'element_type' => 'tccolourpopup',
'element_attributes' => array(
array('tabindex' => -1, 'value' => $defaulttgfgcolour)
)
);
$courseformatoptionsedit['togglebackgroundcolour'] = array(
'label' => new lang_string('settogglebackgroundcolour', 'format_topcoll'),
'help' => 'settogglebackgroundcolour',
'help_component' => 'format_topcoll',
'element_type' => 'tccolourpopup',
'element_attributes' => array(
array('tabindex' => -1, 'value' => $defaulttgbgcolour)
)
);
$courseformatoptionsedit['togglebackgroundhovercolour'] = array(
'label' => new lang_string('settogglebackgroundhovercolour', 'format_topcoll'),
'help' => 'settogglebackgroundhovercolour',
'help_component' => 'format_topcoll',
'element_type' => 'tccolourpopup',
'element_attributes' => array(
array('tabindex' => -1, 'value' => $defaulttgbghvrcolour)
)
);
} else {
$courseformatoptionsedit['toggleforegroundcolour'] =
array('label' => $defaulttgfgcolour, 'element_type' => 'hidden');
$courseformatoptionsedit['togglebackgroundcolour'] =
array('label' => $defaulttgbgcolour, 'element_type' => 'hidden');
$courseformatoptionsedit['togglebackgroundhovercolour'] =
array('label' => $defaulttgbghvrcolour, 'element_type' => 'hidden');
}
$courseformatoptions = array_merge_recursive($courseformatoptions, $courseformatoptionsedit);
}
return $courseformatoptions;
}
/**
* Adds format options elements to the course/section edit form
*
* This function is called from {@link course_edit_form::definition_after_data()}
*
* @param MoodleQuickForm $mform form the elements are added to
* @param bool $forsection 'true' if this is a section edit form, 'false' if this is course edit form
* @return array array of references to the added form elements
*/
public function create_edit_form_elements(&$mform, $forsection = false) {
global $CFG, $OUTPUT;
MoodleQuickForm::registerElementType('tccolourpopup', "$CFG->dirroot/course/format/topcoll/js/tc_colourpopup.php",
'MoodleQuickForm_tccolourpopup');
$elements = parent::create_edit_form_elements($mform, $forsection);
if ($forsection == false) {
global $COURSE, $USER;
/*
Increase the number of sections combo box values if the user has increased the number of sections
using the icon on the course page beyond course 'maxsections' or course 'maxsections' has been
reduced below the number of sections already set for the course on the site administration course
defaults page. This is so that the number of sections is not reduced leaving unintended orphaned
activities / resources.
*/
$maxsections = get_config('moodlecourse', 'maxsections');
$numsections = $mform->getElementValue('numsections');
$numsections = $numsections[0];
if ($numsections > $maxsections) {
$element = $mform->getElement('numsections');
for ($i = $maxsections+1; $i <= $numsections; $i++) {
$element->addOption("$i", $i);
}
}
$coursecontext = context_course::instance($COURSE->id);
$changelayout = has_capability('format/topcoll:changelayout', $coursecontext);
$changecolour = has_capability('format/topcoll:changecolour', $coursecontext);
$changetogglealignment = has_capability('format/topcoll:changetogglealignment', $coursecontext);
$changetoggleiconset = has_capability('format/topcoll:changetoggleiconset', $coursecontext);
$resetall = is_siteadmin($USER); // Site admins only.
$elements[] = $mform->addElement('header', 'ctreset', get_string('ctreset', 'format_topcoll'));
$mform->addHelpButton('ctreset', 'ctreset', 'format_topcoll', '', true);
$resetelements = array();
$checkboxname = get_string('resetdisplayinstructions', 'format_topcoll').$OUTPUT->help_icon('resetdisplayinstructions', 'format_topcoll');
$resetelements[] =& $mform->createElement('checkbox', 'resetdisplayinstructions', '', $checkboxname);
if ($changelayout) {
$checkboxname = get_string('resetlayout', 'format_topcoll').$OUTPUT->help_icon('resetlayout', 'format_topcoll');
$resetelements[] =& $mform->createElement('checkbox', 'resetlayout', '', $checkboxname);
}
if ($changecolour) {
$checkboxname = get_string('resetcolour', 'format_topcoll').$OUTPUT->help_icon('resetcolour', 'format_topcoll');
$resetelements[] =& $mform->createElement('checkbox', 'resetcolour', '', $checkboxname);
}
if ($changetogglealignment) {
$checkboxname = get_string('resettogglealignment', 'format_topcoll').$OUTPUT->help_icon('resettogglealignment', 'format_topcoll');
$resetelements[] =& $mform->createElement('checkbox', 'resettogglealignment', '', $checkboxname);
}
if ($changetoggleiconset) {
$checkboxname = get_string('resettoggleiconset', 'format_topcoll').$OUTPUT->help_icon('resettoggleiconset', 'format_topcoll');
$resetelements[] =& $mform->createElement('checkbox', 'resettoggleiconset', '', $checkboxname);
}
$elements[] = $mform->addGroup($resetelements, 'resetgroup', get_string('resetgrp', 'format_topcoll'), null, false);
if ($resetall) {
$resetallelements = array();
$checkboxname = get_string('resetalldisplayinstructions', 'format_topcoll').$OUTPUT->help_icon('resetalldisplayinstructions', 'format_topcoll');
$resetallelements[] =& $mform->createElement('checkbox', 'resetalldisplayinstructions', '', $checkboxname);
$checkboxname = get_string('resetalllayout', 'format_topcoll').$OUTPUT->help_icon('resetalllayout', 'format_topcoll');
$resetallelements[] =& $mform->createElement('checkbox', 'resetalllayout', '', $checkboxname);
$checkboxname = get_string('resetallcolour', 'format_topcoll').$OUTPUT->help_icon('resetallcolour', 'format_topcoll');
$resetallelements[] =& $mform->createElement('checkbox', 'resetallcolour', '', $checkboxname);
$checkboxname = get_string('resetalltogglealignment', 'format_topcoll').$OUTPUT->help_icon('resetalltogglealignment', 'format_topcoll');
$resetallelements[] =& $mform->createElement('checkbox', 'resetalltogglealignment', '', $checkboxname);
$checkboxname = get_string('resetalltoggleiconset', 'format_topcoll').$OUTPUT->help_icon('resetalltoggleiconset', 'format_topcoll');
$resetallelements[] =& $mform->createElement('checkbox', 'resetalltoggleiconset', '', $checkboxname);
$elements[] = $mform->addGroup($resetallelements, 'resetallgroup', get_string('resetallgrp', 'format_topcoll'), null, false);
}
}
return $elements;
}
/**
* Override if you need to perform some extra validation of the format options
*
* @param array $data array of ("fieldname"=>value) of submitted data
* @param array $files array of uploaded files "element_name"=>tmp_file_path
* @param array $errors errors already discovered in edit form validation
* @return array of "element_name"=>"error_description" if there are errors,
* or an empty array if everything is OK.
* Do not repeat errors from $errors param here
*/
public function edit_form_validation($data, $files, $errors) {
$retr = array();
if ($this->validate_colour($data['toggleforegroundcolour']) === false) {
$retr['toggleforegroundcolour'] = get_string('colourrule', 'format_topcoll');
}
if ($this->validate_colour($data['togglebackgroundcolour']) === false) {
$retr['togglebackgroundcolour'] = get_string('colourrule', 'format_topcoll');
}
if ($this->validate_colour($data['togglebackgroundhovercolour']) === false) {
$retr['togglebackgroundhovercolour'] = get_string('colourrule', 'format_topcoll');
}
return $retr;
}
/**
* Validates the colour that was entered by the user.
* Borrowed from 'admin_setting_configcolourpicker' in '/lib/adminlib.php'.
*
* I'm not completely happy with this solution as would rather embed in the colour
* picker code in the form, however I find this area rather fraut and I hear that
* Dan Poltawski (via MDL-42270) will be re-writing the forms lib so hopefully more
* developer friendly.
*
* Note: Colour names removed, but might consider putting them back in if asked, but
* at the moment that would require quite a few changes and coping with existing
* settings. Either convert the names to hex or allow them as valid values and
* fix the colour picker code and the CSS code in 'format.php' for the setting.
*
* Colour name to hex on: http://www.w3schools.com/cssref/css_colornames.asp.
*
* @param string $data the colour string to validate.
* @return true|false
*/
private function validate_colour($data) {
if (preg_match('/^#?([[:xdigit:]]{3}){1,2}$/', $data)) {
return true;
} else {
return false;
}
}
/**
* Updates format options for a course
*
* In case if course format was changed to 'Collapsed Topics', we try to copy options
* 'coursedisplay', 'numsections' and 'hiddensections' from the previous format.
* If previous course format did not have 'numsections' option, we populate it with the
* current number of sections. The layout and colour defaults will come from 'course_format_options'.
*
* @param stdClass|array $data return value from {@link moodleform::get_data()} or array with data
* @param stdClass $oldcourse if this function is called from {@link update_course()}
* this object contains information about the course before update
* @return bool whether there were any changes to the options values
*/
public function update_course_format_options($data, $oldcourse = null) {
global $DB; // MDL-37976.
/*
* Notes: Using 'unset' to really ensure that the reset form elements never get into the database.
* This has to be done here so that the reset occurs after we have done updates such that the
* reset itself is not seen as an update.
*/
$resetdisplayinstructions = false;
$resetlayout = false;
$resetcolour = false;
$resettogglealignment = false;
$resettoggleiconset = false;
$resetalldisplayinstructions = false;
$resetalllayout = false;
$resetallcolour = false;
$resetalltogglealignment = false;
$resetalltoggleiconset = false;
if (isset($data->resetdisplayinstructions) == true) {
$resetdisplayinstructions = true;
unset($data->resetdisplayinstructions);
}
if (isset($data->resetlayout) == true) {
$resetlayout = true;
unset($data->resetlayout);
}
if (isset($data->resetcolour) == true) {
$resetcolour = true;
unset($data->resetcolour);
}
if (isset($data->resettogglealignment) == true) {
$resettogglealignment = true;
unset($data->resettogglealignment);
}
if (isset($data->resettoggleiconset) == true) {
$resettoggleiconset = true;
unset($data->resettoggleiconset);
}
if (isset($data->resetalldisplayinstructions) == true) {
$resetalldisplayinstructions = true;
unset($data->resetalldisplayinstructions);
}
if (isset($data->resetalllayout) == true) {
$resetalllayout = true;
unset($data->resetalllayout);
}
if (isset($data->resetallcolour) == true) {
$resetallcolour = true;
unset($data->resetallcolour);
}
if (isset($data->resetalltogglealignment) == true) {
$resetalltogglealignment = true;
unset($data->resetalltogglealignment);
}
if (isset($data->resetalltoggleiconset) == true) {
$resetalltoggleiconset = true;
unset($data->resetalltoggleiconset);
}
if ($oldcourse !== null) {
$data = (array) $data;
$oldcourse = (array) $oldcourse;
$options = $this->course_format_options();
foreach ($options as $key => $unused) {
if (!array_key_exists($key, $data)) {
if (array_key_exists($key, $oldcourse)) {
$data[$key] = $oldcourse[$key];
} else if ($key === 'numsections') {
/* If previous format does not have the field 'numsections'
* and $data['numsections'] is not set,
* we fill it with the maximum section number from the DB */
$maxsection = $DB->get_field_sql('SELECT max(section) from {course_sections} WHERE course = ?', array($this->courseid));
if ($maxsection) {
// If there are no sections, or just default 0-section, 'numsections' will be set to default.
$data['numsections'] = $maxsection;
}
}
}
}
}
$changes = $this->update_format_options($data);
// Now we can do the reset.
if (($resetalldisplayinstructions) || ($resetalllayout) || ($resetallcolour) || ($resetalltogglealignment) || ($resetalltoggleiconset)) {
$this->reset_topcoll_setting(0, $resetalldisplayinstructions, $resetalllayout, $resetallcolour, $resetalltogglealignment, $resetalltoggleiconset);
$changes = true;
} else if (($resetdisplayinstructions) || ($resetlayout) || ($resetcolour) || ($resettogglealignment) || ($resettoggleiconset)) {
$this->reset_topcoll_setting($this->courseid, $resetdisplayinstructions, $resetlayout, $resetcolour, $resettogglealignment, $resettoggleiconset);
$changes = true;
}
return $changes;
}
/**
* Is the section passed in the current section?
*
* @param stdClass $section The course_section entry from the DB
* @return bool true if the section is current
*/
public function is_section_current($section) {
$tcsettings = $this->get_settings();
if (($tcsettings['layoutstructure'] == 2) || ($tcsettings['layoutstructure'] == 3)) {
if ($section->section < 1) {
return false;
}
$timenow = time();
$dates = $this->format_topcoll_get_section_dates($section, $this->get_course());
return (($timenow >= $dates->start) && ($timenow < $dates->end));
} else if ($tcsettings['layoutstructure'] == 5) {
if ($section->section < 1) {
return false;
}
$timenow = time();
$day = $this->format_topcoll_get_section_day($section, $this->get_course());
$onedayseconds = 86400;
return (($timenow >= $day) && ($timenow < ($day + $onedayseconds)));
} else {
return parent::is_section_current($section);
}
}
/**
* Return the start and end date of the passed section.
*
* @param int|stdClass $section The course_section entry from the DB.
* @param stdClass $course The course entry from DB.
* @return stdClass property start for startdate, property end for enddate.
*/
private function format_topcoll_get_section_dates($section, $course) {
$oneweekseconds = 604800;
/* Hack alert. We add 2 hours to avoid possible DST problems. (e.g. we go into daylight
savings and the date changes. */
$startdate = $course->startdate + 7200;
$dates = new stdClass();
if (is_object($section)) {
$section = $section->section;
}
$dates->start = $startdate + ($oneweekseconds * ($section - 1));
$dates->end = $dates->start + $oneweekseconds;
return $dates;
}
/**
* Return the date of the passed section.
*
* @param int|stdClass $section The course_section entry from the DB.
* @param stdClass $course The course entry from DB.
* @return stdClass property date.
*/
private function format_topcoll_get_section_day($section, $course) {
$onedayseconds = 86400;
/* Hack alert. We add 2 hours to avoid possible DST problems. (e.g. we go into daylight
savings and the date changes. */
$startdate = $course->startdate + 7200;
if (is_object($section)) {
$section = $section->section;
}
$day = $startdate + ($onedayseconds * ($section - 1));
return $day;
}
/**
* Resets the format setting to the default.
* @param int $courseid If not 0, then a specific course to reset.
* @param int $displayinstructions If true, reset the display instructions to the default in the settings for the format.
* @param int $layout If true, reset the layout to the default in the settings for the format.
* @param int $colour If true, reset the colour to the default in the settings for the format.
* @param int $togglealignment If true, reset the toggle alignment to the default in the settings for the format.
* @param int $toggleiconset If true, reset the toggle icon set to the default in the settings for the format.
*/
public function reset_topcoll_setting($courseid, $displayinstructions, $layout, $colour, $togglealignment, $toggleiconset) {
global $DB, $USER, $COURSE;
$coursecontext = context_course::instance($COURSE->id);
$currentcourseid = 0;
if ($courseid == 0) {
$records = $DB->get_records('course_format_options', array('format' => $this->format), '', 'id,courseid');
} else {
$records = $DB->get_records('course_format_options', array('courseid' => $courseid, 'format' => $this->format), '', 'id,courseid');
}
$resetallifall = ((is_siteadmin($USER)) || ($courseid != 0)); // Will be true if reset all capability or a single course.
$updatedata = array();
$updatedisplayinstructions = false;
$updatelayout = false;
$updatetogglealignment = false;
$updatecolour = false;
$updatetoggleiconset = false;
if ($displayinstructions && $resetallifall) {
$updatedata['displayinstructions'] = get_config('format_topcoll', 'defaultdisplayinstructions');
$updatedisplayinstructions = true;
}
if ($layout && has_capability('format/topcoll:changelayout', $coursecontext) && $resetallifall) {
$updatedata['coursedisplay'] = get_config('format_topcoll', 'defaultcoursedisplay');
$updatedata['layoutelement'] = get_config('format_topcoll', 'defaultlayoutelement');
$updatedata['layoutstructure'] = get_config('format_topcoll', 'defaultlayoutstructure');
$updatedata['layoutcolumns'] = get_config('format_topcoll', 'defaultlayoutcolumns');
$updatedata['layoutcolumnorientation'] = get_config('format_topcoll', 'defaultlayoutcolumnorientation');
$updatedata['toggleiconposition'] = get_config('format_topcoll', 'defaulttoggleiconposition');
$updatelayout = true;
}
if ($togglealignment && has_capability('format/topcoll:changetogglealignment', $coursecontext) && $resetallifall) {
$updatedata['togglealignment'] = get_config('format_topcoll', 'defaulttogglealignment');
$updatetogglealignment = true;
}
if ($colour && has_capability('format/topcoll:changecolour', $coursecontext) && $resetallifall) {
$updatedata['toggleforegroundcolour'] = get_config('format_topcoll', 'defaulttgfgcolour');
$updatedata['togglebackgroundcolour'] = get_config('format_topcoll', 'defaulttgbgcolour');
$updatedata['togglebackgroundhovercolour'] = get_config('format_topcoll', 'defaulttgbghvrcolour');
$updatecolour = true;
}
if ($toggleiconset && has_capability('format/topcoll:changetoggleiconset', $coursecontext) && $resetallifall) {
$updatedata['toggleiconset'] = get_config('format_topcoll', 'defaulttoggleiconset');
$updatedata['toggleallhover'] = get_config('format_topcoll', 'defaulttoggleallhover');
$updatetoggleiconset = true;
}
foreach ($records as $record) {
if ($currentcourseid != $record->courseid) {
$currentcourseid = $record->courseid; // Only do once per course.
if (($updatedisplayinstructions) || ($updatelayout) || ($updatetogglealignment) || ($updatecolour) || ($updatetoggleiconset)) {
$ourcourseid = $this->courseid;
$this->courseid = $currentcourseid;