forked from marinaglancy/moodle-format_flexsections
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathlib.php
1655 lines (1532 loc) · 64.6 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/>.
/**
* This file contains main class for Flexible sections course format.
*
* @package format_flexsections
* @copyright 2022 Marina Glancy
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
require_once($CFG->dirroot. '/course/format/lib.php');
use format_flexsections\constants;
use core\output\inplace_editable;
use format_flexsections\local\helpers\preferences;
define('FORMAT_FLEXSECTIONS_COLLAPSED', 1);
define('FORMAT_FLEXSECTIONS_EXPANDED', 0);
/**
* Main class for the Flexible sections course format.
*
* @package format_flexsections
* @copyright 2022 Marina Glancy
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class format_flexsections extends core_courseformat\base {
use preferences;
/**
* Returns true if this course format uses sections.
*
* @return bool
*/
public function uses_sections() {
return true;
}
/**
* Uses course index
*
* @return bool
*/
public function uses_course_index() {
return $this->get_course_index_display() != constants::COURSEINDEX_NONE;
}
/**
* Type of course index display
*
* @return int
*/
public function get_course_index_display(): int {
return (int)$this->get_course()->courseindexdisplay;
}
/**
* Uses indentation
*
* @return bool
*/
public function uses_indentation(): bool {
return (get_config('format_flexsections', 'indentation')) ? true : false;
}
/**
* Maximum number of subsections
*
* @return int
*/
public function get_max_section_depth(): int {
$limit = (int)get_config('format_flexsections', 'maxsectiondepth');
return max(1, min($limit, 100));
}
/**
* Accordion effect
*
* @return bool
*/
public function get_accordion_setting(): bool {
return (bool)$this->get_course()->accordion;
}
/**
* Returns the display name of the given section that the course prefers.
*
* Use section name is specified by user. Otherwise use default ("Topic #").
*
* @param int|stdClass|section_info $section Section object from database or just field section.section
* @return string Display name that the course format prefers, e.g. "Topic 2"
*/
public function get_section_name($section) {
if (!is_object($section)) {
$section = $this->get_section($section);
}
if ((string)$section->name !== '') {
return format_string($section->name, true,
['context' => context_course::instance($this->courseid)]);
} else {
return $this->get_default_section_name($section);
}
}
/**
* Returns the depth of the section in hierarchy
*
* For example, top section has depth 1, subsection of top section has depth 2,
* its subsection has depth 3.
*
* @param section_info $section
* @return int Depth of the section in hierarchy.
*/
public function get_section_depth(section_info $section): int {
$parent = $this->get_section($section->parent);
return $parent && $parent->section ? $this->get_section_depth($parent) + 1 : 1;
}
/**
* Returns the default section name for the flexsections course format.
*
* If the section number is 0, it will use the string with key = section0name from the course format's lang file.
* If the section number is not 0, the base implementation of course_format::get_default_section_name which uses
* the string with the key = 'sectionname' from the course format's lang file + the section number will be used.
*
* @param stdClass|section_info $section Section object from database or just field course_sections section
* @return string The default value for the section name.
*/
public function get_default_section_name($section) {
if ($section->section == 0) {
// Return the general section.
return get_string('section0name', 'format_flexsections');
} else {
// Use course_format::get_default_section_name implementation which
// will display the section name in "Topic n" format.
return parent::get_default_section_name($section);
}
}
/**
* Generate the title for this section page.
*
* @return string the page title
*/
public function page_title(): string {
global $CFG;
if ((int)$CFG->branch >= 404) {
// TODO it is possible it is not used anymore. Review.
return 'Topic outline';
} else {
return get_string('topicoutline');
}
}
/**
* Returns the section relative number regardless whether argument is an object or an int
*
* @param int|section_info $section
* @return ?int
*/
protected function resolve_section_number($section) {
if ($section === null || $section === '') {
return null;
} else if (is_object($section)) {
return $section->section;
} else {
return (int)$section;
}
}
/**
* 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 = []) {
$url = new moodle_url('/course/view.php', ['id' => $this->courseid]);
$sectionno = $this->resolve_section_number($section);
$section = $this->get_section($sectionno);
if ($sectionno && !$this->is_section_visible($section)) {
return empty($options['navigation']) ? $url : null;
}
if (array_key_exists('sr', $options)) {
// Return to the page for section with number $sr.
$url->param('section', $options['sr']);
if ($sectionno) {
$url->set_anchor('section-'.$sectionno);
}
} else if ($sectionno) {
// Check if this section has separate page.
if ($section->collapsed == FORMAT_FLEXSECTIONS_COLLAPSED) {
$url->param('section', $section->section);
return $url;
}
// Find the parent (or grandparent) page that is displayed on separate page.
if ($parent = $this->find_collapsed_parent($section->parent)) {
$url->param('section', $parent);
}
$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.
*
* @return stdClass
*/
public function supports_ajax() {
$ajaxsupport = new stdClass();
$ajaxsupport->capable = true;
return $ajaxsupport;
}
/**
* Supports components
*
* @return bool
*/
public function supports_components() {
return true;
}
/**
* Loads all of the course sections into the navigation.
*
* @param global_navigation $navigation
* @param navigation_node $node The course node within the navigation
* @return void
*/
public function extend_course_navigation($navigation, navigation_node $node) {
// If course format displays section on separate pages and we are on course/view.php page
// and the section parameter is specified, make sure this section is expanded in
// navigation.
if ($navigation->includesectionnum === false && $this->get_viewed_section() &&
(!defined('AJAX_SCRIPT') || AJAX_SCRIPT == '0')) {
$navigation->includesectionnum = $this->get_viewed_section();
}
$modinfo = get_fast_modinfo($this->courseid);
if (!empty($modinfo->sections[0])) {
foreach ($modinfo->sections[0] as $cmid) {
$this->navigation_add_activity($node, $modinfo->get_cm($cmid));
}
}
foreach ($modinfo->get_section_info_all() as $section) {
if ($section->parent == 0 && $section->section != 0) {
$this->navigation_add_section($navigation, $node, $section);
}
}
}
/**
* Adds a course module to the navigation node
*
* @param navigation_node $node
* @param cm_info $cm
* @return null|navigation_node
*/
protected function navigation_add_activity(navigation_node $node, cm_info $cm): ?navigation_node {
if (!$cm->uservisible || !$cm->has_view()) {
return null;
}
$activityname = $cm->get_formatted_name();
$action = $cm->url;
if ($cm->icon) {
$icon = new pix_icon($cm->icon, $cm->modfullname, $cm->iconcomponent);
} else {
$icon = new pix_icon('icon', $cm->modfullname, $cm->modname);
}
$activitynode = $node->add($activityname, $action, navigation_node::TYPE_ACTIVITY, null, $cm->id, $icon);
if (global_navigation::module_extends_navigation($cm->modname)) {
$activitynode->nodetype = navigation_node::NODETYPE_BRANCH;
} else {
$activitynode->nodetype = navigation_node::NODETYPE_LEAF;
}
if (method_exists($cm, 'is_visible_on_course_page')) {
$activitynode->display = $cm->is_visible_on_course_page();
}
return $activitynode;
}
/**
* Adds a section to navigation node, loads modules and subsections if necessary
*
* @param global_navigation $navigation
* @param navigation_node $node
* @param section_info $section
* @return null|navigation_node
*/
protected function navigation_add_section($navigation, navigation_node $node, section_info $section): ?navigation_node {
if (!$section->uservisible) {
return null;
}
$sectionname = get_section_name($this->get_course(), $section);
$url = course_get_url($this->get_course(), $section->section, ['navigation' => true]);
$sectionnode = $node->add($sectionname, $url, navigation_node::TYPE_SECTION, null, $section->id);
$sectionnode->nodetype = navigation_node::NODETYPE_BRANCH;
$sectionnode->hidden = !$section->visible || !$section->available;
if ($section->section == $this->get_viewed_section()) {
$sectionnode->force_open();
}
if ($this->section_has_parent($navigation->includesectionnum, $section->section)
|| $navigation->includesectionnum == $section->section) {
$modinfo = get_fast_modinfo($this->courseid);
if (!empty($modinfo->sections[$section->section])) {
foreach ($modinfo->sections[$section->section] as $cmid) {
$this->navigation_add_activity($sectionnode, $modinfo->get_cm($cmid));
}
}
foreach ($modinfo->get_section_info_all() as $subsection) {
if ($subsection->parent == $section->section && $subsection->section != 0) {
$this->navigation_add_section($navigation, $sectionnode, $subsection);
}
}
}
return $sectionnode;
}
/**
* 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() {
global $PAGE;
$titles = [];
$course = $this->get_course();
$modinfo = get_fast_modinfo($course);
$renderer = $this->get_renderer($PAGE);
if ($renderer && ($sections = $modinfo->get_section_info_all())) {
foreach ($sections as $number => $section) {
$titles[$number] = $renderer->section_title($section, $course);
}
}
return ['sectiontitles' => $titles, '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 [
BLOCK_POS_LEFT => [],
BLOCK_POS_RIGHT => [],
];
}
/**
* Definitions of the additional options that this course format uses for section
*
* See {@see format_base::course_format_options()} for return array definition.
*
* Additionally section format options may have property 'cache' set to true
* if this option needs to be cached in {@see get_fast_modinfo()}. The 'cache' property
* is recommended to be set only for fields used in {@see format_base::get_section_name()},
* {@see format_base::extend_course_navigation()} and {@see format_base::get_view_url()}
*
* For better performance cached options are recommended to have 'cachedefault' property
* Unlike 'default', 'cachedefault' should be static and not access get_config().
*
* Regardless of value of 'cache' all options are accessed in the code as
* $sectioninfo->OPTIONNAME
* where $sectioninfo is instance of section_info, returned by
* get_fast_modinfo($course)->get_section_info($sectionnum)
* or get_fast_modinfo($course)->get_section_info_all()
*
* All format options for particular section are returned by calling:
* $this->get_format_options($section);
*
* @param bool $foreditform
* @return array
*/
public function section_format_options($foreditform = false): array {
return [
'parent' => [
'type' => PARAM_INT,
'label' => '',
'element_type' => 'hidden',
'default' => 0,
'cache' => true,
'cachedefault' => 0,
],
'visibleold' => [
'type' => PARAM_INT,
'label' => '',
'element_type' => 'hidden',
'default' => 1,
'cache' => true,
'cachedefault' => 0,
],
'collapsed' => [
'type' => PARAM_INT,
'label' => get_string('displaycontent', 'format_flexsections'),
'element_type' => 'select',
'element_attributes' => [
[
FORMAT_FLEXSECTIONS_EXPANDED => new lang_string('showexpanded', 'format_flexsections'),
FORMAT_FLEXSECTIONS_COLLAPSED => new lang_string('showcollapsed', 'format_flexsections'),
],
],
'cache' => true,
'cachedefault' => FORMAT_FLEXSECTIONS_EXPANDED,
'default' => COURSE_DISPLAY_SINGLEPAGE,
],
'cssflex' => [
'type' => PARAM_TEXT,
'label' => get_string('cssflex', 'format_flexsections'),
'element_type' => 'text',
'cache' => true,
],
];
}
/**
* Definitions of the additional options that this course format uses for course.
*
* Flexsections format uses the following options:
* - showsection0title
*
* @param bool $foreditform
* @return array of options
*/
public function course_format_options($foreditform = false) {
static $courseformatoptions = false;
if ($courseformatoptions === false) {
$courseformatoptions = [
'showsection0title' => [
'default' => get_config('format_flexsections', 'showsection0titledefault') ?? 0,
'type' => PARAM_BOOL,
],
'courseindexdisplay' => [
'default' => get_config('format_flexsections', 'courseindexdisplay') ?? 0,
'type' => PARAM_INT,
],
'accordion' => [
'default' => (bool)get_config('format_flexsections', 'accordion'),
'type' => PARAM_BOOL,
],
'cmbacklink' => [
'default' => (bool)get_config('format_flexsections', 'cmbacklink'),
'type' => PARAM_BOOL,
],
];
}
if ($foreditform && !isset($courseformatoptions['showsection0title']['label'])) {
$options = [
constants::COURSEINDEX_FULL => get_string('courseindexfull', 'format_flexsections'),
constants::COURSEINDEX_SECTIONS => get_string('courseindexsections', 'format_flexsections'),
constants::COURSEINDEX_NONE => get_string('courseindexnone', 'format_flexsections'),
];
$courseformatoptionsedit = [
'showsection0title' => [
'label' => new lang_string('showsection0title', 'format_flexsections'),
'help' => 'showsection0title',
'help_component' => 'format_flexsections',
'element_type' => 'advcheckbox',
],
'courseindexdisplay' => [
'label' => new lang_string('courseindexdisplay', 'format_flexsections'),
'element_type' => 'select',
'element_attributes' => [$options],
],
'accordion' => [
'label' => new lang_string('accordion', 'format_flexsections'),
'element_type' => 'advcheckbox',
],
'cmbacklink' => [
'label' => new lang_string('cmbacklink', 'format_flexsections'),
'element_type' => 'advcheckbox',
],
];
$courseformatoptions = array_merge_recursive($courseformatoptions, $courseformatoptionsedit);
}
return $courseformatoptions;
}
/**
* Adds format options elements to the course/section edit form.
*
* This function is called from {@see 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 $COURSE;
$elements = parent::create_edit_form_elements($mform, $forsection);
if (!$forsection && (empty($COURSE->id) || $COURSE->id == SITEID)) {
// Add "numsections" element to the create course form - it will force new course to be prepopulated
// with empty sections.
// The "Number of sections" option is no longer available when editing course, instead teachers should
// delete and add sections when needed.
$courseconfig = get_config('moodlecourse');
$max = (int)$courseconfig->maxsections;
$element = $mform->addElement('select', 'numsections', get_string('numberweeks'), range(0, $max ?: 52));
$mform->setType('numsections', PARAM_INT);
if (is_null($mform->getElementValue('numsections'))) {
$mform->setDefault('numsections', $courseconfig->numsections);
}
array_unshift($elements, $element);
}
return $elements;
}
/**
* Whether this format allows to delete sections.
*
* Do not call this function directly, instead use {@see course_can_delete_section()}
*
* @param int|stdClass|section_info $section
* @return bool
*/
public function can_delete_section($section) {
return true;
}
/**
* Prepares the templateable object to display section name.
*
* @param \section_info|\stdClass $section
* @param bool $linkifneeded
* @param bool $editable
* @param null|lang_string|string $edithint
* @param null|lang_string|string $editlabel
* @return inplace_editable|void
*/
public function inplace_editable_render_section_name($section, $linkifneeded = true,
$editable = null, $edithint = null, $editlabel = null) {
if (empty($edithint)) {
$edithint = new lang_string('editsectionname', 'format_flexsections');
}
if (empty($editlabel)) {
$title = get_section_name($section->course, $section);
$editlabel = new lang_string('newsectionname', 'format_flexsections', $title);
}
$section = $this->get_section($section);
if ($linkifneeded && $section->collapsed != FORMAT_FLEXSECTIONS_COLLAPSED) {
$linkifneeded = false;
}
return parent::inplace_editable_render_section_name($section, $linkifneeded, $editable, $edithint, $editlabel);
}
/**
* Indicates whether the course format supports the creation of a news forum.
*
* @return bool
*/
public function supports_news() {
return true;
}
/**
* Returns whether this course format allows the activity to
* have "triple visibility state" - visible always, hidden on course page but available, hidden.
*
* @param stdClass|cm_info $cm course module (may be null if we are displaying a form for adding a module)
* @param stdClass|section_info $section section where this module is located or will be added to
* @return bool
*/
public function allow_stealth_module_visibility($cm, $section) {
// Allow the third visibility state inside visible sections or in section 0.
return !$section->section || $section->visible;
}
/**
* Callback used in WS core_course_edit_section when teacher performs an AJAX action on a section (show/hide).
*
* Access to the course is already validated in the WS but the callback has to make sure
* that particular action is allowed by checking capabilities
*
* Course formats should register.
*
* @param section_info|stdClass $section
* @param string $action
* @param int $sr
* @return null|array any data for the Javascript post-processor (must be json-encodeable)
*/
public function section_action($section, $action, $sr) {
global $PAGE;
if ($section->section && ($action === 'setmarker' || $action === 'removemarker')) {
// Format 'flexsections' allows to set and remove markers in addition to common section actions.
require_capability('moodle/course:setcurrentsection', context_course::instance($this->courseid));
course_set_marker($this->courseid, ($action === 'setmarker') ? $section->section : 0);
return null;
}
if ($section->section && ($action === 'showexpanded' || $action === 'showcollapsed')) {
require_capability('moodle/course:update', context_course::instance($this->courseid));
$newvalue = ($action === 'showexpanded') ? FORMAT_FLEXSECTIONS_EXPANDED : FORMAT_FLEXSECTIONS_COLLAPSED;
course_update_section($this->courseid, $section, ['collapsed' => $newvalue]);
// TODO what to return?
return null;
}
$mergeup = optional_param('mergeup', null, PARAM_INT);
if ($mergeup && has_capability('moodle/course:update', context_course::instance($this->courseid))) {
require_sesskey();
$section = $this->get_section($mergeup, MUST_EXIST);
$this->mergeup_section($section);
$url = course_get_url($this->courseid, $section->parent);
redirect($url);
}
// For show/hide actions call the parent method and return the new content for .section_availability element.
$rv = parent::section_action($section, $action, $sr);
$renderer = $PAGE->get_renderer('format_flexsections');
if (!($section instanceof section_info)) {
$modinfo = course_modinfo::instance($this->courseid);
$section = $modinfo->get_section_info($section->section);
}
$elementclass = $this->get_output_classname('content\\section\\availability');
$availability = new $elementclass($this, $section);
$rv['section_availability'] = $renderer->render($availability);
return $rv;
}
/**
* Return the plugin configs for external functions.
*
* @return array the list of configuration settings
*/
public function get_config_for_external() {
// Return everything (nothing to hide).
return $this->get_format_options();
}
/**
* Checks if section is really available for the current user (analyses parent section available)
*
* @deprecated since Moodle 4.5
* @param int|section_info $section
* @return bool
*/
public function is_section_real_available($section) {
if (($this->resolve_section_number($section) == 0)) {
// Section 0 is always available.
return true;
}
$context = context_course::instance($this->courseid);
if (has_capability('moodle/course:viewhiddensections', $context)) {
// For the purpose of this function only return true for teachers.
return true;
}
$section = $this->get_section($section);
return $section->available;
}
/**
* Returns either section or it's parent or grandparent, whoever first is collapsed
*
* @param int|section_info $section
* @param bool $returnid
* @return int
*/
public function find_collapsed_parent($section, $returnid = false) {
$section = $this->get_section($section);
if (!$section->section || $section->collapsed == FORMAT_FLEXSECTIONS_COLLAPSED) {
return $returnid ? $section->id : $section->section;
} else {
return $this->find_collapsed_parent($section->parent, $returnid);
}
}
/**
* URL of the page from where this function was called (use referer if this is an AJAX request)
*
* @return moodle_url
*/
protected function get_caller_page_url(): moodle_url {
global $PAGE, $FULLME;
$url = $PAGE->has_set_url() ? $PAGE->url : new moodle_url($FULLME);
if ($url->compare(new moodle_url('/lib/ajax/service.php'), URL_MATCH_BASE)) {
return !empty($_SERVER['HTTP_REFERER']) ? new moodle_url($_SERVER['HTTP_REFERER']) : $url;
}
return $url;
}
/**
* Returns true if we are on /course/view.php page
*
* @return bool
*/
public function on_course_view_page() {
$url = $this->get_caller_page_url();
return ($url && $url->compare(new moodle_url('/course/view.php'), URL_MATCH_BASE));
}
/**
* If we are on course/view.php page return the 'section' attribute from query
*
* @return int
*/
public function get_viewed_section() {
if ($this->on_course_view_page()) {
if ($s = $this->get_caller_page_url()->get_param('section')) {
return (int)$s;
}
$sid = $this->get_caller_page_url()->get_param('sectionid');
if ($sid && ($section = $this->get_modinfo()->get_section_info_by_id($sid))) {
return $section->section;
}
}
return 0;
}
/**
* Is this section displayed on the current page
*
* Used in course index
*
* @param int $sectionnum
* @return bool
*/
public function is_section_displayed_on_current_page(int $sectionnum): bool {
$viewedsection = $this->get_viewed_section();
if ($viewedsection) {
return $sectionnum == $viewedsection || $this->section_has_parent($sectionnum, $viewedsection);
} else {
$section = $this->get_section($sectionnum);
if (!$section->parent) {
return true;
}
return $this->find_collapsed_parent($section->parent) ? false : true;
}
}
/**
* Create a new section under given parent
*
* @param int|section_info $parent parent section
* @param null|int|section_info $before
* @return int $sectionnum
*/
public function create_new_section($parent = 0, $before = null): int {
$section = course_create_section($this->courseid, 0);
$sectionnum = $this->move_section($section, $parent, $before);
return $sectionnum;
}
/**
* Allows course format to execute code on moodle_page::set_course()
*
* format_flexsections processes additional attributes in the view course URL
* to manipulate sections and redirect to course view page
*
* @param moodle_page $page instance of page calling set_course
*/
public function page_set_course(moodle_page $page) {
global $PAGE;
if ($PAGE != $page) {
return;
}
if ($this->on_course_view_page()) {
$context = context_course::instance($this->courseid);
$currentsectionnum = $this->get_viewed_section();
// Fix the section argument.
if ($currentsectionnum && !optional_param('duplicatesection', 0, PARAM_INT)) {
$sectioninfo = $this->get_modinfo()->get_section_info($currentsectionnum);
if (!$sectioninfo || !$sectioninfo->collapsed) {
redirect(course_get_url($this->get_course(), $sectioninfo ? $this->find_collapsed_parent($sectioninfo) : null));
}
}
if ($currentsectionnum) {
navigation_node::override_active_url(new moodle_url('/course/view.php',
['id' => $this->courseid,
'section' => $currentsectionnum]));
}
// If requested, create new section and redirect to course view page.
$addchildsection = optional_param('addchildsection', null, PARAM_INT);
if ($addchildsection !== null && has_capability('moodle/course:update', $context)) {
$sectionnum = $this->create_new_section($addchildsection);
$url = course_get_url($this->courseid, $sectionnum);
redirect($url);
}
// If requested, merge the section content with parent and remove the section.
$mergeup = optional_param('mergeup', null, PARAM_INT);
if ($mergeup && confirm_sesskey() && has_capability('moodle/course:update', $context)) {
$section = $this->get_section($mergeup, MUST_EXIST);
$this->mergeup_section($section);
$url = course_get_url($this->courseid, $section->parent);
redirect($url);
}
// If requested, delete the section.
$deletesection = optional_param('deletesection', null, PARAM_INT);
if ($deletesection && confirm_sesskey() && has_capability('moodle/course:update', $context)
&& optional_param('confirm', 0, PARAM_INT) == 1) {
$section = $this->get_section($deletesection, MUST_EXIST);
$parent = $section->parent;
$this->delete_section_with_children($section);
$url = course_get_url($this->courseid, $parent);
redirect($url);
}
// If requested, move section.
$movesection = optional_param('movesection', null, PARAM_INT);
$moveparent = optional_param('moveparent', null, PARAM_INT);
$movebefore = optional_param('movebefore', null, PARAM_RAW);
$sr = optional_param('sr', null, PARAM_RAW);
$options = [];
if ($sr !== null) {
$options = ['sr' => $sr];
}
if ($movesection !== null && $moveparent !== null && has_capability('moodle/course:update', $context)) {
$newsectionnum = $this->move_section($movesection, $moveparent, $movebefore);
redirect(course_get_url($this->courseid, $newsectionnum, $options));
}
// If requested, switch collapsed attribute.
$switchcollapsed = optional_param('switchcollapsed', null, PARAM_INT);
if ($switchcollapsed && confirm_sesskey() && has_capability('moodle/course:update', $context)
&& ($section = $this->get_section($switchcollapsed))) {
if ($section->collapsed == FORMAT_FLEXSECTIONS_EXPANDED) {
$newvalue = FORMAT_FLEXSECTIONS_COLLAPSED;
} else {
$newvalue = FORMAT_FLEXSECTIONS_EXPANDED;
}
$this->update_section_format_options(['id' => $section->id, 'collapsed' => $newvalue]);
if ($newvalue == FORMAT_FLEXSECTIONS_COLLAPSED) {
if (!isset($options['sr'])) {
$options['sr'] = $this->find_collapsed_parent($section->parent);
}
redirect(course_get_url($this->courseid, $switchcollapsed, $options));
} else {
redirect(course_get_url($this->courseid, $switchcollapsed, $options));
}
}
// Set course marker if required.
$marker = optional_param('marker', null, PARAM_INT);
if ($marker !== null && has_capability('moodle/course:setcurrentsection', $context) && confirm_sesskey()) {
if ($marker > 0) {
// Set marker.
$url = course_get_url($this->courseid, $marker, ['sr' => $this->get_viewed_section()]);
course_set_marker($this->courseid, $marker);
redirect($url);
} else if ($this->get_course()->marker) {
// Remove marker.
$url = course_get_url($this->courseid, $this->get_course()->marker,
['sr' => $this->get_viewed_section()]);
course_set_marker($this->courseid, 0);
redirect($url);
}
}
// Change visibility if required.
$hide = optional_param('hide', null, PARAM_INT);
if ($hide !== null && has_capability('moodle/course:sectionvisibility', $context) && confirm_sesskey()) {
$url = course_get_url($this->courseid, $hide, ['sr' => $this->get_viewed_section()]);
$this->set_section_visible($hide, 0);
redirect($url);
}
$show = optional_param('show', null, PARAM_INT);
if ($show !== null && has_capability('moodle/course:sectionvisibility', $context) && confirm_sesskey()) {
$url = course_get_url($this->courseid, $show, ['sr' => $this->get_viewed_section()]);
$this->set_section_visible($show, 1);
redirect($url);
}
}
}
/**
* Moves section to the specified position
*
* @param int|section_info $section
* @param int|section_info $parent
* @param null|int|section_info $before
* @return int new section number
*/
public function move_section($section, $parent, $before = null) {
global $DB;
$section = $this->get_section($section);
$parent = $this->get_section($parent);
$newsectionnumber = $section->section;
if (!$this->can_move_section_to($section, $parent, $before)) {
return $newsectionnumber;
}
if ($section->visible != $parent->visible && $section->parent != $parent->section) {
// Section is changing parent and new parent has different visibility than the section.
if ($section->visible) {
// Visible section is moved under hidden parent.
$updatesectionvisible = 0;
$updatesectionvisibleold = 1;
} else {
// Hidden section is moved under visible parent.
if ($section->visibleold) {
$updatesectionvisible = 1;
$updatesectionvisibleold = 1;
}
}
}
// Find the changes in the sections numbering.
$origorder = [];
foreach ($this->get_sections() as $subsection) {
$origorder[$subsection->id] = $subsection->section;
}
$neworder = [];
$this->reorder_sections($neworder, 0, $section->section, $parent, $before);
if (count($origorder) != count($neworder)) {
die('Error in sections hierarchy'); // TODO.
}
$changes = [];
foreach ($origorder as $id => $num) {
if ($num == $section->section) {
$newsectionnumber = $neworder[$id];
}
if ($num != $neworder[$id]) {
$changes[$id] = ['old' => $num, 'new' => $neworder[$id]];
if ($num && $this->get_course()->marker == $num) {
$changemarker = $neworder[$id];
}
}
if ($this->resolve_section_number($parent) === $num) {
$newparentnum = $neworder[$id];
}
}
if (empty($changes) && $newparentnum == $section->parent) {
return $newsectionnumber;
}
// Build array of required changes in field 'parent'.
$changeparent = [];
foreach ($this->get_sections() as $subsection) {
foreach ($changes as $id => $change) {
if ($subsection->parent == $change['old']) {
$changeparent[$subsection->id] = $change['new'];
}
}
}
$changeparent[$section->id] = $newparentnum;
// Update all in database in one transaction.
$transaction = $DB->start_delegated_transaction();
// Update sections numbers in 2 steps to avoid breaking database uniqueness constraint.
foreach ($changes as $id => $change) {
$DB->set_field('course_sections', 'section', -$change['new'], ['id' => $id]);
}
foreach ($changes as $id => $change) {
$DB->set_field('course_sections', 'section', $change['new'], ['id' => $id]);
}
// Change parents of their subsections.
foreach ($changeparent as $id => $newnum) {
$this->update_section_format_options(['id' => $id, 'parent' => $newnum]);
}
$transaction->allow_commit();
rebuild_course_cache($this->courseid, true);
if (isset($changemarker)) {
course_set_marker($this->courseid, $changemarker);
}
if (isset($updatesectionvisible)) {
$this->set_section_visible($newsectionnumber, $updatesectionvisible, $updatesectionvisibleold);
}
return $newsectionnumber;
}