forked from moodle/moodle
-
Notifications
You must be signed in to change notification settings - Fork 0
/
navigationlib.php
3576 lines (3335 loc) · 148 KB
/
navigationlib.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 classes used to manage the navigation structures in Moodle
* and was introduced as part of the changes occuring in Moodle 2.0
*
* @since 2.0
* @package moodlecore
* @subpackage navigation
* @copyright 2009 Sam Hemelryk
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
if (!function_exists('get_all_sections')) {
/** Include course lib for its functions */
require_once($CFG->dirroot.'/course/lib.php');
}
/**
* The name that will be used to separate the navigation cache within SESSION
*/
define('NAVIGATION_CACHE_NAME', 'navigation');
/**
* This class is used to represent a node in a navigation tree
*
* This class is used to represent a node in a navigation tree within Moodle,
* the tree could be one of global navigation, settings navigation, or the navbar.
* Each node can be one of two types either a Leaf (default) or a branch.
* When a node is first created it is created as a leaf, when/if children are added
* the node then becomes a branch.
*
* @package moodlecore
* @subpackage navigation
* @copyright 2009 Sam Hemelryk
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class navigation_node {
/** Used to identify this node a leaf (default) */
const NODETYPE_LEAF = 0;
/** Used to identify this node a branch, happens with children */
const NODETYPE_BRANCH = 1;
/** Unknown node type */
const TYPE_UNKNOWN = null;
/** System node type */
const TYPE_SYSTEM = 0;
/** Category node type */
const TYPE_CATEGORY = 10;
/** Course node type */
const TYPE_COURSE = 20;
/** Course Structure node type */
const TYPE_SECTION = 30;
/** Activity node type, e.g. Forum, Quiz */
const TYPE_ACTIVITY = 40;
/** Resource node type, e.g. Link to a file, or label */
const TYPE_RESOURCE = 50;
/** A custom node type, default when adding without specifing type */
const TYPE_CUSTOM = 60;
/** Setting node type, used only within settings nav */
const TYPE_SETTING = 70;
/** Setting node type, used only within settings nav */
const TYPE_USER = 80;
/** @var int Parameter to aid the coder in tracking [optional] */
public $id = null;
/** @var string|int The identifier for the node, used to retrieve the node */
public $key = null;
/** @var string The text to use for the node */
public $text = null;
/** @var string Short text to use if requested [optional] */
public $shorttext = null;
/** @var string The title attribute for an action if one is defined */
public $title = null;
/** @var string A string that can be used to build a help button */
public $helpbutton = null;
/** @var moodle_url|string|null An action for the node (link) */
public $action = null;
/** @var string The path to an icon to use for this node */
public $icon = null;
/** @var int See TYPE_* constants defined for this class */
public $type = self::TYPE_UNKNOWN;
/** @var int See NODETYPE_* constants defined for this class */
public $nodetype = self::NODETYPE_LEAF;
/** @var bool If set to true the node will be collapsed by default */
public $collapse = false;
/** @var bool If set to true the node will be expanded by default */
public $forceopen = false;
/** @var string An array of CSS classes for the node */
public $classes = array();
/** @var array An array of child nodes */
public $children = array();
/** @var bool If set to true the node will be recognised as active */
public $isactive = false;
/** @var string If set to true the node will be dimmed */
public $hidden = false;
/** @var bool If set to false the node will not be displayed */
public $display = true;
/** @var bool If set to true then an HR will be printed before the node */
public $preceedwithhr = false;
/** @var bool If set to true the the navigation bar should ignore this node */
public $mainnavonly = false;
/** @var bool If set to true a title will be added to the action no matter what */
public $forcetitle = false;
/** @var array */
protected $namedtypes = array(0=>'system',10=>'category',20=>'course',30=>'structure',40=>'activity',50=>'resource',60=>'custom',70=>'setting', 80=>'user');
/** @var moodle_url */
protected static $fullmeurl = null;
/**
* Establish the node, with either text string or array or properites
*
* Called when first creating the node, requires one argument which can be either
* a string containing the text for the node or an array or properties one of
* which must be text.
*
* <code>
* $PAGE->navigation->newitem = 'This is a new nav item';
* // or
* $properties = array()
* $properties['text'] = 'This is a new nav item';
* $properties['short'] = 'This is a new nav item';
* $properties['action'] = moodle_url($CFG->wwwroot.'/course/category.php');
* $properties['icon'] = $OUTPUT->old_icon_url('i/course');
* $properties['type'] = navigation_node::TYPE_COURSE;
* $properties['key'] = 'newitem';
* $PAGE->navigation->newitem = $properties;
* </code>
*
* The following are properties that must/can be set in the properties array
* <ul>
* <li><b>text</b>: You must set text, if this is not set a coding exception is thrown.</li>
* <li><b>short</b> <i>optional</i>: A short description used for navbar optional.</li>
* <li><b>action</b> <i>optional</i>: This can be either a {@link moodle_url} for a link, or string that can be directly output in instead of the text.</li>
* <li><b>icon</b> <i>optional</i>: The path to an icon to display with the node.</li>
* <li><b>type</b> <i>optional</i>: This type of the node, defaults to TYPE_CUSTOM.</li>
* <li><b>key</b> <i>optional</i>: This can be set to allow you to easily retrieve a node you have created.</li>
* </ul>
*
* @param string|array $properties
*/
public function __construct($properties) {
global $PAGE;
if (is_array($properties)) {
if (array_key_exists('text', $properties)) {
$this->text = $properties['text'];
}
if (array_key_exists('shorttext', $properties)) {
$this->shorttext = $properties['shorttext'];
}
if (array_key_exists('action', $properties)) {
$this->action = $properties['action'];
if (is_string($this->action)) {
$this->action = new moodle_url($this->action);
}
$this->check_if_active();
}
if (array_key_exists('icon', $properties)) {
$this->icon = $properties['icon'];
}
if (array_key_exists('type', $properties)) {
$this->type = $properties['type'];
} else {
$this->type = self::TYPE_CUSTOM;
}
if (array_key_exists('key', $properties)) {
$this->key = $properties['key'];
}
} else if (is_string($properties)) {
$this->text = $properties;
}
if ($this->text === null) {
throw new coding_exception('You must set the text for the node when you create it.');
}
$this->title = $this->text;
if (strlen($this->text)>50) {
$this->text = substr($this->text, 0, 50).'...';
}
if (is_string($this->shorttext) && strlen($this->shorttext)>25) {
$this->shorttext = substr($this->shorttext, 0, 25).'...';
}
}
/**
* This function overrides the active URL that is used to compare new nodes
* to find out if they are active.
*
* If null is passed then $fullmeurl will be regenerated when the next node
* is created/added
*/
public static function override_active_url(moodle_url $url=null) {
self::$fullmeurl = $url;
}
/**
* This function checks if the node is the active child by comparing its action
* to the current page URL obtained via $ME
*
* This function compares the nodes url to the static var {@link navigation_node::fullmeurl}
* and if they match (based on $strenght) then the node is considered active.
*
* Note: This function is recursive, when you call it it will check itself and all
* children recursivily.
*
* @staticvar moodle_url $fullmeurl
* @param int $strength When using the moodle_url compare function how strictly
* to check for a match. Defaults to URL_MATCH_EXACT
* Can be URL_MATCH_EXACT or URL_MATCH_BASE
* @return bool True is active, false otherwise
*/
public function check_if_active($strength=URL_MATCH_EXACT) {
global $FULLME, $PAGE;
if (self::$fullmeurl == null) {
if ($PAGE->has_set_url()) {
$url = new moodle_url($PAGE->url);
} else {
$url = new moodle_url($FULLME);
}
self::$fullmeurl = $url;
}
if ($this->action instanceof moodle_url && $this->action->compare(self::$fullmeurl, $strength)) {
$this->make_active();
return true;
} else if (is_string($this->action) && $this->action==self::$fullmeurl->out()) {
$this->make_active();
return true;
}
return false;
}
/**
* This function allows the user to add a child node to this node.
*
* @param string $text The text to display in the node
* @param string $action Either a moodle_url or a bit of html to use instead of the text <i>optional</i>
* @param int $type The type of node should be one of the const types of navigation_node <i>optional</i>
* @param string $shorttext The short text to use for this node
* @param string|int $key Sets the key that can be used to retrieve this node <i>optional</i>
* @param string $icon The path to an icon to use for this node <i>optional</i>
* @return string The key that was used for this node
*/
public function add($text, $action=null, $type=null, $shorttext=null, $key=null, $icon=null) {
if ($this->nodetype !== self::NODETYPE_BRANCH) {
$this->nodetype = self::NODETYPE_BRANCH;
}
$itemarray = array('text'=>$text);
if ($type!==null) {
$itemarray['type'] = $type;
} else {
$type = self::TYPE_CUSTOM;
}
if ($action!==null) {
$itemarray['action'] = $action;
}
if ($shorttext!==null) {
$itemarray['shorttext'] = $shorttext;
}
if ($icon!==null) {
$itemarray['icon'] = $icon;
}
if ($key===null) {
$key = count($this->children);
}
$key = $key.':'.$type;
$itemarray['key'] = $key;
$this->children[$key] = new navigation_node($itemarray);
if (($type==self::TYPE_CATEGORY) || (isloggedin() && $type==self::TYPE_COURSE)) {
$this->children[$key]->nodetype = self::NODETYPE_BRANCH;
}
if ($this->hidden) {
$this->children[$key]->hidden = true;
}
return $key;
}
/**
* Adds a new node to a particular point by recursing through an array of node keys
*
* @param array $patharray An array of keys to recurse to find the correct node
* @param string $text The text to display in the node
* @param string|int $key Sets the key that can be used to retrieve this node <i>optional</i>
* @param int $type The type of node should be one of the const types of navigation_node <i>optional</i>
* @param string $action Either a moodle_url or a bit of html to use instead of the text <i>optional</i>
* @param string $icon The path to an icon to use for this node <i>optional</i>
* @return mixed Either the key used for the node once added or false for failure
*/
public function add_to_path($patharray, $key=null, $text=null, $shorttext=null, $type=null, $action=null, $icon=null) {
if (count($patharray)==0) {
$key = $this->add($text, $action, $type, $shorttext, $key, $icon);
return $key;
} else {
$pathkey = array_shift($patharray);
$child = $this->get($pathkey);
if ($child!==false) {
return $child->add_to_path($patharray, $key, $text, $shorttext, $type, $action, $icon);
} else {
return false;
}
}
}
/**
* Add a css class to this particular node
*
* @param string $class The css class to add
* @return bool Returns true
*/
public function add_class($class) {
if (!in_array($class, $this->classes)) {
$this->classes[] = $class;
}
return true;
}
/**
* Removes a given class from this node if it exists
*
* @param string $class
* @return bool
*/
public function remove_class($class) {
if (in_array($class, $this->classes)) {
$key = array_search($class,$this->classes);
if ($key!==false) {
unset($this->classes[$key]);
return true;
}
}
return false;
}
/**
* Recurse down child nodes and collapse everything once a given
* depth of recursion has been reached.
*
* This function is used internally during the initialisation of the nav object
* after the tree has been generated to collapse it to a suitable depth.
*
* @param int $depth defualts to 2
* @return bool Returns true
*/
protected function collapse_at_depth($depth=2) {
if ($depth>0 && $this->nodetype===self::NODETYPE_BRANCH) {
foreach (array_keys($this->children) as $key) {
$this->children[$key]->collapse_at_depth($depth-1);
}
return true;
} else {
$this->collapse_children();
return true;
}
}
/**
* Collapses all of the child nodes recursion optional
*
* @param bool $recurse If set to true child nodes are closed recursively
* @return bool Returns true
*/
protected function collapse_children($recurse=true) {
if ($this->nodetype === self::NODETYPE_BRANCH && count($this->children)>0) {
foreach ($this->children as &$child) {
if (!$this->forceopen) {
$child->collapse = true;
}
if ($recurse && $child instanceof navigation_node) {
$child->collapse_children($recurse);
}
}
unset($child);
}
return true;
}
/**
* Produce the actual HTML content for the node including any action or icon
*
* @param bool $shorttext If true then short text is used rather than text if it has been set
* @return string The HTML content
*/
public function content($shorttext=false) {
global $OUTPUT, $CFG, $PAGE;
if (!$this->display) {
return '';
}
if ($shorttext && $this->shorttext!==null) {
$content = clean_text($this->shorttext);
} else {
$content = clean_text($this->text);
}
$title = '';
if ($this->forcetitle || ($this->shorttext!==null && $this->title !== $this->shorttext) || $this->title !== $this->text) {
$title = $this->title;
}
if ($this->icon!==null) {
$icon = new html_image();
$icon->src = $this->icon;
$content = $OUTPUT->image($icon).' '.$content;
} else if ($this->helpbutton!==null) {
$content = sprintf('%s<span class="clearhelpbutton">%s</span>',trim($this->helpbutton),$content);
}
if ($content != '' && ((is_object($this->action) && ($this->action instanceof moodle_url || $this->action instanceof html_link)) || is_string($this->action))) {
if (!($this->action instanceof html_link)) {
$link = new html_link();
$link->url = $this->action;
$link->text = clean_text($content);
} else {
$link = $this->action;
}
if ($title !== '') {
$link->title = $title;
}
if ($this->hidden) {
$link->add_class('dimmed');
}
if (!empty($CFG->framename) && ($PAGE->generaltype=='topframe' || $CFG->framename!='_top')) {
$breakoutaction = new breakout_of_frame_action();
$link->add_action($breakoutaction);
}
$content = $OUTPUT->link($link);
} else {
$span = new html_span();
$span->contents = $content;
if ($title !== '') {
$span->title = $title;
}
if ($this->hidden) {
$span->add_class('dimmed_text');
}
$content = $OUTPUT->span($span);
}
return $content;
}
/**
* Get the CSS type for this node
*
* @return string
*/
public function get_css_type() {
if (array_key_exists($this->type, $this->namedtypes)) {
return 'type_'.$this->namedtypes[$this->type];
}
return 'type_unknown';
}
/**
* Find and return a child node if it exists (returns a reference to the child)
*
* This function is used to search for and return a reference to a child node when provided
* with the child nodes key and type.
* If the child is found a reference to it is returned otherwise the default is returned.
*
* @param string|int $key The key of the child node you are searching for.
* @param int $type The type of the node you are searching for. Defaults to TYPE_CATEGORY
* @param mixed $default The value to return if the child cannot be found
* @return mixed The child node or what ever default contains (usually false)
*/
public function find_child($key, $type=self::TYPE_CATEGORY, $default = false) {
list($key, $type) = $this->split_key_type($key, $type);
if (array_key_exists($key.":".$type, $this->children)) {
return $this->children[$key.":".$type];
} else if ($this->nodetype === self::NODETYPE_BRANCH && count($this->children)>0 && $this->type<=$type) {
foreach ($this->children as &$child) {
$outcome = $child->find_child($key, $type);
if ($outcome !== false) {
return $outcome;
}
}
}
return $default;
}
/**
* Find the active child
*
* @param null|int $type
* @return navigation_node|bool
*/
public function find_active_node($type=null) {
if ($this->contains_active_node()) {
if ($type!==null && $this->type===$type) {
return $this;
}
if ($this->nodetype === self::NODETYPE_BRANCH && count($this->children)>0) {
foreach ($this->children as $child) {
if ($child->isactive) {
return $child;
} else {
$outcome = $child->find_active_node($type);
if ($outcome!==false) {
return $outcome;
}
}
}
}
}
return false;
}
/**
* Returns the depth of a child
*
* @param string|int $key The key for the child we are looking for
* @param int $type The type of the child we are looking for
* @return int The depth of the child once found
*/
public function find_child_depth($key, $type=self::TYPE_CATEGORY) {
$depth = 0;
list($key, $type) = $this->split_key_type($key, $type);
if (array_key_exists($key.':'.$type, $this->children)) {
$depth = 1;
} else if ($this->nodetype === self::NODETYPE_BRANCH && count($this->children)>0 && $this->type<=$type) {
foreach ($this->children as $child) {
$depth += $child->find_child_depth($key, $type);
}
}
return $depth;
}
/**
* Finds all nodes that have the specified type
*
* @param int $type One of navigation_node::TYPE_*
* @return array An array of navigation_node references for nodes of type $type
*/
public function get_children_by_type($type) {
$nodes = array();
if (count($this->children)>0) {
foreach ($this->children as &$child) {
if ($child->type === $type) {
$nodes[] = $child;
}
}
}
return $nodes;
}
/**
* Finds all nodes (recursivily) that have the specified type, regardless of
* assumed order or position.
*
* @param int $type One of navigation_node::TYPE_*
* @return array An array of navigation_node references for nodes of type $type
*/
public function find_children_by_type($type) {
$nodes = array();
if (count($this->children)>0) {
foreach ($this->children as &$child) {
if ($child->type === $type) {
$nodes[] = $child;
}
if (count($child->children)>0) {
$nodes = array_merge($nodes, $child->find_children_by_type($type));
}
}
}
return $nodes;
}
/**
* Toogles display of nodes and child nodes based on type
*
* If the type of a node if more than the type specified it's display property is set to false
* and it is not shown
*
* @param int $type
* @param bool $display
*/
public function toggle_type_display($type=self::TYPE_COURSE, $display=false) {
if ((int)$this->type > $type) {
$this->display = $display;
}
if (count($this->children)>0) {
foreach ($this->children as $child) {
$child->toggle_type_display($type, $display);
}
}
}
/**
* Find out if a child (or subchild) of this node contains an active node
*
* @return bool True if it does fales otherwise
*/
public function contains_active_node() {
if ($this->nodetype === self::NODETYPE_BRANCH && count($this->children)>0) {
foreach ($this->children as $child) {
if ($child->isactive || $child->contains_active_node()) {
return true;
}
}
}
return false;
}
/**
* Find all nodes that are expandable for this node and its given children.
*
* This function recursively finds all nodes that are expandable by AJAX within
* [and including] this child.
*
* @param array $expandable An array to fill with the HTML id's of all branches
* that can be expanded by AJAX. This is a forced reference.
* @param int $expansionlimit Optional/used internally can be one of navigation_node::TYPE_*
*/
public function find_expandable(&$expandable, $expansionlimit = null) {
static $branchcount;
if ($branchcount==null) {
$branchcount=1;
}
if ($this->nodetype == self::NODETYPE_BRANCH && count($this->children)==0 && ($expansionlimit === null || $this->type < $expansionlimit)) {
$this->id = 'expandable_branch_'.$branchcount;
$this->add_class('canexpand');
$branchcount++;
$expandable[] = array('id'=>$this->id,'branchid'=>$this->key,'type'=>$this->type);
} else if ($this->nodetype==self::NODETYPE_BRANCH && ($expansionlimit === null || $this->type <= $expansionlimit)) {
foreach ($this->children as $child) {
$child->find_expandable($expandable, $expansionlimit);
}
}
}
/**
* Used to return a child node with a given key
*
* This function searchs for a child node with the provided key and returns the
* child. If the child doesn't exist then this function returns false.
*
* @param int|string $key The key to search for
* @param int $type Optional one of TYPE_* constants
* @param navigation_node|bool The child if it exists or false
*/
public function get($key, $type=null) {
if ($key===false) {
return false;
}
list($key, $type) = $this->split_key_type($key);
if ($this->nodetype === self::NODETYPE_BRANCH && count($this->children)>0) {
if ($type!==null) {
if (array_key_exists($key.':'.$type, $this->children)) {
return $this->children[$key.':'.$type];
}
} else {
foreach (array_keys($this->children) as $childkey) {
if (strpos($childkey, $key.':')===0) {
return $this->children[$childkey];
}
}
}
}
return false;
}
/**
* This function is used to split a key into its key and value parts if the
* key is a combination of the two.
*
* Was introduced to help resolve MDL-20543
*
* @param string $key
* @param int|null $type
* @return array
*/
protected function split_key_type($key, $type=null) {
/**
* If the key is a combination it will be of the form `key:type` where key
* could be anything and type will be an int value
*/
if (preg_match('#^(.*)\:(\d{1,3})$#', $key, $match)) {
/**
* If type is null then we want to collect and return the type otherwise
* we will use the provided type. This ensures that if a type was specified
* it is not lost
*/
if ($type===null) {
$type = $match[2];
}
$key = $match[1];
}
return array($key, $type);
}
/**
* Fetch a node given a set of keys that describe its path
*
* @param array $keys An array of keys
* @return navigation_node|bool The node or false
*/
public function get_by_path($keys) {
if (count($keys)==1) {
$key = array_shift($keys);
return $this->get($key);
} else {
$key = array_shift($keys);
$child = $this->get($key);
if ($child !== false) {
return $child->get_by_path($keys);
}
return false;
}
}
/**
* Returns the child marked as active if there is one, false otherwise.
*
* @return navigation_node|bool The active node or false
*/
public function get_active_node() {
foreach ($this->children as $child) {
if ($child->isactive) {
return $child;
}
}
return false;
}
/**
* Mark this node as active
*
* This function marks the node as active my forcing the node to be open,
* setting isactive to true, and adding the class active_tree_node
*/
public function make_active() {
$this->forceopen = true;
$this->isactive = true;
$this->add_class('active_tree_node');
}
/**
* This intense little function looks for branches that are forced open
* and checks to ensure that all parent nodes are also forced open.
*/
public function respect_forced_open() {
foreach ($this->children as $child) {
$child->respect_forced_open();
if ($child->forceopen) {
$this->forceopen = true;
}
}
}
/**
* This function simply removes a given child node
*
* @param string|int $key The key that identifies a child node
* @return bool
*/
public function remove_child($key, $type=null) {
$child = $this->get($key, $type);
if ($child) {
unset($this->children[$child->key]);
return true;
}
return false;
}
/**
* Iterate all children and check if any of them are active
*
* This function iterates all children recursively until it sucecssfully marks
* a node as active, or gets to the end of the tree.
* This can be used on a cached branch to mark the active child.
*
* @param int $strength When using the moodle_url compare function how strictly
* to check for a match. Defaults to URL_MATCH_EXACTLY
* @return bool True is a node was marked active false otherwise
*/
public function reiterate_active_nodes($strength=URL_MATCH_EXACT) {
if ($this->nodetype !== self::NODETYPE_BRANCH) {
return false;
}
foreach ($this->children as $child) {
$outcome = $child->check_if_active($strength);
if (!$outcome && $child->nodetype === self::NODETYPE_BRANCH) {
$outcome = $child->reiterate_active_nodes($strength);
}
if ($outcome) {
$this->forceopen = true;
return true;
}
}
}
/**
* This function sets the title for the node and at the same time sets
* forcetitle to true to ensure that it is used if possible
*
* @param string $title
*/
public function title($title) {
$this->title = $title;
$this->forcetitle = true;
}
/**
* Magic Method: When we unserialise an object make it `unactive`
*
* This is to ensure that when we take a branch out of the cache it is not marked
* active anymore, as we can't be sure it still is (infact it most likely isnt)
*/
public function __wakeup(){
$this->forceopen = false;
$this->isactive = false;
$this->remove_class('active_tree_node');
}
}
/**
* The global navigation class used for... the global navigation
*
* This class is used by PAGE to store the global navigation for the site
* and is then used by the settings nav and navbar to save on processing and DB calls
*
* See
* <ul>
* <li><b>{@link lib/pagelib.php}</b> {@link moodle_page::initialise_theme_and_output()}<li>
* <li><b>{@link lib/ajax/getnavbranch.php}</b> Called by ajax<li>
* </ul>
*
* @package moodlecore
* @subpackage navigation
* @copyright 2009 Sam Hemelryk
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class global_navigation extends navigation_node {
/** @var int */
protected $depthforward = 1;
/** @var cache */
protected $cache = null;
/** @var bool */
protected $initialised = false;
/** @var null|int */
public $expansionlimit = null;
/** @var stdClass */
public $context = null;
/** @var mixed */
public $expandable = null;
/** @var bool */
public $showemptybranches = true;
/** @var bool */
protected $isloggedin = false;
/**
* Sets up the object with basic settings and preparse it for use
*/
public function __construct() {
global $CFG, $PAGE;
if (during_initial_install()) {
return false;
}
$this->key = 0;
$this->type = self::TYPE_SYSTEM;
$this->isloggedin = isloggedin();
$this->text = get_string('home');
$this->forceopen = true;
$this->action = new moodle_url($CFG->wwwroot);
$this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
$PAGE->requires->string_for_js('moveallsidetabstoblock','moodle');
$regenerate = optional_param('regenerate', null, PARAM_TEXT);
if ($regenerate==='navigation') {
$this->cache->clear();
}
}
/**
* Override: This function generated the content of the navigation
*
* If an expansion limit has been set then we hide everything to after that
* set limit type
*
* @return string
*/
public function content() {
if ($this->expansionlimit!==null) {
$this->toggle_type_display($this->expansionlimit);
}
return parent::content();
}
/**
* Initialise the navigation object, calling it to auto generate
*
* This function starts the navigation object automatically retrieving what it
* needs from Moodle objects.
*
* It also passed Javascript args and function calls as required
*
* @return bool Returns true
*/
public function initialise($jsargs = null) {
global $PAGE, $SITE, $CFG;
if ($this->initialised || during_initial_install()) {
return true;
}
$start = microtime(false);
$this->depthforward = 1;
$this->context = &$PAGE->context;
$contextlevel = $this->context->contextlevel;
if ($contextlevel == CONTEXT_COURSE && $PAGE->course->id==$SITE->id) {
$contextlevel = 10;
}
$depth = 0;
/**
* We always want to load the front page activities into the tree, these
* will appear at the bottom of the opening (site) node.
*/
$sitekeys = array();
$this->load_course_activities($sitekeys, $SITE);
$this->load_section_activities($sitekeys, false, $SITE);
switch ($contextlevel) {
case CONTEXT_SYSTEM:
$this->cache->volatile();
$depth = $this->load_for_category(false);
break;
case CONTEXT_COURSECAT:
$depth = $this->load_for_category();
break;
case CONTEXT_BLOCK:
case CONTEXT_COURSE:
$depth = $this->load_for_course();
break;
case CONTEXT_MODULE:
$depth = $this->load_for_activity();
break;
case CONTEXT_USER:
$depth = $this->load_for_user();
break;
}
$this->collapse_at_depth($this->depthforward+$depth);
$this->respect_forced_open();
$expandable = array();
$this->find_expandable($expandable);
$this->expandable = $expandable;
$this->initialised = true;
return true;
}
/**
* This function loads the global navigation structure for a user.
*
* This gets called by {@link initialise()} when the context is CONTEXT_USER
*/
protected function load_for_user() {
global $DB, $SITE, $PAGE, $CFG;
if (!empty($PAGE->course->id)) {
$courseid = $PAGE->course->id;
} else {
$courseid = optional_param('course', false, PARAM_INT);
}
if ($courseid!==false && $courseid!=$SITE->id) {
$course = $DB->get_record('course', array('id'=>$courseid));
}
if (isset($course) && $course) {
if (!empty($CFG->navshowallcourses)) {
$this->load_categories();
}
$this->load_for_course();
} else {
$this->load_categories();
}
}
/**
* Called by the initalise methods if the context was system or category
*
* @param bool $lookforid If system context then we dont want ID because
* it could be userid, courseid, or anything else
* @return int The depth to the active(requested) node
*/
protected function load_for_category($lookforid=true) {
global $PAGE, $CFG;
$id = optional_param('id', null);
if ($lookforid && $id!==null) {
if (!empty($CFG->navshowallcourses)) {
$this->load_categories();