2 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
18 * This file contains classes used to manage the navigation structures within Moodle.
22 * @copyright 2009 Sam Hemelryk
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26 defined('MOODLE_INTERNAL') ||
die();
29 * The name that will be used to separate the navigation cache within SESSION
31 define('NAVIGATION_CACHE_NAME', 'navigation');
32 define('NAVIGATION_SITE_ADMIN_CACHE_NAME', 'navigationsiteadmin');
35 * This class is used to represent a node in a navigation tree
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.
44 * @category navigation
45 * @copyright 2009 Sam Hemelryk
46 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
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 */
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 */
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] */
90 /** @var string|int The identifier for the node, used to retrieve the node */
92 /** @var string The text to use for the node */
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 */
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 */
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;
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;
146 * Constructs a new navigation_node
148 * @param array|string $properties Either an array of properties or a string to use
149 * as the text for the node
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'];
164 if (array_key_exists('shorttext', $properties)) {
165 $this->shorttext
= $properties['shorttext'];
167 if (!array_key_exists('icon', $properties)) {
168 $properties['icon'] = new pix_icon('i/navigationitem', '');
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';
175 $this->icon
->attributes
['class'] .= ' navicon';
178 if (array_key_exists('type', $properties)) {
179 $this->type
= $properties['type'];
181 $this->type
= self
::TYPE_CUSTOM
;
183 if (array_key_exists('key', $properties)) {
184 $this->key
= $properties['key'];
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
);
192 if (self
::$autofindactive) {
193 $this->check_if_active();
196 if (array_key_exists('parent', $properties)) {
197 $this->set_parent($properties['parent']);
199 } else if (is_string($properties)) {
200 $this->text
= $properties;
202 if ($this->text
=== null) {
203 throw new coding_exception('You must set the text for the node when you create it.');
205 // Instantiate a new navigation node collection for this nodes children
206 $this->children
= new navigation_node_collection();
210 * Checks if this node is the active node.
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.
215 * @param int $strength One of URL_MATCH_EXACT, URL_MATCH_PARAMS, or URL_MATCH_BASE
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
));
225 self
::override_active_url(new moodle_url($FULLME));
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();
238 * This sets the URL that the URL of new nodes get compared to when locating
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.
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
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;
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.
262 public static function require_admin_tree() {
263 self
::$loadadmintree = true;
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
272 * @param string $shorttext
273 * @param string|int $key
274 * @param pix_icon $icon
275 * @return navigation_node
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
284 // Set the action if one was provided
285 if ($action!==null) {
286 $itemarray['action'] = $action;
288 // Set the shorttext if one was provided
289 if ($shorttext!==null) {
290 $itemarray['shorttext'] = $shorttext;
292 // Set the icon if one was provided
294 $itemarray['icon'] = $icon;
297 $itemarray['key'] = $key;
298 // Construct and return
299 return new navigation_node($itemarray);
303 * Adds a navigation node as a child of this node.
305 * @param string $text
306 * @param moodle_url|action_link $action
308 * @param string $shorttext
309 * @param string|int $key
310 * @param pix_icon $icon
311 * @return navigation_node
313 public function add($text, $action=null, $type=self
::TYPE_CUSTOM
, $shorttext=null, $key=null, pix_icon
$icon=null) {
315 $childnode = self
::create($text, $action, $type, $shorttext, $key, $icon);
317 // Add the child to end and return
318 return $this->add_node($childnode);
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
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
;
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();
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
;
351 // If this node is hidden mark it's children as hidden also
353 $node->hidden
= true;
355 // Return added node (reference returned by $this->children->add()
360 * Return a list of all the keys of all the child nodes.
361 * @return array the keys.
363 public function get_children_key_list() {
364 return $this->children
->get_key_list();
368 * Searches for a node of the given type with the given key.
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.
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
378 public function find($key, $type) {
379 return $this->children
->find($key, $type);
383 * Get the child of this node that has the given key + (optional) type.
385 * If you are looking for a node and want to search all children + thier children
386 * then please use the find method instead.
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
392 public function get($key, $type=null) {
393 return $this->children
->get($key, $type);
401 public function remove() {
402 return $this->parent
->children
->remove($this->key
, $this->type
);
406 * Checks if this node has or could have any children
408 * @return bool Returns true if it has children or could have (by AJAX expansion)
410 public function has_children() {
411 return ($this->nodetype
=== navigation_node
::NODETYPE_BRANCH ||
$this->children
->count()>0 ||
$this->isexpandable
);
415 * Marks this node as active and forces it open.
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.
422 public function make_active() {
423 $this->isactive
= true;
424 $this->add_class('active_tree_node');
426 if ($this->parent
!== null) {
427 $this->parent
->make_inactive();
432 * Marks a node as inactive and recusised back to the base of the tree
433 * doing the same to all parents.
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();
444 * Forces this node to be open and at the same time forces open all
445 * parents until the root node.
449 public function force_open() {
450 $this->forceopen
= true;
451 if ($this->parent
!== null) {
452 $this->parent
->force_open();
457 * Adds a CSS class to this node.
459 * @param string $class
462 public function add_class($class) {
463 if (!in_array($class, $this->classes
)) {
464 $this->classes
[] = $class;
470 * Removes a CSS class from this node.
472 * @param string $class
473 * @return bool True if the class was successfully removed.
475 public function remove_class($class) {
476 if (in_array($class, $this->classes
)) {
477 $key = array_search($class,$this->classes
);
479 unset($this->classes
[$key]);
487 * Sets the title for this node and forces Moodle to utilise it.
488 * @param string $title
490 public function title($title) {
491 $this->title
= $title;
492 $this->forcetitle
= true;
496 * Resets the page specific information on this node if it is being unserialised.
498 public function __wakeup(){
499 $this->forceopen
= false;
500 $this->isactive
= false;
501 $this->remove_class('active_tree_node');
505 * Checks if this node or any of its children contain the active node.
511 public function contains_active_node() {
512 if ($this->isactive
) {
515 foreach ($this->children
as $child) {
516 if ($child->isactive ||
$child->contains_active_node()) {
525 * Finds the active node.
527 * Searches this nodes children plus all of the children for the active node
528 * and returns it if found.
532 * @return navigation_node|false
534 public function find_active_node() {
535 if ($this->isactive
) {
538 foreach ($this->children
as &$child) {
539 $outcome = $child->find_active_node();
540 if ($outcome !== false) {
549 * Searches all children for the best matching active node
550 * @return navigation_node|false
552 public function search_for_active_node() {
553 if ($this->check_if_active(URL_MATCH_BASE
)) {
556 foreach ($this->children
as &$child) {
557 $outcome = $child->search_for_active_node();
558 if ($outcome !== false) {
567 * Gets the content for this node.
569 * @param bool $shorttext If true shorttext is used rather than the normal text
572 public function get_content($shorttext=false) {
573 if ($shorttext && $this->shorttext
!==null) {
574 return format_string($this->shorttext
);
576 return format_string($this->text
);
581 * Gets the title to use for this node.
585 public function get_title() {
586 if ($this->forcetitle ||
$this->action
!= null){
594 * Gets the CSS class to add to this node to describe its type
598 public function get_css_type() {
599 if (array_key_exists($this->type
, $this->namedtypes
)) {
600 return 'type_'.$this->namedtypes
[$this->type
];
602 return 'type_unknown';
606 * Finds all nodes that are expandable by AJAX
608 * @param array $expandable An array by reference to populate with expandable nodes.
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
);
617 $child->find_expandable($expandable);
622 * Finds all nodes of a given type (recursive)
624 * @param int $type One of navigation_node::TYPE_*
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);
637 * Removes this node if it is empty
639 public function trim_if_empty() {
640 if ($this->children
->count() == 0) {
646 * Creates a tab representation of this nodes children that can be used
647 * with print_tabs to produce the tabs on a page.
649 * call_user_func_array('print_tabs', $node->get_tabs_array());
651 * @param array $inactive
652 * @param bool $return
653 * @return array Array (tabs, selected, inactive, activated, return)
655 public function get_tabs_array(array $inactive=array(), $return=false) {
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
;
669 $rows[] = new tabobject($child->key
, $child->action
, $child->get_content(), $child->get_title());
672 $selected = $node->key
;
676 return array(array($tabs, $rows), $selected, $inactive, $activated, $return);
680 * Sets the parent for this node and if this node is active ensures that the tree is properly
683 * @param navigation_node $parent
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();
698 * Hides the node and any children it has.
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.
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);
719 * Navigation node collection
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
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.
730 * @category navigation
731 * @copyright 2010 Sam Hemelryk
732 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
734 class navigation_node_collection
implements IteratorAggregate
{
736 * A multidimensional array to where the first key is the type and the second
737 * key is the nodes key.
740 protected $collection = array();
742 * An array that contains references to nodes in the same order they were added.
743 * This is maintained as a progressive array.
746 protected $orderedcollection = array();
748 * A reference to the last node that was added to the collection
749 * @var navigation_node
751 protected $last = null;
753 * The total number of items added to this array.
756 protected $count = 0;
759 * Adds a navigation node to the collection
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
766 public function add(navigation_node
$node, $beforekey=null) {
771 // First check we have a 2nd dimension for this type
772 if (!array_key_exists($type, $this->orderedcollection
)) {
773 $this->orderedcollection
[$type] = array();
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
);
780 // Find the key to add before
781 $newindex = $this->count
;
783 if ($beforekey !== null) {
784 foreach ($this->collection
as $index => $othernode) {
785 if ($othernode->key
=== $beforekey) {
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
);
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;
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];
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
814 ksort($this->collection
);
817 // Return the reference to the now added node
822 * Return a list of all the keys of all the nodes.
823 * @return array the keys.
825 public function get_key_list() {
827 foreach ($this->collection
as $node) {
828 $keys[] = $node->key
;
834 * Fetches a node from this collection.
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
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];
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) {
858 * Searches for a node with matching key and type.
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.
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
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];
873 $nodes = $this->getIterator();
874 // Search immediate children first
875 foreach ($nodes as &$node) {
876 if ($node->key
=== $key && ($type === null ||
$type === $node->type
)) {
880 // Now search each childs children
881 foreach ($nodes as &$node) {
882 $result = $node->children
->find($key, $type);
883 if ($result !== false) {
892 * Fetches the last node that was added to this collection
894 * @return navigation_node
896 public function last() {
901 * Fetches all nodes of a given type from this collection
903 * @param string|int $type node type being searched for.
904 * @return array ordered collection
906 public function type($type) {
907 if (!array_key_exists($type, $this->orderedcollection
)) {
908 $this->orderedcollection
[$type] = array();
910 return $this->orderedcollection
[$type];
913 * Removes the node with the given key and type from the collection
915 * @param string|int $key The key of the node we want to find.
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
);
929 unset($this->orderedcollection
[$child->type
][$child->key
]);
937 * Gets the number of nodes in this collection
939 * This option uses an internal count rather than counting the actual options to avoid
940 * a performance hit through the count function.
944 public function count() {
948 * Gets an array iterator for the collection.
950 * This is required by the IteratorAggregator interface and is used by routines
951 * such as the foreach loop.
953 * @return ArrayIterator
955 public function getIterator() {
956 return new ArrayIterator($this->collection
);
961 * The global navigation class used for... the global navigation
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
967 * {@link lib/pagelib.php} {@link moodle_page::initialise_theme_and_output()}
968 * {@link lib/ajax/getnavbranch.php} Called by ajax
971 * @category navigation
972 * @copyright 2009 Sam Hemelryk
973 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
975 class global_navigation
extends navigation_node
{
976 /** @var moodle_page The Moodle page this navigation object belongs to. */
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 */
994 /** @var array An array of course ids that are present in the navigation */
995 protected $addedcourses = array();
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;
1004 /** @var cache_session A cache that stores information on expanded courses */
1005 protected $cacheexpandcourse = null;
1007 /** Used when loading categories to load all top level categories [parent = 0] **/
1008 const LOAD_ROOT_CATEGORIES
= 0;
1009 /** Used when loading categories to load all categories **/
1010 const LOAD_ALL_CATEGORIES
= -1;
1013 * Constructs a new global navigation
1015 * @param moodle_page $page The page this navigation object belongs to
1017 public function __construct(moodle_page
$page) {
1018 global $CFG, $SITE, $USER;
1020 if (during_initial_install()) {
1024 if (get_home_page() == HOMEPAGE_SITE
) {
1025 // We are using the site home for the root element
1026 $properties = array(
1028 'type' => navigation_node
::TYPE_SYSTEM
,
1029 'text' => get_string('home'),
1030 'action' => new moodle_url('/')
1033 // We are using the users my moodle for the root element
1034 $properties = array(
1036 'type' => navigation_node
::TYPE_SYSTEM
,
1037 'text' => get_string('myhome'),
1038 'action' => new moodle_url('/my/')
1042 // Use the parents constructor.... good good reuse
1043 parent
::__construct($properties);
1045 // Initalise and set defaults
1046 $this->page
= $page;
1047 $this->forceopen
= true;
1048 $this->cache
= new navigation_cache(NAVIGATION_CACHE_NAME
);
1052 * Mutator to set userid to allow parent to see child's profile
1053 * page navigation. See MDL-25805 for initial issue. Linked to it
1054 * is an issue explaining why this is a REALLY UGLY HACK thats not
1057 * @param int $userid userid of profile page that parent wants to navigate around.
1059 public function set_userid_for_parent_checks($userid) {
1060 $this->useridtouseforparentchecks
= $userid;
1065 * Initialises the navigation object.
1067 * This causes the navigation object to look at the current state of the page
1068 * that it is associated with and then load the appropriate content.
1070 * This should only occur the first time that the navigation structure is utilised
1071 * which will normally be either when the navbar is called to be displayed or
1072 * when a block makes use of it.
1076 public function initialise() {
1077 global $CFG, $SITE, $USER;
1078 // Check if it has already been initialised
1079 if ($this->initialised ||
during_initial_install()) {
1082 $this->initialised
= true;
1084 // Set up the five base root nodes. These are nodes where we will put our
1085 // content and are as follows:
1086 // site: Navigation for the front page.
1087 // myprofile: User profile information goes here.
1088 // currentcourse: The course being currently viewed.
1089 // mycourses: The users courses get added here.
1090 // courses: Additional courses are added here.
1091 // users: Other users information loaded here.
1092 $this->rootnodes
= array();
1093 if (get_home_page() == HOMEPAGE_SITE
) {
1094 // The home element should be my moodle because the root element is the site
1095 if (isloggedin() && !isguestuser()) { // Makes no sense if you aren't logged in
1096 $this->rootnodes
['home'] = $this->add(get_string('myhome'), new moodle_url('/my/'), self
::TYPE_SETTING
, null, 'home');
1099 // The home element should be the site because the root node is my moodle
1100 $this->rootnodes
['home'] = $this->add(get_string('sitehome'), new moodle_url('/'), self
::TYPE_SETTING
, null, 'home');
1101 if (!empty($CFG->defaulthomepage
) && ($CFG->defaulthomepage
== HOMEPAGE_MY
)) {
1102 // We need to stop automatic redirection
1103 $this->rootnodes
['home']->action
->param('redirect', '0');
1106 $this->rootnodes
['site'] = $this->add_course($SITE);
1107 $this->rootnodes
['myprofile'] = $this->add(get_string('myprofile'), null, self
::TYPE_USER
, null, 'myprofile');
1108 $this->rootnodes
['currentcourse'] = $this->add(get_string('currentcourse'), null, self
::TYPE_ROOTNODE
, null, 'currentcourse');
1109 $this->rootnodes
['mycourses'] = $this->add(get_string('mycourses'), new moodle_url('/my/'), self
::TYPE_ROOTNODE
, null, 'mycourses');
1110 $this->rootnodes
['courses'] = $this->add(get_string('courses'), new moodle_url('/course/index.php'), self
::TYPE_ROOTNODE
, null, 'courses');
1111 $this->rootnodes
['users'] = $this->add(get_string('users'), null, self
::TYPE_ROOTNODE
, null, 'users');
1113 // We always load the frontpage course to ensure it is available without
1114 // JavaScript enabled.
1115 $this->add_front_page_course_essentials($this->rootnodes
['site'], $SITE);
1116 $this->load_course_sections($SITE, $this->rootnodes
['site']);
1118 $course = $this->page
->course
;
1120 // $issite gets set to true if the current pages course is the sites frontpage course
1121 $issite = ($this->page
->course
->id
== $SITE->id
);
1122 // Determine if the user is enrolled in any course.
1123 $enrolledinanycourse = enrol_user_sees_own_courses();
1125 $this->rootnodes
['currentcourse']->mainnavonly
= true;
1126 if ($enrolledinanycourse) {
1127 $this->rootnodes
['mycourses']->isexpandable
= true;
1128 if ($CFG->navshowallcourses
) {
1129 // When we show all courses we need to show both the my courses and the regular courses branch.
1130 $this->rootnodes
['courses']->isexpandable
= true;
1133 $this->rootnodes
['courses']->isexpandable
= true;
1136 if ($this->rootnodes
['mycourses']->isactive
) {
1137 $this->load_courses_enrolled();
1140 $canviewcourseprofile = true;
1142 // Next load context specific content into the navigation
1143 switch ($this->page
->context
->contextlevel
) {
1144 case CONTEXT_SYSTEM
:
1145 // Nothing left to do here I feel.
1147 case CONTEXT_COURSECAT
:
1148 // This is essential, we must load categories.
1149 $this->load_all_categories($this->page
->context
->instanceid
, true);
1151 case CONTEXT_BLOCK
:
1152 case CONTEXT_COURSE
:
1154 // Nothing left to do here.
1158 // Load the course associated with the current page into the navigation.
1159 $coursenode = $this->add_course($course, false, self
::COURSE_CURRENT
);
1160 // If the course wasn't added then don't try going any further.
1162 $canviewcourseprofile = false;
1166 // If the user is not enrolled then we only want to show the
1167 // course node and not populate it.
1169 // Not enrolled, can't view, and hasn't switched roles
1170 if (!can_access_course($course)) {
1171 if ($coursenode->isexpandable
=== true) {
1172 // Obviously the situation has changed, update the cache and adjust the node.
1173 // This occurs if the user access to a course has been revoked (one way or another) after
1174 // initially logging in for this session.
1175 $this->get_expand_course_cache()->set($course->id
, 1);
1176 $coursenode->isexpandable
= true;
1177 $coursenode->nodetype
= self
::NODETYPE_BRANCH
;
1179 // Very ugly hack - do not force "parents" to enrol into course their child is enrolled in,
1180 // this hack has been propagated from user/view.php to display the navigation node. (MDL-25805)
1181 if (!$this->current_user_is_parent_role()) {
1182 $coursenode->make_active();
1183 $canviewcourseprofile = false;
1188 if ($coursenode->isexpandable
=== false) {
1189 // Obviously the situation has changed, update the cache and adjust the node.
1190 // This occurs if the user has been granted access to a course (one way or another) after initially
1191 // logging in for this session.
1192 $this->get_expand_course_cache()->set($course->id
, 1);
1193 $coursenode->isexpandable
= true;
1194 $coursenode->nodetype
= self
::NODETYPE_BRANCH
;
1197 // Add the essentials such as reports etc...
1198 $this->add_course_essentials($coursenode, $course);
1199 // Extend course navigation with it's sections/activities
1200 $this->load_course_sections($course, $coursenode);
1201 if (!$coursenode->contains_active_node() && !$coursenode->search_for_active_node()) {
1202 $coursenode->make_active();
1206 case CONTEXT_MODULE
:
1208 // If this is the site course then most information will have
1209 // already been loaded.
1210 // However we need to check if there is more content that can
1211 // yet be loaded for the specific module instance.
1212 $activitynode = $this->rootnodes
['site']->find($this->page
->cm
->id
, navigation_node
::TYPE_ACTIVITY
);
1213 if ($activitynode) {
1214 $this->load_activity($this->page
->cm
, $this->page
->course
, $activitynode);
1219 $course = $this->page
->course
;
1220 $cm = $this->page
->cm
;
1222 // Load the course associated with the page into the navigation
1223 $coursenode = $this->add_course($course, false, self
::COURSE_CURRENT
);
1225 // If the course wasn't added then don't try going any further.
1227 $canviewcourseprofile = false;
1231 // If the user is not enrolled then we only want to show the
1232 // course node and not populate it.
1233 if (!can_access_course($course)) {
1234 $coursenode->make_active();
1235 $canviewcourseprofile = false;
1239 $this->add_course_essentials($coursenode, $course);
1241 // Load the course sections into the page
1242 $this->load_course_sections($course, $coursenode, null, $cm);
1243 $activity = $coursenode->find($cm->id
, navigation_node
::TYPE_ACTIVITY
);
1244 if (!empty($activity)) {
1245 // Finally load the cm specific navigaton information
1246 $this->load_activity($cm, $course, $activity);
1247 // Check if we have an active ndoe
1248 if (!$activity->contains_active_node() && !$activity->search_for_active_node()) {
1249 // And make the activity node active.
1250 $activity->make_active();
1256 // The users profile information etc is already loaded
1257 // for the front page.
1260 $course = $this->page
->course
;
1261 // Load the course associated with the user into the navigation
1262 $coursenode = $this->add_course($course, false, self
::COURSE_CURRENT
);
1264 // If the course wasn't added then don't try going any further.
1266 $canviewcourseprofile = false;
1270 // If the user is not enrolled then we only want to show the
1271 // course node and not populate it.
1272 if (!can_access_course($course)) {
1273 $coursenode->make_active();
1274 $canviewcourseprofile = false;
1277 $this->add_course_essentials($coursenode, $course);
1278 $this->load_course_sections($course, $coursenode);
1282 // Load for the current user
1283 $this->load_for_user();
1284 if ($this->page
->context
->contextlevel
>= CONTEXT_COURSE
&& $this->page
->context
->instanceid
!= $SITE->id
&& $canviewcourseprofile) {
1285 $this->load_for_user(null, true);
1287 // Load each extending user into the navigation.
1288 foreach ($this->extendforuser
as $user) {
1289 if ($user->id
!= $USER->id
) {
1290 $this->load_for_user($user);
1294 // Give the local plugins a chance to include some navigation if they want.
1295 foreach (core_component
::get_plugin_list_with_file('local', 'lib.php', true) as $plugin => $file) {
1296 $function = "local_{$plugin}_extends_navigation";
1297 $oldfunction = "{$plugin}_extends_navigation";
1298 if (function_exists($function)) {
1299 // This is the preferred function name as there is less chance of conflicts
1301 } else if (function_exists($oldfunction)) {
1302 // We continue to support the old function name to ensure backwards compatibility
1303 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
);
1304 $oldfunction($this);
1308 // Remove any empty root nodes
1309 foreach ($this->rootnodes
as $node) {
1310 // Dont remove the home node
1311 /** @var navigation_node $node */
1312 if ($node->key
!== 'home' && !$node->has_children() && !$node->isactive
) {
1317 if (!$this->contains_active_node()) {
1318 $this->search_for_active_node();
1321 // If the user is not logged in modify the navigation structure as detailed
1322 // in {@link http://docs.moodle.org/dev/Navigation_2.0_structure}
1323 if (!isloggedin()) {
1324 $activities = clone($this->rootnodes
['site']->children
);
1325 $this->rootnodes
['site']->remove();
1326 $children = clone($this->children
);
1327 $this->children
= new navigation_node_collection();
1328 foreach ($activities as $child) {
1329 $this->children
->add($child);
1331 foreach ($children as $child) {
1332 $this->children
->add($child);
1339 * Returns true if the current user is a parent of the user being currently viewed.
1341 * If the current user is not viewing another user, or if the current user does not hold any parent roles over the
1342 * other user being viewed this function returns false.
1343 * In order to set the user for whom we are checking against you must call {@link set_userid_for_parent_checks()}
1348 protected function current_user_is_parent_role() {
1350 if ($this->useridtouseforparentchecks
&& $this->useridtouseforparentchecks
!= $USER->id
) {
1351 $usercontext = context_user
::instance($this->useridtouseforparentchecks
, MUST_EXIST
);
1352 if (!has_capability('moodle/user:viewdetails', $usercontext)) {
1355 if ($DB->record_exists('role_assignments', array('userid' => $USER->id
, 'contextid' => $usercontext->id
))) {
1363 * Returns true if courses should be shown within categories on the navigation.
1365 * @param bool $ismycourse Set to true if you are calculating this for a course.
1368 protected function show_categories($ismycourse = false) {
1371 return $this->show_my_categories();
1373 if ($this->showcategories
=== null) {
1375 if ($this->page
->context
->contextlevel
== CONTEXT_COURSECAT
) {
1377 } else if (!empty($CFG->navshowcategories
) && $DB->count_records('course_categories') > 1) {
1380 $this->showcategories
= $show;
1382 return $this->showcategories
;
1386 * Returns true if we should show categories in the My Courses branch.
1389 protected function show_my_categories() {
1391 if ($this->showmycategories
=== null) {
1392 $this->showmycategories
= !empty($CFG->navshowmycoursecategories
) && $DB->count_records('course_categories') > 1;
1394 return $this->showmycategories
;
1398 * Loads the courses in Moodle into the navigation.
1400 * @global moodle_database $DB
1401 * @param string|array $categoryids An array containing categories to load courses
1402 * for, OR null to load courses for all categories.
1403 * @return array An array of navigation_nodes one for each course
1405 protected function load_all_courses($categoryids = null) {
1406 global $CFG, $DB, $SITE;
1408 // Work out the limit of courses.
1410 if (!empty($CFG->navcourselimit
)) {
1411 $limit = $CFG->navcourselimit
;
1414 $toload = (empty($CFG->navshowallcourses
))?self
::LOAD_ROOT_CATEGORIES
:self
::LOAD_ALL_CATEGORIES
;
1416 // If we are going to show all courses AND we are showing categories then
1417 // to save us repeated DB calls load all of the categories now
1418 if ($this->show_categories()) {
1419 $this->load_all_categories($toload);
1422 // Will be the return of our efforts
1423 $coursenodes = array();
1425 // Check if we need to show categories.
1426 if ($this->show_categories()) {
1427 // Hmmm we need to show categories... this is going to be painful.
1428 // We now need to fetch up to $limit courses for each category to
1430 if ($categoryids !== null) {
1431 if (!is_array($categoryids)) {
1432 $categoryids = array($categoryids);
1434 list($categorywhere, $categoryparams) = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED
, 'cc');
1435 $categorywhere = 'WHERE cc.id '.$categorywhere;
1436 } else if ($toload == self
::LOAD_ROOT_CATEGORIES
) {
1437 $categorywhere = 'WHERE cc.depth = 1 OR cc.depth = 2';
1438 $categoryparams = array();
1440 $categorywhere = '';
1441 $categoryparams = array();
1444 // First up we are going to get the categories that we are going to
1445 // need so that we can determine how best to load the courses from them.
1446 $sql = "SELECT cc.id, COUNT(c.id) AS coursecount
1447 FROM {course_categories} cc
1448 LEFT JOIN {course} c ON c.category = cc.id
1451 $categories = $DB->get_recordset_sql($sql, $categoryparams);
1452 $fullfetch = array();
1453 $partfetch = array();
1454 foreach ($categories as $category) {
1455 if (!$this->can_add_more_courses_to_category($category->id
)) {
1458 if ($category->coursecount
> $limit * 5) {
1459 $partfetch[] = $category->id
;
1460 } else if ($category->coursecount
> 0) {
1461 $fullfetch[] = $category->id
;
1464 $categories->close();
1466 if (count($fullfetch)) {
1467 // First up fetch all of the courses in categories where we know that we are going to
1468 // need the majority of courses.
1469 list($categoryids, $categoryparams) = $DB->get_in_or_equal($fullfetch, SQL_PARAMS_NAMED
, 'lcategory');
1470 $ccselect = ', ' . context_helper
::get_preload_record_columns_sql('ctx');
1471 $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
1472 $categoryparams['contextlevel'] = CONTEXT_COURSE
;
1473 $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
1476 WHERE c.category {$categoryids}
1477 ORDER BY c.sortorder ASC";
1478 $coursesrs = $DB->get_recordset_sql($sql, $categoryparams);
1479 foreach ($coursesrs as $course) {
1480 if ($course->id
== $SITE->id
) {
1481 // This should not be necessary, frontpage is not in any category.
1484 if (array_key_exists($course->id
, $this->addedcourses
)) {
1485 // It is probably better to not include the already loaded courses
1486 // directly in SQL because inequalities may confuse query optimisers
1487 // and may interfere with query caching.
1490 if (!$this->can_add_more_courses_to_category($course->category
)) {
1493 context_helper
::preload_from_record($course);
1494 if (!$course->visible
&& !is_role_switched($course->id
) && !has_capability('moodle/course:viewhiddencourses', context_course
::instance($course->id
))) {
1497 $coursenodes[$course->id
] = $this->add_course($course);
1499 $coursesrs->close();
1502 if (count($partfetch)) {
1503 // Next we will work our way through the categories where we will likely only need a small
1504 // proportion of the courses.
1505 foreach ($partfetch as $categoryid) {
1506 $ccselect = ', ' . context_helper
::get_preload_record_columns_sql('ctx');
1507 $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
1508 $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
1511 WHERE c.category = :categoryid
1512 ORDER BY c.sortorder ASC";
1513 $courseparams = array('categoryid' => $categoryid, 'contextlevel' => CONTEXT_COURSE
);
1514 $coursesrs = $DB->get_recordset_sql($sql, $courseparams, 0, $limit * 5);
1515 foreach ($coursesrs as $course) {
1516 if ($course->id
== $SITE->id
) {
1517 // This should not be necessary, frontpage is not in any category.
1520 if (array_key_exists($course->id
, $this->addedcourses
)) {
1521 // It is probably better to not include the already loaded courses
1522 // directly in SQL because inequalities may confuse query optimisers
1523 // and may interfere with query caching.
1524 // This also helps to respect expected $limit on repeated executions.
1527 if (!$this->can_add_more_courses_to_category($course->category
)) {
1530 context_helper
::preload_from_record($course);
1531 if (!$course->visible
&& !is_role_switched($course->id
) && !has_capability('moodle/course:viewhiddencourses', context_course
::instance($course->id
))) {
1534 $coursenodes[$course->id
] = $this->add_course($course);
1536 $coursesrs->close();
1540 // Prepare the SQL to load the courses and their contexts
1541 list($courseids, $courseparams) = $DB->get_in_or_equal(array_keys($this->addedcourses
), SQL_PARAMS_NAMED
, 'lc', false);
1542 $ccselect = ', ' . context_helper
::get_preload_record_columns_sql('ctx');
1543 $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
1544 $courseparams['contextlevel'] = CONTEXT_COURSE
;
1545 $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
1548 WHERE c.id {$courseids}
1549 ORDER BY c.sortorder ASC";
1550 $coursesrs = $DB->get_recordset_sql($sql, $courseparams);
1551 foreach ($coursesrs as $course) {
1552 if ($course->id
== $SITE->id
) {
1553 // frotpage is not wanted here
1556 if ($this->page
->course
&& ($this->page
->course
->id
== $course->id
)) {
1557 // Don't include the currentcourse in this nodelist - it's displayed in the Current course node
1560 context_helper
::preload_from_record($course);
1561 if (!$course->visible
&& !is_role_switched($course->id
) && !has_capability('moodle/course:viewhiddencourses', context_course
::instance($course->id
))) {
1564 $coursenodes[$course->id
] = $this->add_course($course);
1565 if (count($coursenodes) >= $limit) {
1569 $coursesrs->close();
1572 return $coursenodes;
1576 * Returns true if more courses can be added to the provided category.
1578 * @param int|navigation_node|stdClass $category
1581 protected function can_add_more_courses_to_category($category) {
1584 if (!empty($CFG->navcourselimit
)) {
1585 $limit = (int)$CFG->navcourselimit
;
1587 if (is_numeric($category)) {
1588 if (!array_key_exists($category, $this->addedcategories
)) {
1591 $coursecount = count($this->addedcategories
[$category]->children
->type(self
::TYPE_COURSE
));
1592 } else if ($category instanceof navigation_node
) {
1593 if (($category->type
!= self
::TYPE_CATEGORY
) ||
($category->type
!= self
::TYPE_MY_CATEGORY
)) {
1596 $coursecount = count($category->children
->type(self
::TYPE_COURSE
));
1597 } else if (is_object($category) && property_exists($category,'id')) {
1598 $coursecount = count($this->addedcategories
[$category->id
]->children
->type(self
::TYPE_COURSE
));
1600 return ($coursecount <= $limit);
1604 * Loads all categories (top level or if an id is specified for that category)
1606 * @param int $categoryid The category id to load or null/0 to load all base level categories
1607 * @param bool $showbasecategories If set to true all base level categories will be loaded as well
1608 * as the requested category and any parent categories.
1609 * @return navigation_node|void returns a navigation node if a category has been loaded.
1611 protected function load_all_categories($categoryid = self
::LOAD_ROOT_CATEGORIES
, $showbasecategories = false) {
1614 // Check if this category has already been loaded
1615 if ($this->allcategoriesloaded ||
($categoryid < 1 && $this->is_category_fully_loaded($categoryid))) {
1619 $catcontextsql = context_helper
::get_preload_record_columns_sql('ctx');
1620 $sqlselect = "SELECT cc.*, $catcontextsql
1621 FROM {course_categories} cc
1622 JOIN {context} ctx ON cc.id = ctx.instanceid";
1623 $sqlwhere = "WHERE ctx.contextlevel = ".CONTEXT_COURSECAT
;
1624 $sqlorder = "ORDER BY cc.depth ASC, cc.sortorder ASC, cc.id ASC";
1627 $categoriestoload = array();
1628 if ($categoryid == self
::LOAD_ALL_CATEGORIES
) {
1629 // We are going to load all categories regardless... prepare to fire
1630 // on the database server!
1631 } else if ($categoryid == self
::LOAD_ROOT_CATEGORIES
) { // can be 0
1632 // We are going to load all of the first level categories (categories without parents)
1633 $sqlwhere .= " AND cc.parent = 0";
1634 } else if (array_key_exists($categoryid, $this->addedcategories
)) {
1635 // The category itself has been loaded already so we just need to ensure its subcategories
1637 list($sql, $params) = $DB->get_in_or_equal(array_keys($this->addedcategories
), SQL_PARAMS_NAMED
, 'parent', false);
1638 if ($showbasecategories) {
1639 // We need to include categories with parent = 0 as well
1640 $sqlwhere .= " AND (cc.parent = :categoryid OR cc.parent = 0) AND cc.parent {$sql}";
1642 // All we need is categories that match the parent
1643 $sqlwhere .= " AND cc.parent = :categoryid AND cc.parent {$sql}";
1645 $params['categoryid'] = $categoryid;
1647 // This category hasn't been loaded yet so we need to fetch it, work out its category path
1648 // and load this category plus all its parents and subcategories
1649 $category = $DB->get_record('course_categories', array('id' => $categoryid), 'path', MUST_EXIST
);
1650 $categoriestoload = explode('/', trim($category->path
, '/'));
1651 list($select, $params) = $DB->get_in_or_equal($categoriestoload);
1652 // We are going to use select twice so double the params
1653 $params = array_merge($params, $params);
1654 $basecategorysql = ($showbasecategories)?
' OR cc.depth = 1':'';
1655 $sqlwhere .= " AND (cc.id {$select} OR cc.parent {$select}{$basecategorysql})";
1658 $categoriesrs = $DB->get_recordset_sql("$sqlselect $sqlwhere $sqlorder", $params);
1659 $categories = array();
1660 foreach ($categoriesrs as $category) {
1661 // Preload the context.. we'll need it when adding the category in order
1662 // to format the category name.
1663 context_helper
::preload_from_record($category);
1664 if (array_key_exists($category->id
, $this->addedcategories
)) {
1665 // Do nothing, its already been added.
1666 } else if ($category->parent
== '0') {
1667 // This is a root category lets add it immediately
1668 $this->add_category($category, $this->rootnodes
['courses']);
1669 } else if (array_key_exists($category->parent
, $this->addedcategories
)) {
1670 // This categories parent has already been added we can add this immediately
1671 $this->add_category($category, $this->addedcategories
[$category->parent
]);
1673 $categories[] = $category;
1676 $categoriesrs->close();
1678 // Now we have an array of categories we need to add them to the navigation.
1679 while (!empty($categories)) {
1680 $category = reset($categories);
1681 if (array_key_exists($category->id
, $this->addedcategories
)) {
1683 } else if ($category->parent
== '0') {
1684 $this->add_category($category, $this->rootnodes
['courses']);
1685 } else if (array_key_exists($category->parent
, $this->addedcategories
)) {
1686 $this->add_category($category, $this->addedcategories
[$category->parent
]);
1688 // This category isn't in the navigation and niether is it's parent (yet).
1689 // We need to go through the category path and add all of its components in order.
1690 $path = explode('/', trim($category->path
, '/'));
1691 foreach ($path as $catid) {
1692 if (!array_key_exists($catid, $this->addedcategories
)) {
1693 // This category isn't in the navigation yet so add it.
1694 $subcategory = $categories[$catid];
1695 if ($subcategory->parent
== '0') {
1696 // Yay we have a root category - this likely means we will now be able
1697 // to add categories without problems.
1698 $this->add_category($subcategory, $this->rootnodes
['courses']);
1699 } else if (array_key_exists($subcategory->parent
, $this->addedcategories
)) {
1700 // The parent is in the category (as we'd expect) so add it now.
1701 $this->add_category($subcategory, $this->addedcategories
[$subcategory->parent
]);
1702 // Remove the category from the categories array.
1703 unset($categories[$catid]);
1705 // We should never ever arrive here - if we have then there is a bigger
1707 throw new coding_exception('Category path order is incorrect and/or there are missing categories');
1712 // Remove the category from the categories array now that we know it has been added.
1713 unset($categories[$category->id
]);
1715 if ($categoryid === self
::LOAD_ALL_CATEGORIES
) {
1716 $this->allcategoriesloaded
= true;
1718 // Check if there are any categories to load.
1719 if (count($categoriestoload) > 0) {
1720 $readytoloadcourses = array();
1721 foreach ($categoriestoload as $category) {
1722 if ($this->can_add_more_courses_to_category($category)) {
1723 $readytoloadcourses[] = $category;
1726 if (count($readytoloadcourses)) {
1727 $this->load_all_courses($readytoloadcourses);
1731 // Look for all categories which have been loaded
1732 if (!empty($this->addedcategories
)) {
1733 $categoryids = array();
1734 foreach ($this->addedcategories
as $category) {
1735 if ($this->can_add_more_courses_to_category($category)) {
1736 $categoryids[] = $category->key
;
1740 list($categoriessql, $params) = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED
);
1741 $params['limit'] = (!empty($CFG->navcourselimit
))?
$CFG->navcourselimit
:20;
1742 $sql = "SELECT cc.id, COUNT(c.id) AS coursecount
1743 FROM {course_categories} cc
1744 JOIN {course} c ON c.category = cc.id
1745 WHERE cc.id {$categoriessql}
1747 HAVING COUNT(c.id) > :limit";
1748 $excessivecategories = $DB->get_records_sql($sql, $params);
1749 foreach ($categories as &$category) {
1750 if (array_key_exists($category->key
, $excessivecategories) && !$this->can_add_more_courses_to_category($category)) {
1751 $url = new moodle_url('/course/index.php', array('categoryid' => $category->key
));
1752 $category->add(get_string('viewallcourses'), $url, self
::TYPE_SETTING
);
1760 * Adds a structured category to the navigation in the correct order/place
1762 * @param stdClass $category category to be added in navigation.
1763 * @param navigation_node $parent parent navigation node
1764 * @param int $nodetype type of node, if category is under MyHome then it's TYPE_MY_CATEGORY
1767 protected function add_category(stdClass
$category, navigation_node
$parent, $nodetype = self
::TYPE_CATEGORY
) {
1768 if (array_key_exists($category->id
, $this->addedcategories
)) {
1771 $url = new moodle_url('/course/index.php', array('categoryid' => $category->id
));
1772 $context = context_coursecat
::instance($category->id
);
1773 $categoryname = format_string($category->name
, true, array('context' => $context));
1774 $categorynode = $parent->add($categoryname, $url, $nodetype, $categoryname, $category->id
);
1775 if (empty($category->visible
)) {
1776 if (has_capability('moodle/category:viewhiddencategories', context_system
::instance())) {
1777 $categorynode->hidden
= true;
1779 $categorynode->display
= false;
1782 $this->addedcategories
[$category->id
] = $categorynode;
1786 * Loads the given course into the navigation
1788 * @param stdClass $course
1789 * @return navigation_node
1791 protected function load_course(stdClass
$course) {
1793 if ($course->id
== $SITE->id
) {
1794 // This is always loaded during initialisation
1795 return $this->rootnodes
['site'];
1796 } else if (array_key_exists($course->id
, $this->addedcourses
)) {
1797 // The course has already been loaded so return a reference
1798 return $this->addedcourses
[$course->id
];
1801 return $this->add_course($course);
1806 * Loads all of the courses section into the navigation.
1808 * This function calls method from current course format, see
1809 * {@link format_base::extend_course_navigation()}
1810 * If course module ($cm) is specified but course format failed to create the node,
1811 * the activity node is created anyway.
1813 * By default course formats call the method {@link global_navigation::load_generic_course_sections()}
1815 * @param stdClass $course Database record for the course
1816 * @param navigation_node $coursenode The course node within the navigation
1817 * @param null|int $sectionnum If specified load the contents of section with this relative number
1818 * @param null|cm_info $cm If specified make sure that activity node is created (either
1819 * in containg section or by calling load_stealth_activity() )
1821 protected function load_course_sections(stdClass
$course, navigation_node
$coursenode, $sectionnum = null, $cm = null) {
1823 require_once($CFG->dirroot
.'/course/lib.php');
1824 if (isset($cm->sectionnum
)) {
1825 $sectionnum = $cm->sectionnum
;
1827 if ($sectionnum !== null) {
1828 $this->includesectionnum
= $sectionnum;
1830 course_get_format($course)->extend_course_navigation($this, $coursenode, $sectionnum, $cm);
1831 if (isset($cm->id
)) {
1832 $activity = $coursenode->find($cm->id
, self
::TYPE_ACTIVITY
);
1833 if (empty($activity)) {
1834 $activity = $this->load_stealth_activity($coursenode, get_fast_modinfo($course));
1840 * Generates an array of sections and an array of activities for the given course.
1842 * This method uses the cache to improve performance and avoid the get_fast_modinfo call
1844 * @param stdClass $course
1845 * @return array Array($sections, $activities)
1847 protected function generate_sections_and_activities(stdClass
$course) {
1849 require_once($CFG->dirroot
.'/course/lib.php');
1851 $modinfo = get_fast_modinfo($course);
1852 $sections = $modinfo->get_section_info_all();
1854 // For course formats using 'numsections' trim the sections list
1855 $courseformatoptions = course_get_format($course)->get_format_options();
1856 if (isset($courseformatoptions['numsections'])) {
1857 $sections = array_slice($sections, 0, $courseformatoptions['numsections']+
1, true);
1860 $activities = array();
1862 foreach ($sections as $key => $section) {
1863 // Clone and unset summary to prevent $SESSION bloat (MDL-31802).
1864 $sections[$key] = clone($section);
1865 unset($sections[$key]->summary
);
1866 $sections[$key]->hasactivites
= false;
1867 if (!array_key_exists($section->section
, $modinfo->sections
)) {
1870 foreach ($modinfo->sections
[$section->section
] as $cmid) {
1871 $cm = $modinfo->cms
[$cmid];
1872 $activity = new stdClass
;
1873 $activity->id
= $cm->id
;
1874 $activity->course
= $course->id
;
1875 $activity->section
= $section->section
;
1876 $activity->name
= $cm->name
;
1877 $activity->icon
= $cm->icon
;
1878 $activity->iconcomponent
= $cm->iconcomponent
;
1879 $activity->hidden
= (!$cm->visible
);
1880 $activity->modname
= $cm->modname
;
1881 $activity->nodetype
= navigation_node
::NODETYPE_LEAF
;
1882 $activity->onclick
= $cm->get_on_click();
1883 $url = $cm->get_url();
1885 $activity->url
= null;
1886 $activity->display
= false;
1888 $activity->url
= $cm->get_url()->out();
1889 $activity->display
= $cm->uservisible ?
true : false;
1890 if (self
::module_extends_navigation($cm->modname
)) {
1891 $activity->nodetype
= navigation_node
::NODETYPE_BRANCH
;
1894 $activities[$cmid] = $activity;
1895 if ($activity->display
) {
1896 $sections[$key]->hasactivites
= true;
1901 return array($sections, $activities);
1905 * Generically loads the course sections into the course's navigation.
1907 * @param stdClass $course
1908 * @param navigation_node $coursenode
1909 * @return array An array of course section nodes
1911 public function load_generic_course_sections(stdClass
$course, navigation_node
$coursenode) {
1912 global $CFG, $DB, $USER, $SITE;
1913 require_once($CFG->dirroot
.'/course/lib.php');
1915 list($sections, $activities) = $this->generate_sections_and_activities($course);
1917 $navigationsections = array();
1918 foreach ($sections as $sectionid => $section) {
1919 $section = clone($section);
1920 if ($course->id
== $SITE->id
) {
1921 $this->load_section_activities($coursenode, $section->section
, $activities);
1923 if (!$section->uservisible ||
(!$this->showemptysections
&&
1924 !$section->hasactivites
&& $this->includesectionnum
!== $section->section
)) {
1928 $sectionname = get_section_name($course, $section);
1929 $url = course_get_url($course, $section->section
, array('navigation' => true));
1931 $sectionnode = $coursenode->add($sectionname, $url, navigation_node
::TYPE_SECTION
, null, $section->id
);
1932 $sectionnode->nodetype
= navigation_node
::NODETYPE_BRANCH
;
1933 $sectionnode->hidden
= (!$section->visible ||
!$section->available
);
1934 if ($this->includesectionnum
!== false && $this->includesectionnum
== $section->section
) {
1935 $this->load_section_activities($sectionnode, $section->section
, $activities);
1937 $section->sectionnode
= $sectionnode;
1938 $navigationsections[$sectionid] = $section;
1941 return $navigationsections;
1945 * Loads all of the activities for a section into the navigation structure.
1947 * @param navigation_node $sectionnode
1948 * @param int $sectionnumber
1949 * @param array $activities An array of activites as returned by {@link global_navigation::generate_sections_and_activities()}
1950 * @param stdClass $course The course object the section and activities relate to.
1951 * @return array Array of activity nodes
1953 protected function load_section_activities(navigation_node
$sectionnode, $sectionnumber, array $activities, $course = null) {
1955 // A static counter for JS function naming
1956 static $legacyonclickcounter = 0;
1958 $activitynodes = array();
1959 if (empty($activities)) {
1960 return $activitynodes;
1963 if (!is_object($course)) {
1964 $activity = reset($activities);
1965 $courseid = $activity->course
;
1967 $courseid = $course->id
;
1969 $showactivities = ($courseid != $SITE->id ||
!empty($CFG->navshowfrontpagemods
));
1971 foreach ($activities as $activity) {
1972 if ($activity->section
!= $sectionnumber) {
1975 if ($activity->icon
) {
1976 $icon = new pix_icon($activity->icon
, get_string('modulename', $activity->modname
), $activity->iconcomponent
);
1978 $icon = new pix_icon('icon', get_string('modulename', $activity->modname
), $activity->modname
);
1981 // Prepare the default name and url for the node
1982 $activityname = format_string($activity->name
, true, array('context' => context_module
::instance($activity->id
)));
1983 $action = new moodle_url($activity->url
);
1985 // Check if the onclick property is set (puke!)
1986 if (!empty($activity->onclick
)) {
1987 // Increment the counter so that we have a unique number.
1988 $legacyonclickcounter++
;
1989 // Generate the function name we will use
1990 $functionname = 'legacy_activity_onclick_handler_'.$legacyonclickcounter;
1991 $propogrationhandler = '';
1992 // Check if we need to cancel propogation. Remember inline onclick
1993 // events would return false if they wanted to prevent propogation and the
1995 if (strpos($activity->onclick
, 'return false')) {
1996 $propogrationhandler = 'e.halt();';
1998 // Decode the onclick - it has already been encoded for display (puke)
1999 $onclick = htmlspecialchars_decode($activity->onclick
, ENT_QUOTES
);
2000 // Build the JS function the click event will call
2001 $jscode = "function {$functionname}(e) { $propogrationhandler $onclick }";
2002 $this->page
->requires
->js_init_code($jscode);
2003 // Override the default url with the new action link
2004 $action = new action_link($action, $activityname, new component_action('click', $functionname));
2007 $activitynode = $sectionnode->add($activityname, $action, navigation_node
::TYPE_ACTIVITY
, null, $activity->id
, $icon);
2008 $activitynode->title(get_string('modulename', $activity->modname
));
2009 $activitynode->hidden
= $activity->hidden
;
2010 $activitynode->display
= $showactivities && $activity->display
;
2011 $activitynode->nodetype
= $activity->nodetype
;
2012 $activitynodes[$activity->id
] = $activitynode;
2015 return $activitynodes;
2018 * Loads a stealth module from unavailable section
2019 * @param navigation_node $coursenode
2020 * @param stdClass $modinfo
2021 * @return navigation_node or null if not accessible
2023 protected function load_stealth_activity(navigation_node
$coursenode, $modinfo) {
2024 if (empty($modinfo->cms
[$this->page
->cm
->id
])) {
2027 $cm = $modinfo->cms
[$this->page
->cm
->id
];
2029 $icon = new pix_icon($cm->icon
, get_string('modulename', $cm->modname
), $cm->iconcomponent
);
2031 $icon = new pix_icon('icon', get_string('modulename', $cm->modname
), $cm->modname
);
2033 $url = $cm->get_url();
2034 $activitynode = $coursenode->add(format_string($cm->name
), $url, navigation_node
::TYPE_ACTIVITY
, null, $cm->id
, $icon);
2035 $activitynode->title(get_string('modulename', $cm->modname
));
2036 $activitynode->hidden
= (!$cm->visible
);
2037 if (!$cm->uservisible
) {
2038 // Do not show any error here, let the page handle exception that activity is not visible for the current user.
2039 // Also there may be no exception at all in case when teacher is logged in as student.
2040 $activitynode->display
= false;
2042 // Don't show activities that don't have links!
2043 $activitynode->display
= false;
2044 } else if (self
::module_extends_navigation($cm->modname
)) {
2045 $activitynode->nodetype
= navigation_node
::NODETYPE_BRANCH
;
2047 return $activitynode;
2050 * Loads the navigation structure for the given activity into the activities node.
2052 * This method utilises a callback within the modules lib.php file to load the
2053 * content specific to activity given.
2055 * The callback is a method: {modulename}_extend_navigation()
2057 * * {@link forum_extend_navigation()}
2058 * * {@link workshop_extend_navigation()}
2060 * @param cm_info|stdClass $cm
2061 * @param stdClass $course
2062 * @param navigation_node $activity
2065 protected function load_activity($cm, stdClass
$course, navigation_node
$activity) {
2068 // make sure we have a $cm from get_fast_modinfo as this contains activity access details
2069 if (!($cm instanceof cm_info
)) {
2070 $modinfo = get_fast_modinfo($course);
2071 $cm = $modinfo->get_cm($cm->id
);
2073 $activity->nodetype
= navigation_node
::NODETYPE_LEAF
;
2074 $activity->make_active();
2075 $file = $CFG->dirroot
.'/mod/'.$cm->modname
.'/lib.php';
2076 $function = $cm->modname
.'_extend_navigation';
2078 if (file_exists($file)) {
2079 require_once($file);
2080 if (function_exists($function)) {
2081 $activtyrecord = $DB->get_record($cm->modname
, array('id' => $cm->instance
), '*', MUST_EXIST
);
2082 $function($activity, $course, $activtyrecord, $cm);
2086 // Allow the active advanced grading method plugin to append module navigation
2087 $featuresfunc = $cm->modname
.'_supports';
2088 if (function_exists($featuresfunc) && $featuresfunc(FEATURE_ADVANCED_GRADING
)) {
2089 require_once($CFG->dirroot
.'/grade/grading/lib.php');
2090 $gradingman = get_grading_manager($cm->context
, $cm->modname
);
2091 $gradingman->extend_navigation($this, $activity);
2094 return $activity->has_children();
2097 * Loads user specific information into the navigation in the appropriate place.
2099 * If no user is provided the current user is assumed.
2101 * @param stdClass $user
2102 * @param bool $forceforcontext probably force something to be loaded somewhere (ask SamH if not sure what this means)
2105 protected function load_for_user($user=null, $forceforcontext=false) {
2106 global $DB, $CFG, $USER, $SITE;
2108 if ($user === null) {
2109 // We can't require login here but if the user isn't logged in we don't
2110 // want to show anything
2111 if (!isloggedin() ||
isguestuser()) {
2115 } else if (!is_object($user)) {
2116 // If the user is not an object then get them from the database
2117 $select = context_helper
::get_preload_record_columns_sql('ctx');
2118 $sql = "SELECT u.*, $select
2120 JOIN {context} ctx ON u.id = ctx.instanceid
2121 WHERE u.id = :userid AND
2122 ctx.contextlevel = :contextlevel";
2123 $user = $DB->get_record_sql($sql, array('userid' => (int)$user, 'contextlevel' => CONTEXT_USER
), MUST_EXIST
);
2124 context_helper
::preload_from_record($user);
2127 $iscurrentuser = ($user->id
== $USER->id
);
2129 $usercontext = context_user
::instance($user->id
);
2131 // Get the course set against the page, by default this will be the site
2132 $course = $this->page
->course
;
2133 $baseargs = array('id'=>$user->id
);
2134 if ($course->id
!= $SITE->id
&& (!$iscurrentuser ||
$forceforcontext)) {
2135 $coursenode = $this->add_course($course, false, self
::COURSE_CURRENT
);
2136 $baseargs['course'] = $course->id
;
2137 $coursecontext = context_course
::instance($course->id
);
2138 $issitecourse = false;
2140 // Load all categories and get the context for the system
2141 $coursecontext = context_system
::instance();
2142 $issitecourse = true;
2145 // Create a node to add user information under.
2146 if ($iscurrentuser && !$forceforcontext) {
2147 // If it's the current user the information will go under the profile root node
2148 $usernode = $this->rootnodes
['myprofile'];
2149 $course = get_site();
2150 $coursecontext = context_course
::instance($course->id
);
2151 $issitecourse = true;
2153 if (!$issitecourse) {
2154 // Not the current user so add it to the participants node for the current course
2155 $usersnode = $coursenode->get('participants', navigation_node
::TYPE_CONTAINER
);
2156 $userviewurl = new moodle_url('/user/view.php', $baseargs);
2158 // This is the site so add a users node to the root branch
2159 $usersnode = $this->rootnodes
['users'];
2160 if (has_capability('moodle/course:viewparticipants', $coursecontext)) {
2161 $usersnode->action
= new moodle_url('/user/index.php', array('id'=>$course->id
));
2163 $userviewurl = new moodle_url('/user/profile.php', $baseargs);
2166 // We should NEVER get here, if the course hasn't been populated
2167 // with a participants node then the navigaiton either wasn't generated
2168 // for it (you are missing a require_login or set_context call) or
2169 // you don't have access.... in the interests of no leaking informatin
2170 // we simply quit...
2173 // Add a branch for the current user
2174 $canseefullname = has_capability('moodle/site:viewfullnames', $coursecontext);
2175 $usernode = $usersnode->add(fullname($user, $canseefullname), $userviewurl, self
::TYPE_USER
, null, $user->id
);
2177 if ($this->page
->context
->contextlevel
== CONTEXT_USER
&& $user->id
== $this->page
->context
->instanceid
) {
2178 $usernode->make_active();
2182 // If the user is the current user or has permission to view the details of the requested
2183 // user than add a view profile link.
2184 if ($iscurrentuser ||
has_capability('moodle/user:viewdetails', $coursecontext) ||
has_capability('moodle/user:viewdetails', $usercontext)) {
2185 if ($issitecourse ||
($iscurrentuser && !$forceforcontext)) {
2186 $usernode->add(get_string('viewprofile'), new moodle_url('/user/profile.php',$baseargs));
2188 $usernode->add(get_string('viewprofile'), new moodle_url('/user/view.php',$baseargs));
2192 if (!empty($CFG->navadduserpostslinks
)) {
2193 // Add nodes for forum posts and discussions if the user can view either or both
2194 // There are no capability checks here as the content of the page is based
2195 // purely on the forums the current user has access too.
2196 $forumtab = $usernode->add(get_string('forumposts', 'forum'));
2197 $forumtab->add(get_string('posts', 'forum'), new moodle_url('/mod/forum/user.php', $baseargs));
2198 $forumtab->add(get_string('discussions', 'forum'), new moodle_url('/mod/forum/user.php', array_merge($baseargs, array('mode'=>'discussions'))));
2202 if (!empty($CFG->enableblogs
)) {
2203 if (!$this->cache
->cached('userblogoptions'.$user->id
)) {
2204 require_once($CFG->dirroot
.'/blog/lib.php');
2205 // Get all options for the user
2206 $options = blog_get_options_for_user($user);
2207 $this->cache
->set('userblogoptions'.$user->id
, $options);
2209 $options = $this->cache
->{'userblogoptions'.$user->id
};
2212 if (count($options) > 0) {
2213 $blogs = $usernode->add(get_string('blogs', 'blog'), null, navigation_node
::TYPE_CONTAINER
);
2214 foreach ($options as $type => $option) {
2215 if ($type == "rss") {
2216 $blogs->add($option['string'], $option['link'], settings_navigation
::TYPE_SETTING
, null, null, new pix_icon('i/rss', ''));
2218 $blogs->add($option['string'], $option['link']);
2224 if (!empty($CFG->messaging
)) {
2225 $messageargs = array('user1' => $USER->id
);
2226 if ($USER->id
!= $user->id
) {
2227 $messageargs['user2'] = $user->id
;
2229 if ($course->id
!= $SITE->id
) {
2230 $messageargs['viewing'] = MESSAGE_VIEW_COURSE
. $course->id
;
2232 $url = new moodle_url('/message/index.php',$messageargs);
2233 $usernode->add(get_string('messages', 'message'), $url, self
::TYPE_SETTING
, null, 'messages');
2236 if ($iscurrentuser && has_capability('moodle/user:manageownfiles', context_user
::instance($USER->id
))) {
2237 $url = new moodle_url('/user/files.php');
2238 $usernode->add(get_string('myfiles'), $url, self
::TYPE_SETTING
);
2241 if (!empty($CFG->enablebadges
) && $iscurrentuser &&
2242 has_capability('moodle/badges:manageownbadges', context_user
::instance($USER->id
))) {
2243 $url = new moodle_url('/badges/mybadges.php');
2244 $usernode->add(get_string('mybadges', 'badges'), $url, self
::TYPE_SETTING
);
2247 // Add a node to view the users notes if permitted
2248 if (!empty($CFG->enablenotes
) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $coursecontext)) {
2249 $url = new moodle_url('/notes/index.php',array('user'=>$user->id
));
2250 if ($coursecontext->instanceid
!= SITEID
) {
2251 $url->param('course', $coursecontext->instanceid
);
2253 $usernode->add(get_string('notes', 'notes'), $url);
2256 // If the user is the current user add the repositories for the current user
2257 $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields
));
2258 if ($iscurrentuser) {
2259 if (!$this->cache
->cached('contexthasrepos'.$usercontext->id
)) {
2260 require_once($CFG->dirroot
. '/repository/lib.php');
2261 $editabletypes = repository
::get_editable_types($usercontext);
2262 $haseditabletypes = !empty($editabletypes);
2263 unset($editabletypes);
2264 $this->cache
->set('contexthasrepos'.$usercontext->id
, $haseditabletypes);
2266 $haseditabletypes = $this->cache
->{'contexthasrepos'.$usercontext->id
};
2268 if ($haseditabletypes) {
2269 $usernode->add(get_string('repositories', 'repository'), new moodle_url('/repository/manage_instances.php', array('contextid' => $usercontext->id
)));
2271 } else if ($course->id
== $SITE->id
&& has_capability('moodle/user:viewdetails', $usercontext) && (!in_array('mycourses', $hiddenfields) ||
has_capability('moodle/user:viewhiddendetails', $coursecontext))) {
2273 // Add view grade report is permitted
2274 $reports = core_component
::get_plugin_list('gradereport');
2275 arsort($reports); // user is last, we want to test it first
2277 $userscourses = enrol_get_users_courses($user->id
);
2278 $userscoursesnode = $usernode->add(get_string('courses'));
2280 foreach ($userscourses as $usercourse) {
2281 $usercoursecontext = context_course
::instance($usercourse->id
);
2282 $usercourseshortname = format_string($usercourse->shortname
, true, array('context' => $usercoursecontext));
2283 $usercoursenode = $userscoursesnode->add($usercourseshortname, new moodle_url('/user/view.php', array('id'=>$user->id
, 'course'=>$usercourse->id
)), self
::TYPE_CONTAINER
);
2285 $gradeavailable = has_capability('moodle/grade:viewall', $usercoursecontext);
2286 if (!$gradeavailable && !empty($usercourse->showgrades
) && is_array($reports) && !empty($reports)) {
2287 foreach ($reports as $plugin => $plugindir) {
2288 if (has_capability('gradereport/'.$plugin.':view', $usercoursecontext)) {
2289 //stop when the first visible plugin is found
2290 $gradeavailable = true;
2296 if ($gradeavailable) {
2297 $url = new moodle_url('/grade/report/index.php', array('id'=>$usercourse->id
));
2298 $usercoursenode->add(get_string('grades'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/grades', ''));
2301 // Add a node to view the users notes if permitted
2302 if (!empty($CFG->enablenotes
) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $usercoursecontext)) {
2303 $url = new moodle_url('/notes/index.php',array('user'=>$user->id
, 'course'=>$usercourse->id
));
2304 $usercoursenode->add(get_string('notes', 'notes'), $url, self
::TYPE_SETTING
);
2307 if (can_access_course($usercourse, $user->id
)) {
2308 $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', ''));
2311 $reporttab = $usercoursenode->add(get_string('activityreports'));
2313 $reports = get_plugin_list_with_function('report', 'extend_navigation_user', 'lib.php');
2314 foreach ($reports as $reportfunction) {
2315 $reportfunction($reporttab, $user, $usercourse);
2318 $reporttab->trim_if_empty();
2325 * This method simply checks to see if a given module can extend the navigation.
2327 * @todo (MDL-25290) A shared caching solution should be used to save details on what extends navigation.
2329 * @param string $modname
2332 public static function module_extends_navigation($modname) {
2334 static $extendingmodules = array();
2335 if (!array_key_exists($modname, $extendingmodules)) {
2336 $extendingmodules[$modname] = false;
2337 $file = $CFG->dirroot
.'/mod/'.$modname.'/lib.php';
2338 if (file_exists($file)) {
2339 $function = $modname.'_extend_navigation';
2340 require_once($file);
2341 $extendingmodules[$modname] = (function_exists($function));
2344 return $extendingmodules[$modname];
2347 * Extends the navigation for the given user.
2349 * @param stdClass $user A user from the database
2351 public function extend_for_user($user) {
2352 $this->extendforuser
[] = $user;
2356 * Returns all of the users the navigation is being extended for
2358 * @return array An array of extending users.
2360 public function get_extending_users() {
2361 return $this->extendforuser
;
2364 * Adds the given course to the navigation structure.
2366 * @param stdClass $course
2367 * @param bool $forcegeneric
2368 * @param bool $ismycourse
2369 * @return navigation_node
2371 public function add_course(stdClass
$course, $forcegeneric = false, $coursetype = self
::COURSE_OTHER
) {
2374 // We found the course... we can return it now :)
2375 if (!$forcegeneric && array_key_exists($course->id
, $this->addedcourses
)) {
2376 return $this->addedcourses
[$course->id
];
2379 $coursecontext = context_course
::instance($course->id
);
2381 if ($course->id
!= $SITE->id
&& !$course->visible
) {
2382 if (is_role_switched($course->id
)) {
2383 // user has to be able to access course in order to switch, let's skip the visibility test here
2384 } else if (!has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2389 $issite = ($course->id
== $SITE->id
);
2390 $shortname = format_string($course->shortname
, true, array('context' => $coursecontext));
2391 $fullname = format_string($course->fullname
, true, array('context' => $coursecontext));
2392 // This is the name that will be shown for the course.
2393 $coursename = empty($CFG->navshowfullcoursenames
) ?
$shortname : $fullname;
2395 // Can the user expand the course to see its content.
2396 $canexpandcourse = true;
2400 if (empty($CFG->usesitenameforsitepages
)) {
2401 $coursename = get_string('sitepages');
2403 } else if ($coursetype == self
::COURSE_CURRENT
) {
2404 $parent = $this->rootnodes
['currentcourse'];
2405 $url = new moodle_url('/course/view.php', array('id'=>$course->id
));
2406 } else if ($coursetype == self
::COURSE_MY
&& !$forcegeneric) {
2407 if (!empty($CFG->navshowmycoursecategories
) && ($parent = $this->rootnodes
['mycourses']->find($course->category
, self
::TYPE_MY_CATEGORY
))) {
2408 // Nothing to do here the above statement set $parent to the category within mycourses.
2410 $parent = $this->rootnodes
['mycourses'];
2412 $url = new moodle_url('/course/view.php', array('id'=>$course->id
));
2414 $parent = $this->rootnodes
['courses'];
2415 $url = new moodle_url('/course/view.php', array('id'=>$course->id
));
2416 // They can only expand the course if they can access it.
2417 $canexpandcourse = $this->can_expand_course($course);
2418 if (!empty($course->category
) && $this->show_categories($coursetype == self
::COURSE_MY
)) {
2419 if (!$this->is_category_fully_loaded($course->category
)) {
2420 // We need to load the category structure for this course
2421 $this->load_all_categories($course->category
, false);
2423 if (array_key_exists($course->category
, $this->addedcategories
)) {
2424 $parent = $this->addedcategories
[$course->category
];
2425 // This could lead to the course being created so we should check whether it is the case again
2426 if (!$forcegeneric && array_key_exists($course->id
, $this->addedcourses
)) {
2427 return $this->addedcourses
[$course->id
];
2433 $coursenode = $parent->add($coursename, $url, self
::TYPE_COURSE
, $shortname, $course->id
);
2434 $coursenode->hidden
= (!$course->visible
);
2435 // We need to decode &'s here as they will have been added by format_string above and attributes will be encoded again
2437 $coursenode->title(str_replace('&', '&', $fullname));
2438 if ($canexpandcourse) {
2439 // This course can be expanded by the user, make it a branch to make the system aware that its expandable by ajax.
2440 $coursenode->nodetype
= self
::NODETYPE_BRANCH
;
2441 $coursenode->isexpandable
= true;
2443 $coursenode->nodetype
= self
::NODETYPE_LEAF
;
2444 $coursenode->isexpandable
= false;
2446 if (!$forcegeneric) {
2447 $this->addedcourses
[$course->id
] = $coursenode;
2454 * Returns a cache instance to use for the expand course cache.
2455 * @return cache_session
2457 protected function get_expand_course_cache() {
2458 if ($this->cacheexpandcourse
=== null) {
2459 $this->cacheexpandcourse
= cache
::make('core', 'navigation_expandcourse');
2461 return $this->cacheexpandcourse
;
2465 * Checks if a user can expand a course in the navigation.
2467 * We use a cache here because in order to be accurate we need to call can_access_course which is a costly function.
2468 * Because this functionality is basic + non-essential and because we lack good event triggering this cache
2469 * permits stale data.
2470 * In the situation the user is granted access to a course after we've initialised this session cache the cache
2472 * It is brought up to date in only one of two ways.
2473 * 1. The user logs out and in again.
2474 * 2. The user browses to the course they've just being given access to.
2476 * Really all this controls is whether the node is shown as expandable or not. It is uber un-important.
2478 * @param stdClass $course
2481 protected function can_expand_course($course) {
2482 $cache = $this->get_expand_course_cache();
2483 $canexpand = $cache->get($course->id
);
2484 if ($canexpand === false) {
2485 $canexpand = isloggedin() && can_access_course($course);
2486 $canexpand = (int)$canexpand;
2487 $cache->set($course->id
, $canexpand);
2489 return ($canexpand === 1);
2493 * Returns true if the category has already been loaded as have any child categories
2495 * @param int $categoryid
2498 protected function is_category_fully_loaded($categoryid) {
2499 return (array_key_exists($categoryid, $this->addedcategories
) && ($this->allcategoriesloaded ||
$this->addedcategories
[$categoryid]->children
->count() > 0));
2503 * Adds essential course nodes to the navigation for the given course.
2505 * This method adds nodes such as reports, blogs and participants
2507 * @param navigation_node $coursenode
2508 * @param stdClass $course
2509 * @return bool returns true on successful addition of a node.
2511 public function add_course_essentials($coursenode, stdClass
$course) {
2514 if ($course->id
== $SITE->id
) {
2515 return $this->add_front_page_course_essentials($coursenode, $course);
2518 if ($coursenode == false ||
!($coursenode instanceof navigation_node
) ||
$coursenode->get('participants', navigation_node
::TYPE_CONTAINER
)) {
2523 if (has_capability('moodle/course:viewparticipants', $this->page
->context
)) {
2524 $participants = $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id
), self
::TYPE_CONTAINER
, get_string('participants'), 'participants');
2525 if (!empty($CFG->enableblogs
)) {
2526 if (($CFG->bloglevel
== BLOG_GLOBAL_LEVEL
or ($CFG->bloglevel
== BLOG_SITE_LEVEL
and (isloggedin() and !isguestuser())))
2527 and has_capability('moodle/blog:view', context_system
::instance())) {
2528 $blogsurls = new moodle_url('/blog/index.php');
2529 if ($course->id
== $SITE->id
) {
2530 $blogsurls->param('courseid', 0);
2531 } else if ($currentgroup = groups_get_course_group($course, true)) {
2532 $blogsurls->param('groupid', $currentgroup);
2534 $blogsurls->param('courseid', $course->id
);
2536 $participants->add(get_string('blogscourse','blog'), $blogsurls->out());
2539 if (!empty($CFG->enablenotes
) && (has_capability('moodle/notes:manage', $this->page
->context
) ||
has_capability('moodle/notes:view', $this->page
->context
))) {
2540 $participants->add(get_string('notes','notes'), new moodle_url('/notes/index.php', array('filtertype'=>'course', 'filterselect'=>$course->id
)));
2542 } else if (count($this->extendforuser
) > 0 ||
$this->page
->course
->id
== $course->id
) {
2543 $participants = $coursenode->add(get_string('participants'), null, self
::TYPE_CONTAINER
, get_string('participants'), 'participants');
2547 if (!empty($CFG->enablebadges
) && !empty($CFG->badges_allowcoursebadges
) &&
2548 has_capability('moodle/badges:viewbadges', $this->page
->context
)) {
2549 $url = new moodle_url('/badges/view.php', array('type' => 2, 'id' => $course->id
));
2551 $coursenode->add(get_string('coursebadges', 'badges'), null,
2552 navigation_node
::TYPE_CONTAINER
, null, 'coursebadges');
2553 $coursenode->get('coursebadges')->add(get_string('badgesview', 'badges'), $url,
2554 navigation_node
::TYPE_SETTING
, null, 'badgesview',
2555 new pix_icon('i/badge', get_string('badgesview', 'badges')));
2561 * This generates the structure of the course that won't be generated when
2562 * the modules and sections are added.
2564 * Things such as the reports branch, the participants branch, blogs... get
2565 * added to the course node by this method.
2567 * @param navigation_node $coursenode
2568 * @param stdClass $course
2569 * @return bool True for successfull generation
2571 public function add_front_page_course_essentials(navigation_node
$coursenode, stdClass
$course) {
2574 if ($coursenode == false ||
$coursenode->get('frontpageloaded', navigation_node
::TYPE_CUSTOM
)) {
2578 // Hidden node that we use to determine if the front page navigation is loaded.
2579 // This required as there are not other guaranteed nodes that may be loaded.
2580 $coursenode->add('frontpageloaded', null, self
::TYPE_CUSTOM
, null, 'frontpageloaded')->display
= false;
2583 if (has_capability('moodle/course:viewparticipants', context_system
::instance())) {
2584 $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id
), self
::TYPE_CUSTOM
, get_string('participants'), 'participants');
2590 if (!empty($CFG->enableblogs
)
2591 and ($CFG->bloglevel
== BLOG_GLOBAL_LEVEL
or ($CFG->bloglevel
== BLOG_SITE_LEVEL
and (isloggedin() and !isguestuser())))
2592 and has_capability('moodle/blog:view', context_system
::instance())) {
2593 $blogsurls = new moodle_url('/blog/index.php', array('courseid' => $filterselect));
2594 $coursenode->add(get_string('blogssite','blog'), $blogsurls->out());
2598 if (!empty($CFG->enablebadges
) && has_capability('moodle/badges:viewbadges', $this->page
->context
)) {
2599 $url = new moodle_url($CFG->wwwroot
. '/badges/view.php', array('type' => 1));
2600 $coursenode->add(get_string('sitebadges', 'badges'), $url, navigation_node
::TYPE_CUSTOM
);
2604 if (!empty($CFG->enablenotes
) && (has_capability('moodle/notes:manage', $this->page
->context
) ||
has_capability('moodle/notes:view', $this->page
->context
))) {
2605 $coursenode->add(get_string('notes','notes'), new moodle_url('/notes/index.php', array('filtertype'=>'course', 'filterselect'=>$filterselect)));
2609 if (!empty($CFG->usetags
) && isloggedin()) {
2610 $coursenode->add(get_string('tags', 'tag'), new moodle_url('/tag/search.php'));
2615 $calendarurl = new moodle_url('/calendar/view.php', array('view' => 'month'));
2616 $coursenode->add(get_string('calendar', 'calendar'), $calendarurl, self
::TYPE_CUSTOM
, null, 'calendar');
2623 * Clears the navigation cache
2625 public function clear_cache() {
2626 $this->cache
->clear();
2630 * Sets an expansion limit for the navigation
2632 * The expansion limit is used to prevent the display of content that has a type
2633 * greater than the provided $type.
2635 * Can be used to ensure things such as activities or activity content don't get
2636 * shown on the navigation.
2637 * They are still generated in order to ensure the navbar still makes sense.
2639 * @param int $type One of navigation_node::TYPE_*
2640 * @return bool true when complete.
2642 public function set_expansion_limit($type) {
2644 $nodes = $this->find_all_of_type($type);
2646 // We only want to hide specific types of nodes.
2647 // Only nodes that represent "structure" in the navigation tree should be hidden.
2648 // If we hide all nodes then we risk hiding vital information.
2649 $typestohide = array(
2650 self
::TYPE_CATEGORY
,
2656 foreach ($nodes as $node) {
2657 // We need to generate the full site node
2658 if ($type == self
::TYPE_COURSE
&& $node->key
== $SITE->id
) {
2661 foreach ($node->children
as $child) {
2662 $child->hide($typestohide);
2668 * Attempts to get the navigation with the given key from this nodes children.
2670 * This function only looks at this nodes children, it does NOT look recursivily.
2671 * If the node can't be found then false is returned.
2673 * If you need to search recursivily then use the {@link global_navigation::find()} method.
2675 * Note: If you are trying to set the active node {@link navigation_node::override_active_url()}
2676 * may be of more use to you.
2678 * @param string|int $key The key of the node you wish to receive.
2679 * @param int $type One of navigation_node::TYPE_*
2680 * @return navigation_node|false
2682 public function get($key, $type = null) {
2683 if (!$this->initialised
) {
2684 $this->initialise();
2686 return parent
::get($key, $type);
2690 * Searches this nodes children and their children to find a navigation node
2691 * with the matching key and type.
2693 * This method is recursive and searches children so until either a node is
2694 * found or there are no more nodes to search.
2696 * If you know that the node being searched for is a child of this node
2697 * then use the {@link global_navigation::get()} method instead.
2699 * Note: If you are trying to set the active node {@link navigation_node::override_active_url()}
2700 * may be of more use to you.
2702 * @param string|int $key The key of the node you wish to receive.
2703 * @param int $type One of navigation_node::TYPE_*
2704 * @return navigation_node|false
2706 public function find($key, $type) {
2707 if (!$this->initialised
) {
2708 $this->initialise();
2710 if ($type == self
::TYPE_ROOTNODE
&& array_key_exists($key, $this->rootnodes
)) {
2711 return $this->rootnodes
[$key];
2713 return parent
::find($key, $type);
2717 * They've expanded the 'my courses' branch.
2719 protected function load_courses_enrolled() {
2721 $sortorder = 'visible DESC';
2722 // Prevent undefined $CFG->navsortmycoursessort errors.
2723 if (empty($CFG->navsortmycoursessort
)) {
2724 $CFG->navsortmycoursessort
= 'sortorder';
2726 // Append the chosen sortorder.
2727 $sortorder = $sortorder . ',' . $CFG->navsortmycoursessort
. ' ASC';
2728 $courses = enrol_get_my_courses(null, $sortorder);
2729 if (count($courses) && $this->show_my_categories()) {
2730 // OK Actually we are loading categories. We only want to load categories that have a parent of 0.
2731 // In order to make sure we load everything required we must first find the categories that are not
2732 // base categories and work out the bottom category in thier path.
2733 $categoryids = array();
2734 foreach ($courses as $course) {
2735 $categoryids[] = $course->category
;
2737 $categoryids = array_unique($categoryids);
2738 list($sql, $params) = $DB->get_in_or_equal($categoryids);
2739 $categories = $DB->get_recordset_select('course_categories', 'id '.$sql.' AND parent <> 0', $params, 'sortorder, id', 'id, path');
2740 foreach ($categories as $category) {
2741 $bits = explode('/', trim($category->path
,'/'));
2742 $categoryids[] = array_shift($bits);
2744 $categoryids = array_unique($categoryids);
2745 $categories->close();
2747 // Now we load the base categories.
2748 list($sql, $params) = $DB->get_in_or_equal($categoryids);
2749 $categories = $DB->get_recordset_select('course_categories', 'id '.$sql.' AND parent = 0', $params, 'sortorder, id');
2750 foreach ($categories as $category) {
2751 $this->add_category($category, $this->rootnodes
['mycourses'], self
::TYPE_MY_CATEGORY
);
2753 $categories->close();
2755 foreach ($courses as $course) {
2756 $this->add_course($course, false, self
::COURSE_MY
);
2763 * The global navigation class used especially for AJAX requests.
2765 * The primary methods that are used in the global navigation class have been overriden
2766 * to ensure that only the relevant branch is generated at the root of the tree.
2767 * This can be done because AJAX is only used when the backwards structure for the
2768 * requested branch exists.
2769 * This has been done only because it shortens the amounts of information that is generated
2770 * which of course will speed up the response time.. because no one likes laggy AJAX.
2773 * @category navigation
2774 * @copyright 2009 Sam Hemelryk
2775 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2777 class global_navigation_for_ajax
extends global_navigation
{
2779 /** @var int used for determining what type of navigation_node::TYPE_* is being used */
2780 protected $branchtype;
2782 /** @var int the instance id */
2783 protected $instanceid;
2785 /** @var array Holds an array of expandable nodes */
2786 protected $expandable = array();
2789 * Constructs the navigation for use in an AJAX request
2791 * @param moodle_page $page moodle_page object
2792 * @param int $branchtype
2795 public function __construct($page, $branchtype, $id) {
2796 $this->page
= $page;
2797 $this->cache
= new navigation_cache(NAVIGATION_CACHE_NAME
);
2798 $this->children
= new navigation_node_collection();
2799 $this->branchtype
= $branchtype;
2800 $this->instanceid
= $id;
2801 $this->initialise();
2804 * Initialise the navigation given the type and id for the branch to expand.
2806 * @return array An array of the expandable nodes
2808 public function initialise() {
2811 if ($this->initialised ||
during_initial_install()) {
2812 return $this->expandable
;
2814 $this->initialised
= true;
2816 $this->rootnodes
= array();
2817 $this->rootnodes
['site'] = $this->add_course($SITE);
2818 $this->rootnodes
['mycourses'] = $this->add(get_string('mycourses'), new moodle_url('/my'), self
::TYPE_ROOTNODE
, null, 'mycourses');
2819 $this->rootnodes
['courses'] = $this->add(get_string('courses'), null, self
::TYPE_ROOTNODE
, null, 'courses');
2820 // The courses branch is always displayed, and is always expandable (although may be empty).
2821 // This mimicks what is done during {@link global_navigation::initialise()}.
2822 $this->rootnodes
['courses']->isexpandable
= true;
2824 // Branchtype will be one of navigation_node::TYPE_*
2825 switch ($this->branchtype
) {
2827 if ($this->instanceid
=== 'mycourses') {
2828 $this->load_courses_enrolled();
2829 } else if ($this->instanceid
=== 'courses') {
2830 $this->load_courses_other();
2833 case self
::TYPE_CATEGORY
:
2834 $this->load_category($this->instanceid
);
2836 case self
::TYPE_MY_CATEGORY
:
2837 $this->load_category($this->instanceid
, self
::TYPE_MY_CATEGORY
);
2839 case self
::TYPE_COURSE
:
2840 $course = $DB->get_record('course', array('id' => $this->instanceid
), '*', MUST_EXIST
);
2841 if (!can_access_course($course)) {
2842 // Thats OK all courses are expandable by default. We don't need to actually expand it we can just
2843 // add the course node and break. This leads to an empty node.
2844 $this->add_course($course);
2847 require_course_login($course, true, null, false, true);
2848 $this->page
->set_context(context_course
::instance($course->id
));
2849 $coursenode = $this->add_course($course);
2850 $this->add_course_essentials($coursenode, $course);
2851 $this->load_course_sections($course, $coursenode);
2853 case self
::TYPE_SECTION
:
2854 $sql = 'SELECT c.*, cs.section AS sectionnumber
2856 LEFT JOIN {course_sections} cs ON cs.course = c.id
2858 $course = $DB->get_record_sql($sql, array($this->instanceid
), MUST_EXIST
);
2859 require_course_login($course, true, null, false, true);
2860 $this->page
->set_context(context_course
::instance($course->id
));
2861 $coursenode = $this->add_course($course);
2862 $this->add_course_essentials($coursenode, $course);
2863 $this->load_course_sections($course, $coursenode, $course->sectionnumber
);
2865 case self
::TYPE_ACTIVITY
:
2868 JOIN {course_modules} cm ON cm.course = c.id
2869 WHERE cm.id = :cmid";
2870 $params = array('cmid' => $this->instanceid
);
2871 $course = $DB->get_record_sql($sql, $params, MUST_EXIST
);
2872 $modinfo = get_fast_modinfo($course);
2873 $cm = $modinfo->get_cm($this->instanceid
);
2874 require_course_login($course, true, $cm, false, true);
2875 $this->page
->set_context(context_module
::instance($cm->id
));
2876 $coursenode = $this->load_course($course);
2877 if ($course->id
!= $SITE->id
) {
2878 $this->load_course_sections($course, $coursenode, null, $cm);
2880 $modulenode = $this->load_activity($cm, $course, $coursenode->find($cm->id
, self
::TYPE_ACTIVITY
));
2883 throw new Exception('Unknown type');
2884 return $this->expandable
;
2887 if ($this->page
->context
->contextlevel
== CONTEXT_COURSE
&& $this->page
->context
->instanceid
!= $SITE->id
) {
2888 $this->load_for_user(null, true);
2891 $this->find_expandable($this->expandable
);
2892 return $this->expandable
;
2896 * They've expanded the general 'courses' branch.
2898 protected function load_courses_other() {
2899 $this->load_all_courses();
2903 * Loads a single category into the AJAX navigation.
2905 * This function is special in that it doesn't concern itself with the parent of
2906 * the requested category or its siblings.
2907 * This is because with the AJAX navigation we know exactly what is wanted and only need to
2910 * @global moodle_database $DB
2911 * @param int $categoryid id of category to load in navigation.
2912 * @param int $nodetype type of node, if category is under MyHome then it's TYPE_MY_CATEGORY
2915 protected function load_category($categoryid, $nodetype = self
::TYPE_CATEGORY
) {
2919 if (!empty($CFG->navcourselimit
)) {
2920 $limit = (int)$CFG->navcourselimit
;
2923 $catcontextsql = context_helper
::get_preload_record_columns_sql('ctx');
2924 $sql = "SELECT cc.*, $catcontextsql
2925 FROM {course_categories} cc
2926 JOIN {context} ctx ON cc.id = ctx.instanceid
2927 WHERE ctx.contextlevel = ".CONTEXT_COURSECAT
." AND
2928 (cc.id = :categoryid1 OR cc.parent = :categoryid2)
2929 ORDER BY cc.depth ASC, cc.sortorder ASC, cc.id ASC";
2930 $params = array('categoryid1' => $categoryid, 'categoryid2' => $categoryid);
2931 $categories = $DB->get_recordset_sql($sql, $params, 0, $limit);
2932 $categorylist = array();
2933 $subcategories = array();
2934 $basecategory = null;
2935 foreach ($categories as $category) {
2936 $categorylist[] = $category->id
;
2937 context_helper
::preload_from_record($category);
2938 if ($category->id
== $categoryid) {
2939 $this->add_category($category, $this, $nodetype);
2940 $basecategory = $this->addedcategories
[$category->id
];
2942 $subcategories[$category->id
] = $category;
2945 $categories->close();
2948 // If category is shown in MyHome then only show enrolled courses and hide empty subcategories,
2949 // else show all courses.
2950 if ($nodetype === self
::TYPE_MY_CATEGORY
) {
2951 $courses = enrol_get_my_courses();
2952 $categoryids = array();
2954 // Only search for categories if basecategory was found.
2955 if (!is_null($basecategory)) {
2956 // Get course parent category ids.
2957 foreach ($courses as $course) {
2958 $categoryids[] = $course->category
;
2961 // Get a unique list of category ids which a part of the path
2962 // to user's courses.
2963 $coursesubcategories = array();
2964 $addedsubcategories = array();
2966 list($sql, $params) = $DB->get_in_or_equal($categoryids);
2967 $categories = $DB->get_recordset_select('course_categories', 'id '.$sql, $params, 'sortorder, id', 'id, path');
2969 foreach ($categories as $category){
2970 $coursesubcategories = array_merge($coursesubcategories, explode('/', trim($category->path
, "/")));
2972 $coursesubcategories = array_unique($coursesubcategories);
2974 // Only add a subcategory if it is part of the path to user's course and
2975 // wasn't already added.
2976 foreach ($subcategories as $subid => $subcategory) {
2977 if (in_array($subid, $coursesubcategories) &&
2978 !in_array($subid, $addedsubcategories)) {
2979 $this->add_category($subcategory, $basecategory, $nodetype);
2980 $addedsubcategories[] = $subid;
2985 foreach ($courses as $course) {
2986 // Add course if it's in category.
2987 if (in_array($course->category
, $categorylist)) {
2988 $this->add_course($course, true, self
::COURSE_MY
);
2992 if (!is_null($basecategory)) {
2993 foreach ($subcategories as $key=>$category) {
2994 $this->add_category($category, $basecategory, $nodetype);
2997 $courses = $DB->get_recordset('course', array('category' => $categoryid), 'sortorder', '*' , 0, $limit);
2998 foreach ($courses as $course) {
2999 $this->add_course($course);
3006 * Returns an array of expandable nodes
3009 public function get_expandable() {
3010 return $this->expandable
;
3017 * This class is used to manage the navbar, which is initialised from the navigation
3018 * object held by PAGE
3021 * @category navigation
3022 * @copyright 2009 Sam Hemelryk
3023 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3025 class navbar
extends navigation_node
{
3026 /** @var bool A switch for whether the navbar is initialised or not */
3027 protected $initialised = false;
3028 /** @var mixed keys used to reference the nodes on the navbar */
3029 protected $keys = array();
3030 /** @var null|string content of the navbar */
3031 protected $content = null;
3032 /** @var moodle_page object the moodle page that this navbar belongs to */
3034 /** @var bool A switch for whether to ignore the active navigation information */
3035 protected $ignoreactive = false;
3036 /** @var bool A switch to let us know if we are in the middle of an install */
3037 protected $duringinstall = false;
3038 /** @var bool A switch for whether the navbar has items */
3039 protected $hasitems = false;
3040 /** @var array An array of navigation nodes for the navbar */
3042 /** @var array An array of child node objects */
3043 public $children = array();
3044 /** @var bool A switch for whether we want to include the root node in the navbar */
3045 public $includesettingsbase = false;
3046 /** @var navigation_node[] $prependchildren */
3047 protected $prependchildren = array();
3049 * The almighty constructor
3051 * @param moodle_page $page
3053 public function __construct(moodle_page
$page) {
3055 if (during_initial_install()) {
3056 $this->duringinstall
= true;
3059 $this->page
= $page;
3060 $this->text
= get_string('home');
3061 $this->shorttext
= get_string('home');
3062 $this->action
= new moodle_url($CFG->wwwroot
);
3063 $this->nodetype
= self
::NODETYPE_BRANCH
;
3064 $this->type
= self
::TYPE_SYSTEM
;
3068 * Quick check to see if the navbar will have items in.
3070 * @return bool Returns true if the navbar will have items, false otherwise
3072 public function has_items() {
3073 if ($this->duringinstall
) {
3075 } else if ($this->hasitems
!== false) {
3078 $this->page
->navigation
->initialise($this->page
);
3080 $activenodefound = ($this->page
->navigation
->contains_active_node() ||
3081 $this->page
->settingsnav
->contains_active_node());
3083 $outcome = (count($this->children
) > 0 ||
count($this->prependchildren
) ||
(!$this->ignoreactive
&& $activenodefound));
3084 $this->hasitems
= $outcome;
3089 * Turn on/off ignore active
3091 * @param bool $setting
3093 public function ignore_active($setting=true) {
3094 $this->ignoreactive
= ($setting);
3098 * Gets a navigation node
3100 * @param string|int $key for referencing the navbar nodes
3101 * @param int $type navigation_node::TYPE_*
3102 * @return navigation_node|bool
3104 public function get($key, $type = null) {
3105 foreach ($this->children
as &$child) {
3106 if ($child->key
=== $key && ($type == null ||
$type == $child->type
)) {
3110 foreach ($this->prependchildren
as &$child) {
3111 if ($child->key
=== $key && ($type == null ||
$type == $child->type
)) {
3118 * Returns an array of navigation_node's that make up the navbar.
3122 public function get_items() {
3125 // Make sure that navigation is initialised
3126 if (!$this->has_items()) {
3129 if ($this->items
!== null) {
3130 return $this->items
;
3133 if (count($this->children
) > 0) {
3134 // Add the custom children.
3135 $items = array_reverse($this->children
);
3138 $navigationactivenode = $this->page
->navigation
->find_active_node();
3139 $settingsactivenode = $this->page
->settingsnav
->find_active_node();
3141 // Check if navigation contains the active node
3142 if (!$this->ignoreactive
) {
3144 if ($navigationactivenode && $settingsactivenode) {
3145 // Parse a combined navigation tree
3146 while ($settingsactivenode && $settingsactivenode->parent
!== null) {
3147 if (!$settingsactivenode->mainnavonly
) {
3148 $items[] = $settingsactivenode;
3150 $settingsactivenode = $settingsactivenode->parent
;
3152 if (!$this->includesettingsbase
) {
3153 // Removes the first node from the settings (root node) from the list
3156 while ($navigationactivenode && $navigationactivenode->parent
!== null) {
3157 if (!$navigationactivenode->mainnavonly
) {
3158 $items[] = $navigationactivenode;
3160 if (!empty($CFG->navshowcategories
) &&
3161 $navigationactivenode->type
=== self
::TYPE_COURSE
&&
3162 $navigationactivenode->parent
->key
=== 'currentcourse') {
3163 $items = array_merge($items, $this->get_course_categories());
3165 $navigationactivenode = $navigationactivenode->parent
;
3167 } else if ($navigationactivenode) {
3168 // Parse the navigation tree to get the active node
3169 while ($navigationactivenode && $navigationactivenode->parent
!== null) {
3170 if (!$navigationactivenode->mainnavonly
) {
3171 $items[] = $navigationactivenode;
3173 if (!empty($CFG->navshowcategories
) &&
3174 $navigationactivenode->type
=== self
::TYPE_COURSE
&&
3175 $navigationactivenode->parent
->key
=== 'currentcourse') {
3176 $items = array_merge($items, $this->get_course_categories());
3178 $navigationactivenode = $navigationactivenode->parent
;
3180 } else if ($settingsactivenode) {
3181 // Parse the settings navigation to get the active node
3182 while ($settingsactivenode && $settingsactivenode->parent
!== null) {
3183 if (!$settingsactivenode->mainnavonly
) {
3184 $items[] = $settingsactivenode;
3186 $settingsactivenode = $settingsactivenode->parent
;
3191 $items[] = new navigation_node(array(
3192 'text'=>$this->page
->navigation
->text
,
3193 'shorttext'=>$this->page
->navigation
->shorttext
,
3194 'key'=>$this->page
->navigation
->key
,
3195 'action'=>$this->page
->navigation
->action
3198 if (count($this->prependchildren
) > 0) {
3199 // Add the custom children
3200 $items = array_merge($items, array_reverse($this->prependchildren
));
3203 $this->items
= array_reverse($items);
3204 return $this->items
;
3208 * Get the list of categories leading to this course.
3210 * This function is used by {@link navbar::get_items()} to add back the "courses"
3211 * node and category chain leading to the current course. Note that this is only ever
3212 * called for the current course, so we don't need to bother taking in any parameters.
3216 private function get_course_categories() {
3219 require_once($CFG->dirroot
.'/course/lib.php');
3220 $categories = array();
3221 $cap = 'moodle/category:viewhiddencategories';
3222 foreach ($this->page
->categories
as $category) {
3223 if (!$category->visible
&& !has_capability($cap, get_category_or_system_context($category->parent
))) {
3226 $url = new moodle_url('/course/index.php', array('categoryid' => $category->id
));
3227 $name = format_string($category->name
, true, array('context' => context_coursecat
::instance($category->id
)));
3228 $categorynode = navigation_node
::create($name, $url, self
::TYPE_CATEGORY
, null, $category->id
);
3229 if (!$category->visible
) {
3230 $categorynode->hidden
= true;
3232 $categories[] = $categorynode;
3234 if (is_enrolled(context_course
::instance($this->page
->course
->id
))) {
3235 $courses = $this->page
->navigation
->get('mycourses');
3237 $courses = $this->page
->navigation
->get('courses');
3240 // Courses node may not be present.
3241 $courses = navigation_node
::create(
3242 get_string('courses'),
3243 new moodle_url('/course/index.php'),
3244 self
::TYPE_CONTAINER
3247 $categories[] = $courses;
3252 * Add a new navigation_node to the navbar, overrides parent::add
3254 * This function overrides {@link navigation_node::add()} so that we can change
3255 * the way nodes get added to allow us to simply call add and have the node added to the
3258 * @param string $text
3259 * @param string|moodle_url|action_link $action An action to associate with this node.
3260 * @param int $type One of navigation_node::TYPE_*
3261 * @param string $shorttext
3262 * @param string|int $key A key to identify this node with. Key + type is unique to a parent.
3263 * @param pix_icon $icon An optional icon to use for this node.
3264 * @return navigation_node
3266 public function add($text, $action=null, $type=self
::TYPE_CUSTOM
, $shorttext=null, $key=null, pix_icon
$icon=null) {
3267 if ($this->content
!== null) {
3268 debugging('Nav bar items must be printed before $OUTPUT->header() has been called', DEBUG_DEVELOPER
);
3271 // Properties array used when creating the new navigation node
3276 // Set the action if one was provided
3277 if ($action!==null) {
3278 $itemarray['action'] = $action;
3280 // Set the shorttext if one was provided
3281 if ($shorttext!==null) {
3282 $itemarray['shorttext'] = $shorttext;
3284 // Set the icon if one was provided
3286 $itemarray['icon'] = $icon;
3288 // Default the key to the number of children if not provided
3289 if ($key === null) {
3290 $key = count($this->children
);
3293 $itemarray['key'] = $key;
3294 // Set the parent to this node
3295 $itemarray['parent'] = $this;
3296 // Add the child using the navigation_node_collections add method
3297 $this->children
[] = new navigation_node($itemarray);
3302 * Prepends a new navigation_node to the start of the navbar
3304 * @param string $text
3305 * @param string|moodle_url|action_link $action An action to associate with this node.
3306 * @param int $type One of navigation_node::TYPE_*
3307 * @param string $shorttext
3308 * @param string|int $key A key to identify this node with. Key + type is unique to a parent.
3309 * @param pix_icon $icon An optional icon to use for this node.
3310 * @return navigation_node
3312 public function prepend($text, $action=null, $type=self
::TYPE_CUSTOM
, $shorttext=null, $key=null, pix_icon
$icon=null) {
3313 if ($this->content
!== null) {
3314 debugging('Nav bar items must be printed before $OUTPUT->header() has been called', DEBUG_DEVELOPER
);
3316 // Properties array used when creating the new navigation node.
3321 // Set the action if one was provided.
3322 if ($action!==null) {
3323 $itemarray['action'] = $action;
3325 // Set the shorttext if one was provided.
3326 if ($shorttext!==null) {
3327 $itemarray['shorttext'] = $shorttext;
3329 // Set the icon if one was provided.
3331 $itemarray['icon'] = $icon;
3333 // Default the key to the number of children if not provided.
3334 if ($key === null) {
3335 $key = count($this->children
);
3338 $itemarray['key'] = $key;
3339 // Set the parent to this node.
3340 $itemarray['parent'] = $this;
3341 // Add the child node to the prepend list.
3342 $this->prependchildren
[] = new navigation_node($itemarray);
3348 * Class used to manage the settings option for the current page
3350 * This class is used to manage the settings options in a tree format (recursively)
3351 * and was created initially for use with the settings blocks.
3354 * @category navigation
3355 * @copyright 2009 Sam Hemelryk
3356 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3358 class settings_navigation
extends navigation_node
{
3359 /** @var stdClass the current context */
3361 /** @var moodle_page the moodle page that the navigation belongs to */
3363 /** @var string contains administration section navigation_nodes */
3364 protected $adminsection;
3365 /** @var bool A switch to see if the navigation node is initialised */
3366 protected $initialised = false;
3367 /** @var array An array of users that the nodes can extend for. */
3368 protected $userstoextendfor = array();
3369 /** @var navigation_cache **/
3373 * Sets up the object with basic settings and preparse it for use
3375 * @param moodle_page $page
3377 public function __construct(moodle_page
&$page) {
3378 if (during_initial_install()) {
3381 $this->page
= $page;
3382 // Initialise the main navigation. It is most important that this is done
3383 // before we try anything
3384 $this->page
->navigation
->initialise();
3385 // Initialise the navigation cache
3386 $this->cache
= new navigation_cache(NAVIGATION_CACHE_NAME
);
3387 $this->children
= new navigation_node_collection();
3390 * Initialise the settings navigation based on the current context
3392 * This function initialises the settings navigation tree for a given context
3393 * by calling supporting functions to generate major parts of the tree.
3396 public function initialise() {
3397 global $DB, $SESSION, $SITE;
3399 if (during_initial_install()) {
3401 } else if ($this->initialised
) {
3404 $this->id
= 'settingsnav';
3405 $this->context
= $this->page
->context
;
3407 $context = $this->context
;
3408 if ($context->contextlevel
== CONTEXT_BLOCK
) {
3409 $this->load_block_settings();
3410 $context = $context->get_parent_context();
3412 switch ($context->contextlevel
) {
3413 case CONTEXT_SYSTEM
:
3414 if ($this->page
->url
->compare(new moodle_url('/admin/settings.php', array('section'=>'frontpagesettings')))) {
3415 $this->load_front_page_settings(($context->id
== $this->context
->id
));
3418 case CONTEXT_COURSECAT
:
3419 $this->load_category_settings();
3421 case CONTEXT_COURSE
:
3422 if ($this->page
->course
->id
!= $SITE->id
) {
3423 $this->load_course_settings(($context->id
== $this->context
->id
));
3425 $this->load_front_page_settings(($context->id
== $this->context
->id
));
3428 case CONTEXT_MODULE
:
3429 $this->load_module_settings();
3430 $this->load_course_settings();
3433 if ($this->page
->course
->id
!= $SITE->id
) {
3434 $this->load_course_settings();
3439 $usersettings = $this->load_user_settings($this->page
->course
->id
);
3441 $adminsettings = false;
3442 if (isloggedin() && !isguestuser() && (!isset($SESSION->load_navigation_admin
) ||
$SESSION->load_navigation_admin
)) {
3443 $isadminpage = $this->is_admin_tree_needed();
3445 if (has_capability('moodle/site:config', context_system
::instance())) {
3446 // Make sure this works even if config capability changes on the fly
3447 // and also make it fast for admin right after login.
3448 $SESSION->load_navigation_admin
= 1;
3450 $adminsettings = $this->load_administration_settings();
3453 } else if (!isset($SESSION->load_navigation_admin
)) {
3454 $adminsettings = $this->load_administration_settings();
3455 $SESSION->load_navigation_admin
= (int)($adminsettings->children
->count() > 0);
3457 } else if ($SESSION->load_navigation_admin
) {
3459 $adminsettings = $this->load_administration_settings();
3463 // Print empty navigation node, if needed.
3464 if ($SESSION->load_navigation_admin
&& !$isadminpage) {
3465 if ($adminsettings) {
3466 // Do not print settings tree on pages that do not need it, this helps with performance.
3467 $adminsettings->remove();
3468 $adminsettings = false;
3470 $siteadminnode = $this->add(get_string('administrationsite'), new moodle_url('/admin'), self
::TYPE_SITE_ADMIN
, null, 'siteadministration');
3471 $siteadminnode->id
= 'expandable_branch_'.$siteadminnode->type
.'_'.clean_param($siteadminnode->key
, PARAM_ALPHANUMEXT
);
3472 $this->page
->requires
->data_for_js('siteadminexpansion', $siteadminnode);
3476 if ($context->contextlevel
== CONTEXT_SYSTEM
&& $adminsettings) {
3477 $adminsettings->force_open();
3478 } else if ($context->contextlevel
== CONTEXT_USER
&& $usersettings) {
3479 $usersettings->force_open();
3482 // Check if the user is currently logged in as another user
3483 if (\core\session\manager
::is_loggedinas()) {
3484 // Get the actual user, we need this so we can display an informative return link
3485 $realuser = \core\session\manager
::get_realuser();
3486 // Add the informative return to original user link
3487 $url = new moodle_url('/course/loginas.php',array('id'=>$this->page
->course
->id
, 'return'=>1,'sesskey'=>sesskey()));
3488 $this->add(get_string('returntooriginaluser', 'moodle', fullname($realuser, true)), $url, self
::TYPE_SETTING
, null, null, new pix_icon('t/left', ''));
3491 // At this point we give any local plugins the ability to extend/tinker with the navigation settings.
3492 $this->load_local_plugin_settings();
3494 foreach ($this->children
as $key=>$node) {
3495 if ($node->nodetype
!= self
::NODETYPE_BRANCH ||
$node->children
->count()===0) {
3496 // Site administration is shown as link.
3497 if (!empty($SESSION->load_navigation_admin
) && ($node->type
=== self
::TYPE_SITE_ADMIN
)) {
3503 $this->initialised
= true;
3506 * Override the parent function so that we can add preceeding hr's and set a
3507 * root node class against all first level element
3509 * It does this by first calling the parent's add method {@link navigation_node::add()}
3510 * and then proceeds to use the key to set class and hr
3512 * @param string $text text to be used for the link.
3513 * @param string|moodle_url $url url for the new node
3514 * @param int $type the type of node navigation_node::TYPE_*
3515 * @param string $shorttext
3516 * @param string|int $key a key to access the node by.
3517 * @param pix_icon $icon An icon that appears next to the node.
3518 * @return navigation_node with the new node added to it.
3520 public function add($text, $url=null, $type=null, $shorttext=null, $key=null, pix_icon
$icon=null) {
3521 $node = parent
::add($text, $url, $type, $shorttext, $key, $icon);
3522 $node->add_class('root_node');
3527 * This function allows the user to add something to the start of the settings
3528 * navigation, which means it will be at the top of the settings navigation block
3530 * @param string $text text to be used for the link.
3531 * @param string|moodle_url $url url for the new node
3532 * @param int $type the type of node navigation_node::TYPE_*
3533 * @param string $shorttext
3534 * @param string|int $key a key to access the node by.
3535 * @param pix_icon $icon An icon that appears next to the node.
3536 * @return navigation_node $node with the new node added to it.
3538 public function prepend($text, $url=null, $type=null, $shorttext=null, $key=null, pix_icon
$icon=null) {
3539 $children = $this->children
;
3540 $childrenclass = get_class($children);
3541 $this->children
= new $childrenclass;
3542 $node = $this->add($text, $url, $type, $shorttext, $key, $icon);
3543 foreach ($children as $child) {
3544 $this->children
->add($child);
3550 * Does this page require loading of full admin tree or is
3551 * it enough rely on AJAX?
3555 protected function is_admin_tree_needed() {
3556 if (self
::$loadadmintree) {
3557 // Usually external admin page or settings page.
3561 if ($this->page
->pagelayout
=== 'admin' or strpos($this->page
->pagetype
, 'admin-') === 0) {
3562 // Admin settings tree is intended for system level settings and management only, use navigation for the rest!
3563 if ($this->page
->context
->contextlevel
!= CONTEXT_SYSTEM
) {
3573 * Load the site administration tree
3575 * This function loads the site administration tree by using the lib/adminlib library functions
3577 * @param navigation_node $referencebranch A reference to a branch in the settings
3579 * @param part_of_admin_tree $adminbranch The branch to add, if null generate the admin
3580 * tree and start at the beginning
3581 * @return mixed A key to access the admin tree by
3583 protected function load_administration_settings(navigation_node
$referencebranch=null, part_of_admin_tree
$adminbranch=null) {
3586 // Check if we are just starting to generate this navigation.
3587 if ($referencebranch === null) {
3589 // Require the admin lib then get an admin structure
3590 if (!function_exists('admin_get_root')) {
3591 require_once($CFG->dirroot
.'/lib/adminlib.php');
3593 $adminroot = admin_get_root(false, false);
3594 // This is the active section identifier
3595 $this->adminsection
= $this->page
->url
->param('section');
3597 // Disable the navigation from automatically finding the active node
3598 navigation_node
::$autofindactive = false;
3599 $referencebranch = $this->add(get_string('administrationsite'), null, self
::TYPE_SITE_ADMIN
, null, 'root');
3600 foreach ($adminroot->children
as $adminbranch) {
3601 $this->load_administration_settings($referencebranch, $adminbranch);
3603 navigation_node
::$autofindactive = true;
3605 // Use the admin structure to locate the active page
3606 if (!$this->contains_active_node() && $current = $adminroot->locate($this->adminsection
, true)) {
3607 $currentnode = $this;
3608 while (($pathkey = array_pop($current->path
))!==null && $currentnode) {
3609 $currentnode = $currentnode->get($pathkey);
3612 $currentnode->make_active();
3615 $this->scan_for_active_node($referencebranch);
3617 return $referencebranch;
3618 } else if ($adminbranch->check_access()) {
3619 // We have a reference branch that we can access and is not hidden `hurrah`
3620 // Now we need to display it and any children it may have
3623 if ($adminbranch instanceof admin_settingpage
) {
3624 $url = new moodle_url('/'.$CFG->admin
.'/settings.php', array('section'=>$adminbranch->name
));
3625 } else if ($adminbranch instanceof admin_externalpage
) {
3626 $url = $adminbranch->url
;
3627 } else if (!empty($CFG->linkadmincategories
) && $adminbranch instanceof admin_category
) {
3628 $url = new moodle_url('/'.$CFG->admin
.'/category.php', array('category' => $adminbranch->name
));
3632 $reference = $referencebranch->add($adminbranch->visiblename
, $url, self
::TYPE_SETTING
, null, $adminbranch->name
, $icon);
3634 if ($adminbranch->is_hidden()) {
3635 if (($adminbranch instanceof admin_externalpage ||
$adminbranch instanceof admin_settingpage
) && $adminbranch->name
== $this->adminsection
) {
3636 $reference->add_class('hidden');
3638 $reference->display
= false;
3642 // Check if we are generating the admin notifications and whether notificiations exist
3643 if ($adminbranch->name
=== 'adminnotifications' && admin_critical_warnings_present()) {
3644 $reference->add_class('criticalnotification');
3646 // Check if this branch has children
3647 if ($reference && isset($adminbranch->children
) && is_array($adminbranch->children
) && count($adminbranch->children
)>0) {
3648 foreach ($adminbranch->children
as $branch) {
3649 // Generate the child branches as well now using this branch as the reference
3650 $this->load_administration_settings($reference, $branch);
3653 $reference->icon
= new pix_icon('i/settings', '');
3659 * This function recursivily scans nodes until it finds the active node or there
3660 * are no more nodes.
3661 * @param navigation_node $node
3663 protected function scan_for_active_node(navigation_node
$node) {
3664 if (!$node->check_if_active() && $node->children
->count()>0) {
3665 foreach ($node->children
as &$child) {
3666 $this->scan_for_active_node($child);
3672 * Gets a navigation node given an array of keys that represent the path to
3675 * @param array $path
3676 * @return navigation_node|false
3678 protected function get_by_path(array $path) {
3679 $node = $this->get(array_shift($path));
3680 foreach ($path as $key) {
3687 * This function loads the course settings that are available for the user
3689 * @param bool $forceopen If set to true the course node will be forced open
3690 * @return navigation_node|false
3692 protected function load_course_settings($forceopen = false) {
3695 $course = $this->page
->course
;
3696 $coursecontext = context_course
::instance($course->id
);
3698 // note: do not test if enrolled or viewing here because we need the enrol link in Course administration section
3700 $coursenode = $this->add(get_string('courseadministration'), null, self
::TYPE_COURSE
, null, 'courseadmin');
3702 $coursenode->force_open();
3705 if ($this->page
->user_allowed_editing()) {
3706 // Add the turn on/off settings
3708 if ($this->page
->url
->compare(new moodle_url('/course/view.php'), URL_MATCH_BASE
)) {
3709 // We are on the course page, retain the current page params e.g. section.
3710 $baseurl = clone($this->page
->url
);
3711 $baseurl->param('sesskey', sesskey());
3713 // Edit on the main course page.
3714 $baseurl = new moodle_url('/course/view.php', array('id'=>$course->id
, 'return'=>$this->page
->url
->out_as_local_url(false), 'sesskey'=>sesskey()));
3717 $editurl = clone($baseurl);
3718 if ($this->page
->user_is_editing()) {
3719 $editurl->param('edit', 'off');
3720 $editstring = get_string('turneditingoff');
3722 $editurl->param('edit', 'on');
3723 $editstring = get_string('turneditingon');
3725 $coursenode->add($editstring, $editurl, self
::TYPE_SETTING
, null, 'turneditingonoff', new pix_icon('i/edit', ''));
3728 if (has_capability('moodle/course:update', $coursecontext)) {
3729 // Add the course settings link
3730 $url = new moodle_url('/course/edit.php', array('id'=>$course->id
));
3731 $coursenode->add(get_string('editsettings'), $url, self
::TYPE_SETTING
, null, 'editsettings', new pix_icon('i/settings', ''));
3733 // Add the course completion settings link
3734 if ($CFG->enablecompletion
&& $course->enablecompletion
) {
3735 $url = new moodle_url('/course/completion.php', array('id'=>$course->id
));
3736 $coursenode->add(get_string('coursecompletion', 'completion'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/settings', ''));
3741 enrol_add_course_navigation($coursenode, $course);
3744 if (has_capability('moodle/filter:manage', $coursecontext) && count(filter_get_available_in_context($coursecontext))>0) {
3745 $url = new moodle_url('/filter/manage.php', array('contextid'=>$coursecontext->id
));
3746 $coursenode->add(get_string('filters', 'admin'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/filter', ''));
3749 // View course reports.
3750 if (has_capability('moodle/site:viewreports', $coursecontext)) { // Basic capability for listing of reports.
3751 $reportnav = $coursenode->add(get_string('reports'), null, self
::TYPE_CONTAINER
, null, null,
3752 new pix_icon('i/stats', ''));
3753 $coursereports = core_component
::get_plugin_list('coursereport');
3754 foreach ($coursereports as $report => $dir) {
3755 $libfile = $CFG->dirroot
.'/course/report/'.$report.'/lib.php';
3756 if (file_exists($libfile)) {
3757 require_once($libfile);
3758 $reportfunction = $report.'_report_extend_navigation';
3759 if (function_exists($report.'_report_extend_navigation')) {
3760 $reportfunction($reportnav, $course, $coursecontext);
3765 $reports = get_plugin_list_with_function('report', 'extend_navigation_course', 'lib.php');
3766 foreach ($reports as $reportfunction) {
3767 $reportfunction($reportnav, $course, $coursecontext);
3771 // Add view grade report is permitted
3772 $reportavailable = false;
3773 if (has_capability('moodle/grade:viewall', $coursecontext)) {
3774 $reportavailable = true;
3775 } else if (!empty($course->showgrades
)) {
3776 $reports = core_component
::get_plugin_list('gradereport');
3777 if (is_array($reports) && count($reports)>0) { // Get all installed reports
3778 arsort($reports); // user is last, we want to test it first
3779 foreach ($reports as $plugin => $plugindir) {
3780 if (has_capability('gradereport/'.$plugin.':view', $coursecontext)) {
3781 //stop when the first visible plugin is found
3782 $reportavailable = true;
3788 if ($reportavailable) {
3789 $url = new moodle_url('/grade/report/index.php', array('id'=>$course->id
));
3790 $gradenode = $coursenode->add(get_string('grades'), $url, self
::TYPE_SETTING
, null, 'grades', new pix_icon('i/grades', ''));
3793 // Add outcome if permitted
3794 if (!empty($CFG->enableoutcomes
) && has_capability('moodle/course:update', $coursecontext)) {
3795 $url = new moodle_url('/grade/edit/outcome/course.php', array('id'=>$course->id
));
3796 $coursenode->add(get_string('outcomes', 'grades'), $url, self
::TYPE_SETTING
, null, 'outcomes', new pix_icon('i/outcomes', ''));
3799 //Add badges navigation
3800 require_once($CFG->libdir
.'/badgeslib.php');
3801 badges_add_course_navigation($coursenode, $course);
3803 // Backup this course
3804 if (has_capability('moodle/backup:backupcourse', $coursecontext)) {
3805 $url = new moodle_url('/backup/backup.php', array('id'=>$course->id
));
3806 $coursenode->add(get_string('backup'), $url, self
::TYPE_SETTING
, null, 'backup', new pix_icon('i/backup', ''));
3809 // Restore to this course
3810 if (has_capability('moodle/restore:restorecourse', $coursecontext)) {
3811 $url = new moodle_url('/backup/restorefile.php', array('contextid'=>$coursecontext->id
));
3812 $coursenode->add(get_string('restore'), $url, self
::TYPE_SETTING
, null, 'restore', new pix_icon('i/restore', ''));
3815 // Import data from other courses
3816 if (has_capability('moodle/restore:restoretargetimport', $coursecontext)) {
3817 $url = new moodle_url('/backup/import.php', array('id'=>$course->id
));
3818 $coursenode->add(get_string('import'), $url, self
::TYPE_SETTING
, null, 'import', new pix_icon('i/import', ''));
3821 // Publish course on a hub
3822 if (has_capability('moodle/course:publish', $coursecontext)) {
3823 $url = new moodle_url('/course/publish/index.php', array('id'=>$course->id
));
3824 $coursenode->add(get_string('publish'), $url, self
::TYPE_SETTING
, null, 'publish', new pix_icon('i/publish', ''));
3827 // Reset this course
3828 if (has_capability('moodle/course:reset', $coursecontext)) {
3829 $url = new moodle_url('/course/reset.php', array('id'=>$course->id
));
3830 $coursenode->add(get_string('reset'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/return', ''));
3834 require_once($CFG->libdir
. '/questionlib.php');
3835 question_extend_settings_navigation($coursenode, $coursecontext)->trim_if_empty();
3837 if (has_capability('moodle/course:update', $coursecontext)) {
3838 // Repository Instances
3839 if (!$this->cache
->cached('contexthasrepos'.$coursecontext->id
)) {
3840 require_once($CFG->dirroot
. '/repository/lib.php');
3841 $editabletypes = repository
::get_editable_types($coursecontext);
3842 $haseditabletypes = !empty($editabletypes);
3843 unset($editabletypes);
3844 $this->cache
->set('contexthasrepos'.$coursecontext->id
, $haseditabletypes);
3846 $haseditabletypes = $this->cache
->{'contexthasrepos'.$coursecontext->id
};
3848 if ($haseditabletypes) {
3849 $url = new moodle_url('/repository/manage_instances.php', array('contextid' => $coursecontext->id
));
3850 $coursenode->add(get_string('repositories'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/repository', ''));
3855 if ($course->legacyfiles
== 2 and has_capability('moodle/course:managefiles', $coursecontext)) {
3856 // hidden in new courses and courses where legacy files were turned off
3857 $url = new moodle_url('/files/index.php', array('contextid'=>$coursecontext->id
));
3858 $coursenode->add(get_string('courselegacyfiles'), $url, self
::TYPE_SETTING
, null, 'coursefiles', new pix_icon('i/folder', ''));
3864 $assumedrole = $this->in_alternative_role();
3865 if ($assumedrole !== false) {
3866 $roles[0] = get_string('switchrolereturn');
3868 if (has_capability('moodle/role:switchroles', $coursecontext)) {
3869 $availableroles = get_switchable_roles($coursecontext);
3870 if (is_array($availableroles)) {
3871 foreach ($availableroles as $key=>$role) {
3872 if ($assumedrole == (int)$key) {
3875 $roles[$key] = $role;
3879 if (is_array($roles) && count($roles)>0) {
3880 $switchroles = $this->add(get_string('switchroleto'));
3881 if ((count($roles)==1 && array_key_exists(0, $roles))||
$assumedrole!==false) {
3882 $switchroles->force_open();
3884 foreach ($roles as $key => $name) {
3885 $url = new moodle_url('/course/switchrole.php', array('id'=>$course->id
, 'sesskey'=>sesskey(), 'switchrole'=>$key, 'returnurl'=>$this->page
->url
->out_as_local_url(false)));
3886 $switchroles->add($name, $url, self
::TYPE_SETTING
, null, $key, new pix_icon('i/switchrole', ''));
3889 // Return we are done
3894 * This function calls the module function to inject module settings into the
3895 * settings navigation tree.
3897 * This only gets called if there is a corrosponding function in the modules
3900 * For examples mod/forum/lib.php {@link forum_extend_settings_navigation()}
3902 * @return navigation_node|false
3904 protected function load_module_settings() {
3907 if (!$this->page
->cm
&& $this->context
->contextlevel
== CONTEXT_MODULE
&& $this->context
->instanceid
) {
3908 $cm = get_coursemodule_from_id(false, $this->context
->instanceid
, 0, false, MUST_EXIST
);
3909 $this->page
->set_cm($cm, $this->page
->course
);
3912 $file = $CFG->dirroot
.'/mod/'.$this->page
->activityname
.'/lib.php';
3913 if (file_exists($file)) {
3914 require_once($file);
3917 $modulenode = $this->add(get_string('pluginadministration', $this->page
->activityname
), null, self
::TYPE_SETTING
, null, 'modulesettings');
3918 $modulenode->force_open();
3920 // Settings for the module
3921 if (has_capability('moodle/course:manageactivities', $this->page
->cm
->context
)) {
3922 $url = new moodle_url('/course/modedit.php', array('update' => $this->page
->cm
->id
, 'return' => 1));
3923 $modulenode->add(get_string('editsettings'), $url, navigation_node
::TYPE_SETTING
, null, 'modedit');
3925 // Assign local roles
3926 if (count(get_assignable_roles($this->page
->cm
->context
))>0) {
3927 $url = new moodle_url('/'.$CFG->admin
.'/roles/assign.php', array('contextid'=>$this->page
->cm
->context
->id
));
3928 $modulenode->add(get_string('localroles', 'role'), $url, self
::TYPE_SETTING
, null, 'roleassign');
3931 if (has_capability('moodle/role:review', $this->page
->cm
->context
) or count(get_overridable_roles($this->page
->cm
->context
))>0) {
3932 $url = new moodle_url('/'.$CFG->admin
.'/roles/permissions.php', array('contextid'=>$this->page
->cm
->context
->id
));
3933 $modulenode->add(get_string('permissions', 'role'), $url, self
::TYPE_SETTING
, null, 'roleoverride');
3935 // Check role permissions
3936 if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:assign'), $this->page
->cm
->context
)) {
3937 $url = new moodle_url('/'.$CFG->admin
.'/roles/check.php', array('contextid'=>$this->page
->cm
->context
->id
));
3938 $modulenode->add(get_string('checkpermissions', 'role'), $url, self
::TYPE_SETTING
, null, 'rolecheck');
3941 if (has_capability('moodle/filter:manage', $this->page
->cm
->context
) && count(filter_get_available_in_context($this->page
->cm
->context
))>0) {
3942 $url = new moodle_url('/filter/manage.php', array('contextid'=>$this->page
->cm
->context
->id
));
3943 $modulenode->add(get_string('filters', 'admin'), $url, self
::TYPE_SETTING
, null, 'filtermanage');
3946 $reports = get_plugin_list_with_function('report', 'extend_navigation_module', 'lib.php');
3947 foreach ($reports as $reportfunction) {
3948 $reportfunction($modulenode, $this->page
->cm
);
3950 // Add a backup link
3951 $featuresfunc = $this->page
->activityname
.'_supports';
3952 if (function_exists($featuresfunc) && $featuresfunc(FEATURE_BACKUP_MOODLE2
) && has_capability('moodle/backup:backupactivity', $this->page
->cm
->context
)) {
3953 $url = new moodle_url('/backup/backup.php', array('id'=>$this->page
->cm
->course
, 'cm'=>$this->page
->cm
->id
));
3954 $modulenode->add(get_string('backup'), $url, self
::TYPE_SETTING
, null, 'backup');
3957 // Restore this activity
3958 $featuresfunc = $this->page
->activityname
.'_supports';
3959 if (function_exists($featuresfunc) && $featuresfunc(FEATURE_BACKUP_MOODLE2
) && has_capability('moodle/restore:restoreactivity', $this->page
->cm
->context
)) {
3960 $url = new moodle_url('/backup/restorefile.php', array('contextid'=>$this->page
->cm
->context
->id
));
3961 $modulenode->add(get_string('restore'), $url, self
::TYPE_SETTING
, null, 'restore');
3964 // Allow the active advanced grading method plugin to append its settings
3965 $featuresfunc = $this->page
->activityname
.'_supports';
3966 if (function_exists($featuresfunc) && $featuresfunc(FEATURE_ADVANCED_GRADING
) && has_capability('moodle/grade:managegradingforms', $this->page
->cm
->context
)) {
3967 require_once($CFG->dirroot
.'/grade/grading/lib.php');
3968 $gradingman = get_grading_manager($this->page
->cm
->context
, $this->page
->activityname
);
3969 $gradingman->extend_settings_navigation($this, $modulenode);
3972 $function = $this->page
->activityname
.'_extend_settings_navigation';
3973 if (!function_exists($function)) {
3977 $function($this, $modulenode);
3979 // Remove the module node if there are no children
3980 if (empty($modulenode->children
)) {
3981 $modulenode->remove();
3988 * Loads the user settings block of the settings nav
3990 * This function is simply works out the userid and whether we need to load
3991 * just the current users profile settings, or the current user and the user the
3992 * current user is viewing.
3994 * This function has some very ugly code to work out the user, if anyone has
3995 * any bright ideas please feel free to intervene.
3997 * @param int $courseid The course id of the current course
3998 * @return navigation_node|false
4000 protected function load_user_settings($courseid = SITEID
) {
4003 if (isguestuser() ||
!isloggedin()) {
4007 $navusers = $this->page
->navigation
->get_extending_users();
4009 if (count($this->userstoextendfor
) > 0 ||
count($navusers) > 0) {
4011 foreach ($this->userstoextendfor
as $userid) {
4012 if ($userid == $USER->id
) {
4015 $node = $this->generate_user_settings($courseid, $userid, 'userviewingsettings');
4016 if (is_null($usernode)) {
4020 foreach ($navusers as $user) {
4021 if ($user->id
== $USER->id
) {
4024 $node = $this->generate_user_settings($courseid, $user->id
, 'userviewingsettings');
4025 if (is_null($usernode)) {
4029 $this->generate_user_settings($courseid, $USER->id
);
4031 $usernode = $this->generate_user_settings($courseid, $USER->id
);
4037 * Extends the settings navigation for the given user.
4039 * Note: This method gets called automatically if you call
4040 * $PAGE->navigation->extend_for_user($userid)
4042 * @param int $userid
4044 public function extend_for_user($userid) {
4047 if (!in_array($userid, $this->userstoextendfor
)) {
4048 $this->userstoextendfor
[] = $userid;
4049 if ($this->initialised
) {
4050 $this->generate_user_settings($this->page
->course
->id
, $userid, 'userviewingsettings');
4051 $children = array();
4052 foreach ($this->children
as $child) {
4053 $children[] = $child;
4055 array_unshift($children, array_pop($children));
4056 $this->children
= new navigation_node_collection();
4057 foreach ($children as $child) {
4058 $this->children
->add($child);
4065 * This function gets called by {@link settings_navigation::load_user_settings()} and actually works out
4066 * what can be shown/done
4068 * @param int $courseid The current course' id
4069 * @param int $userid The user id to load for
4070 * @param string $gstitle The string to pass to get_string for the branch title
4071 * @return navigation_node|false
4073 protected function generate_user_settings($courseid, $userid, $gstitle='usercurrentsettings') {
4074 global $DB, $CFG, $USER, $SITE;
4076 if ($courseid != $SITE->id
) {
4077 if (!empty($this->page
->course
->id
) && $this->page
->course
->id
== $courseid) {
4078 $course = $this->page
->course
;
4080 $select = context_helper
::get_preload_record_columns_sql('ctx');
4081 $sql = "SELECT c.*, $select
4083 JOIN {context} ctx ON c.id = ctx.instanceid
4084 WHERE c.id = :courseid AND ctx.contextlevel = :contextlevel";
4085 $params = array('courseid' => $courseid, 'contextlevel' => CONTEXT_COURSE
);
4086 $course = $DB->get_record_sql($sql, $params, MUST_EXIST
);
4087 context_helper
::preload_from_record($course);
4093 $coursecontext = context_course
::instance($course->id
); // Course context
4094 $systemcontext = context_system
::instance();
4095 $currentuser = ($USER->id
== $userid);
4099 $usercontext = context_user
::instance($user->id
); // User context
4101 $select = context_helper
::get_preload_record_columns_sql('ctx');
4102 $sql = "SELECT u.*, $select
4104 JOIN {context} ctx ON u.id = ctx.instanceid
4105 WHERE u.id = :userid AND ctx.contextlevel = :contextlevel";
4106 $params = array('userid' => $userid, 'contextlevel' => CONTEXT_USER
);
4107 $user = $DB->get_record_sql($sql, $params, IGNORE_MISSING
);
4111 context_helper
::preload_from_record($user);
4113 // Check that the user can view the profile
4114 $usercontext = context_user
::instance($user->id
); // User context
4115 $canviewuser = has_capability('moodle/user:viewdetails', $usercontext);
4117 if ($course->id
== $SITE->id
) {
4118 if ($CFG->forceloginforprofiles
&& !has_coursecontact_role($user->id
) && !$canviewuser) { // Reduce possibility of "browsing" userbase at site level
4119 // Teachers can browse and be browsed at site level. If not forceloginforprofiles, allow access (bug #4366)
4123 $canviewusercourse = has_capability('moodle/user:viewdetails', $coursecontext);
4124 $userisenrolled = is_enrolled($coursecontext, $user->id
);
4125 if ((!$canviewusercourse && !$canviewuser) ||
!$userisenrolled) {
4128 $canaccessallgroups = has_capability('moodle/site:accessallgroups', $coursecontext);
4129 if (!$canaccessallgroups && groups_get_course_groupmode($course) == SEPARATEGROUPS
) {
4130 // If groups are in use, make sure we can see that group
4136 $fullname = fullname($user, has_capability('moodle/site:viewfullnames', $this->page
->context
));
4139 if ($gstitle != 'usercurrentsettings') {
4143 // Add a user setting branch
4144 $usersetting = $this->add(get_string($gstitle, 'moodle', $fullname), null, self
::TYPE_CONTAINER
, null, $key);
4145 $usersetting->id
= 'usersettings';
4146 if ($this->page
->context
->contextlevel
== CONTEXT_USER
&& $this->page
->context
->instanceid
== $user->id
) {
4147 // Automatically start by making it active
4148 $usersetting->make_active();
4151 // Check if the user has been deleted
4152 if ($user->deleted
) {
4153 if (!has_capability('moodle/user:update', $coursecontext)) {
4154 // We can't edit the user so just show the user deleted message
4155 $usersetting->add(get_string('userdeleted'), null, self
::TYPE_SETTING
);
4157 // We can edit the user so show the user deleted message and link it to the profile
4158 if ($course->id
== $SITE->id
) {
4159 $profileurl = new moodle_url('/user/profile.php', array('id'=>$user->id
));
4161 $profileurl = new moodle_url('/user/view.php', array('id'=>$user->id
, 'course'=>$course->id
));
4163 $usersetting->add(get_string('userdeleted'), $profileurl, self
::TYPE_SETTING
);
4168 $userauthplugin = false;
4169 if (!empty($user->auth
)) {
4170 $userauthplugin = get_auth_plugin($user->auth
);
4173 // Add the profile edit link
4174 if (isloggedin() && !isguestuser($user) && !is_mnet_remote_user($user)) {
4175 if (($currentuser ||
is_siteadmin($USER) ||
!is_siteadmin($user)) && has_capability('moodle/user:update', $systemcontext)) {
4176 $url = new moodle_url('/user/editadvanced.php', array('id'=>$user->id
, 'course'=>$course->id
));
4177 $usersetting->add(get_string('editmyprofile'), $url, self
::TYPE_SETTING
);
4178 } else if ((has_capability('moodle/user:editprofile', $usercontext) && !is_siteadmin($user)) ||
($currentuser && has_capability('moodle/user:editownprofile', $systemcontext))) {
4179 if ($userauthplugin && $userauthplugin->can_edit_profile()) {
4180 $url = $userauthplugin->edit_profile_url();
4182 $url = new moodle_url('/user/edit.php', array('id'=>$user->id
, 'course'=>$course->id
));
4184 $usersetting->add(get_string('editmyprofile'), $url, self
::TYPE_SETTING
);
4189 // Change password link
4190 if ($userauthplugin && $currentuser && !\core\session\manager
::is_loggedinas() && !isguestuser() && has_capability('moodle/user:changeownpassword', $systemcontext) && $userauthplugin->can_change_password()) {
4191 $passwordchangeurl = $userauthplugin->change_password_url();
4192 if (empty($passwordchangeurl)) {
4193 $passwordchangeurl = new moodle_url('/login/change_password.php', array('id'=>$course->id
));
4195 $usersetting->add(get_string("changepassword"), $passwordchangeurl, self
::TYPE_SETTING
);
4198 // View the roles settings
4199 if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:manage'), $usercontext)) {
4200 $roles = $usersetting->add(get_string('roles'), null, self
::TYPE_SETTING
);
4202 $url = new moodle_url('/admin/roles/usersroles.php', array('userid'=>$user->id
, 'courseid'=>$course->id
));
4203 $roles->add(get_string('thisusersroles', 'role'), $url, self
::TYPE_SETTING
);
4205 $assignableroles = get_assignable_roles($usercontext, ROLENAME_BOTH
);
4207 if (!empty($assignableroles)) {
4208 $url = new moodle_url('/admin/roles/assign.php', array('contextid'=>$usercontext->id
,'userid'=>$user->id
, 'courseid'=>$course->id
));
4209 $roles->add(get_string('assignrolesrelativetothisuser', 'role'), $url, self
::TYPE_SETTING
);
4212 if (has_capability('moodle/role:review', $usercontext) ||
count(get_overridable_roles($usercontext, ROLENAME_BOTH
))>0) {
4213 $url = new moodle_url('/admin/roles/permissions.php', array('contextid'=>$usercontext->id
,'userid'=>$user->id
, 'courseid'=>$course->id
));
4214 $roles->add(get_string('permissions', 'role'), $url, self
::TYPE_SETTING
);
4217 $url = new moodle_url('/admin/roles/check.php', array('contextid'=>$usercontext->id
,'userid'=>$user->id
, 'courseid'=>$course->id
));
4218 $roles->add(get_string('checkpermissions', 'role'), $url, self
::TYPE_SETTING
);
4222 if ($currentuser && !empty($CFG->enableportfolios
) && has_capability('moodle/portfolio:export', $systemcontext)) {
4223 require_once($CFG->libdir
. '/portfoliolib.php');
4224 if (portfolio_has_visible_instances()) {
4225 $portfolio = $usersetting->add(get_string('portfolios', 'portfolio'), null, self
::TYPE_SETTING
);
4227 $url = new moodle_url('/user/portfolio.php', array('courseid'=>$course->id
));
4228 $portfolio->add(get_string('configure', 'portfolio'), $url, self
::TYPE_SETTING
);
4230 $url = new moodle_url('/user/portfoliologs.php', array('courseid'=>$course->id
));
4231 $portfolio->add(get_string('logs', 'portfolio'), $url, self
::TYPE_SETTING
);
4235 $enablemanagetokens = false;
4236 if (!empty($CFG->enablerssfeeds
)) {
4237 $enablemanagetokens = true;
4238 } else if (!is_siteadmin($USER->id
)
4239 && !empty($CFG->enablewebservices
)
4240 && has_capability('moodle/webservice:createtoken', context_system
::instance()) ) {
4241 $enablemanagetokens = true;
4244 if ($currentuser && $enablemanagetokens) {
4245 $url = new moodle_url('/user/managetoken.php', array('sesskey'=>sesskey()));
4246 $usersetting->add(get_string('securitykeys', 'webservice'), $url, self
::TYPE_SETTING
);
4250 if (($currentuser && has_capability('moodle/user:editownmessageprofile', $systemcontext)) ||
(!isguestuser($user) && has_capability('moodle/user:editmessageprofile', $usercontext) && !is_primary_admin($user->id
))) {
4251 $url = new moodle_url('/message/edit.php', array('id'=>$user->id
));
4252 $usersetting->add(get_string('messaging', 'message'), $url, self
::TYPE_SETTING
);
4256 if ($currentuser && !empty($CFG->enableblogs
)) {
4257 $blog = $usersetting->add(get_string('blogs', 'blog'), null, navigation_node
::TYPE_CONTAINER
, null, 'blogs');
4258 $blog->add(get_string('preferences', 'blog'), new moodle_url('/blog/preferences.php'), navigation_node
::TYPE_SETTING
);
4259 if (!empty($CFG->useexternalblogs
) && $CFG->maxexternalblogsperuser
> 0 && has_capability('moodle/blog:manageexternal', context_system
::instance())) {
4260 $blog->add(get_string('externalblogs', 'blog'), new moodle_url('/blog/external_blogs.php'), navigation_node
::TYPE_SETTING
);
4261 $blog->add(get_string('addnewexternalblog', 'blog'), new moodle_url('/blog/external_blog_edit.php'), navigation_node
::TYPE_SETTING
);
4266 if ($currentuser && !empty($CFG->enablebadges
)) {
4267 $badges = $usersetting->add(get_string('badges'), null, navigation_node
::TYPE_CONTAINER
, null, 'badges');
4268 $badges->add(get_string('preferences'), new moodle_url('/badges/preferences.php'), navigation_node
::TYPE_SETTING
);
4269 if (!empty($CFG->badges_allowexternalbackpack
)) {
4270 $badges->add(get_string('backpackdetails', 'badges'), new moodle_url('/badges/mybackpack.php'), navigation_node
::TYPE_SETTING
);
4274 // Add reports node.
4275 $reporttab = $usersetting->add(get_string('activityreports'));
4276 $reports = get_plugin_list_with_function('report', 'extend_navigation_user', 'lib.php');
4277 foreach ($reports as $reportfunction) {
4278 $reportfunction($reporttab, $user, $course);
4280 $anyreport = has_capability('moodle/user:viewuseractivitiesreport', $usercontext);
4281 if ($anyreport ||
($course->showreports
&& $currentuser)) {
4282 // Add grade hardcoded grade report if necessary.
4283 $gradeaccess = false;
4284 if (has_capability('moodle/grade:viewall', $coursecontext)) {
4285 // Can view all course grades.
4286 $gradeaccess = true;
4287 } else if ($course->showgrades
) {
4288 if ($currentuser && has_capability('moodle/grade:view', $coursecontext)) {
4289 // Can view own grades.
4290 $gradeaccess = true;
4291 } else if (has_capability('moodle/grade:viewall', $usercontext)) {
4292 // Can view grades of this user - parent most probably.
4293 $gradeaccess = true;
4294 } else if ($anyreport) {
4295 // Can view grades of this user - parent most probably.
4296 $gradeaccess = true;
4300 $reporttab->add(get_string('grade'), new moodle_url('/course/user.php', array('mode'=>'grade', 'id'=>$course->id
,
4301 'user'=>$usercontext->instanceid
)));
4304 // Check the number of nodes in the report node... if there are none remove the node
4305 $reporttab->trim_if_empty();
4308 if (!$user->deleted
and !$currentuser && !\core\session\manager
::is_loggedinas() && has_capability('moodle/user:loginas', $coursecontext) && !is_siteadmin($user->id
)) {
4309 $url = new moodle_url('/course/loginas.php', array('id'=>$course->id
, 'user'=>$user->id
, 'sesskey'=>sesskey()));
4310 $usersetting->add(get_string('loginas'), $url, self
::TYPE_SETTING
);
4313 return $usersetting;
4317 * Loads block specific settings in the navigation
4319 * @return navigation_node
4321 protected function load_block_settings() {
4324 $blocknode = $this->add($this->context
->get_context_name(), null, self
::TYPE_SETTING
, null, 'blocksettings');
4325 $blocknode->force_open();
4327 // Assign local roles
4328 $assignurl = new moodle_url('/'.$CFG->admin
.'/roles/assign.php', array('contextid'=>$this->context
->id
));
4329 $blocknode->add(get_string('assignroles', 'role'), $assignurl, self
::TYPE_SETTING
);
4332 if (has_capability('moodle/role:review', $this->context
) or count(get_overridable_roles($this->context
))>0) {
4333 $url = new moodle_url('/'.$CFG->admin
.'/roles/permissions.php', array('contextid'=>$this->context
->id
));
4334 $blocknode->add(get_string('permissions', 'role'), $url, self
::TYPE_SETTING
);
4336 // Check role permissions
4337 if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:assign'), $this->context
)) {
4338 $url = new moodle_url('/'.$CFG->admin
.'/roles/check.php', array('contextid'=>$this->context
->id
));
4339 $blocknode->add(get_string('checkpermissions', 'role'), $url, self
::TYPE_SETTING
);
4346 * Loads category specific settings in the navigation
4348 * @return navigation_node
4350 protected function load_category_settings() {
4353 $categorynode = $this->add($this->context
->get_context_name(), null, null, null, 'categorysettings');
4354 $categorynode->force_open();
4356 if (can_edit_in_category($this->context
->instanceid
)) {
4357 $url = new moodle_url('/course/management.php', array('categoryid' => $this->context
->instanceid
));
4358 $editstring = get_string('managecategorythis');
4359 $categorynode->add($editstring, $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/edit', ''));
4362 if (has_capability('moodle/category:manage', $this->context
)) {
4363 $editurl = new moodle_url('/course/editcategory.php', array('id' => $this->context
->instanceid
));
4364 $categorynode->add(get_string('editcategorythis'), $editurl, self
::TYPE_SETTING
, null, 'edit', new pix_icon('i/edit', ''));
4366 $addsubcaturl = new moodle_url('/course/editcategory.php', array('parent' => $this->context
->instanceid
));
4367 $categorynode->add(get_string('addsubcategory'), $addsubcaturl, self
::TYPE_SETTING
, null, 'addsubcat', new pix_icon('i/withsubcat', ''));
4370 // Assign local roles
4371 if (has_capability('moodle/role:assign', $this->context
)) {
4372 $assignurl = new moodle_url('/'.$CFG->admin
.'/roles/assign.php', array('contextid'=>$this->context
->id
));
4373 $categorynode->add(get_string('assignroles', 'role'), $assignurl, self
::TYPE_SETTING
, null, 'roles', new pix_icon('i/assignroles', ''));
4377 if (has_capability('moodle/role:review', $this->context
) or count(get_overridable_roles($this->context
))>0) {
4378 $url = new moodle_url('/'.$CFG->admin
.'/roles/permissions.php', array('contextid'=>$this->context
->id
));
4379 $categorynode->add(get_string('permissions', 'role'), $url, self
::TYPE_SETTING
, null, 'permissions', new pix_icon('i/permissions', ''));
4381 // Check role permissions
4382 if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:assign'), $this->context
)) {
4383 $url = new moodle_url('/'.$CFG->admin
.'/roles/check.php', array('contextid'=>$this->context
->id
));
4384 $categorynode->add(get_string('checkpermissions', 'role'), $url, self
::TYPE_SETTING
, null, 'checkpermissions', new pix_icon('i/checkpermissions', ''));
4388 if (has_any_capability(array('moodle/cohort:view', 'moodle/cohort:manage'), $this->context
)) {
4389 $categorynode->add(get_string('cohorts', 'cohort'), new moodle_url('/cohort/index.php', array('contextid' => $this->context
->id
)), self
::TYPE_SETTING
, null, 'cohort', new pix_icon('i/cohort', ''));
4393 if (has_capability('moodle/filter:manage', $this->context
) && count(filter_get_available_in_context($this->context
))>0) {
4394 $url = new moodle_url('/filter/manage.php', array('contextid'=>$this->context
->id
));
4395 $categorynode->add(get_string('filters', 'admin'), $url, self
::TYPE_SETTING
, null, 'filters', new pix_icon('i/filter', ''));
4398 return $categorynode;
4402 * Determine whether the user is assuming another role
4404 * This function checks to see if the user is assuming another role by means of
4405 * role switching. In doing this we compare each RSW key (context path) against
4406 * the current context path. This ensures that we can provide the switching
4407 * options against both the course and any page shown under the course.
4409 * @return bool|int The role(int) if the user is in another role, false otherwise
4411 protected function in_alternative_role() {
4413 if (!empty($USER->access
['rsw']) && is_array($USER->access
['rsw'])) {
4414 if (!empty($this->page
->context
) && !empty($USER->access
['rsw'][$this->page
->context
->path
])) {
4415 return $USER->access
['rsw'][$this->page
->context
->path
];
4417 foreach ($USER->access
['rsw'] as $key=>$role) {
4418 if (strpos($this->context
->path
,$key)===0) {
4427 * This function loads all of the front page settings into the settings navigation.
4428 * This function is called when the user is on the front page, or $COURSE==$SITE
4429 * @param bool $forceopen (optional)
4430 * @return navigation_node
4432 protected function load_front_page_settings($forceopen = false) {
4435 $course = clone($SITE);
4436 $coursecontext = context_course
::instance($course->id
); // Course context
4438 $frontpage = $this->add(get_string('frontpagesettings'), null, self
::TYPE_SETTING
, null, 'frontpage');
4440 $frontpage->force_open();
4442 $frontpage->id
= 'frontpagesettings';
4444 if ($this->page
->user_allowed_editing()) {
4446 // Add the turn on/off settings
4447 $url = new moodle_url('/course/view.php', array('id'=>$course->id
, 'sesskey'=>sesskey()));
4448 if ($this->page
->user_is_editing()) {
4449 $url->param('edit', 'off');
4450 $editstring = get_string('turneditingoff');
4452 $url->param('edit', 'on');
4453 $editstring = get_string('turneditingon');
4455 $frontpage->add($editstring, $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/edit', ''));
4458 if (has_capability('moodle/course:update', $coursecontext)) {
4459 // Add the course settings link
4460 $url = new moodle_url('/admin/settings.php', array('section'=>'frontpagesettings'));
4461 $frontpage->add(get_string('editsettings'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/settings', ''));
4465 enrol_add_course_navigation($frontpage, $course);
4468 if (has_capability('moodle/filter:manage', $coursecontext) && count(filter_get_available_in_context($coursecontext))>0) {
4469 $url = new moodle_url('/filter/manage.php', array('contextid'=>$coursecontext->id
));
4470 $frontpage->add(get_string('filters', 'admin'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/filter', ''));
4473 // View course reports.
4474 if (has_capability('moodle/site:viewreports', $coursecontext)) { // Basic capability for listing of reports.
4475 $frontpagenav = $frontpage->add(get_string('reports'), null, self
::TYPE_CONTAINER
, null, null,
4476 new pix_icon('i/stats', ''));
4477 $coursereports = core_component
::get_plugin_list('coursereport');
4478 foreach ($coursereports as $report=>$dir) {
4479 $libfile = $CFG->dirroot
.'/course/report/'.$report.'/lib.php';
4480 if (file_exists($libfile)) {
4481 require_once($libfile);
4482 $reportfunction = $report.'_report_extend_navigation';
4483 if (function_exists($report.'_report_extend_navigation')) {
4484 $reportfunction($frontpagenav, $course, $coursecontext);
4489 $reports = get_plugin_list_with_function('report', 'extend_navigation_course', 'lib.php');
4490 foreach ($reports as $reportfunction) {
4491 $reportfunction($frontpagenav, $course, $coursecontext);
4495 // Backup this course
4496 if (has_capability('moodle/backup:backupcourse', $coursecontext)) {
4497 $url = new moodle_url('/backup/backup.php', array('id'=>$course->id
));
4498 $frontpage->add(get_string('backup'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/backup', ''));
4501 // Restore to this course
4502 if (has_capability('moodle/restore:restorecourse', $coursecontext)) {
4503 $url = new moodle_url('/backup/restorefile.php', array('contextid'=>$coursecontext->id
));
4504 $frontpage->add(get_string('restore'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/restore', ''));
4508 require_once($CFG->libdir
. '/questionlib.php');
4509 question_extend_settings_navigation($frontpage, $coursecontext)->trim_if_empty();
4512 if ($course->legacyfiles
== 2 and has_capability('moodle/course:managefiles', $this->context
)) {
4513 //hiden in new installs
4514 $url = new moodle_url('/files/index.php', array('contextid'=>$coursecontext->id
));
4515 $frontpage->add(get_string('sitelegacyfiles'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/folder', ''));
4521 * This function gives local plugins an opportunity to modify the settings navigation.
4523 protected function load_local_plugin_settings() {
4524 // Get all local plugins with an extend_settings_navigation function in their lib.php file
4525 foreach (get_plugin_list_with_function('local', 'extends_settings_navigation') as $function) {
4526 // Call each function providing this (the settings navigation) and the current context.
4527 $function($this, $this->context
);
4532 * This function marks the cache as volatile so it is cleared during shutdown
4534 public function clear_cache() {
4535 $this->cache
->volatile();
4540 * Class used to populate site admin navigation for ajax.
4543 * @category navigation
4544 * @copyright 2013 Rajesh Taneja <rajesh@moodle.com>
4545 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4547 class settings_navigation_ajax
extends settings_navigation
{
4549 * Constructs the navigation for use in an AJAX request
4551 * @param moodle_page $page
4553 public function __construct(moodle_page
&$page) {
4554 $this->page
= $page;
4555 $this->cache
= new navigation_cache(NAVIGATION_CACHE_NAME
);
4556 $this->children
= new navigation_node_collection();
4557 $this->initialise();
4561 * Initialise the site admin navigation.
4563 * @return array An array of the expandable nodes
4565 public function initialise() {
4566 if ($this->initialised ||
during_initial_install()) {
4569 $this->context
= $this->page
->context
;
4570 $this->load_administration_settings();
4572 // Check if local plugins is adding node to site admin.
4573 $this->load_local_plugin_settings();
4575 $this->initialised
= true;
4580 * Simple class used to output a navigation branch in XML
4583 * @category navigation
4584 * @copyright 2009 Sam Hemelryk
4585 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4587 class navigation_json
{
4588 /** @var array An array of different node types */
4589 protected $nodetype = array('node','branch');
4590 /** @var array An array of node keys and types */
4591 protected $expandable = array();
4593 * Turns a branch and all of its children into XML
4595 * @param navigation_node $branch
4596 * @return string XML string
4598 public function convert($branch) {
4599 $xml = $this->convert_child($branch);
4603 * Set the expandable items in the array so that we have enough information
4604 * to attach AJAX events
4605 * @param array $expandable
4607 public function set_expandable($expandable) {
4608 foreach ($expandable as $node) {
4609 $this->expandable
[$node['key'].':'.$node['type']] = $node;
4613 * Recusively converts a child node and its children to XML for output
4615 * @param navigation_node $child The child to convert
4616 * @param int $depth Pointlessly used to track the depth of the XML structure
4617 * @return string JSON
4619 protected function convert_child($child, $depth=1) {
4620 if (!$child->display
) {
4623 $attributes = array();
4624 $attributes['id'] = $child->id
;
4625 $attributes['name'] = (string)$child->text
; // This can be lang_string object so typecast it.
4626 $attributes['type'] = $child->type
;
4627 $attributes['key'] = $child->key
;
4628 $attributes['class'] = $child->get_css_type();
4630 if ($child->icon
instanceof pix_icon
) {
4631 $attributes['icon'] = array(
4632 'component' => $child->icon
->component
,
4633 'pix' => $child->icon
->pix
,
4635 foreach ($child->icon
->attributes
as $key=>$value) {
4636 if ($key == 'class') {
4637 $attributes['icon']['classes'] = explode(' ', $value);
4638 } else if (!array_key_exists($key, $attributes['icon'])) {
4639 $attributes['icon'][$key] = $value;
4643 } else if (!empty($child->icon
)) {
4644 $attributes['icon'] = (string)$child->icon
;
4647 if ($child->forcetitle ||
$child->title
!== $child->text
) {
4648 $attributes['title'] = htmlentities($child->title
, ENT_QUOTES
, 'UTF-8');
4650 if (array_key_exists($child->key
.':'.$child->type
, $this->expandable
)) {
4651 $attributes['expandable'] = $child->key
;
4652 $child->add_class($this->expandable
[$child->key
.':'.$child->type
]['id']);
4655 if (count($child->classes
)>0) {
4656 $attributes['class'] .= ' '.join(' ',$child->classes
);
4658 if (is_string($child->action
)) {
4659 $attributes['link'] = $child->action
;
4660 } else if ($child->action
instanceof moodle_url
) {
4661 $attributes['link'] = $child->action
->out();
4662 } else if ($child->action
instanceof action_link
) {
4663 $attributes['link'] = $child->action
->url
->out();
4665 $attributes['hidden'] = ($child->hidden
);
4666 $attributes['haschildren'] = ($child->children
->count()>0 ||
$child->type
== navigation_node
::TYPE_CATEGORY
);
4667 $attributes['haschildren'] = $attributes['haschildren'] ||
$child->type
== navigation_node
::TYPE_MY_CATEGORY
;
4669 if ($child->children
->count() > 0) {
4670 $attributes['children'] = array();
4671 foreach ($child->children
as $subchild) {
4672 $attributes['children'][] = $this->convert_child($subchild, $depth+
1);
4679 return json_encode($attributes);
4685 * The cache class used by global navigation and settings navigation.
4687 * It is basically an easy access point to session with a bit of smarts to make
4688 * sure that the information that is cached is valid still.
4692 * if (!$cache->viewdiscussion()) {
4693 * // Code to do stuff and produce cachable content
4694 * $cache->viewdiscussion = has_capability('mod/forum:viewdiscussion', $coursecontext);
4696 * $content = $cache->viewdiscussion;
4700 * @category navigation
4701 * @copyright 2009 Sam Hemelryk
4702 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4704 class navigation_cache
{
4705 /** @var int represents the time created */
4706 protected $creation;
4707 /** @var array An array of session keys */
4710 * The string to use to segregate this particular cache. It can either be
4711 * unique to start a fresh cache or if you want to share a cache then make
4712 * it the string used in the original cache.
4716 /** @var int a time that the information will time out */
4718 /** @var stdClass The current context */
4719 protected $currentcontext;
4720 /** @var int cache time information */
4721 const CACHETIME
= 0;
4722 /** @var int cache user id */
4723 const CACHEUSERID
= 1;
4724 /** @var int cache value */
4725 const CACHEVALUE
= 2;
4726 /** @var null|array An array of navigation cache areas to expire on shutdown */
4727 public static $volatilecaches;
4730 * Contructor for the cache. Requires two arguments
4732 * @param string $area The string to use to segregate this particular cache
4733 * it can either be unique to start a fresh cache or if you want
4734 * to share a cache then make it the string used in the original
4736 * @param int $timeout The number of seconds to time the information out after
4738 public function __construct($area, $timeout=1800) {
4739 $this->creation
= time();
4740 $this->area
= $area;
4741 $this->timeout
= time() - $timeout;
4742 if (rand(0,100) === 0) {
4743 $this->garbage_collection();
4748 * Used to set up the cache within the SESSION.
4750 * This is called for each access and ensure that we don't put anything into the session before
4753 protected function ensure_session_cache_initialised() {
4755 if (empty($this->session
)) {
4756 if (!isset($SESSION->navcache
)) {
4757 $SESSION->navcache
= new stdClass
;
4759 if (!isset($SESSION->navcache
->{$this->area
})) {
4760 $SESSION->navcache
->{$this->area
} = array();
4762 $this->session
= &$SESSION->navcache
->{$this->area
}; // pointer to array, =& is correct here
4767 * Magic Method to retrieve something by simply calling using = cache->key
4769 * @param mixed $key The identifier for the information you want out again
4770 * @return void|mixed Either void or what ever was put in
4772 public function __get($key) {
4773 if (!$this->cached($key)) {
4776 $information = $this->session
[$key][self
::CACHEVALUE
];
4777 return unserialize($information);
4781 * Magic method that simply uses {@link set();} to store something in the cache
4783 * @param string|int $key
4784 * @param mixed $information
4786 public function __set($key, $information) {
4787 $this->set($key, $information);
4791 * Sets some information against the cache (session) for later retrieval
4793 * @param string|int $key
4794 * @param mixed $information
4796 public function set($key, $information) {
4798 $this->ensure_session_cache_initialised();
4799 $information = serialize($information);
4800 $this->session
[$key]= array(self
::CACHETIME
=>time(), self
::CACHEUSERID
=>$USER->id
, self
::CACHEVALUE
=>$information);
4803 * Check the existence of the identifier in the cache
4805 * @param string|int $key
4808 public function cached($key) {
4810 $this->ensure_session_cache_initialised();
4811 if (!array_key_exists($key, $this->session
) ||
!is_array($this->session
[$key]) ||
$this->session
[$key][self
::CACHEUSERID
]!=$USER->id ||
$this->session
[$key][self
::CACHETIME
] < $this->timeout
) {
4817 * Compare something to it's equivilant in the cache
4819 * @param string $key
4820 * @param mixed $value
4821 * @param bool $serialise Whether to serialise the value before comparison
4822 * this should only be set to false if the value is already
4824 * @return bool If the value is the same false if it is not set or doesn't match
4826 public function compare($key, $value, $serialise = true) {
4827 if ($this->cached($key)) {
4829 $value = serialize($value);
4831 if ($this->session
[$key][self
::CACHEVALUE
] === $value) {
4838 * Wipes the entire cache, good to force regeneration
4840 public function clear() {
4842 unset($SESSION->navcache
);
4843 $this->session
= null;
4846 * Checks all cache entries and removes any that have expired, good ole cleanup
4848 protected function garbage_collection() {
4849 if (empty($this->session
)) {
4852 foreach ($this->session
as $key=>$cachedinfo) {
4853 if (is_array($cachedinfo) && $cachedinfo[self
::CACHETIME
]<$this->timeout
) {
4854 unset($this->session
[$key]);
4860 * Marks the cache as being volatile (likely to change)
4862 * Any caches marked as volatile will be destroyed at the on shutdown by
4863 * {@link navigation_node::destroy_volatile_caches()} which is registered
4864 * as a shutdown function if any caches are marked as volatile.
4866 * @param bool $setting True to destroy the cache false not too
4868 public function volatile($setting = true) {
4869 if (self
::$volatilecaches===null) {
4870 self
::$volatilecaches = array();
4871 core_shutdown_manager
::register_function(array('navigation_cache','destroy_volatile_caches'));
4875 self
::$volatilecaches[$this->area
] = $this->area
;
4876 } else if (array_key_exists($this->area
, self
::$volatilecaches)) {
4877 unset(self
::$volatilecaches[$this->area
]);
4882 * Destroys all caches marked as volatile
4884 * This function is static and works in conjunction with the static volatilecaches
4885 * property of navigation cache.
4886 * Because this function is static it manually resets the cached areas back to an
4889 public static function destroy_volatile_caches() {
4891 if (is_array(self
::$volatilecaches) && count(self
::$volatilecaches)>0) {
4892 foreach (self
::$volatilecaches as $area) {
4893 $SESSION->navcache
->{$area} = array();
4896 $SESSION->navcache
= new stdClass
;