Merge branch 'MDL-42711-master' of git://github.com/nebgor/moodle
[moodle.git] / lib / navigationlib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * This file contains classes used to manage the navigation structures within Moodle.
19  *
20  * @since      2.0
21  * @package    core
22  * @copyright  2009 Sam Hemelryk
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die();
28 /**
29  * The name that will be used to separate the navigation cache within SESSION
30  */
31 define('NAVIGATION_CACHE_NAME', 'navigation');
32 define('NAVIGATION_SITE_ADMIN_CACHE_NAME', 'navigationsiteadmin');
34 /**
35  * This class is used to represent a node in a navigation tree
36  *
37  * This class is used to represent a node in a navigation tree within Moodle,
38  * the tree could be one of global navigation, settings navigation, or the navbar.
39  * Each node can be one of two types either a Leaf (default) or a branch.
40  * When a node is first created it is created as a leaf, when/if children are added
41  * the node then becomes a branch.
42  *
43  * @package   core
44  * @category  navigation
45  * @copyright 2009 Sam Hemelryk
46  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
47  */
48 class navigation_node implements renderable {
49     /** @var int Used to identify this node a leaf (default) 0 */
50     const NODETYPE_LEAF =   0;
51     /** @var int Used to identify this node a branch, happens with children  1 */
52     const NODETYPE_BRANCH = 1;
53     /** @var null Unknown node type null */
54     const TYPE_UNKNOWN =    null;
55     /** @var int System node type 0 */
56     const TYPE_ROOTNODE =   0;
57     /** @var int System node type 1 */
58     const TYPE_SYSTEM =     1;
59     /** @var int Category node type 10 */
60     const TYPE_CATEGORY =   10;
61     /** var int Category displayed in MyHome navigation node */
62     const TYPE_MY_CATEGORY = 11;
63     /** @var int Course node type 20 */
64     const TYPE_COURSE =     20;
65     /** @var int Course Structure node type 30 */
66     const TYPE_SECTION =    30;
67     /** @var int Activity node type, e.g. Forum, Quiz 40 */
68     const TYPE_ACTIVITY =   40;
69     /** @var int Resource node type, e.g. Link to a file, or label 50 */
70     const TYPE_RESOURCE =   50;
71     /** @var int A custom node type, default when adding without specifing type 60 */
72     const TYPE_CUSTOM =     60;
73     /** @var int Setting node type, used only within settings nav 70 */
74     const TYPE_SETTING =    70;
75     /** @var int site admin branch node type, used only within settings nav 71 */
76     const TYPE_SITE_ADMIN = 71;
77     /** @var int Setting node type, used only within settings nav 80 */
78     const TYPE_USER =       80;
79     /** @var int Setting node type, used for containers of no importance 90 */
80     const TYPE_CONTAINER =  90;
81     /** var int Course the current user is not enrolled in */
82     const COURSE_OTHER = 0;
83     /** var int Course the current user is enrolled in but not viewing */
84     const COURSE_MY = 1;
85     /** var int Course the current user is currently viewing */
86     const COURSE_CURRENT = 2;
88     /** @var int Parameter to aid the coder in tracking [optional] */
89     public $id = null;
90     /** @var string|int The identifier for the node, used to retrieve the node */
91     public $key = null;
92     /** @var string The text to use for the node */
93     public $text = null;
94     /** @var string Short text to use if requested [optional] */
95     public $shorttext = null;
96     /** @var string The title attribute for an action if one is defined */
97     public $title = null;
98     /** @var string A string that can be used to build a help button */
99     public $helpbutton = null;
100     /** @var moodle_url|action_link|null An action for the node (link) */
101     public $action = null;
102     /** @var pix_icon The path to an icon to use for this node */
103     public $icon = null;
104     /** @var int See TYPE_* constants defined for this class */
105     public $type = self::TYPE_UNKNOWN;
106     /** @var int See NODETYPE_* constants defined for this class */
107     public $nodetype = self::NODETYPE_LEAF;
108     /** @var bool If set to true the node will be collapsed by default */
109     public $collapse = false;
110     /** @var bool If set to true the node will be expanded by default */
111     public $forceopen = false;
112     /** @var array An array of CSS classes for the node */
113     public $classes = array();
114     /** @var navigation_node_collection An array of child nodes */
115     public $children = array();
116     /** @var bool If set to true the node will be recognised as active */
117     public $isactive = false;
118     /** @var bool If set to true the node will be dimmed */
119     public $hidden = false;
120     /** @var bool If set to false the node will not be displayed */
121     public $display = true;
122     /** @var bool If set to true then an HR will be printed before the node */
123     public $preceedwithhr = false;
124     /** @var bool If set to true the the navigation bar should ignore this node */
125     public $mainnavonly = false;
126     /** @var bool If set to true a title will be added to the action no matter what */
127     public $forcetitle = false;
128     /** @var navigation_node A reference to the node parent, you should never set this directly you should always call set_parent */
129     public $parent = null;
130     /** @var bool Override to not display the icon even if one is provided **/
131     public $hideicon = false;
132     /** @var bool Set to true if we KNOW that this node can be expanded.  */
133     public $isexpandable = false;
134     /** @var array */
135     protected $namedtypes = array(0=>'system',10=>'category',20=>'course',30=>'structure',40=>'activity',50=>'resource',60=>'custom',70=>'setting',71=>'siteadmin', 80=>'user');
136     /** @var moodle_url */
137     protected static $fullmeurl = null;
138     /** @var bool toogles auto matching of active node */
139     public static $autofindactive = true;
140     /** @var bool should we load full admin tree or rely on AJAX for performance reasons */
141     protected static $loadadmintree = false;
142     /** @var mixed If set to an int, that section will be included even if it has no activities */
143     public $includesectionnum = false;
145     /**
146      * Constructs a new navigation_node
147      *
148      * @param array|string $properties Either an array of properties or a string to use
149      *                     as the text for the node
150      */
151     public function __construct($properties) {
152         if (is_array($properties)) {
153             // Check the array for each property that we allow to set at construction.
154             // text         - The main content for the node
155             // shorttext    - A short text if required for the node
156             // icon         - The icon to display for the node
157             // type         - The type of the node
158             // key          - The key to use to identify the node
159             // parent       - A reference to the nodes parent
160             // action       - The action to attribute to this node, usually a URL to link to
161             if (array_key_exists('text', $properties)) {
162                 $this->text = $properties['text'];
163             }
164             if (array_key_exists('shorttext', $properties)) {
165                 $this->shorttext = $properties['shorttext'];
166             }
167             if (!array_key_exists('icon', $properties)) {
168                 $properties['icon'] = new pix_icon('i/navigationitem', '');
169             }
170             $this->icon = $properties['icon'];
171             if ($this->icon instanceof pix_icon) {
172                 if (empty($this->icon->attributes['class'])) {
173                     $this->icon->attributes['class'] = 'navicon';
174                 } else {
175                     $this->icon->attributes['class'] .= ' navicon';
176                 }
177             }
178             if (array_key_exists('type', $properties)) {
179                 $this->type = $properties['type'];
180             } else {
181                 $this->type = self::TYPE_CUSTOM;
182             }
183             if (array_key_exists('key', $properties)) {
184                 $this->key = $properties['key'];
185             }
186             // This needs to happen last because of the check_if_active call that occurs
187             if (array_key_exists('action', $properties)) {
188                 $this->action = $properties['action'];
189                 if (is_string($this->action)) {
190                     $this->action = new moodle_url($this->action);
191                 }
192                 if (self::$autofindactive) {
193                     $this->check_if_active();
194                 }
195             }
196             if (array_key_exists('parent', $properties)) {
197                 $this->set_parent($properties['parent']);
198             }
199         } else if (is_string($properties)) {
200             $this->text = $properties;
201         }
202         if ($this->text === null) {
203             throw new coding_exception('You must set the text for the node when you create it.');
204         }
205         // Instantiate a new navigation node collection for this nodes children
206         $this->children = new navigation_node_collection();
207     }
209     /**
210      * Checks if this node is the active node.
211      *
212      * This is determined by comparing the action for the node against the
213      * defined URL for the page. A match will see this node marked as active.
214      *
215      * @param int $strength One of URL_MATCH_EXACT, URL_MATCH_PARAMS, or URL_MATCH_BASE
216      * @return bool
217      */
218     public function check_if_active($strength=URL_MATCH_EXACT) {
219         global $FULLME, $PAGE;
220         // Set fullmeurl if it hasn't already been set
221         if (self::$fullmeurl == null) {
222             if ($PAGE->has_set_url()) {
223                 self::override_active_url(new moodle_url($PAGE->url));
224             } else {
225                 self::override_active_url(new moodle_url($FULLME));
226             }
227         }
229         // Compare the action of this node against the fullmeurl
230         if ($this->action instanceof moodle_url && $this->action->compare(self::$fullmeurl, $strength)) {
231             $this->make_active();
232             return true;
233         }
234         return false;
235     }
237     /**
238      * This sets the URL that the URL of new nodes get compared to when locating
239      * the active node.
240      *
241      * The active node is the node that matches the URL set here. By default this
242      * is either $PAGE->url or if that hasn't been set $FULLME.
243      *
244      * @param moodle_url $url The url to use for the fullmeurl.
245      * @param bool $loadadmintree use true if the URL point to administration tree
246      */
247     public static function override_active_url(moodle_url $url, $loadadmintree = false) {
248         // Clone the URL, in case the calling script changes their URL later.
249         self::$fullmeurl = new moodle_url($url);
250         // True means we do not want AJAX loaded admin tree, required for all admin pages.
251         if ($loadadmintree) {
252             // Do not change back to false if already set.
253             self::$loadadmintree = true;
254         }
255     }
257     /**
258      * Use when page is linked from the admin tree,
259      * if not used navigation could not find the page using current URL
260      * because the tree is not fully loaded.
261      */
262     public static function require_admin_tree() {
263         self::$loadadmintree = true;
264     }
266     /**
267      * Creates a navigation node, ready to add it as a child using add_node
268      * function. (The created node needs to be added before you can use it.)
269      * @param string $text
270      * @param moodle_url|action_link $action
271      * @param int $type
272      * @param string $shorttext
273      * @param string|int $key
274      * @param pix_icon $icon
275      * @return navigation_node
276      */
277     public static function create($text, $action=null, $type=self::TYPE_CUSTOM,
278             $shorttext=null, $key=null, pix_icon $icon=null) {
279         // Properties array used when creating the new navigation node
280         $itemarray = array(
281             'text' => $text,
282             'type' => $type
283         );
284         // Set the action if one was provided
285         if ($action!==null) {
286             $itemarray['action'] = $action;
287         }
288         // Set the shorttext if one was provided
289         if ($shorttext!==null) {
290             $itemarray['shorttext'] = $shorttext;
291         }
292         // Set the icon if one was provided
293         if ($icon!==null) {
294             $itemarray['icon'] = $icon;
295         }
296         // Set the key
297         $itemarray['key'] = $key;
298         // Construct and return
299         return new navigation_node($itemarray);
300     }
302     /**
303      * Adds a navigation node as a child of this node.
304      *
305      * @param string $text
306      * @param moodle_url|action_link $action
307      * @param int $type
308      * @param string $shorttext
309      * @param string|int $key
310      * @param pix_icon $icon
311      * @return navigation_node
312      */
313     public function add($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, pix_icon $icon=null) {
314         // Create child node
315         $childnode = self::create($text, $action, $type, $shorttext, $key, $icon);
317         // Add the child to end and return
318         return $this->add_node($childnode);
319     }
321     /**
322      * Adds a navigation node as a child of this one, given a $node object
323      * created using the create function.
324      * @param navigation_node $childnode Node to add
325      * @param string $beforekey
326      * @return navigation_node The added node
327      */
328     public function add_node(navigation_node $childnode, $beforekey=null) {
329         // First convert the nodetype for this node to a branch as it will now have children
330         if ($this->nodetype !== self::NODETYPE_BRANCH) {
331             $this->nodetype = self::NODETYPE_BRANCH;
332         }
333         // Set the parent to this node
334         $childnode->set_parent($this);
336         // Default the key to the number of children if not provided
337         if ($childnode->key === null) {
338             $childnode->key = $this->children->count();
339         }
341         // Add the child using the navigation_node_collections add method
342         $node = $this->children->add($childnode, $beforekey);
344         // If added node is a category node or the user is logged in and it's a course
345         // then mark added node as a branch (makes it expandable by AJAX)
346         $type = $childnode->type;
347         if (($type == self::TYPE_CATEGORY) || (isloggedin() && ($type == self::TYPE_COURSE)) || ($type == self::TYPE_MY_CATEGORY) ||
348                 ($type === self::TYPE_SITE_ADMIN)) {
349             $node->nodetype = self::NODETYPE_BRANCH;
350         }
351         // If this node is hidden mark it's children as hidden also
352         if ($this->hidden) {
353             $node->hidden = true;
354         }
355         // Return added node (reference returned by $this->children->add()
356         return $node;
357     }
359     /**
360      * Return a list of all the keys of all the child nodes.
361      * @return array the keys.
362      */
363     public function get_children_key_list() {
364         return $this->children->get_key_list();
365     }
367     /**
368      * Searches for a node of the given type with the given key.
369      *
370      * This searches this node plus all of its children, and their children....
371      * If you know the node you are looking for is a child of this node then please
372      * use the get method instead.
373      *
374      * @param int|string $key The key of the node we are looking for
375      * @param int $type One of navigation_node::TYPE_*
376      * @return navigation_node|false
377      */
378     public function find($key, $type) {
379         return $this->children->find($key, $type);
380     }
382     /**
383      * Get the child of this node that has the given key + (optional) type.
384      *
385      * If you are looking for a node and want to search all children + thier children
386      * then please use the find method instead.
387      *
388      * @param int|string $key The key of the node we are looking for
389      * @param int $type One of navigation_node::TYPE_*
390      * @return navigation_node|false
391      */
392     public function get($key, $type=null) {
393         return $this->children->get($key, $type);
394     }
396     /**
397      * Removes this node.
398      *
399      * @return bool
400      */
401     public function remove() {
402         return $this->parent->children->remove($this->key, $this->type);
403     }
405     /**
406      * Checks if this node has or could have any children
407      *
408      * @return bool Returns true if it has children or could have (by AJAX expansion)
409      */
410     public function has_children() {
411         return ($this->nodetype === navigation_node::NODETYPE_BRANCH || $this->children->count()>0 || $this->isexpandable);
412     }
414     /**
415      * Marks this node as active and forces it open.
416      *
417      * Important: If you are here because you need to mark a node active to get
418      * the navigation to do what you want have you looked at {@link navigation_node::override_active_url()}?
419      * You can use it to specify a different URL to match the active navigation node on
420      * rather than having to locate and manually mark a node active.
421      */
422     public function make_active() {
423         $this->isactive = true;
424         $this->add_class('active_tree_node');
425         $this->force_open();
426         if ($this->parent !== null) {
427             $this->parent->make_inactive();
428         }
429     }
431     /**
432      * Marks a node as inactive and recusised back to the base of the tree
433      * doing the same to all parents.
434      */
435     public function make_inactive() {
436         $this->isactive = false;
437         $this->remove_class('active_tree_node');
438         if ($this->parent !== null) {
439             $this->parent->make_inactive();
440         }
441     }
443     /**
444      * Forces this node to be open and at the same time forces open all
445      * parents until the root node.
446      *
447      * Recursive.
448      */
449     public function force_open() {
450         $this->forceopen = true;
451         if ($this->parent !== null) {
452             $this->parent->force_open();
453         }
454     }
456     /**
457      * Adds a CSS class to this node.
458      *
459      * @param string $class
460      * @return bool
461      */
462     public function add_class($class) {
463         if (!in_array($class, $this->classes)) {
464             $this->classes[] = $class;
465         }
466         return true;
467     }
469     /**
470      * Removes a CSS class from this node.
471      *
472      * @param string $class
473      * @return bool True if the class was successfully removed.
474      */
475     public function remove_class($class) {
476         if (in_array($class, $this->classes)) {
477             $key = array_search($class,$this->classes);
478             if ($key!==false) {
479                 unset($this->classes[$key]);
480                 return true;
481             }
482         }
483         return false;
484     }
486     /**
487      * Sets the title for this node and forces Moodle to utilise it.
488      * @param string $title
489      */
490     public function title($title) {
491         $this->title = $title;
492         $this->forcetitle = true;
493     }
495     /**
496      * Resets the page specific information on this node if it is being unserialised.
497      */
498     public function __wakeup(){
499         $this->forceopen = false;
500         $this->isactive = false;
501         $this->remove_class('active_tree_node');
502     }
504     /**
505      * Checks if this node or any of its children contain the active node.
506      *
507      * Recursive.
508      *
509      * @return bool
510      */
511     public function contains_active_node() {
512         if ($this->isactive) {
513             return true;
514         } else {
515             foreach ($this->children as $child) {
516                 if ($child->isactive || $child->contains_active_node()) {
517                     return true;
518                 }
519             }
520         }
521         return false;
522     }
524     /**
525      * Finds the active node.
526      *
527      * Searches this nodes children plus all of the children for the active node
528      * and returns it if found.
529      *
530      * Recursive.
531      *
532      * @return navigation_node|false
533      */
534     public function find_active_node() {
535         if ($this->isactive) {
536             return $this;
537         } else {
538             foreach ($this->children as &$child) {
539                 $outcome = $child->find_active_node();
540                 if ($outcome !== false) {
541                     return $outcome;
542                 }
543             }
544         }
545         return false;
546     }
548     /**
549      * Searches all children for the best matching active node
550      * @return navigation_node|false
551      */
552     public function search_for_active_node() {
553         if ($this->check_if_active(URL_MATCH_BASE)) {
554             return $this;
555         } else {
556             foreach ($this->children as &$child) {
557                 $outcome = $child->search_for_active_node();
558                 if ($outcome !== false) {
559                     return $outcome;
560                 }
561             }
562         }
563         return false;
564     }
566     /**
567      * Gets the content for this node.
568      *
569      * @param bool $shorttext If true shorttext is used rather than the normal text
570      * @return string
571      */
572     public function get_content($shorttext=false) {
573         if ($shorttext && $this->shorttext!==null) {
574             return format_string($this->shorttext);
575         } else {
576             return format_string($this->text);
577         }
578     }
580     /**
581      * Gets the title to use for this node.
582      *
583      * @return string
584      */
585     public function get_title() {
586         if ($this->forcetitle || $this->action != null){
587             return $this->title;
588         } else {
589             return '';
590         }
591     }
593     /**
594      * Gets the CSS class to add to this node to describe its type
595      *
596      * @return string
597      */
598     public function get_css_type() {
599         if (array_key_exists($this->type, $this->namedtypes)) {
600             return 'type_'.$this->namedtypes[$this->type];
601         }
602         return 'type_unknown';
603     }
605     /**
606      * Finds all nodes that are expandable by AJAX
607      *
608      * @param array $expandable An array by reference to populate with expandable nodes.
609      */
610     public function find_expandable(array &$expandable) {
611         foreach ($this->children as &$child) {
612             if ($child->display && $child->has_children() && $child->children->count() == 0) {
613                 $child->id = 'expandable_branch_'.$child->type.'_'.clean_param($child->key, PARAM_ALPHANUMEXT);
614                 $this->add_class('canexpand');
615                 $expandable[] = array('id' => $child->id, 'key' => $child->key, 'type' => $child->type);
616             }
617             $child->find_expandable($expandable);
618         }
619     }
621     /**
622      * Finds all nodes of a given type (recursive)
623      *
624      * @param int $type One of navigation_node::TYPE_*
625      * @return array
626      */
627     public function find_all_of_type($type) {
628         $nodes = $this->children->type($type);
629         foreach ($this->children as &$node) {
630             $childnodes = $node->find_all_of_type($type);
631             $nodes = array_merge($nodes, $childnodes);
632         }
633         return $nodes;
634     }
636     /**
637      * Removes this node if it is empty
638      */
639     public function trim_if_empty() {
640         if ($this->children->count() == 0) {
641             $this->remove();
642         }
643     }
645     /**
646      * Creates a tab representation of this nodes children that can be used
647      * with print_tabs to produce the tabs on a page.
648      *
649      * call_user_func_array('print_tabs', $node->get_tabs_array());
650      *
651      * @param array $inactive
652      * @param bool $return
653      * @return array Array (tabs, selected, inactive, activated, return)
654      */
655     public function get_tabs_array(array $inactive=array(), $return=false) {
656         $tabs = array();
657         $rows = array();
658         $selected = null;
659         $activated = array();
660         foreach ($this->children as $node) {
661             $tabs[] = new tabobject($node->key, $node->action, $node->get_content(), $node->get_title());
662             if ($node->contains_active_node()) {
663                 if ($node->children->count() > 0) {
664                     $activated[] = $node->key;
665                     foreach ($node->children as $child) {
666                         if ($child->contains_active_node()) {
667                             $selected = $child->key;
668                         }
669                         $rows[] = new tabobject($child->key, $child->action, $child->get_content(), $child->get_title());
670                     }
671                 } else {
672                     $selected = $node->key;
673                 }
674             }
675         }
676         return array(array($tabs, $rows), $selected, $inactive, $activated, $return);
677     }
679     /**
680      * Sets the parent for this node and if this node is active ensures that the tree is properly
681      * adjusted as well.
682      *
683      * @param navigation_node $parent
684      */
685     public function set_parent(navigation_node $parent) {
686         // Set the parent (thats the easy part)
687         $this->parent = $parent;
688         // Check if this node is active (this is checked during construction)
689         if ($this->isactive) {
690             // Force all of the parent nodes open so you can see this node
691             $this->parent->force_open();
692             // Make all parents inactive so that its clear where we are.
693             $this->parent->make_inactive();
694         }
695     }
697     /**
698      * Hides the node and any children it has.
699      *
700      * @since 2.5
701      * @param array $typestohide Optional. An array of node types that should be hidden.
702      *      If null all nodes will be hidden.
703      *      If an array is given then nodes will only be hidden if their type mtatches an element in the array.
704      *          e.g. array(navigation_node::TYPE_COURSE) would hide only course nodes.
705      */
706     public function hide(array $typestohide = null) {
707         if ($typestohide === null || in_array($this->type, $typestohide)) {
708             $this->display = false;
709             if ($this->has_children()) {
710                 foreach ($this->children as $child) {
711                     $child->hide($typestohide);
712                 }
713             }
714         }
715     }
718 /**
719  * Navigation node collection
720  *
721  * This class is responsible for managing a collection of navigation nodes.
722  * It is required because a node's unique identifier is a combination of both its
723  * key and its type.
724  *
725  * Originally an array was used with a string key that was a combination of the two
726  * however it was decided that a better solution would be to use a class that
727  * implements the standard IteratorAggregate interface.
728  *
729  * @package   core
730  * @category  navigation
731  * @copyright 2010 Sam Hemelryk
732  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
733  */
734 class navigation_node_collection implements IteratorAggregate {
735     /**
736      * A multidimensional array to where the first key is the type and the second
737      * key is the nodes key.
738      * @var array
739      */
740     protected $collection = array();
741     /**
742      * An array that contains references to nodes in the same order they were added.
743      * This is maintained as a progressive array.
744      * @var array
745      */
746     protected $orderedcollection = array();
747     /**
748      * A reference to the last node that was added to the collection
749      * @var navigation_node
750      */
751     protected $last = null;
752     /**
753      * The total number of items added to this array.
754      * @var int
755      */
756     protected $count = 0;
758     /**
759      * Adds a navigation node to the collection
760      *
761      * @param navigation_node $node Node to add
762      * @param string $beforekey If specified, adds before a node with this key,
763      *   otherwise adds at end
764      * @return navigation_node Added node
765      */
766     public function add(navigation_node $node, $beforekey=null) {
767         global $CFG;
768         $key = $node->key;
769         $type = $node->type;
771         // First check we have a 2nd dimension for this type
772         if (!array_key_exists($type, $this->orderedcollection)) {
773             $this->orderedcollection[$type] = array();
774         }
775         // Check for a collision and report if debugging is turned on
776         if ($CFG->debug && array_key_exists($key, $this->orderedcollection[$type])) {
777             debugging('Navigation node intersect: Adding a node that already exists '.$key, DEBUG_DEVELOPER);
778         }
780         // Find the key to add before
781         $newindex = $this->count;
782         $last = true;
783         if ($beforekey !== null) {
784             foreach ($this->collection as $index => $othernode) {
785                 if ($othernode->key === $beforekey) {
786                     $newindex = $index;
787                     $last = false;
788                     break;
789                 }
790             }
791             if ($newindex === $this->count) {
792                 debugging('Navigation node add_before: Reference node not found ' . $beforekey .
793                         ', options: ' . implode(' ', $this->get_key_list()), DEBUG_DEVELOPER);
794             }
795         }
797         // Add the node to the appropriate place in the by-type structure (which
798         // is not ordered, despite the variable name)
799         $this->orderedcollection[$type][$key] = $node;
800         if (!$last) {
801             // Update existing references in the ordered collection (which is the
802             // one that isn't called 'ordered') to shuffle them along if required
803             for ($oldindex = $this->count; $oldindex > $newindex; $oldindex--) {
804                 $this->collection[$oldindex] = $this->collection[$oldindex - 1];
805             }
806         }
807         // Add a reference to the node to the progressive collection.
808         $this->collection[$newindex] = $this->orderedcollection[$type][$key];
809         // Update the last property to a reference to this new node.
810         $this->last = $this->orderedcollection[$type][$key];
812         // Reorder the array by index if needed
813         if (!$last) {
814             ksort($this->collection);
815         }
816         $this->count++;
817         // Return the reference to the now added node
818         return $node;
819     }
821     /**
822      * Return a list of all the keys of all the nodes.
823      * @return array the keys.
824      */
825     public function get_key_list() {
826         $keys = array();
827         foreach ($this->collection as $node) {
828             $keys[] = $node->key;
829         }
830         return $keys;
831     }
833     /**
834      * Fetches a node from this collection.
835      *
836      * @param string|int $key The key of the node we want to find.
837      * @param int $type One of navigation_node::TYPE_*.
838      * @return navigation_node|null
839      */
840     public function get($key, $type=null) {
841         if ($type !== null) {
842             // If the type is known then we can simply check and fetch
843             if (!empty($this->orderedcollection[$type][$key])) {
844                 return $this->orderedcollection[$type][$key];
845             }
846         } else {
847             // Because we don't know the type we look in the progressive array
848             foreach ($this->collection as $node) {
849                 if ($node->key === $key) {
850                     return $node;
851                 }
852             }
853         }
854         return false;
855     }
857     /**
858      * Searches for a node with matching key and type.
859      *
860      * This function searches both the nodes in this collection and all of
861      * the nodes in each collection belonging to the nodes in this collection.
862      *
863      * Recursive.
864      *
865      * @param string|int $key  The key of the node we want to find.
866      * @param int $type  One of navigation_node::TYPE_*.
867      * @return navigation_node|null
868      */
869     public function find($key, $type=null) {
870         if ($type !== null && array_key_exists($type, $this->orderedcollection) && array_key_exists($key, $this->orderedcollection[$type])) {
871             return $this->orderedcollection[$type][$key];
872         } else {
873             $nodes = $this->getIterator();
874             // Search immediate children first
875             foreach ($nodes as &$node) {
876                 if ($node->key === $key && ($type === null || $type === $node->type)) {
877                     return $node;
878                 }
879             }
880             // Now search each childs children
881             foreach ($nodes as &$node) {
882                 $result = $node->children->find($key, $type);
883                 if ($result !== false) {
884                     return $result;
885                 }
886             }
887         }
888         return false;
889     }
891     /**
892      * Fetches the last node that was added to this collection
893      *
894      * @return navigation_node
895      */
896     public function last() {
897         return $this->last;
898     }
900     /**
901      * Fetches all nodes of a given type from this collection
902      *
903      * @param string|int $type  node type being searched for.
904      * @return array ordered collection
905      */
906     public function type($type) {
907         if (!array_key_exists($type, $this->orderedcollection)) {
908             $this->orderedcollection[$type] = array();
909         }
910         return $this->orderedcollection[$type];
911     }
912     /**
913      * Removes the node with the given key and type from the collection
914      *
915      * @param string|int $key The key of the node we want to find.
916      * @param int $type
917      * @return bool
918      */
919     public function remove($key, $type=null) {
920         $child = $this->get($key, $type);
921         if ($child !== false) {
922             foreach ($this->collection as $colkey => $node) {
923                 if ($node->key === $key && $node->type == $type) {
924                     unset($this->collection[$colkey]);
925                     $this->collection = array_values($this->collection);
926                     break;
927                 }
928             }
929             unset($this->orderedcollection[$child->type][$child->key]);
930             $this->count--;
931             return true;
932         }
933         return false;
934     }
936     /**
937      * Gets the number of nodes in this collection
938      *
939      * This option uses an internal count rather than counting the actual options to avoid
940      * a performance hit through the count function.
941      *
942      * @return int
943      */
944     public function count() {
945         return $this->count;
946     }
947     /**
948      * Gets an array iterator for the collection.
949      *
950      * This is required by the IteratorAggregator interface and is used by routines
951      * such as the foreach loop.
952      *
953      * @return ArrayIterator
954      */
955     public function getIterator() {
956         return new ArrayIterator($this->collection);
957     }
960 /**
961  * The global navigation class used for... the global navigation
962  *
963  * This class is used by PAGE to store the global navigation for the site
964  * and is then used by the settings nav and navbar to save on processing and DB calls
965  *
966  * See
967  * {@link lib/pagelib.php} {@link moodle_page::initialise_theme_and_output()}
968  * {@link lib/ajax/getnavbranch.php} Called by ajax
969  *
970  * @package   core
971  * @category  navigation
972  * @copyright 2009 Sam Hemelryk
973  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
974  */
975 class global_navigation extends navigation_node {
976     /** @var moodle_page The Moodle page this navigation object belongs to. */
977     protected $page;
978     /** @var bool switch to let us know if the navigation object is initialised*/
979     protected $initialised = false;
980     /** @var array An array of course information */
981     protected $mycourses = array();
982     /** @var array An array for containing  root navigation nodes */
983     protected $rootnodes = array();
984     /** @var bool A switch for whether to show empty sections in the navigation */
985     protected $showemptysections = true;
986     /** @var bool A switch for whether courses should be shown within categories on the navigation. */
987     protected $showcategories = null;
988     /** @var null@var bool A switch for whether or not to show categories in the my courses branch. */
989     protected $showmycategories = null;
990     /** @var array An array of stdClasses for users that the navigation is extended for */
991     protected $extendforuser = array();
992     /** @var navigation_cache */
993     protected $cache;
994     /** @var array An array of course ids that are present in the navigation */
995     protected $addedcourses = array();
996     /** @var bool */
997     protected $allcategoriesloaded = false;
998     /** @var array An array of category ids that are included in the navigation */
999     protected $addedcategories = array();
1000     /** @var int expansion limit */
1001     protected $expansionlimit = 0;
1002     /** @var int userid to allow parent to see child's profile page navigation */
1003     protected $useridtouseforparentchecks = 0;
1005     /** Used when loading categories to load all top level categories [parent = 0] **/
1006     const LOAD_ROOT_CATEGORIES = 0;
1007     /** Used when loading categories to load all categories **/
1008     const LOAD_ALL_CATEGORIES = -1;
1010     /**
1011      * Constructs a new global navigation
1012      *
1013      * @param moodle_page $page The page this navigation object belongs to
1014      */
1015     public function __construct(moodle_page $page) {
1016         global $CFG, $SITE, $USER;
1018         if (during_initial_install()) {
1019             return;
1020         }
1022         if (get_home_page() == HOMEPAGE_SITE) {
1023             // We are using the site home for the root element
1024             $properties = array(
1025                 'key' => 'home',
1026                 'type' => navigation_node::TYPE_SYSTEM,
1027                 'text' => get_string('home'),
1028                 'action' => new moodle_url('/')
1029             );
1030         } else {
1031             // We are using the users my moodle for the root element
1032             $properties = array(
1033                 'key' => 'myhome',
1034                 'type' => navigation_node::TYPE_SYSTEM,
1035                 'text' => get_string('myhome'),
1036                 'action' => new moodle_url('/my/')
1037             );
1038         }
1040         // Use the parents constructor.... good good reuse
1041         parent::__construct($properties);
1043         // Initalise and set defaults
1044         $this->page = $page;
1045         $this->forceopen = true;
1046         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
1047     }
1049     /**
1050      * Mutator to set userid to allow parent to see child's profile
1051      * page navigation. See MDL-25805 for initial issue. Linked to it
1052      * is an issue explaining why this is a REALLY UGLY HACK thats not
1053      * for you to use!
1054      *
1055      * @param int $userid userid of profile page that parent wants to navigate around.
1056      */
1057     public function set_userid_for_parent_checks($userid) {
1058         $this->useridtouseforparentchecks = $userid;
1059     }
1062     /**
1063      * Initialises the navigation object.
1064      *
1065      * This causes the navigation object to look at the current state of the page
1066      * that it is associated with and then load the appropriate content.
1067      *
1068      * This should only occur the first time that the navigation structure is utilised
1069      * which will normally be either when the navbar is called to be displayed or
1070      * when a block makes use of it.
1071      *
1072      * @return bool
1073      */
1074     public function initialise() {
1075         global $CFG, $SITE, $USER;
1076         // Check if it has already been initialised
1077         if ($this->initialised || during_initial_install()) {
1078             return true;
1079         }
1080         $this->initialised = true;
1082         // Set up the five base root nodes. These are nodes where we will put our
1083         // content and are as follows:
1084         // site: Navigation for the front page.
1085         // myprofile: User profile information goes here.
1086         // currentcourse: The course being currently viewed.
1087         // mycourses: The users courses get added here.
1088         // courses: Additional courses are added here.
1089         // users: Other users information loaded here.
1090         $this->rootnodes = array();
1091         if (get_home_page() == HOMEPAGE_SITE) {
1092             // The home element should be my moodle because the root element is the site
1093             if (isloggedin() && !isguestuser()) {  // Makes no sense if you aren't logged in
1094                 $this->rootnodes['home'] = $this->add(get_string('myhome'), new moodle_url('/my/'), self::TYPE_SETTING, null, 'home');
1095             }
1096         } else {
1097             // The home element should be the site because the root node is my moodle
1098             $this->rootnodes['home'] = $this->add(get_string('sitehome'), new moodle_url('/'), self::TYPE_SETTING, null, 'home');
1099             if (!empty($CFG->defaulthomepage) && ($CFG->defaulthomepage == HOMEPAGE_MY)) {
1100                 // We need to stop automatic redirection
1101                 $this->rootnodes['home']->action->param('redirect', '0');
1102             }
1103         }
1104         $this->rootnodes['site'] = $this->add_course($SITE);
1105         $this->rootnodes['myprofile'] = $this->add(get_string('myprofile'), null, self::TYPE_USER, null, 'myprofile');
1106         $this->rootnodes['currentcourse'] = $this->add(get_string('currentcourse'), null, self::TYPE_ROOTNODE, null, 'currentcourse');
1107         $this->rootnodes['mycourses'] = $this->add(get_string('mycourses'), new moodle_url('/my/'), self::TYPE_ROOTNODE, null, 'mycourses');
1108         $this->rootnodes['courses'] = $this->add(get_string('courses'), new moodle_url('/course/index.php'), self::TYPE_ROOTNODE, null, 'courses');
1109         $this->rootnodes['users'] = $this->add(get_string('users'), null, self::TYPE_ROOTNODE, null, 'users');
1111         // We always load the frontpage course to ensure it is available without
1112         // JavaScript enabled.
1113         $this->add_front_page_course_essentials($this->rootnodes['site'], $SITE);
1114         $this->load_course_sections($SITE, $this->rootnodes['site']);
1116         $course = $this->page->course;
1118         // $issite gets set to true if the current pages course is the sites frontpage course
1119         $issite = ($this->page->course->id == $SITE->id);
1120         // Determine if the user is enrolled in any course.
1121         $enrolledinanycourse = enrol_user_sees_own_courses();
1123         $this->rootnodes['currentcourse']->mainnavonly = true;
1124         if ($enrolledinanycourse) {
1125             $this->rootnodes['mycourses']->isexpandable = true;
1126             if ($CFG->navshowallcourses) {
1127                 // When we show all courses we need to show both the my courses and the regular courses branch.
1128                 $this->rootnodes['courses']->isexpandable = true;
1129             }
1130         } else {
1131             $this->rootnodes['courses']->isexpandable = true;
1132         }
1134         if ($this->rootnodes['mycourses']->isactive) {
1135             $this->load_courses_enrolled();
1136         }
1138         $canviewcourseprofile = true;
1140         // Next load context specific content into the navigation
1141         switch ($this->page->context->contextlevel) {
1142             case CONTEXT_SYSTEM :
1143                 // Nothing left to do here I feel.
1144                 break;
1145             case CONTEXT_COURSECAT :
1146                 // This is essential, we must load categories.
1147                 $this->load_all_categories($this->page->context->instanceid, true);
1148                 break;
1149             case CONTEXT_BLOCK :
1150             case CONTEXT_COURSE :
1151                 if ($issite) {
1152                     // Nothing left to do here.
1153                     break;
1154                 }
1156                 // Load the course associated with the current page into the navigation.
1157                 $coursenode = $this->add_course($course, false, self::COURSE_CURRENT);
1158                 // If the course wasn't added then don't try going any further.
1159                 if (!$coursenode) {
1160                     $canviewcourseprofile = false;
1161                     break;
1162                 }
1164                 // If the user is not enrolled then we only want to show the
1165                 // course node and not populate it.
1167                 // Not enrolled, can't view, and hasn't switched roles
1168                 if (!can_access_course($course)) {
1169                     // Very ugly hack - do not force "parents" to enrol into course their child is enrolled in,
1170                     // this hack has been propagated from user/view.php to display the navigation node. (MDL-25805)
1171                     if (!$this->current_user_is_parent_role()) {
1172                         $coursenode->make_active();
1173                         $canviewcourseprofile = false;
1174                         break;
1175                     }
1176                 }
1178                 // Add the essentials such as reports etc...
1179                 $this->add_course_essentials($coursenode, $course);
1180                 // Extend course navigation with it's sections/activities
1181                 $this->load_course_sections($course, $coursenode);
1182                 if (!$coursenode->contains_active_node() && !$coursenode->search_for_active_node()) {
1183                     $coursenode->make_active();
1184                 }
1186                 break;
1187             case CONTEXT_MODULE :
1188                 if ($issite) {
1189                     // If this is the site course then most information will have
1190                     // already been loaded.
1191                     // However we need to check if there is more content that can
1192                     // yet be loaded for the specific module instance.
1193                     $activitynode = $this->rootnodes['site']->find($this->page->cm->id, navigation_node::TYPE_ACTIVITY);
1194                     if ($activitynode) {
1195                         $this->load_activity($this->page->cm, $this->page->course, $activitynode);
1196                     }
1197                     break;
1198                 }
1200                 $course = $this->page->course;
1201                 $cm = $this->page->cm;
1203                 // Load the course associated with the page into the navigation
1204                 $coursenode = $this->add_course($course, false, self::COURSE_CURRENT);
1206                 // If the course wasn't added then don't try going any further.
1207                 if (!$coursenode) {
1208                     $canviewcourseprofile = false;
1209                     break;
1210                 }
1212                 // If the user is not enrolled then we only want to show the
1213                 // course node and not populate it.
1214                 if (!can_access_course($course)) {
1215                     $coursenode->make_active();
1216                     $canviewcourseprofile = false;
1217                     break;
1218                 }
1220                 $this->add_course_essentials($coursenode, $course);
1222                 // Load the course sections into the page
1223                 $this->load_course_sections($course, $coursenode, null, $cm);
1224                 $activity = $coursenode->find($cm->id, navigation_node::TYPE_ACTIVITY);
1225                 if (!empty($activity)) {
1226                     // Finally load the cm specific navigaton information
1227                     $this->load_activity($cm, $course, $activity);
1228                     // Check if we have an active ndoe
1229                     if (!$activity->contains_active_node() && !$activity->search_for_active_node()) {
1230                         // And make the activity node active.
1231                         $activity->make_active();
1232                     }
1233                 }
1234                 break;
1235             case CONTEXT_USER :
1236                 if ($issite) {
1237                     // The users profile information etc is already loaded
1238                     // for the front page.
1239                     break;
1240                 }
1241                 $course = $this->page->course;
1242                 // Load the course associated with the user into the navigation
1243                 $coursenode = $this->add_course($course, false, self::COURSE_CURRENT);
1245                 // If the course wasn't added then don't try going any further.
1246                 if (!$coursenode) {
1247                     $canviewcourseprofile = false;
1248                     break;
1249                 }
1251                 // If the user is not enrolled then we only want to show the
1252                 // course node and not populate it.
1253                 if (!can_access_course($course)) {
1254                     $coursenode->make_active();
1255                     $canviewcourseprofile = false;
1256                     break;
1257                 }
1258                 $this->add_course_essentials($coursenode, $course);
1259                 $this->load_course_sections($course, $coursenode);
1260                 break;
1261         }
1263         // Load for the current user
1264         $this->load_for_user();
1265         if ($this->page->context->contextlevel >= CONTEXT_COURSE && $this->page->context->instanceid != $SITE->id && $canviewcourseprofile) {
1266             $this->load_for_user(null, true);
1267         }
1268         // Load each extending user into the navigation.
1269         foreach ($this->extendforuser as $user) {
1270             if ($user->id != $USER->id) {
1271                 $this->load_for_user($user);
1272             }
1273         }
1275         // Give the local plugins a chance to include some navigation if they want.
1276         foreach (core_component::get_plugin_list_with_file('local', 'lib.php', true) as $plugin => $file) {
1277             $function = "local_{$plugin}_extends_navigation";
1278             $oldfunction = "{$plugin}_extends_navigation";
1279             if (function_exists($function)) {
1280                 // This is the preferred function name as there is less chance of conflicts
1281                 $function($this);
1282             } else if (function_exists($oldfunction)) {
1283                 // We continue to support the old function name to ensure backwards compatibility
1284                 debugging("Deprecated local plugin navigation callback: Please rename '{$oldfunction}' to '{$function}'. Support for the old callback will be dropped after the release of 2.4", DEBUG_DEVELOPER);
1285                 $oldfunction($this);
1286             }
1287         }
1289         // Remove any empty root nodes
1290         foreach ($this->rootnodes as $node) {
1291             // Dont remove the home node
1292             /** @var navigation_node $node */
1293             if ($node->key !== 'home' && !$node->has_children() && !$node->isactive) {
1294                 $node->remove();
1295             }
1296         }
1298         if (!$this->contains_active_node()) {
1299             $this->search_for_active_node();
1300         }
1302         // If the user is not logged in modify the navigation structure as detailed
1303         // in {@link http://docs.moodle.org/dev/Navigation_2.0_structure}
1304         if (!isloggedin()) {
1305             $activities = clone($this->rootnodes['site']->children);
1306             $this->rootnodes['site']->remove();
1307             $children = clone($this->children);
1308             $this->children = new navigation_node_collection();
1309             foreach ($activities as $child) {
1310                 $this->children->add($child);
1311             }
1312             foreach ($children as $child) {
1313                 $this->children->add($child);
1314             }
1315         }
1316         return true;
1317     }
1319     /**
1320      * Returns true if the current user is a parent of the user being currently viewed.
1321      *
1322      * If the current user is not viewing another user, or if the current user does not hold any parent roles over the
1323      * other user being viewed this function returns false.
1324      * In order to set the user for whom we are checking against you must call {@link set_userid_for_parent_checks()}
1325      *
1326      * @since 2.4
1327      * @return bool
1328      */
1329     protected function current_user_is_parent_role() {
1330         global $USER, $DB;
1331         if ($this->useridtouseforparentchecks && $this->useridtouseforparentchecks != $USER->id) {
1332             $usercontext = context_user::instance($this->useridtouseforparentchecks, MUST_EXIST);
1333             if (!has_capability('moodle/user:viewdetails', $usercontext)) {
1334                 return false;
1335             }
1336             if ($DB->record_exists('role_assignments', array('userid' => $USER->id, 'contextid' => $usercontext->id))) {
1337                 return true;
1338             }
1339         }
1340         return false;
1341     }
1343     /**
1344      * Returns true if courses should be shown within categories on the navigation.
1345      *
1346      * @param bool $ismycourse Set to true if you are calculating this for a course.
1347      * @return bool
1348      */
1349     protected function show_categories($ismycourse = false) {
1350         global $CFG, $DB;
1351         if ($ismycourse) {
1352             return $this->show_my_categories();
1353         }
1354         if ($this->showcategories === null) {
1355             $show = false;
1356             if ($this->page->context->contextlevel == CONTEXT_COURSECAT) {
1357                 $show = true;
1358             } else if (!empty($CFG->navshowcategories) && $DB->count_records('course_categories') > 1) {
1359                 $show = true;
1360             }
1361             $this->showcategories = $show;
1362         }
1363         return $this->showcategories;
1364     }
1366     /**
1367      * Returns true if we should show categories in the My Courses branch.
1368      * @return bool
1369      */
1370     protected function show_my_categories() {
1371         global $CFG, $DB;
1372         if ($this->showmycategories === null) {
1373             $this->showmycategories = !empty($CFG->navshowmycoursecategories) && $DB->count_records('course_categories') > 1;
1374         }
1375         return $this->showmycategories;
1376     }
1378     /**
1379      * Loads the courses in Moodle into the navigation.
1380      *
1381      * @global moodle_database $DB
1382      * @param string|array $categoryids An array containing categories to load courses
1383      *                     for, OR null to load courses for all categories.
1384      * @return array An array of navigation_nodes one for each course
1385      */
1386     protected function load_all_courses($categoryids = null) {
1387         global $CFG, $DB, $SITE;
1389         // Work out the limit of courses.
1390         $limit = 20;
1391         if (!empty($CFG->navcourselimit)) {
1392             $limit = $CFG->navcourselimit;
1393         }
1395         $toload = (empty($CFG->navshowallcourses))?self::LOAD_ROOT_CATEGORIES:self::LOAD_ALL_CATEGORIES;
1397         // If we are going to show all courses AND we are showing categories then
1398         // to save us repeated DB calls load all of the categories now
1399         if ($this->show_categories()) {
1400             $this->load_all_categories($toload);
1401         }
1403         // Will be the return of our efforts
1404         $coursenodes = array();
1406         // Check if we need to show categories.
1407         if ($this->show_categories()) {
1408             // Hmmm we need to show categories... this is going to be painful.
1409             // We now need to fetch up to $limit courses for each category to
1410             // be displayed.
1411             if ($categoryids !== null) {
1412                 if (!is_array($categoryids)) {
1413                     $categoryids = array($categoryids);
1414                 }
1415                 list($categorywhere, $categoryparams) = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED, 'cc');
1416                 $categorywhere = 'WHERE cc.id '.$categorywhere;
1417             } else if ($toload == self::LOAD_ROOT_CATEGORIES) {
1418                 $categorywhere = 'WHERE cc.depth = 1 OR cc.depth = 2';
1419                 $categoryparams = array();
1420             } else {
1421                 $categorywhere = '';
1422                 $categoryparams = array();
1423             }
1425             // First up we are going to get the categories that we are going to
1426             // need so that we can determine how best to load the courses from them.
1427             $sql = "SELECT cc.id, COUNT(c.id) AS coursecount
1428                         FROM {course_categories} cc
1429                     LEFT JOIN {course} c ON c.category = cc.id
1430                             {$categorywhere}
1431                     GROUP BY cc.id";
1432             $categories = $DB->get_recordset_sql($sql, $categoryparams);
1433             $fullfetch = array();
1434             $partfetch = array();
1435             foreach ($categories as $category) {
1436                 if (!$this->can_add_more_courses_to_category($category->id)) {
1437                     continue;
1438                 }
1439                 if ($category->coursecount > $limit * 5) {
1440                     $partfetch[] = $category->id;
1441                 } else if ($category->coursecount > 0) {
1442                     $fullfetch[] = $category->id;
1443                 }
1444             }
1445             $categories->close();
1447             if (count($fullfetch)) {
1448                 // First up fetch all of the courses in categories where we know that we are going to
1449                 // need the majority of courses.
1450                 list($categoryids, $categoryparams) = $DB->get_in_or_equal($fullfetch, SQL_PARAMS_NAMED, 'lcategory');
1451                 $ccselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
1452                 $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
1453                 $categoryparams['contextlevel'] = CONTEXT_COURSE;
1454                 $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
1455                             FROM {course} c
1456                                 $ccjoin
1457                             WHERE c.category {$categoryids}
1458                         ORDER BY c.sortorder ASC";
1459                 $coursesrs = $DB->get_recordset_sql($sql, $categoryparams);
1460                 foreach ($coursesrs as $course) {
1461                     if ($course->id == $SITE->id) {
1462                         // This should not be necessary, frontpage is not in any category.
1463                         continue;
1464                     }
1465                     if (array_key_exists($course->id, $this->addedcourses)) {
1466                         // It is probably better to not include the already loaded courses
1467                         // directly in SQL because inequalities may confuse query optimisers
1468                         // and may interfere with query caching.
1469                         continue;
1470                     }
1471                     if (!$this->can_add_more_courses_to_category($course->category)) {
1472                         continue;
1473                     }
1474                     context_helper::preload_from_record($course);
1475                     if (!$course->visible && !is_role_switched($course->id) && !has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
1476                         continue;
1477                     }
1478                     $coursenodes[$course->id] = $this->add_course($course);
1479                 }
1480                 $coursesrs->close();
1481             }
1483             if (count($partfetch)) {
1484                 // Next we will work our way through the categories where we will likely only need a small
1485                 // proportion of the courses.
1486                 foreach ($partfetch as $categoryid) {
1487                     $ccselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
1488                     $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
1489                     $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
1490                                 FROM {course} c
1491                                     $ccjoin
1492                                 WHERE c.category = :categoryid
1493                             ORDER BY c.sortorder ASC";
1494                     $courseparams = array('categoryid' => $categoryid, 'contextlevel' => CONTEXT_COURSE);
1495                     $coursesrs = $DB->get_recordset_sql($sql, $courseparams, 0, $limit * 5);
1496                     foreach ($coursesrs as $course) {
1497                         if ($course->id == $SITE->id) {
1498                             // This should not be necessary, frontpage is not in any category.
1499                             continue;
1500                         }
1501                         if (array_key_exists($course->id, $this->addedcourses)) {
1502                             // It is probably better to not include the already loaded courses
1503                             // directly in SQL because inequalities may confuse query optimisers
1504                             // and may interfere with query caching.
1505                             // This also helps to respect expected $limit on repeated executions.
1506                             continue;
1507                         }
1508                         if (!$this->can_add_more_courses_to_category($course->category)) {
1509                             break;
1510                         }
1511                         context_helper::preload_from_record($course);
1512                         if (!$course->visible && !is_role_switched($course->id) && !has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
1513                             continue;
1514                         }
1515                         $coursenodes[$course->id] = $this->add_course($course);
1516                     }
1517                     $coursesrs->close();
1518                 }
1519             }
1520         } else {
1521             // Prepare the SQL to load the courses and their contexts
1522             list($courseids, $courseparams) = $DB->get_in_or_equal(array_keys($this->addedcourses), SQL_PARAMS_NAMED, 'lc', false);
1523             $ccselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
1524             $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
1525             $courseparams['contextlevel'] = CONTEXT_COURSE;
1526             $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
1527                         FROM {course} c
1528                             $ccjoin
1529                         WHERE c.id {$courseids}
1530                     ORDER BY c.sortorder ASC";
1531             $coursesrs = $DB->get_recordset_sql($sql, $courseparams);
1532             foreach ($coursesrs as $course) {
1533                 if ($course->id == $SITE->id) {
1534                     // frotpage is not wanted here
1535                     continue;
1536                 }
1537                 if ($this->page->course && ($this->page->course->id == $course->id)) {
1538                     // Don't include the currentcourse in this nodelist - it's displayed in the Current course node
1539                     continue;
1540                 }
1541                 context_helper::preload_from_record($course);
1542                 if (!$course->visible && !is_role_switched($course->id) && !has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
1543                     continue;
1544                 }
1545                 $coursenodes[$course->id] = $this->add_course($course);
1546                 if (count($coursenodes) >= $limit) {
1547                     break;
1548                 }
1549             }
1550             $coursesrs->close();
1551         }
1553         return $coursenodes;
1554     }
1556     /**
1557      * Returns true if more courses can be added to the provided category.
1558      *
1559      * @param int|navigation_node|stdClass $category
1560      * @return bool
1561      */
1562     protected function can_add_more_courses_to_category($category) {
1563         global $CFG;
1564         $limit = 20;
1565         if (!empty($CFG->navcourselimit)) {
1566             $limit = (int)$CFG->navcourselimit;
1567         }
1568         if (is_numeric($category)) {
1569             if (!array_key_exists($category, $this->addedcategories)) {
1570                 return true;
1571             }
1572             $coursecount = count($this->addedcategories[$category]->children->type(self::TYPE_COURSE));
1573         } else if ($category instanceof navigation_node) {
1574             if (($category->type != self::TYPE_CATEGORY) || ($category->type != self::TYPE_MY_CATEGORY)) {
1575                 return false;
1576             }
1577             $coursecount = count($category->children->type(self::TYPE_COURSE));
1578         } else if (is_object($category) && property_exists($category,'id')) {
1579             $coursecount = count($this->addedcategories[$category->id]->children->type(self::TYPE_COURSE));
1580         }
1581         return ($coursecount <= $limit);
1582     }
1584     /**
1585      * Loads all categories (top level or if an id is specified for that category)
1586      *
1587      * @param int $categoryid The category id to load or null/0 to load all base level categories
1588      * @param bool $showbasecategories If set to true all base level categories will be loaded as well
1589      *        as the requested category and any parent categories.
1590      * @return navigation_node|void returns a navigation node if a category has been loaded.
1591      */
1592     protected function load_all_categories($categoryid = self::LOAD_ROOT_CATEGORIES, $showbasecategories = false) {
1593         global $CFG, $DB;
1595         // Check if this category has already been loaded
1596         if ($this->allcategoriesloaded || ($categoryid < 1 && $this->is_category_fully_loaded($categoryid))) {
1597             return true;
1598         }
1600         $catcontextsql = context_helper::get_preload_record_columns_sql('ctx');
1601         $sqlselect = "SELECT cc.*, $catcontextsql
1602                       FROM {course_categories} cc
1603                       JOIN {context} ctx ON cc.id = ctx.instanceid";
1604         $sqlwhere = "WHERE ctx.contextlevel = ".CONTEXT_COURSECAT;
1605         $sqlorder = "ORDER BY cc.depth ASC, cc.sortorder ASC, cc.id ASC";
1606         $params = array();
1608         $categoriestoload = array();
1609         if ($categoryid == self::LOAD_ALL_CATEGORIES) {
1610             // We are going to load all categories regardless... prepare to fire
1611             // on the database server!
1612         } else if ($categoryid == self::LOAD_ROOT_CATEGORIES) { // can be 0
1613             // We are going to load all of the first level categories (categories without parents)
1614             $sqlwhere .= " AND cc.parent = 0";
1615         } else if (array_key_exists($categoryid, $this->addedcategories)) {
1616             // The category itself has been loaded already so we just need to ensure its subcategories
1617             // have been loaded
1618             list($sql, $params) = $DB->get_in_or_equal(array_keys($this->addedcategories), SQL_PARAMS_NAMED, 'parent', false);
1619             if ($showbasecategories) {
1620                 // We need to include categories with parent = 0 as well
1621                 $sqlwhere .= " AND (cc.parent = :categoryid OR cc.parent = 0) AND cc.parent {$sql}";
1622             } else {
1623                 // All we need is categories that match the parent
1624                 $sqlwhere .= " AND cc.parent = :categoryid AND cc.parent {$sql}";
1625             }
1626             $params['categoryid'] = $categoryid;
1627         } else {
1628             // This category hasn't been loaded yet so we need to fetch it, work out its category path
1629             // and load this category plus all its parents and subcategories
1630             $category = $DB->get_record('course_categories', array('id' => $categoryid), 'path', MUST_EXIST);
1631             $categoriestoload = explode('/', trim($category->path, '/'));
1632             list($select, $params) = $DB->get_in_or_equal($categoriestoload);
1633             // We are going to use select twice so double the params
1634             $params = array_merge($params, $params);
1635             $basecategorysql = ($showbasecategories)?' OR cc.depth = 1':'';
1636             $sqlwhere .= " AND (cc.id {$select} OR cc.parent {$select}{$basecategorysql})";
1637         }
1639         $categoriesrs = $DB->get_recordset_sql("$sqlselect $sqlwhere $sqlorder", $params);
1640         $categories = array();
1641         foreach ($categoriesrs as $category) {
1642             // Preload the context.. we'll need it when adding the category in order
1643             // to format the category name.
1644             context_helper::preload_from_record($category);
1645             if (array_key_exists($category->id, $this->addedcategories)) {
1646                 // Do nothing, its already been added.
1647             } else if ($category->parent == '0') {
1648                 // This is a root category lets add it immediately
1649                 $this->add_category($category, $this->rootnodes['courses']);
1650             } else if (array_key_exists($category->parent, $this->addedcategories)) {
1651                 // This categories parent has already been added we can add this immediately
1652                 $this->add_category($category, $this->addedcategories[$category->parent]);
1653             } else {
1654                 $categories[] = $category;
1655             }
1656         }
1657         $categoriesrs->close();
1659         // Now we have an array of categories we need to add them to the navigation.
1660         while (!empty($categories)) {
1661             $category = reset($categories);
1662             if (array_key_exists($category->id, $this->addedcategories)) {
1663                 // Do nothing
1664             } else if ($category->parent == '0') {
1665                 $this->add_category($category, $this->rootnodes['courses']);
1666             } else if (array_key_exists($category->parent, $this->addedcategories)) {
1667                 $this->add_category($category, $this->addedcategories[$category->parent]);
1668             } else {
1669                 // This category isn't in the navigation and niether is it's parent (yet).
1670                 // We need to go through the category path and add all of its components in order.
1671                 $path = explode('/', trim($category->path, '/'));
1672                 foreach ($path as $catid) {
1673                     if (!array_key_exists($catid, $this->addedcategories)) {
1674                         // This category isn't in the navigation yet so add it.
1675                         $subcategory = $categories[$catid];
1676                         if ($subcategory->parent == '0') {
1677                             // Yay we have a root category - this likely means we will now be able
1678                             // to add categories without problems.
1679                             $this->add_category($subcategory, $this->rootnodes['courses']);
1680                         } else if (array_key_exists($subcategory->parent, $this->addedcategories)) {
1681                             // The parent is in the category (as we'd expect) so add it now.
1682                             $this->add_category($subcategory, $this->addedcategories[$subcategory->parent]);
1683                             // Remove the category from the categories array.
1684                             unset($categories[$catid]);
1685                         } else {
1686                             // We should never ever arrive here - if we have then there is a bigger
1687                             // problem at hand.
1688                             throw new coding_exception('Category path order is incorrect and/or there are missing categories');
1689                         }
1690                     }
1691                 }
1692             }
1693             // Remove the category from the categories array now that we know it has been added.
1694             unset($categories[$category->id]);
1695         }
1696         if ($categoryid === self::LOAD_ALL_CATEGORIES) {
1697             $this->allcategoriesloaded = true;
1698         }
1699         // Check if there are any categories to load.
1700         if (count($categoriestoload) > 0) {
1701             $readytoloadcourses = array();
1702             foreach ($categoriestoload as $category) {
1703                 if ($this->can_add_more_courses_to_category($category)) {
1704                     $readytoloadcourses[] = $category;
1705                 }
1706             }
1707             if (count($readytoloadcourses)) {
1708                 $this->load_all_courses($readytoloadcourses);
1709             }
1710         }
1712         // Look for all categories which have been loaded
1713         if (!empty($this->addedcategories)) {
1714             $categoryids = array();
1715             foreach ($this->addedcategories as $category) {
1716                 if ($this->can_add_more_courses_to_category($category)) {
1717                     $categoryids[] = $category->key;
1718                 }
1719             }
1720             if ($categoryids) {
1721                 list($categoriessql, $params) = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED);
1722                 $params['limit'] = (!empty($CFG->navcourselimit))?$CFG->navcourselimit:20;
1723                 $sql = "SELECT cc.id, COUNT(c.id) AS coursecount
1724                           FROM {course_categories} cc
1725                           JOIN {course} c ON c.category = cc.id
1726                          WHERE cc.id {$categoriessql}
1727                       GROUP BY cc.id
1728                         HAVING COUNT(c.id) > :limit";
1729                 $excessivecategories = $DB->get_records_sql($sql, $params);
1730                 foreach ($categories as &$category) {
1731                     if (array_key_exists($category->key, $excessivecategories) && !$this->can_add_more_courses_to_category($category)) {
1732                         $url = new moodle_url('/course/index.php', array('categoryid' => $category->key));
1733                         $category->add(get_string('viewallcourses'), $url, self::TYPE_SETTING);
1734                     }
1735                 }
1736             }
1737         }
1738     }
1740     /**
1741      * Adds a structured category to the navigation in the correct order/place
1742      *
1743      * @param stdClass $category category to be added in navigation.
1744      * @param navigation_node $parent parent navigation node
1745      * @param int $nodetype type of node, if category is under MyHome then it's TYPE_MY_CATEGORY
1746      * @return void.
1747      */
1748     protected function add_category(stdClass $category, navigation_node $parent, $nodetype = self::TYPE_CATEGORY) {
1749         if (array_key_exists($category->id, $this->addedcategories)) {
1750             return;
1751         }
1752         $url = new moodle_url('/course/index.php', array('categoryid' => $category->id));
1753         $context = context_coursecat::instance($category->id);
1754         $categoryname = format_string($category->name, true, array('context' => $context));
1755         $categorynode = $parent->add($categoryname, $url, $nodetype, $categoryname, $category->id);
1756         if (empty($category->visible)) {
1757             if (has_capability('moodle/category:viewhiddencategories', context_system::instance())) {
1758                 $categorynode->hidden = true;
1759             } else {
1760                 $categorynode->display = false;
1761             }
1762         }
1763         $this->addedcategories[$category->id] = $categorynode;
1764     }
1766     /**
1767      * Loads the given course into the navigation
1768      *
1769      * @param stdClass $course
1770      * @return navigation_node
1771      */
1772     protected function load_course(stdClass $course) {
1773         global $SITE;
1774         if ($course->id == $SITE->id) {
1775             // This is always loaded during initialisation
1776             return $this->rootnodes['site'];
1777         } else if (array_key_exists($course->id, $this->addedcourses)) {
1778             // The course has already been loaded so return a reference
1779             return $this->addedcourses[$course->id];
1780         } else {
1781             // Add the course
1782             return $this->add_course($course);
1783         }
1784     }
1786     /**
1787      * Loads all of the courses section into the navigation.
1788      *
1789      * This function calls method from current course format, see
1790      * {@link format_base::extend_course_navigation()}
1791      * If course module ($cm) is specified but course format failed to create the node,
1792      * the activity node is created anyway.
1793      *
1794      * By default course formats call the method {@link global_navigation::load_generic_course_sections()}
1795      *
1796      * @param stdClass $course Database record for the course
1797      * @param navigation_node $coursenode The course node within the navigation
1798      * @param null|int $sectionnum If specified load the contents of section with this relative number
1799      * @param null|cm_info $cm If specified make sure that activity node is created (either
1800      *    in containg section or by calling load_stealth_activity() )
1801      */
1802     protected function load_course_sections(stdClass $course, navigation_node $coursenode, $sectionnum = null, $cm = null) {
1803         global $CFG, $SITE;
1804         require_once($CFG->dirroot.'/course/lib.php');
1805         if (isset($cm->sectionnum)) {
1806             $sectionnum = $cm->sectionnum;
1807         }
1808         if ($sectionnum !== null) {
1809             $this->includesectionnum = $sectionnum;
1810         }
1811         course_get_format($course)->extend_course_navigation($this, $coursenode, $sectionnum, $cm);
1812         if (isset($cm->id)) {
1813             $activity = $coursenode->find($cm->id, self::TYPE_ACTIVITY);
1814             if (empty($activity)) {
1815                 $activity = $this->load_stealth_activity($coursenode, get_fast_modinfo($course));
1816             }
1817         }
1818    }
1820     /**
1821      * Generates an array of sections and an array of activities for the given course.
1822      *
1823      * This method uses the cache to improve performance and avoid the get_fast_modinfo call
1824      *
1825      * @param stdClass $course
1826      * @return array Array($sections, $activities)
1827      */
1828     protected function generate_sections_and_activities(stdClass $course) {
1829         global $CFG;
1830         require_once($CFG->dirroot.'/course/lib.php');
1832         $modinfo = get_fast_modinfo($course);
1833         $sections = $modinfo->get_section_info_all();
1835         // For course formats using 'numsections' trim the sections list
1836         $courseformatoptions = course_get_format($course)->get_format_options();
1837         if (isset($courseformatoptions['numsections'])) {
1838             $sections = array_slice($sections, 0, $courseformatoptions['numsections']+1, true);
1839         }
1841         $activities = array();
1843         foreach ($sections as $key => $section) {
1844             // Clone and unset summary to prevent $SESSION bloat (MDL-31802).
1845             $sections[$key] = clone($section);
1846             unset($sections[$key]->summary);
1847             $sections[$key]->hasactivites = false;
1848             if (!array_key_exists($section->section, $modinfo->sections)) {
1849                 continue;
1850             }
1851             foreach ($modinfo->sections[$section->section] as $cmid) {
1852                 $cm = $modinfo->cms[$cmid];
1853                 if (!$cm->uservisible) {
1854                     continue;
1855                 }
1856                 $activity = new stdClass;
1857                 $activity->id = $cm->id;
1858                 $activity->course = $course->id;
1859                 $activity->section = $section->section;
1860                 $activity->name = $cm->name;
1861                 $activity->icon = $cm->icon;
1862                 $activity->iconcomponent = $cm->iconcomponent;
1863                 $activity->hidden = (!$cm->visible);
1864                 $activity->modname = $cm->modname;
1865                 $activity->nodetype = navigation_node::NODETYPE_LEAF;
1866                 $activity->onclick = $cm->get_on_click();
1867                 $url = $cm->get_url();
1868                 if (!$url) {
1869                     $activity->url = null;
1870                     $activity->display = false;
1871                 } else {
1872                     $activity->url = $cm->get_url()->out();
1873                     $activity->display = true;
1874                     if (self::module_extends_navigation($cm->modname)) {
1875                         $activity->nodetype = navigation_node::NODETYPE_BRANCH;
1876                     }
1877                 }
1878                 $activities[$cmid] = $activity;
1879                 if ($activity->display) {
1880                     $sections[$key]->hasactivites = true;
1881                 }
1882             }
1883         }
1885         return array($sections, $activities);
1886     }
1888     /**
1889      * Generically loads the course sections into the course's navigation.
1890      *
1891      * @param stdClass $course
1892      * @param navigation_node $coursenode
1893      * @return array An array of course section nodes
1894      */
1895     public function load_generic_course_sections(stdClass $course, navigation_node $coursenode) {
1896         global $CFG, $DB, $USER, $SITE;
1897         require_once($CFG->dirroot.'/course/lib.php');
1899         list($sections, $activities) = $this->generate_sections_and_activities($course);
1901         $navigationsections = array();
1902         foreach ($sections as $sectionid => $section) {
1903             $section = clone($section);
1904             if ($course->id == $SITE->id) {
1905                 $this->load_section_activities($coursenode, $section->section, $activities);
1906             } else {
1907                 if (!$section->uservisible || (!$this->showemptysections &&
1908                         !$section->hasactivites && $this->includesectionnum !== $section->section)) {
1909                     continue;
1910                 }
1912                 $sectionname = get_section_name($course, $section);
1913                 $url = course_get_url($course, $section->section, array('navigation' => true));
1915                 $sectionnode = $coursenode->add($sectionname, $url, navigation_node::TYPE_SECTION, null, $section->id);
1916                 $sectionnode->nodetype = navigation_node::NODETYPE_BRANCH;
1917                 $sectionnode->hidden = (!$section->visible || !$section->available);
1918                 if ($this->includesectionnum !== false && $this->includesectionnum == $section->section) {
1919                     $this->load_section_activities($sectionnode, $section->section, $activities);
1920                 }
1921                 $section->sectionnode = $sectionnode;
1922                 $navigationsections[$sectionid] = $section;
1923             }
1924         }
1925         return $navigationsections;
1926     }
1928     /**
1929      * Loads all of the activities for a section into the navigation structure.
1930      *
1931      * @param navigation_node $sectionnode
1932      * @param int $sectionnumber
1933      * @param array $activities An array of activites as returned by {@link global_navigation::generate_sections_and_activities()}
1934      * @param stdClass $course The course object the section and activities relate to.
1935      * @return array Array of activity nodes
1936      */
1937     protected function load_section_activities(navigation_node $sectionnode, $sectionnumber, array $activities, $course = null) {
1938         global $CFG, $SITE;
1939         // A static counter for JS function naming
1940         static $legacyonclickcounter = 0;
1942         $activitynodes = array();
1943         if (empty($activities)) {
1944             return $activitynodes;
1945         }
1947         if (!is_object($course)) {
1948             $activity = reset($activities);
1949             $courseid = $activity->course;
1950         } else {
1951             $courseid = $course->id;
1952         }
1953         $showactivities = ($courseid != $SITE->id || !empty($CFG->navshowfrontpagemods));
1955         foreach ($activities as $activity) {
1956             if ($activity->section != $sectionnumber) {
1957                 continue;
1958             }
1959             if ($activity->icon) {
1960                 $icon = new pix_icon($activity->icon, get_string('modulename', $activity->modname), $activity->iconcomponent);
1961             } else {
1962                 $icon = new pix_icon('icon', get_string('modulename', $activity->modname), $activity->modname);
1963             }
1965             // Prepare the default name and url for the node
1966             $activityname = format_string($activity->name, true, array('context' => context_module::instance($activity->id)));
1967             $action = new moodle_url($activity->url);
1969             // Check if the onclick property is set (puke!)
1970             if (!empty($activity->onclick)) {
1971                 // Increment the counter so that we have a unique number.
1972                 $legacyonclickcounter++;
1973                 // Generate the function name we will use
1974                 $functionname = 'legacy_activity_onclick_handler_'.$legacyonclickcounter;
1975                 $propogrationhandler = '';
1976                 // Check if we need to cancel propogation. Remember inline onclick
1977                 // events would return false if they wanted to prevent propogation and the
1978                 // default action.
1979                 if (strpos($activity->onclick, 'return false')) {
1980                     $propogrationhandler = 'e.halt();';
1981                 }
1982                 // Decode the onclick - it has already been encoded for display (puke)
1983                 $onclick = htmlspecialchars_decode($activity->onclick, ENT_QUOTES);
1984                 // Build the JS function the click event will call
1985                 $jscode = "function {$functionname}(e) { $propogrationhandler $onclick }";
1986                 $this->page->requires->js_init_code($jscode);
1987                 // Override the default url with the new action link
1988                 $action = new action_link($action, $activityname, new component_action('click', $functionname));
1989             }
1991             $activitynode = $sectionnode->add($activityname, $action, navigation_node::TYPE_ACTIVITY, null, $activity->id, $icon);
1992             $activitynode->title(get_string('modulename', $activity->modname));
1993             $activitynode->hidden = $activity->hidden;
1994             $activitynode->display = $showactivities && $activity->display;
1995             $activitynode->nodetype = $activity->nodetype;
1996             $activitynodes[$activity->id] = $activitynode;
1997         }
1999         return $activitynodes;
2000     }
2001     /**
2002      * Loads a stealth module from unavailable section
2003      * @param navigation_node $coursenode
2004      * @param stdClass $modinfo
2005      * @return navigation_node or null if not accessible
2006      */
2007     protected function load_stealth_activity(navigation_node $coursenode, $modinfo) {
2008         if (empty($modinfo->cms[$this->page->cm->id])) {
2009             return null;
2010         }
2011         $cm = $modinfo->cms[$this->page->cm->id];
2012         if (!$cm->uservisible) {
2013             return null;
2014         }
2015         if ($cm->icon) {
2016             $icon = new pix_icon($cm->icon, get_string('modulename', $cm->modname), $cm->iconcomponent);
2017         } else {
2018             $icon = new pix_icon('icon', get_string('modulename', $cm->modname), $cm->modname);
2019         }
2020         $url = $cm->get_url();
2021         $activitynode = $coursenode->add(format_string($cm->name), $url, navigation_node::TYPE_ACTIVITY, null, $cm->id, $icon);
2022         $activitynode->title(get_string('modulename', $cm->modname));
2023         $activitynode->hidden = (!$cm->visible);
2024         if (!$url) {
2025             // Don't show activities that don't have links!
2026             $activitynode->display = false;
2027         } else if (self::module_extends_navigation($cm->modname)) {
2028             $activitynode->nodetype = navigation_node::NODETYPE_BRANCH;
2029         }
2030         return $activitynode;
2031     }
2032     /**
2033      * Loads the navigation structure for the given activity into the activities node.
2034      *
2035      * This method utilises a callback within the modules lib.php file to load the
2036      * content specific to activity given.
2037      *
2038      * The callback is a method: {modulename}_extend_navigation()
2039      * Examples:
2040      *  * {@link forum_extend_navigation()}
2041      *  * {@link workshop_extend_navigation()}
2042      *
2043      * @param cm_info|stdClass $cm
2044      * @param stdClass $course
2045      * @param navigation_node $activity
2046      * @return bool
2047      */
2048     protected function load_activity($cm, stdClass $course, navigation_node $activity) {
2049         global $CFG, $DB;
2051         // make sure we have a $cm from get_fast_modinfo as this contains activity access details
2052         if (!($cm instanceof cm_info)) {
2053             $modinfo = get_fast_modinfo($course);
2054             $cm = $modinfo->get_cm($cm->id);
2055         }
2056         $activity->nodetype = navigation_node::NODETYPE_LEAF;
2057         $activity->make_active();
2058         $file = $CFG->dirroot.'/mod/'.$cm->modname.'/lib.php';
2059         $function = $cm->modname.'_extend_navigation';
2061         if (file_exists($file)) {
2062             require_once($file);
2063             if (function_exists($function)) {
2064                 $activtyrecord = $DB->get_record($cm->modname, array('id' => $cm->instance), '*', MUST_EXIST);
2065                 $function($activity, $course, $activtyrecord, $cm);
2066             }
2067         }
2069         // Allow the active advanced grading method plugin to append module navigation
2070         $featuresfunc = $cm->modname.'_supports';
2071         if (function_exists($featuresfunc) && $featuresfunc(FEATURE_ADVANCED_GRADING)) {
2072             require_once($CFG->dirroot.'/grade/grading/lib.php');
2073             $gradingman = get_grading_manager($cm->context, $cm->modname);
2074             $gradingman->extend_navigation($this, $activity);
2075         }
2077         return $activity->has_children();
2078     }
2079     /**
2080      * Loads user specific information into the navigation in the appropriate place.
2081      *
2082      * If no user is provided the current user is assumed.
2083      *
2084      * @param stdClass $user
2085      * @param bool $forceforcontext probably force something to be loaded somewhere (ask SamH if not sure what this means)
2086      * @return bool
2087      */
2088     protected function load_for_user($user=null, $forceforcontext=false) {
2089         global $DB, $CFG, $USER, $SITE;
2091         if ($user === null) {
2092             // We can't require login here but if the user isn't logged in we don't
2093             // want to show anything
2094             if (!isloggedin() || isguestuser()) {
2095                 return false;
2096             }
2097             $user = $USER;
2098         } else if (!is_object($user)) {
2099             // If the user is not an object then get them from the database
2100             $select = context_helper::get_preload_record_columns_sql('ctx');
2101             $sql = "SELECT u.*, $select
2102                       FROM {user} u
2103                       JOIN {context} ctx ON u.id = ctx.instanceid
2104                      WHERE u.id = :userid AND
2105                            ctx.contextlevel = :contextlevel";
2106             $user = $DB->get_record_sql($sql, array('userid' => (int)$user, 'contextlevel' => CONTEXT_USER), MUST_EXIST);
2107             context_helper::preload_from_record($user);
2108         }
2110         $iscurrentuser = ($user->id == $USER->id);
2112         $usercontext = context_user::instance($user->id);
2114         // Get the course set against the page, by default this will be the site
2115         $course = $this->page->course;
2116         $baseargs = array('id'=>$user->id);
2117         if ($course->id != $SITE->id && (!$iscurrentuser || $forceforcontext)) {
2118             $coursenode = $this->add_course($course, false, self::COURSE_CURRENT);
2119             $baseargs['course'] = $course->id;
2120             $coursecontext = context_course::instance($course->id);
2121             $issitecourse = false;
2122         } else {
2123             // Load all categories and get the context for the system
2124             $coursecontext = context_system::instance();
2125             $issitecourse = true;
2126         }
2128         // Create a node to add user information under.
2129         if ($iscurrentuser && !$forceforcontext) {
2130             // If it's the current user the information will go under the profile root node
2131             $usernode = $this->rootnodes['myprofile'];
2132             $course = get_site();
2133             $coursecontext = context_course::instance($course->id);
2134             $issitecourse = true;
2135         } else {
2136             if (!$issitecourse) {
2137                 // Not the current user so add it to the participants node for the current course
2138                 $usersnode = $coursenode->get('participants', navigation_node::TYPE_CONTAINER);
2139                 $userviewurl = new moodle_url('/user/view.php', $baseargs);
2140             } else {
2141                 // This is the site so add a users node to the root branch
2142                 $usersnode = $this->rootnodes['users'];
2143                 if (has_capability('moodle/course:viewparticipants', $coursecontext)) {
2144                     $usersnode->action = new moodle_url('/user/index.php', array('id'=>$course->id));
2145                 }
2146                 $userviewurl = new moodle_url('/user/profile.php', $baseargs);
2147             }
2148             if (!$usersnode) {
2149                 // We should NEVER get here, if the course hasn't been populated
2150                 // with a participants node then the navigaiton either wasn't generated
2151                 // for it (you are missing a require_login or set_context call) or
2152                 // you don't have access.... in the interests of no leaking informatin
2153                 // we simply quit...
2154                 return false;
2155             }
2156             // Add a branch for the current user
2157             $canseefullname = has_capability('moodle/site:viewfullnames', $coursecontext);
2158             $usernode = $usersnode->add(fullname($user, $canseefullname), $userviewurl, self::TYPE_USER, null, $user->id);
2160             if ($this->page->context->contextlevel == CONTEXT_USER && $user->id == $this->page->context->instanceid) {
2161                 $usernode->make_active();
2162             }
2163         }
2165         // If the user is the current user or has permission to view the details of the requested
2166         // user than add a view profile link.
2167         if ($iscurrentuser || has_capability('moodle/user:viewdetails', $coursecontext) || has_capability('moodle/user:viewdetails', $usercontext)) {
2168             if ($issitecourse || ($iscurrentuser && !$forceforcontext)) {
2169                 $usernode->add(get_string('viewprofile'), new moodle_url('/user/profile.php',$baseargs));
2170             } else {
2171                 $usernode->add(get_string('viewprofile'), new moodle_url('/user/view.php',$baseargs));
2172             }
2173         }
2175         if (!empty($CFG->navadduserpostslinks)) {
2176             // Add nodes for forum posts and discussions if the user can view either or both
2177             // There are no capability checks here as the content of the page is based
2178             // purely on the forums the current user has access too.
2179             $forumtab = $usernode->add(get_string('forumposts', 'forum'));
2180             $forumtab->add(get_string('posts', 'forum'), new moodle_url('/mod/forum/user.php', $baseargs));
2181             $forumtab->add(get_string('discussions', 'forum'), new moodle_url('/mod/forum/user.php', array_merge($baseargs, array('mode'=>'discussions'))));
2182         }
2184         // Add blog nodes
2185         if (!empty($CFG->enableblogs)) {
2186             if (!$this->cache->cached('userblogoptions'.$user->id)) {
2187                 require_once($CFG->dirroot.'/blog/lib.php');
2188                 // Get all options for the user
2189                 $options = blog_get_options_for_user($user);
2190                 $this->cache->set('userblogoptions'.$user->id, $options);
2191             } else {
2192                 $options = $this->cache->{'userblogoptions'.$user->id};
2193             }
2195             if (count($options) > 0) {
2196                 $blogs = $usernode->add(get_string('blogs', 'blog'), null, navigation_node::TYPE_CONTAINER);
2197                 foreach ($options as $type => $option) {
2198                     if ($type == "rss") {
2199                         $blogs->add($option['string'], $option['link'], settings_navigation::TYPE_SETTING, null, null, new pix_icon('i/rss', ''));
2200                     } else {
2201                         $blogs->add($option['string'], $option['link']);
2202                     }
2203                 }
2204             }
2205         }
2207         if (!empty($CFG->messaging)) {
2208             $messageargs = array('user1' => $USER->id);
2209             if ($USER->id != $user->id) {
2210                 $messageargs['user2'] = $user->id;
2211             }
2212             if ($course->id != $SITE->id) {
2213                 $messageargs['viewing'] = MESSAGE_VIEW_COURSE. $course->id;
2214             }
2215             $url = new moodle_url('/message/index.php',$messageargs);
2216             $usernode->add(get_string('messages', 'message'), $url, self::TYPE_SETTING, null, 'messages');
2217         }
2219         if ($iscurrentuser && has_capability('moodle/user:manageownfiles', context_user::instance($USER->id))) {
2220             $url = new moodle_url('/user/files.php');
2221             $usernode->add(get_string('myfiles'), $url, self::TYPE_SETTING);
2222         }
2224         if (!empty($CFG->enablebadges) && $iscurrentuser &&
2225                 has_capability('moodle/badges:manageownbadges', context_user::instance($USER->id))) {
2226             $url = new moodle_url('/badges/mybadges.php');
2227             $usernode->add(get_string('mybadges', 'badges'), $url, self::TYPE_SETTING);
2228         }
2230         // Add a node to view the users notes if permitted
2231         if (!empty($CFG->enablenotes) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $coursecontext)) {
2232             $url = new moodle_url('/notes/index.php',array('user'=>$user->id));
2233             if ($coursecontext->instanceid) {
2234                 $url->param('course', $coursecontext->instanceid);
2235             }
2236             $usernode->add(get_string('notes', 'notes'), $url);
2237         }
2239         // If the user is the current user add the repositories for the current user
2240         $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields));
2241         if ($iscurrentuser) {
2242             if (!$this->cache->cached('contexthasrepos'.$usercontext->id)) {
2243                 require_once($CFG->dirroot . '/repository/lib.php');
2244                 $editabletypes = repository::get_editable_types($usercontext);
2245                 $haseditabletypes = !empty($editabletypes);
2246                 unset($editabletypes);
2247                 $this->cache->set('contexthasrepos'.$usercontext->id, $haseditabletypes);
2248             } else {
2249                 $haseditabletypes = $this->cache->{'contexthasrepos'.$usercontext->id};
2250             }
2251             if ($haseditabletypes) {
2252                 $usernode->add(get_string('repositories', 'repository'), new moodle_url('/repository/manage_instances.php', array('contextid' => $usercontext->id)));
2253             }
2254         } else if ($course->id == $SITE->id && has_capability('moodle/user:viewdetails', $usercontext) && (!in_array('mycourses', $hiddenfields) || has_capability('moodle/user:viewhiddendetails', $coursecontext))) {
2256             // Add view grade report is permitted
2257             $reports = core_component::get_plugin_list('gradereport');
2258             arsort($reports); // user is last, we want to test it first
2260             $userscourses = enrol_get_users_courses($user->id);
2261             $userscoursesnode = $usernode->add(get_string('courses'));
2263             foreach ($userscourses as $usercourse) {
2264                 $usercoursecontext = context_course::instance($usercourse->id);
2265                 $usercourseshortname = format_string($usercourse->shortname, true, array('context' => $usercoursecontext));
2266                 $usercoursenode = $userscoursesnode->add($usercourseshortname, new moodle_url('/user/view.php', array('id'=>$user->id, 'course'=>$usercourse->id)), self::TYPE_CONTAINER);
2268                 $gradeavailable = has_capability('moodle/grade:viewall', $usercoursecontext);
2269                 if (!$gradeavailable && !empty($usercourse->showgrades) && is_array($reports) && !empty($reports)) {
2270                     foreach ($reports as $plugin => $plugindir) {
2271                         if (has_capability('gradereport/'.$plugin.':view', $usercoursecontext)) {
2272                             //stop when the first visible plugin is found
2273                             $gradeavailable = true;
2274                             break;
2275                         }
2276                     }
2277                 }
2279                 if ($gradeavailable) {
2280                     $url = new moodle_url('/grade/report/index.php', array('id'=>$usercourse->id));
2281                     $usercoursenode->add(get_string('grades'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/grades', ''));
2282                 }
2284                 // Add a node to view the users notes if permitted
2285                 if (!empty($CFG->enablenotes) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $usercoursecontext)) {
2286                     $url = new moodle_url('/notes/index.php',array('user'=>$user->id, 'course'=>$usercourse->id));
2287                     $usercoursenode->add(get_string('notes', 'notes'), $url, self::TYPE_SETTING);
2288                 }
2290                 if (can_access_course($usercourse, $user->id)) {
2291                     $usercoursenode->add(get_string('entercourse'), new moodle_url('/course/view.php', array('id'=>$usercourse->id)), self::TYPE_SETTING, null, null, new pix_icon('i/course', ''));
2292                 }
2294                 $reporttab = $usercoursenode->add(get_string('activityreports'));
2296                 $reports = get_plugin_list_with_function('report', 'extend_navigation_user', 'lib.php');
2297                 foreach ($reports as $reportfunction) {
2298                     $reportfunction($reporttab, $user, $usercourse);
2299                 }
2301                 $reporttab->trim_if_empty();
2302             }
2303         }
2304         return true;
2305     }
2307     /**
2308      * This method simply checks to see if a given module can extend the navigation.
2309      *
2310      * @todo (MDL-25290) A shared caching solution should be used to save details on what extends navigation.
2311      *
2312      * @param string $modname
2313      * @return bool
2314      */
2315     public static function module_extends_navigation($modname) {
2316         global $CFG;
2317         static $extendingmodules = array();
2318         if (!array_key_exists($modname, $extendingmodules)) {
2319             $extendingmodules[$modname] = false;
2320             $file = $CFG->dirroot.'/mod/'.$modname.'/lib.php';
2321             if (file_exists($file)) {
2322                 $function = $modname.'_extend_navigation';
2323                 require_once($file);
2324                 $extendingmodules[$modname] = (function_exists($function));
2325             }
2326         }
2327         return $extendingmodules[$modname];
2328     }
2329     /**
2330      * Extends the navigation for the given user.
2331      *
2332      * @param stdClass $user A user from the database
2333      */
2334     public function extend_for_user($user) {
2335         $this->extendforuser[] = $user;
2336     }
2338     /**
2339      * Returns all of the users the navigation is being extended for
2340      *
2341      * @return array An array of extending users.
2342      */
2343     public function get_extending_users() {
2344         return $this->extendforuser;
2345     }
2346     /**
2347      * Adds the given course to the navigation structure.
2348      *
2349      * @param stdClass $course
2350      * @param bool $forcegeneric
2351      * @param bool $ismycourse
2352      * @return navigation_node
2353      */
2354     public function add_course(stdClass $course, $forcegeneric = false, $coursetype = self::COURSE_OTHER) {
2355         global $CFG, $SITE;
2357         // We found the course... we can return it now :)
2358         if (!$forcegeneric && array_key_exists($course->id, $this->addedcourses)) {
2359             return $this->addedcourses[$course->id];
2360         }
2362         $coursecontext = context_course::instance($course->id);
2364         if ($course->id != $SITE->id && !$course->visible) {
2365             if (is_role_switched($course->id)) {
2366                 // user has to be able to access course in order to switch, let's skip the visibility test here
2367             } else if (!has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2368                 return false;
2369             }
2370         }
2372         $issite = ($course->id == $SITE->id);
2373         $shortname = format_string($course->shortname, true, array('context' => $coursecontext));
2374         $fullname = format_string($course->fullname, true, array('context' => $coursecontext));
2375         // This is the name that will be shown for the course.
2376         $coursename = empty($CFG->navshowfullcoursenames) ? $shortname : $fullname;
2378         if ($issite) {
2379             $parent = $this;
2380             $url = null;
2381             if (empty($CFG->usesitenameforsitepages)) {
2382                 $coursename = get_string('sitepages');
2383             }
2384         } else if ($coursetype == self::COURSE_CURRENT) {
2385             $parent = $this->rootnodes['currentcourse'];
2386             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
2387         } else if ($coursetype == self::COURSE_MY && !$forcegeneric) {
2388             if (!empty($CFG->navshowmycoursecategories) && ($parent = $this->rootnodes['mycourses']->find($course->category, self::TYPE_MY_CATEGORY))) {
2389                 // Nothing to do here the above statement set $parent to the category within mycourses.
2390             } else {
2391                 $parent = $this->rootnodes['mycourses'];
2392             }
2393             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
2394         } else {
2395             $parent = $this->rootnodes['courses'];
2396             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
2397             if (!empty($course->category) && $this->show_categories($coursetype == self::COURSE_MY)) {
2398                 if (!$this->is_category_fully_loaded($course->category)) {
2399                     // We need to load the category structure for this course
2400                     $this->load_all_categories($course->category, false);
2401                 }
2402                 if (array_key_exists($course->category, $this->addedcategories)) {
2403                     $parent = $this->addedcategories[$course->category];
2404                     // This could lead to the course being created so we should check whether it is the case again
2405                     if (!$forcegeneric && array_key_exists($course->id, $this->addedcourses)) {
2406                         return $this->addedcourses[$course->id];
2407                     }
2408                 }
2409             }
2410         }
2412         $coursenode = $parent->add($coursename, $url, self::TYPE_COURSE, $shortname, $course->id);
2413         $coursenode->nodetype = self::NODETYPE_BRANCH;
2414         $coursenode->hidden = (!$course->visible);
2415         // We need to decode &amp;'s here as they will have been added by format_string above and attributes will be encoded again
2416         // later.
2417         $coursenode->title(str_replace('&amp;', '&', $fullname));
2418         if (!$forcegeneric) {
2419             $this->addedcourses[$course->id] = $coursenode;
2420         }
2422         return $coursenode;
2423     }
2425     /**
2426      * Returns true if the category has already been loaded as have any child categories
2427      *
2428      * @param int $categoryid
2429      * @return bool
2430      */
2431     protected function is_category_fully_loaded($categoryid) {
2432         return (array_key_exists($categoryid, $this->addedcategories) && ($this->allcategoriesloaded || $this->addedcategories[$categoryid]->children->count() > 0));
2433     }
2435     /**
2436      * Adds essential course nodes to the navigation for the given course.
2437      *
2438      * This method adds nodes such as reports, blogs and participants
2439      *
2440      * @param navigation_node $coursenode
2441      * @param stdClass $course
2442      * @return bool returns true on successful addition of a node.
2443      */
2444     public function add_course_essentials($coursenode, stdClass $course) {
2445         global $CFG, $SITE;
2447         if ($course->id == $SITE->id) {
2448             return $this->add_front_page_course_essentials($coursenode, $course);
2449         }
2451         if ($coursenode == false || !($coursenode instanceof navigation_node) || $coursenode->get('participants', navigation_node::TYPE_CONTAINER)) {
2452             return true;
2453         }
2455         //Participants
2456         if (has_capability('moodle/course:viewparticipants', $this->page->context)) {
2457             $participants = $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id), self::TYPE_CONTAINER, get_string('participants'), 'participants');
2458             $currentgroup = groups_get_course_group($course, true);
2459             if ($course->id == $SITE->id) {
2460                 $filtervar = 'courseid';
2461                 $filterselect = '';
2462             } else if ($course->id && !$currentgroup) {
2463                 $filtervar = 'courseid';
2464                 $filterselect = $course->id;
2465             } else {
2466                 $filtervar = 'groupid';
2467                 $filterselect = $currentgroup;
2468             }
2469             $filterselect = clean_param($filterselect, PARAM_INT);
2470             if (($CFG->bloglevel == BLOG_GLOBAL_LEVEL or ($CFG->bloglevel == BLOG_SITE_LEVEL and (isloggedin() and !isguestuser())))
2471                and has_capability('moodle/blog:view', context_system::instance())) {
2472                 $blogsurls = new moodle_url('/blog/index.php', array($filtervar => $filterselect));
2473                 $participants->add(get_string('blogscourse','blog'), $blogsurls->out());
2474             }
2475             if (!empty($CFG->enablenotes) && (has_capability('moodle/notes:manage', $this->page->context) || has_capability('moodle/notes:view', $this->page->context))) {
2476                 $participants->add(get_string('notes','notes'), new moodle_url('/notes/index.php', array('filtertype'=>'course', 'filterselect'=>$course->id)));
2477             }
2478         } else if (count($this->extendforuser) > 0 || $this->page->course->id == $course->id) {
2479             $participants = $coursenode->add(get_string('participants'), null, self::TYPE_CONTAINER, get_string('participants'), 'participants');
2480         }
2482         // Badges.
2483         if (!empty($CFG->enablebadges) && !empty($CFG->badges_allowcoursebadges) &&
2484             has_capability('moodle/badges:viewbadges', $this->page->context)) {
2485             $url = new moodle_url('/badges/view.php', array('type' => 2, 'id' => $course->id));
2487             $coursenode->add(get_string('coursebadges', 'badges'), null,
2488                     navigation_node::TYPE_CONTAINER, null, 'coursebadges');
2489             $coursenode->get('coursebadges')->add(get_string('badgesview', 'badges'), $url,
2490                     navigation_node::TYPE_SETTING, null, 'badgesview',
2491                     new pix_icon('i/badge', get_string('badgesview', 'badges')));
2492         }
2494         return true;
2495     }
2496     /**
2497      * This generates the structure of the course that won't be generated when
2498      * the modules and sections are added.
2499      *
2500      * Things such as the reports branch, the participants branch, blogs... get
2501      * added to the course node by this method.
2502      *
2503      * @param navigation_node $coursenode
2504      * @param stdClass $course
2505      * @return bool True for successfull generation
2506      */
2507     public function add_front_page_course_essentials(navigation_node $coursenode, stdClass $course) {
2508         global $CFG;
2510         if ($coursenode == false || $coursenode->get('frontpageloaded', navigation_node::TYPE_CUSTOM)) {
2511             return true;
2512         }
2514         // Hidden node that we use to determine if the front page navigation is loaded.
2515         // This required as there are not other guaranteed nodes that may be loaded.
2516         $coursenode->add('frontpageloaded', null, self::TYPE_CUSTOM, null, 'frontpageloaded')->display = false;
2518         //Participants
2519         if (has_capability('moodle/course:viewparticipants',  context_system::instance())) {
2520             $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id), self::TYPE_CUSTOM, get_string('participants'), 'participants');
2521         }
2523         $filterselect = 0;
2525         // Blogs
2526         if (!empty($CFG->enableblogs)
2527           and ($CFG->bloglevel == BLOG_GLOBAL_LEVEL or ($CFG->bloglevel == BLOG_SITE_LEVEL and (isloggedin() and !isguestuser())))
2528           and has_capability('moodle/blog:view', context_system::instance())) {
2529             $blogsurls = new moodle_url('/blog/index.php', array('courseid' => $filterselect));
2530             $coursenode->add(get_string('blogssite','blog'), $blogsurls->out());
2531         }
2533         //Badges
2534         if (!empty($CFG->enablebadges) && has_capability('moodle/badges:viewbadges', $this->page->context)) {
2535             $url = new moodle_url($CFG->wwwroot . '/badges/view.php', array('type' => 1));
2536             $coursenode->add(get_string('sitebadges', 'badges'), $url, navigation_node::TYPE_CUSTOM);
2537         }
2539         // Notes
2540         if (!empty($CFG->enablenotes) && (has_capability('moodle/notes:manage', $this->page->context) || has_capability('moodle/notes:view', $this->page->context))) {
2541             $coursenode->add(get_string('notes','notes'), new moodle_url('/notes/index.php', array('filtertype'=>'course', 'filterselect'=>$filterselect)));
2542         }
2544         // Tags
2545         if (!empty($CFG->usetags) && isloggedin()) {
2546             $coursenode->add(get_string('tags', 'tag'), new moodle_url('/tag/search.php'));
2547         }
2549         if (isloggedin()) {
2550             // Calendar
2551             $calendarurl = new moodle_url('/calendar/view.php', array('view' => 'month'));
2552             $coursenode->add(get_string('calendar', 'calendar'), $calendarurl, self::TYPE_CUSTOM, null, 'calendar');
2553         }
2555         return true;
2556     }
2558     /**
2559      * Clears the navigation cache
2560      */
2561     public function clear_cache() {
2562         $this->cache->clear();
2563     }
2565     /**
2566      * Sets an expansion limit for the navigation
2567      *
2568      * The expansion limit is used to prevent the display of content that has a type
2569      * greater than the provided $type.
2570      *
2571      * Can be used to ensure things such as activities or activity content don't get
2572      * shown on the navigation.
2573      * They are still generated in order to ensure the navbar still makes sense.
2574      *
2575      * @param int $type One of navigation_node::TYPE_*
2576      * @return bool true when complete.
2577      */
2578     public function set_expansion_limit($type) {
2579         global $SITE;
2580         $nodes = $this->find_all_of_type($type);
2582         // We only want to hide specific types of nodes.
2583         // Only nodes that represent "structure" in the navigation tree should be hidden.
2584         // If we hide all nodes then we risk hiding vital information.
2585         $typestohide = array(
2586             self::TYPE_CATEGORY,
2587             self::TYPE_COURSE,
2588             self::TYPE_SECTION,
2589             self::TYPE_ACTIVITY
2590         );
2592         foreach ($nodes as $node) {
2593             // We need to generate the full site node
2594             if ($type == self::TYPE_COURSE && $node->key == $SITE->id) {
2595                 continue;
2596             }
2597             foreach ($node->children as $child) {
2598                 $child->hide($typestohide);
2599             }
2600         }
2601         return true;
2602     }
2603     /**
2604      * Attempts to get the navigation with the given key from this nodes children.
2605      *
2606      * This function only looks at this nodes children, it does NOT look recursivily.
2607      * If the node can't be found then false is returned.
2608      *
2609      * If you need to search recursivily then use the {@link global_navigation::find()} method.
2610      *
2611      * Note: If you are trying to set the active node {@link navigation_node::override_active_url()}
2612      * may be of more use to you.
2613      *
2614      * @param string|int $key The key of the node you wish to receive.
2615      * @param int $type One of navigation_node::TYPE_*
2616      * @return navigation_node|false
2617      */
2618     public function get($key, $type = null) {
2619         if (!$this->initialised) {
2620             $this->initialise();
2621         }
2622         return parent::get($key, $type);
2623     }
2625     /**
2626      * Searches this nodes children and their children to find a navigation node
2627      * with the matching key and type.
2628      *
2629      * This method is recursive and searches children so until either a node is
2630      * found or there are no more nodes to search.
2631      *
2632      * If you know that the node being searched for is a child of this node
2633      * then use the {@link global_navigation::get()} method instead.
2634      *
2635      * Note: If you are trying to set the active node {@link navigation_node::override_active_url()}
2636      * may be of more use to you.
2637      *
2638      * @param string|int $key The key of the node you wish to receive.
2639      * @param int $type One of navigation_node::TYPE_*
2640      * @return navigation_node|false
2641      */
2642     public function find($key, $type) {
2643         if (!$this->initialised) {
2644             $this->initialise();
2645         }
2646         if ($type == self::TYPE_ROOTNODE && array_key_exists($key, $this->rootnodes)) {
2647             return $this->rootnodes[$key];
2648         }
2649         return parent::find($key, $type);
2650     }
2652     /**
2653      * They've expanded the 'my courses' branch.
2654      */
2655     protected function load_courses_enrolled() {
2656         global $CFG, $DB;
2657         $sortorder = 'visible DESC';
2658         // Prevent undefined $CFG->navsortmycoursessort errors.
2659         if (empty($CFG->navsortmycoursessort)) {
2660             $CFG->navsortmycoursessort = 'sortorder';
2661         }
2662         // Append the chosen sortorder.
2663         $sortorder = $sortorder . ',' . $CFG->navsortmycoursessort . ' ASC';
2664         $courses = enrol_get_my_courses(null, $sortorder);
2665         if (count($courses) && $this->show_my_categories()) {
2666             // OK Actually we are loading categories. We only want to load categories that have a parent of 0.
2667             // In order to make sure we load everything required we must first find the categories that are not
2668             // base categories and work out the bottom category in thier path.
2669             $categoryids = array();
2670             foreach ($courses as $course) {
2671                 $categoryids[] = $course->category;
2672             }
2673             $categoryids = array_unique($categoryids);
2674             list($sql, $params) = $DB->get_in_or_equal($categoryids);
2675             $categories = $DB->get_recordset_select('course_categories', 'id '.$sql.' AND parent <> 0', $params, 'sortorder, id', 'id, path');
2676             foreach ($categories as $category) {
2677                 $bits = explode('/', trim($category->path,'/'));
2678                 $categoryids[] = array_shift($bits);
2679             }
2680             $categoryids = array_unique($categoryids);
2681             $categories->close();
2683             // Now we load the base categories.
2684             list($sql, $params) = $DB->get_in_or_equal($categoryids);
2685             $categories = $DB->get_recordset_select('course_categories', 'id '.$sql.' AND parent = 0', $params, 'sortorder, id');
2686             foreach ($categories as $category) {
2687                 $this->add_category($category, $this->rootnodes['mycourses'], self::TYPE_MY_CATEGORY);
2688             }
2689             $categories->close();
2690         } else {
2691             foreach ($courses as $course) {
2692                 $this->add_course($course, false, self::COURSE_MY);
2693             }
2694         }
2695     }
2698 /**
2699  * The global navigation class used especially for AJAX requests.
2700  *
2701  * The primary methods that are used in the global navigation class have been overriden
2702  * to ensure that only the relevant branch is generated at the root of the tree.
2703  * This can be done because AJAX is only used when the backwards structure for the
2704  * requested branch exists.
2705  * This has been done only because it shortens the amounts of information that is generated
2706  * which of course will speed up the response time.. because no one likes laggy AJAX.
2707  *
2708  * @package   core
2709  * @category  navigation
2710  * @copyright 2009 Sam Hemelryk
2711  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2712  */
2713 class global_navigation_for_ajax extends global_navigation {
2715     /** @var int used for determining what type of navigation_node::TYPE_* is being used */
2716     protected $branchtype;
2718     /** @var int the instance id */
2719     protected $instanceid;
2721     /** @var array Holds an array of expandable nodes */
2722     protected $expandable = array();
2724     /**
2725      * Constructs the navigation for use in an AJAX request
2726      *
2727      * @param moodle_page $page moodle_page object
2728      * @param int $branchtype
2729      * @param int $id
2730      */
2731     public function __construct($page, $branchtype, $id) {
2732         $this->page = $page;
2733         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
2734         $this->children = new navigation_node_collection();
2735         $this->branchtype = $branchtype;
2736         $this->instanceid = $id;
2737         $this->initialise();
2738     }
2739     /**
2740      * Initialise the navigation given the type and id for the branch to expand.
2741      *
2742      * @return array An array of the expandable nodes
2743      */
2744     public function initialise() {
2745         global $DB, $SITE;
2747         if ($this->initialised || during_initial_install()) {
2748             return $this->expandable;
2749         }
2750         $this->initialised = true;
2752         $this->rootnodes = array();
2753         $this->rootnodes['site']    = $this->add_course($SITE);
2754         $this->rootnodes['mycourses'] = $this->add(get_string('mycourses'), new moodle_url('/my'), self::TYPE_ROOTNODE, null, 'mycourses');
2755         $this->rootnodes['courses'] = $this->add(get_string('courses'), null, self::TYPE_ROOTNODE, null, 'courses');
2757         // Branchtype will be one of navigation_node::TYPE_*
2758         switch ($this->branchtype) {
2759             case 0:
2760                 if ($this->instanceid === 'mycourses') {
2761                     $this->load_courses_enrolled();
2762                 } else if ($this->instanceid === 'courses') {
2763                     $this->load_courses_other();
2764                 }
2765                 break;
2766             case self::TYPE_CATEGORY :
2767                 $this->load_category($this->instanceid);
2768                 break;
2769             case self::TYPE_MY_CATEGORY :
2770                 $this->load_category($this->instanceid, self::TYPE_MY_CATEGORY);
2771                 break;
2772             case self::TYPE_COURSE :
2773                 $course = $DB->get_record('course', array('id' => $this->instanceid), '*', MUST_EXIST);
2774                 require_course_login($course, true, null, false, true);
2775                 $this->page->set_context(context_course::instance($course->id));
2776                 $coursenode = $this->add_course($course);
2777                 $this->add_course_essentials($coursenode, $course);
2778                 $this->load_course_sections($course, $coursenode);
2779                 break;
2780             case self::TYPE_SECTION :
2781                 $sql = 'SELECT c.*, cs.section AS sectionnumber
2782                         FROM {course} c
2783                         LEFT JOIN {course_sections} cs ON cs.course = c.id
2784                         WHERE cs.id = ?';
2785                 $course = $DB->get_record_sql($sql, array($this->instanceid), MUST_EXIST);
2786                 require_course_login($course, true, null, false, true);
2787                 $this->page->set_context(context_course::instance($course->id));
2788                 $coursenode = $this->add_course($course);
2789                 $this->add_course_essentials($coursenode, $course);
2790                 $this->load_course_sections($course, $coursenode, $course->sectionnumber);
2791                 break;
2792             case self::TYPE_ACTIVITY :
2793                 $sql = "SELECT c.*
2794                           FROM {course} c
2795                           JOIN {course_modules} cm ON cm.course = c.id
2796                          WHERE cm.id = :cmid";
2797                 $params = array('cmid' => $this->instanceid);
2798                 $course = $DB->get_record_sql($sql, $params, MUST_EXIST);
2799                 $modinfo = get_fast_modinfo($course);
2800                 $cm = $modinfo->get_cm($this->instanceid);
2801                 require_course_login($course, true, $cm, false, true);
2802                 $this->page->set_context(context_module::instance($cm->id));
2803                 $coursenode = $this->load_course($course);
2804                 if ($course->id != $SITE->id) {
2805                     $this->load_course_sections($course, $coursenode, null, $cm);
2806                 }
2807                 $modulenode = $this->load_activity($cm, $course, $coursenode->find($cm->id, self::TYPE_ACTIVITY));
2808                 break;
2809             default:
2810                 throw new Exception('Unknown type');
2811                 return $this->expandable;
2812         }
2814         if ($this->page->context->contextlevel == CONTEXT_COURSE && $this->page->context->instanceid != $SITE->id) {
2815             $this->load_for_user(null, true);
2816         }
2818         $this->find_expandable($this->expandable);
2819         return $this->expandable;
2820     }
2822     /**
2823      * They've expanded the general 'courses' branch.
2824      */
2825     protected function load_courses_other() {
2826         $this->load_all_courses();
2827     }
2829     /**
2830      * Loads a single category into the AJAX navigation.
2831      *
2832      * This function is special in that it doesn't concern itself with the parent of
2833      * the requested category or its siblings.
2834      * This is because with the AJAX navigation we know exactly what is wanted and only need to
2835      * request that.
2836      *
2837      * @global moodle_database $DB
2838      * @param int $categoryid id of category to load in navigation.
2839      * @param int $nodetype type of node, if category is under MyHome then it's TYPE_MY_CATEGORY
2840      * @return void.
2841      */
2842     protected function load_category($categoryid, $nodetype = self::TYPE_CATEGORY) {
2843         global $CFG, $DB;
2845         $limit = 20;
2846         if (!empty($CFG->navcourselimit)) {
2847             $limit = (int)$CFG->navcourselimit;
2848         }
2850         $catcontextsql = context_helper::get_preload_record_columns_sql('ctx');
2851         $sql = "SELECT cc.*, $catcontextsql
2852                   FROM {course_categories} cc
2853                   JOIN {context} ctx ON cc.id = ctx.instanceid
2854                  WHERE ctx.contextlevel = ".CONTEXT_COURSECAT." AND
2855                        (cc.id = :categoryid1 OR cc.parent = :categoryid2)
2856               ORDER BY cc.depth ASC, cc.sortorder ASC, cc.id ASC";
2857         $params = array('categoryid1' => $categoryid, 'categoryid2' => $categoryid);
2858         $categories = $DB->get_recordset_sql($sql, $params, 0, $limit);
2859         $categorylist = array();
2860         $subcategories = array();
2861         $basecategory = null;
2862         foreach ($categories as $category) {
2863             $categorylist[] = $category->id;
2864             context_helper::preload_from_record($category);
2865             if ($category->id == $categoryid) {
2866                 $this->add_category($category, $this, $nodetype);
2867                 $basecategory = $this->addedcategories[$category->id];
2868             } else {
2869                 $subcategories[$category->id] = $category;
2870             }
2871         }
2872         $categories->close();
2875         // If category is shown in MyHome then only show enrolled courses and hide empty subcategories,
2876         // else show all courses.
2877         if ($nodetype === self::TYPE_MY_CATEGORY) {
2878             $courses = enrol_get_my_courses();
2879             $categoryids = array();
2881             // Only search for categories if basecategory was found.
2882             if (!is_null($basecategory)) {
2883                 // Get course parent category ids.
2884                 foreach ($courses as $course) {
2885                     $categoryids[] = $course->category;
2886                 }
2888                 // Get a unique list of category ids which a part of the path
2889                 // to user's courses.
2890                 $coursesubcategories = array();
2891                 $addedsubcategories = array();
2893                 list($sql, $params) = $DB->get_in_or_equal($categoryids);
2894                 $categories = $DB->get_recordset_select('course_categories', 'id '.$sql, $params, 'sortorder, id', 'id, path');
2896                 foreach ($categories as $category){
2897                     $coursesubcategories = array_merge($coursesubcategories, explode('/', trim($category->path, "/")));
2898                 }
2899                 $coursesubcategories = array_unique($coursesubcategories);
2901                 // Only add a subcategory if it is part of the path to user's course and
2902                 // wasn't already added.
2903                 foreach ($subcategories as $subid => $subcategory) {
2904                     if (in_array($subid, $coursesubcategories) &&
2905                             !in_array($subid, $addedsubcategories)) {
2906                             $this->add_category($subcategory, $basecategory, $nodetype);
2907                             $addedsubcategories[] = $subid;
2908                     }
2909                 }
2910             }
2912             foreach ($courses as $course) {
2913                 // Add course if it's in category.
2914                 if (in_array($course->category, $categorylist)) {
2915                     $this->add_course($course, true, self::COURSE_MY);
2916                 }
2917             }
2918         } else {
2919             if (!is_null($basecategory)) {
2920                 foreach ($subcategories as $key=>$category) {
2921                     $this->add_category($category, $basecategory, $nodetype);
2922                 }
2923             }
2924             $courses = $DB->get_recordset('course', array('category' => $categoryid), 'sortorder', '*' , 0, $limit);
2925             foreach ($courses as $course) {
2926                 $this->add_course($course);
2927             }
2928             $courses->close();
2929         }
2930     }
2932     /**
2933      * Returns an array of expandable nodes
2934      * @return array
2935      */
2936     public function get_expandable() {
2937         return $this->expandable;
2938     }
2941 /**
2942  * Navbar class
2943  *
2944  * This class is used to manage the navbar, which is initialised from the navigation
2945  * object held by PAGE
2946  *
2947  * @package   core
2948  * @category  navigation
2949  * @copyright 2009 Sam Hemelryk
2950  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2951  */
2952 class navbar extends navigation_node {
2953     /** @var bool A switch for whether the navbar is initialised or not */
2954     protected $initialised = false;
2955     /** @var mixed keys used to reference the nodes on the navbar */
2956     protected $keys = array();
2957     /** @var null|string content of the navbar */
2958     protected $content = null;
2959     /** @var moodle_page object the moodle page that this navbar belongs to */
2960     protected $page;
2961     /** @var bool A switch for whether to ignore the active navigation information */
2962     protected $ignoreactive = false;
2963     /** @var bool A switch to let us know if we are in the middle of an install */
2964     protected $duringinstall = false;
2965     /** @var bool A switch for whether the navbar has items */
2966     protected $hasitems = false;
2967     /** @var array An array of navigation nodes for the navbar */
2968     protected $items;
2969     /** @var array An array of child node objects */
2970     public $children = array();
2971     /** @var bool A switch for whether we want to include the root node in the navbar */
2972     public $includesettingsbase = false;
2973     /** @var navigation_node[] $prependchildren */
2974     protected $prependchildren = array();
2975     /**
2976      * The almighty constructor
2977      *
2978      * @param moodle_page $page
2979      */
2980     public function __construct(moodle_page $page) {
2981         global $CFG;
2982         if (during_initial_install()) {
2983             $this->duringinstall = true;
2984             return false;
2985         }
2986         $this->page = $page;
2987         $this->text = get_string('home');
2988         $this->shorttext = get_string('home');
2989         $this->action = new moodle_url($CFG->wwwroot);
2990         $this->nodetype = self::NODETYPE_BRANCH;
2991         $this->type = self::TYPE_SYSTEM;
2992     }
2994     /**
2995      * Quick check to see if the navbar will have items in.
2996      *
2997      * @return bool Returns true if the navbar will have items, false otherwise
2998      */
2999     public function has_items() {
3000         if ($this->duringinstall) {
3001             return false;
3002         } else if ($this->hasitems !== false) {
3003             return true;
3004         }
3005         $this->page->navigation->initialise($this->page);
3007         $activenodefound = ($this->page->navigation->contains_active_node() ||
3008                             $this->page->settingsnav->contains_active_node());
3010         $outcome = (count($this->children) > 0 || count($this->prependchildren) || (!$this->ignoreactive && $activenodefound));
3011         $this->hasitems = $outcome;
3012         return $outcome;
3013     }
3015     /**
3016      * Turn on/off ignore active
3017      *
3018      * @param bool $setting
3019      */
3020     public function ignore_active($setting=true) {
3021         $this->ignoreactive = ($setting);
3022     }
3024     /**
3025      * Gets a navigation node
3026      *
3027      * @param string|int $key for referencing the navbar nodes
3028      * @param int $type navigation_node::TYPE_*
3029      * @return navigation_node|bool
3030      */
3031     public function get($key, $type = null) {
3032         foreach ($this->children as &$child) {
3033             if ($child->key === $key && ($type == null || $type == $child->type)) {
3034                 return $child;
3035             }
3036         }
3037         foreach ($this->prependchildren as &$child) {
3038             if ($child->key === $key && ($type == null || $type == $child->type)) {
3039                 return $child;
3040             }
3041         }
3042         return false;
3043     }
3044     /**
3045      * Returns an array of navigation_node's that make up the navbar.
3046      *
3047      * @return array
3048      */
3049     public function get_items() {
3050         global $CFG;
3051         $items = array();
3052         // Make sure that navigation is initialised
3053         if (!$this->has_items()) {
3054             return $items;
3055         }
3056         if ($this->items !== null) {
3057             return $this->items;
3058         }
3060         if (count($this->children) > 0) {
3061             // Add the custom children.
3062             $items = array_reverse($this->children);
3063         }
3065         $navigationactivenode = $this->page->navigation->find_active_node();
3066         $settingsactivenode = $this->page->settingsnav->find_active_node();
3068         // Check if navigation contains the active node
3069         if (!$this->ignoreactive) {
3071             if ($navigationactivenode && $settingsactivenode) {
3072                 // Parse a combined navigation tree
3073                 while ($settingsactivenode && $settingsactivenode->parent !== null) {
3074                     if (!$settingsactivenode->mainnavonly) {
3075                         $items[] = $settingsactivenode;
3076                     }
3077                     $settingsactivenode = $settingsactivenode->parent;
3078                 }
3079                 if (!$this->includesettingsbase) {
3080                     // Removes the first node from the settings (root node) from the list
3081                     array_pop($items);
3082                 }
3083                 while ($navigationactivenode && $navigationactivenode->parent !== null) {
3084                     if (!$navigationactivenode->mainnavonly) {
3085                         $items[] = $navigationactivenode;
3086                     }
3087                     if (!empty($CFG->navshowcategories) &&
3088                             $navigationactivenode->type === self::TYPE_COURSE &&
3089                             $navigationactivenode->parent->key === 'currentcourse') {
3090                         $items = array_merge($items, $this->get_course_categories());
3091                     }
3092                     $navigationactivenode = $navigationactivenode->parent;
3093                 }
3094             } else if ($navigationactivenode) {
3095                 // Parse the navigation tree to get the active node
3096                 while ($navigationactivenode && $navigationactivenode->parent !== null) {
3097                     if (!$navigationactivenode->mainnavonly) {
3098                         $items[] = $navigationactivenode;
3099                     }
3100                     if (!empty($CFG->navshowcategories) &&
3101                             $navigationactivenode->type === self::TYPE_COURSE &&
3102                             $navigationactivenode->parent->key === 'currentcourse') {
3103                         $items = array_merge($items, $this->get_course_categories());
3104                     }
3105                     $navigationactivenode = $navigationactivenode->parent;
3106                 }
3107             } else if ($settingsactivenode) {
3108                 // Parse the settings navigation to get the active node
3109                 while ($settingsactivenode && $settingsactivenode->parent !== null) {
3110                     if (!$settingsactivenode->mainnavonly) {
3111                         $items[] = $settingsactivenode;
3112                     }
3113                     $settingsactivenode = $settingsactivenode->parent;
3114                 }
3115             }
3116         }
3118         $items[] = new navigation_node(array(
3119             'text'=>$this->page->navigation->text,
3120             'shorttext'=>$this->page->navigation->shorttext,
3121             'key'=>$this->page->navigation->key,
3122             'action'=>$this->page->navigation->action
3123         ));
3125         if (count($this->prependchildren) > 0) {
3126             // Add the custom children
3127             $items = array_merge($items, array_reverse($this->prependchildren));
3128         }
3130         $this->items = array_reverse($items);
3131         return $this->items;
3132     }
3134     /**
3135      * Get the list of categories leading to this course.
3136      *
3137      * This function is used by {@link navbar::get_items()} to add back the "courses"
3138      * node and category chain leading to the current course.  Note that this is only ever
3139      * called for the current course, so we don't need to bother taking in any parameters.
3140      *
3141      * @return array
3142      */
3143     private function get_course_categories() {
3144         global $CFG;
3146         require_once($CFG->dirroot.'/course/lib.php');
3147         $categories = array();
3148         $cap = 'moodle/category:viewhiddencategories';
3149         foreach ($this->page->categories as $category) {
3150             if (!$category->visible && !has_capability($cap, get_category_or_system_context($category->parent))) {
3151                 continue;
3152             }
3153             $url = new moodle_url('/course/index.php', array('categoryid' => $category->id));
3154             $name = format_string($category->name, true, array('context' => context_coursecat::instance($category->id)));
3155             $categorynode = navigation_node::create($name, $url, self::TYPE_CATEGORY, null, $category->id);
3156             if (!$category->visible) {
3157                 $categorynode->hidden = true;
3158             }
3159             $categories[] = $categorynode;
3160         }
3161         if (is_enrolled(context_course::instance($this->page->course->id))) {
3162             $courses = $this->page->navigation->get('mycourses');
3163         } else {
3164             $courses = $this->page->navigation->get('courses');
3165         }
3166         if (!$courses) {
3167             // Courses node may not be present.
3168             $courses = navigation_node::create(
3169                 get_string('courses'),
3170                 new moodle_url('/course/index.php'),
3171                 self::TYPE_CONTAINER
3172             );
3173         }
3174         $categories[] = $courses;
3175         return $categories;
3176     }
3178     /**
3179      * Add a new navigation_node to the navbar, overrides parent::add
3180      *
3181      * This function overrides {@link navigation_node::add()} so that we can change
3182      * the way nodes get added to allow us to simply call add and have the node added to the
3183      * end of the navbar
3184      *
3185      * @param string $text
3186      * @param string|moodle_url|action_link $action An action to associate with this node.
3187      * @param int $type One of navigation_node::TYPE_*
3188      * @param string $shorttext
3189      * @param string|int $key A key to identify this node with. Key + type is unique to a parent.
3190      * @param pix_icon $icon An optional icon to use for this node.
3191      * @return navigation_node
3192      */
3193     public function add($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, pix_icon $icon=null) {
3194         if ($this->content !== null) {
3195             debugging('Nav bar items must be printed before $OUTPUT->header() has been called', DEBUG_DEVELOPER);
3196         }
3198         // Properties array used when creating the new navigation node
3199         $itemarray = array(
3200             'text' => $text,
3201             'type' => $type
3202         );
3203         // Set the action if one was provided
3204         if ($action!==null) {
3205             $itemarray['action'] = $action;
3206         }
3207         // Set the shorttext if one was provided
3208         if ($shorttext!==null) {
3209             $itemarray['shorttext'] = $shorttext;
3210         }
3211         // Set the icon if one was provided
3212         if ($icon!==null) {
3213             $itemarray['icon'] = $icon;
3214         }
3215         // Default the key to the number of children if not provided
3216         if ($key === null) {
3217             $key = count($this->children);
3218         }
3219         // Set the key
3220         $itemarray['key'] = $key;
3221         // Set the parent to this node
3222         $itemarray['parent'] = $this;
3223         // Add the child using the navigation_node_collections add method
3224         $this->children[] = new navigation_node($itemarray);
3225         return $this;
3226     }
3228     /**
3229      * Prepends a new navigation_node to the start of the navbar
3230      *
3231      * @param string $text
3232      * @param string|moodle_url|action_link $action An action to associate with this node.
3233      * @param int $type One of navigation_node::TYPE_*
3234      * @param string $shorttext
3235      * @param string|int $key A key to identify this node with. Key + type is unique to a parent.
3236      * @param pix_icon $icon An optional icon to use for this node.
3237      * @return navigation_node
3238      */
3239     public function prepend($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, pix_icon $icon=null) {
3240         if ($this->content !== null) {
3241             debugging('Nav bar items must be printed before $OUTPUT->header() has been called', DEBUG_DEVELOPER);
3242         }
3243         // Properties array used when creating the new navigation node.
3244         $itemarray = array(
3245             'text' => $text,
3246             'type' => $type
3247         );
3248         // Set the action if one was provided.
3249         if ($action!==null) {
3250             $itemarray['action'] = $action;
3251         }
3252         // Set the shorttext if one was provided.
3253         if ($shorttext!==null) {
3254             $itemarray['shorttext'] = $shorttext;
3255         }
3256         // Set the icon if one was provided.
3257         if ($icon!==null) {
3258             $itemarray['icon'] = $icon;
3259         }
3260         // Default the key to the number of children if not provided.
3261         if ($key === null) {
3262             $key = count($this->children);
3263         }
3264         // Set the key.
3265         $itemarray['key'] = $key;
3266         // Set the parent to this node.
3267         $itemarray['parent'] = $this;
3268         // Add the child node to the prepend list.
3269         $this->prependchildren[] = new navigation_node($itemarray);
3270         return $this;
3271     }
3274 /**
3275  * Class used to manage the settings option for the current page
3276  *
3277  * This class is used to manage the settings options in a tree format (recursively)
3278  * and was created initially for use with the settings blocks.
3279  *
3280  * @package   core
3281  * @category  navigation
3282  * @copyright 2009 Sam Hemelryk
3283  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3284  */
3285 class settings_navigation extends navigation_node {
3286     /** @var stdClass the current context */
3287     protected $context;
3288     /** @var moodle_page the moodle page that the navigation belongs to */
3289     protected $page;
3290     /** @var string contains administration section navigation_nodes */
3291     protected $adminsection;
3292     /** @var bool A switch to see if the navigation node is initialised */
3293     protected $initialised = false;
3294     /** @var array An array of users that the nodes can extend for. */
3295     protected $userstoextendfor = array();
3296     /** @var navigation_cache **/
3297     protected $cache;