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 navigation_node[] 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 // Load the users enrolled courses if they are viewing the My Moodle page AND the admin has not
1137 // set that they wish to keep the My Courses branch collapsed by default.
1138 if (!empty($CFG->navexpandmycourses
) && $this->rootnodes
['mycourses']->isactive
){
1139 $this->load_courses_enrolled();
1141 $this->rootnodes
['mycourses']->collapse
= true;
1142 $this->rootnodes
['mycourses']->make_inactive();
1145 $canviewcourseprofile = true;
1147 // Next load context specific content into the navigation
1148 switch ($this->page
->context
->contextlevel
) {
1149 case CONTEXT_SYSTEM
:
1150 // Nothing left to do here I feel.
1152 case CONTEXT_COURSECAT
:
1153 // This is essential, we must load categories.
1154 $this->load_all_categories($this->page
->context
->instanceid
, true);
1156 case CONTEXT_BLOCK
:
1157 case CONTEXT_COURSE
:
1159 // Nothing left to do here.
1163 // Load the course associated with the current page into the navigation.
1164 $coursenode = $this->add_course($course, false, self
::COURSE_CURRENT
);
1165 // If the course wasn't added then don't try going any further.
1167 $canviewcourseprofile = false;
1171 // If the user is not enrolled then we only want to show the
1172 // course node and not populate it.
1174 // Not enrolled, can't view, and hasn't switched roles
1175 if (!can_access_course($course)) {
1176 if ($coursenode->isexpandable
=== true) {
1177 // Obviously the situation has changed, update the cache and adjust the node.
1178 // This occurs if the user access to a course has been revoked (one way or another) after
1179 // initially logging in for this session.
1180 $this->get_expand_course_cache()->set($course->id
, 1);
1181 $coursenode->isexpandable
= true;
1182 $coursenode->nodetype
= self
::NODETYPE_BRANCH
;
1184 // Very ugly hack - do not force "parents" to enrol into course their child is enrolled in,
1185 // this hack has been propagated from user/view.php to display the navigation node. (MDL-25805)
1186 if (!$this->current_user_is_parent_role()) {
1187 $coursenode->make_active();
1188 $canviewcourseprofile = false;
1193 if ($coursenode->isexpandable
=== false) {
1194 // Obviously the situation has changed, update the cache and adjust the node.
1195 // This occurs if the user has been granted access to a course (one way or another) after initially
1196 // logging in for this session.
1197 $this->get_expand_course_cache()->set($course->id
, 1);
1198 $coursenode->isexpandable
= true;
1199 $coursenode->nodetype
= self
::NODETYPE_BRANCH
;
1202 // Add the essentials such as reports etc...
1203 $this->add_course_essentials($coursenode, $course);
1204 // Extend course navigation with it's sections/activities
1205 $this->load_course_sections($course, $coursenode);
1206 if (!$coursenode->contains_active_node() && !$coursenode->search_for_active_node()) {
1207 $coursenode->make_active();
1211 case CONTEXT_MODULE
:
1213 // If this is the site course then most information will have
1214 // already been loaded.
1215 // However we need to check if there is more content that can
1216 // yet be loaded for the specific module instance.
1217 $activitynode = $this->rootnodes
['site']->find($this->page
->cm
->id
, navigation_node
::TYPE_ACTIVITY
);
1218 if ($activitynode) {
1219 $this->load_activity($this->page
->cm
, $this->page
->course
, $activitynode);
1224 $course = $this->page
->course
;
1225 $cm = $this->page
->cm
;
1227 // Load the course associated with the page into the navigation
1228 $coursenode = $this->add_course($course, false, self
::COURSE_CURRENT
);
1230 // If the course wasn't added then don't try going any further.
1232 $canviewcourseprofile = false;
1236 // If the user is not enrolled then we only want to show the
1237 // course node and not populate it.
1238 if (!can_access_course($course)) {
1239 $coursenode->make_active();
1240 $canviewcourseprofile = false;
1244 $this->add_course_essentials($coursenode, $course);
1246 // Load the course sections into the page
1247 $this->load_course_sections($course, $coursenode, null, $cm);
1248 $activity = $coursenode->find($cm->id
, navigation_node
::TYPE_ACTIVITY
);
1249 if (!empty($activity)) {
1250 // Finally load the cm specific navigaton information
1251 $this->load_activity($cm, $course, $activity);
1252 // Check if we have an active ndoe
1253 if (!$activity->contains_active_node() && !$activity->search_for_active_node()) {
1254 // And make the activity node active.
1255 $activity->make_active();
1261 // The users profile information etc is already loaded
1262 // for the front page.
1265 $course = $this->page
->course
;
1266 // Load the course associated with the user into the navigation
1267 $coursenode = $this->add_course($course, false, self
::COURSE_CURRENT
);
1269 // If the course wasn't added then don't try going any further.
1271 $canviewcourseprofile = false;
1275 // If the user is not enrolled then we only want to show the
1276 // course node and not populate it.
1277 if (!can_access_course($course)) {
1278 $coursenode->make_active();
1279 $canviewcourseprofile = false;
1282 $this->add_course_essentials($coursenode, $course);
1283 $this->load_course_sections($course, $coursenode);
1287 // Load for the current user
1288 $this->load_for_user();
1289 if ($this->page
->context
->contextlevel
>= CONTEXT_COURSE
&& $this->page
->context
->instanceid
!= $SITE->id
&& $canviewcourseprofile) {
1290 $this->load_for_user(null, true);
1292 // Load each extending user into the navigation.
1293 foreach ($this->extendforuser
as $user) {
1294 if ($user->id
!= $USER->id
) {
1295 $this->load_for_user($user);
1299 // Give the local plugins a chance to include some navigation if they want.
1300 foreach (core_component
::get_plugin_list_with_file('local', 'lib.php', true) as $plugin => $file) {
1301 $function = "local_{$plugin}_extends_navigation";
1302 $oldfunction = "{$plugin}_extends_navigation";
1303 if (function_exists($function)) {
1304 // This is the preferred function name as there is less chance of conflicts
1306 } else if (function_exists($oldfunction)) {
1307 // We continue to support the old function name to ensure backwards compatibility
1308 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
);
1309 $oldfunction($this);
1313 // Remove any empty root nodes
1314 foreach ($this->rootnodes
as $node) {
1315 // Dont remove the home node
1316 /** @var navigation_node $node */
1317 if ($node->key
!== 'home' && !$node->has_children() && !$node->isactive
) {
1322 if (!$this->contains_active_node()) {
1323 $this->search_for_active_node();
1326 // If the user is not logged in modify the navigation structure as detailed
1327 // in {@link http://docs.moodle.org/dev/Navigation_2.0_structure}
1328 if (!isloggedin()) {
1329 $activities = clone($this->rootnodes
['site']->children
);
1330 $this->rootnodes
['site']->remove();
1331 $children = clone($this->children
);
1332 $this->children
= new navigation_node_collection();
1333 foreach ($activities as $child) {
1334 $this->children
->add($child);
1336 foreach ($children as $child) {
1337 $this->children
->add($child);
1344 * Returns true if the current user is a parent of the user being currently viewed.
1346 * If the current user is not viewing another user, or if the current user does not hold any parent roles over the
1347 * other user being viewed this function returns false.
1348 * In order to set the user for whom we are checking against you must call {@link set_userid_for_parent_checks()}
1353 protected function current_user_is_parent_role() {
1355 if ($this->useridtouseforparentchecks
&& $this->useridtouseforparentchecks
!= $USER->id
) {
1356 $usercontext = context_user
::instance($this->useridtouseforparentchecks
, MUST_EXIST
);
1357 if (!has_capability('moodle/user:viewdetails', $usercontext)) {
1360 if ($DB->record_exists('role_assignments', array('userid' => $USER->id
, 'contextid' => $usercontext->id
))) {
1368 * Returns true if courses should be shown within categories on the navigation.
1370 * @param bool $ismycourse Set to true if you are calculating this for a course.
1373 protected function show_categories($ismycourse = false) {
1376 return $this->show_my_categories();
1378 if ($this->showcategories
=== null) {
1380 if ($this->page
->context
->contextlevel
== CONTEXT_COURSECAT
) {
1382 } else if (!empty($CFG->navshowcategories
) && $DB->count_records('course_categories') > 1) {
1385 $this->showcategories
= $show;
1387 return $this->showcategories
;
1391 * Returns true if we should show categories in the My Courses branch.
1394 protected function show_my_categories() {
1396 if ($this->showmycategories
=== null) {
1397 $this->showmycategories
= !empty($CFG->navshowmycoursecategories
) && $DB->count_records('course_categories') > 1;
1399 return $this->showmycategories
;
1403 * Loads the courses in Moodle into the navigation.
1405 * @global moodle_database $DB
1406 * @param string|array $categoryids An array containing categories to load courses
1407 * for, OR null to load courses for all categories.
1408 * @return array An array of navigation_nodes one for each course
1410 protected function load_all_courses($categoryids = null) {
1411 global $CFG, $DB, $SITE;
1413 // Work out the limit of courses.
1415 if (!empty($CFG->navcourselimit
)) {
1416 $limit = $CFG->navcourselimit
;
1419 $toload = (empty($CFG->navshowallcourses
))?self
::LOAD_ROOT_CATEGORIES
:self
::LOAD_ALL_CATEGORIES
;
1421 // If we are going to show all courses AND we are showing categories then
1422 // to save us repeated DB calls load all of the categories now
1423 if ($this->show_categories()) {
1424 $this->load_all_categories($toload);
1427 // Will be the return of our efforts
1428 $coursenodes = array();
1430 // Check if we need to show categories.
1431 if ($this->show_categories()) {
1432 // Hmmm we need to show categories... this is going to be painful.
1433 // We now need to fetch up to $limit courses for each category to
1435 if ($categoryids !== null) {
1436 if (!is_array($categoryids)) {
1437 $categoryids = array($categoryids);
1439 list($categorywhere, $categoryparams) = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED
, 'cc');
1440 $categorywhere = 'WHERE cc.id '.$categorywhere;
1441 } else if ($toload == self
::LOAD_ROOT_CATEGORIES
) {
1442 $categorywhere = 'WHERE cc.depth = 1 OR cc.depth = 2';
1443 $categoryparams = array();
1445 $categorywhere = '';
1446 $categoryparams = array();
1449 // First up we are going to get the categories that we are going to
1450 // need so that we can determine how best to load the courses from them.
1451 $sql = "SELECT cc.id, COUNT(c.id) AS coursecount
1452 FROM {course_categories} cc
1453 LEFT JOIN {course} c ON c.category = cc.id
1456 $categories = $DB->get_recordset_sql($sql, $categoryparams);
1457 $fullfetch = array();
1458 $partfetch = array();
1459 foreach ($categories as $category) {
1460 if (!$this->can_add_more_courses_to_category($category->id
)) {
1463 if ($category->coursecount
> $limit * 5) {
1464 $partfetch[] = $category->id
;
1465 } else if ($category->coursecount
> 0) {
1466 $fullfetch[] = $category->id
;
1469 $categories->close();
1471 if (count($fullfetch)) {
1472 // First up fetch all of the courses in categories where we know that we are going to
1473 // need the majority of courses.
1474 list($categoryids, $categoryparams) = $DB->get_in_or_equal($fullfetch, SQL_PARAMS_NAMED
, 'lcategory');
1475 $ccselect = ', ' . context_helper
::get_preload_record_columns_sql('ctx');
1476 $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
1477 $categoryparams['contextlevel'] = CONTEXT_COURSE
;
1478 $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
1481 WHERE c.category {$categoryids}
1482 ORDER BY c.sortorder ASC";
1483 $coursesrs = $DB->get_recordset_sql($sql, $categoryparams);
1484 foreach ($coursesrs as $course) {
1485 if ($course->id
== $SITE->id
) {
1486 // This should not be necessary, frontpage is not in any category.
1489 if (array_key_exists($course->id
, $this->addedcourses
)) {
1490 // It is probably better to not include the already loaded courses
1491 // directly in SQL because inequalities may confuse query optimisers
1492 // and may interfere with query caching.
1495 if (!$this->can_add_more_courses_to_category($course->category
)) {
1498 context_helper
::preload_from_record($course);
1499 if (!$course->visible
&& !is_role_switched($course->id
) && !has_capability('moodle/course:viewhiddencourses', context_course
::instance($course->id
))) {
1502 $coursenodes[$course->id
] = $this->add_course($course);
1504 $coursesrs->close();
1507 if (count($partfetch)) {
1508 // Next we will work our way through the categories where we will likely only need a small
1509 // proportion of the courses.
1510 foreach ($partfetch as $categoryid) {
1511 $ccselect = ', ' . context_helper
::get_preload_record_columns_sql('ctx');
1512 $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
1513 $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
1516 WHERE c.category = :categoryid
1517 ORDER BY c.sortorder ASC";
1518 $courseparams = array('categoryid' => $categoryid, 'contextlevel' => CONTEXT_COURSE
);
1519 $coursesrs = $DB->get_recordset_sql($sql, $courseparams, 0, $limit * 5);
1520 foreach ($coursesrs as $course) {
1521 if ($course->id
== $SITE->id
) {
1522 // This should not be necessary, frontpage is not in any category.
1525 if (array_key_exists($course->id
, $this->addedcourses
)) {
1526 // It is probably better to not include the already loaded courses
1527 // directly in SQL because inequalities may confuse query optimisers
1528 // and may interfere with query caching.
1529 // This also helps to respect expected $limit on repeated executions.
1532 if (!$this->can_add_more_courses_to_category($course->category
)) {
1535 context_helper
::preload_from_record($course);
1536 if (!$course->visible
&& !is_role_switched($course->id
) && !has_capability('moodle/course:viewhiddencourses', context_course
::instance($course->id
))) {
1539 $coursenodes[$course->id
] = $this->add_course($course);
1541 $coursesrs->close();
1545 // Prepare the SQL to load the courses and their contexts
1546 list($courseids, $courseparams) = $DB->get_in_or_equal(array_keys($this->addedcourses
), SQL_PARAMS_NAMED
, 'lc', false);
1547 $ccselect = ', ' . context_helper
::get_preload_record_columns_sql('ctx');
1548 $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
1549 $courseparams['contextlevel'] = CONTEXT_COURSE
;
1550 $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
1553 WHERE c.id {$courseids}
1554 ORDER BY c.sortorder ASC";
1555 $coursesrs = $DB->get_recordset_sql($sql, $courseparams);
1556 foreach ($coursesrs as $course) {
1557 if ($course->id
== $SITE->id
) {
1558 // frotpage is not wanted here
1561 if ($this->page
->course
&& ($this->page
->course
->id
== $course->id
)) {
1562 // Don't include the currentcourse in this nodelist - it's displayed in the Current course node
1565 context_helper
::preload_from_record($course);
1566 if (!$course->visible
&& !is_role_switched($course->id
) && !has_capability('moodle/course:viewhiddencourses', context_course
::instance($course->id
))) {
1569 $coursenodes[$course->id
] = $this->add_course($course);
1570 if (count($coursenodes) >= $limit) {
1574 $coursesrs->close();
1577 return $coursenodes;
1581 * Returns true if more courses can be added to the provided category.
1583 * @param int|navigation_node|stdClass $category
1586 protected function can_add_more_courses_to_category($category) {
1589 if (!empty($CFG->navcourselimit
)) {
1590 $limit = (int)$CFG->navcourselimit
;
1592 if (is_numeric($category)) {
1593 if (!array_key_exists($category, $this->addedcategories
)) {
1596 $coursecount = count($this->addedcategories
[$category]->children
->type(self
::TYPE_COURSE
));
1597 } else if ($category instanceof navigation_node
) {
1598 if (($category->type
!= self
::TYPE_CATEGORY
) ||
($category->type
!= self
::TYPE_MY_CATEGORY
)) {
1601 $coursecount = count($category->children
->type(self
::TYPE_COURSE
));
1602 } else if (is_object($category) && property_exists($category,'id')) {
1603 $coursecount = count($this->addedcategories
[$category->id
]->children
->type(self
::TYPE_COURSE
));
1605 return ($coursecount <= $limit);
1609 * Loads all categories (top level or if an id is specified for that category)
1611 * @param int $categoryid The category id to load or null/0 to load all base level categories
1612 * @param bool $showbasecategories If set to true all base level categories will be loaded as well
1613 * as the requested category and any parent categories.
1614 * @return navigation_node|void returns a navigation node if a category has been loaded.
1616 protected function load_all_categories($categoryid = self
::LOAD_ROOT_CATEGORIES
, $showbasecategories = false) {
1619 // Check if this category has already been loaded
1620 if ($this->allcategoriesloaded ||
($categoryid < 1 && $this->is_category_fully_loaded($categoryid))) {
1624 $catcontextsql = context_helper
::get_preload_record_columns_sql('ctx');
1625 $sqlselect = "SELECT cc.*, $catcontextsql
1626 FROM {course_categories} cc
1627 JOIN {context} ctx ON cc.id = ctx.instanceid";
1628 $sqlwhere = "WHERE ctx.contextlevel = ".CONTEXT_COURSECAT
;
1629 $sqlorder = "ORDER BY cc.depth ASC, cc.sortorder ASC, cc.id ASC";
1632 $categoriestoload = array();
1633 if ($categoryid == self
::LOAD_ALL_CATEGORIES
) {
1634 // We are going to load all categories regardless... prepare to fire
1635 // on the database server!
1636 } else if ($categoryid == self
::LOAD_ROOT_CATEGORIES
) { // can be 0
1637 // We are going to load all of the first level categories (categories without parents)
1638 $sqlwhere .= " AND cc.parent = 0";
1639 } else if (array_key_exists($categoryid, $this->addedcategories
)) {
1640 // The category itself has been loaded already so we just need to ensure its subcategories
1642 list($sql, $params) = $DB->get_in_or_equal(array_keys($this->addedcategories
), SQL_PARAMS_NAMED
, 'parent', false);
1643 if ($showbasecategories) {
1644 // We need to include categories with parent = 0 as well
1645 $sqlwhere .= " AND (cc.parent = :categoryid OR cc.parent = 0) AND cc.parent {$sql}";
1647 // All we need is categories that match the parent
1648 $sqlwhere .= " AND cc.parent = :categoryid AND cc.parent {$sql}";
1650 $params['categoryid'] = $categoryid;
1652 // This category hasn't been loaded yet so we need to fetch it, work out its category path
1653 // and load this category plus all its parents and subcategories
1654 $category = $DB->get_record('course_categories', array('id' => $categoryid), 'path', MUST_EXIST
);
1655 $categoriestoload = explode('/', trim($category->path
, '/'));
1656 list($select, $params) = $DB->get_in_or_equal($categoriestoload);
1657 // We are going to use select twice so double the params
1658 $params = array_merge($params, $params);
1659 $basecategorysql = ($showbasecategories)?
' OR cc.depth = 1':'';
1660 $sqlwhere .= " AND (cc.id {$select} OR cc.parent {$select}{$basecategorysql})";
1663 $categoriesrs = $DB->get_recordset_sql("$sqlselect $sqlwhere $sqlorder", $params);
1664 $categories = array();
1665 foreach ($categoriesrs as $category) {
1666 // Preload the context.. we'll need it when adding the category in order
1667 // to format the category name.
1668 context_helper
::preload_from_record($category);
1669 if (array_key_exists($category->id
, $this->addedcategories
)) {
1670 // Do nothing, its already been added.
1671 } else if ($category->parent
== '0') {
1672 // This is a root category lets add it immediately
1673 $this->add_category($category, $this->rootnodes
['courses']);
1674 } else if (array_key_exists($category->parent
, $this->addedcategories
)) {
1675 // This categories parent has already been added we can add this immediately
1676 $this->add_category($category, $this->addedcategories
[$category->parent
]);
1678 $categories[] = $category;
1681 $categoriesrs->close();
1683 // Now we have an array of categories we need to add them to the navigation.
1684 while (!empty($categories)) {
1685 $category = reset($categories);
1686 if (array_key_exists($category->id
, $this->addedcategories
)) {
1688 } else if ($category->parent
== '0') {
1689 $this->add_category($category, $this->rootnodes
['courses']);
1690 } else if (array_key_exists($category->parent
, $this->addedcategories
)) {
1691 $this->add_category($category, $this->addedcategories
[$category->parent
]);
1693 // This category isn't in the navigation and niether is it's parent (yet).
1694 // We need to go through the category path and add all of its components in order.
1695 $path = explode('/', trim($category->path
, '/'));
1696 foreach ($path as $catid) {
1697 if (!array_key_exists($catid, $this->addedcategories
)) {
1698 // This category isn't in the navigation yet so add it.
1699 $subcategory = $categories[$catid];
1700 if ($subcategory->parent
== '0') {
1701 // Yay we have a root category - this likely means we will now be able
1702 // to add categories without problems.
1703 $this->add_category($subcategory, $this->rootnodes
['courses']);
1704 } else if (array_key_exists($subcategory->parent
, $this->addedcategories
)) {
1705 // The parent is in the category (as we'd expect) so add it now.
1706 $this->add_category($subcategory, $this->addedcategories
[$subcategory->parent
]);
1707 // Remove the category from the categories array.
1708 unset($categories[$catid]);
1710 // We should never ever arrive here - if we have then there is a bigger
1712 throw new coding_exception('Category path order is incorrect and/or there are missing categories');
1717 // Remove the category from the categories array now that we know it has been added.
1718 unset($categories[$category->id
]);
1720 if ($categoryid === self
::LOAD_ALL_CATEGORIES
) {
1721 $this->allcategoriesloaded
= true;
1723 // Check if there are any categories to load.
1724 if (count($categoriestoload) > 0) {
1725 $readytoloadcourses = array();
1726 foreach ($categoriestoload as $category) {
1727 if ($this->can_add_more_courses_to_category($category)) {
1728 $readytoloadcourses[] = $category;
1731 if (count($readytoloadcourses)) {
1732 $this->load_all_courses($readytoloadcourses);
1736 // Look for all categories which have been loaded
1737 if (!empty($this->addedcategories
)) {
1738 $categoryids = array();
1739 foreach ($this->addedcategories
as $category) {
1740 if ($this->can_add_more_courses_to_category($category)) {
1741 $categoryids[] = $category->key
;
1745 list($categoriessql, $params) = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED
);
1746 $params['limit'] = (!empty($CFG->navcourselimit
))?
$CFG->navcourselimit
:20;
1747 $sql = "SELECT cc.id, COUNT(c.id) AS coursecount
1748 FROM {course_categories} cc
1749 JOIN {course} c ON c.category = cc.id
1750 WHERE cc.id {$categoriessql}
1752 HAVING COUNT(c.id) > :limit";
1753 $excessivecategories = $DB->get_records_sql($sql, $params);
1754 foreach ($categories as &$category) {
1755 if (array_key_exists($category->key
, $excessivecategories) && !$this->can_add_more_courses_to_category($category)) {
1756 $url = new moodle_url('/course/index.php', array('categoryid' => $category->key
));
1757 $category->add(get_string('viewallcourses'), $url, self
::TYPE_SETTING
);
1765 * Adds a structured category to the navigation in the correct order/place
1767 * @param stdClass $category category to be added in navigation.
1768 * @param navigation_node $parent parent navigation node
1769 * @param int $nodetype type of node, if category is under MyHome then it's TYPE_MY_CATEGORY
1772 protected function add_category(stdClass
$category, navigation_node
$parent, $nodetype = self
::TYPE_CATEGORY
) {
1773 if (array_key_exists($category->id
, $this->addedcategories
)) {
1776 $url = new moodle_url('/course/index.php', array('categoryid' => $category->id
));
1777 $context = context_coursecat
::instance($category->id
);
1778 $categoryname = format_string($category->name
, true, array('context' => $context));
1779 $categorynode = $parent->add($categoryname, $url, $nodetype, $categoryname, $category->id
);
1780 if (empty($category->visible
)) {
1781 if (has_capability('moodle/category:viewhiddencategories', context_system
::instance())) {
1782 $categorynode->hidden
= true;
1784 $categorynode->display
= false;
1787 $this->addedcategories
[$category->id
] = $categorynode;
1791 * Loads the given course into the navigation
1793 * @param stdClass $course
1794 * @return navigation_node
1796 protected function load_course(stdClass
$course) {
1798 if ($course->id
== $SITE->id
) {
1799 // This is always loaded during initialisation
1800 return $this->rootnodes
['site'];
1801 } else if (array_key_exists($course->id
, $this->addedcourses
)) {
1802 // The course has already been loaded so return a reference
1803 return $this->addedcourses
[$course->id
];
1806 return $this->add_course($course);
1811 * Loads all of the courses section into the navigation.
1813 * This function calls method from current course format, see
1814 * {@link format_base::extend_course_navigation()}
1815 * If course module ($cm) is specified but course format failed to create the node,
1816 * the activity node is created anyway.
1818 * By default course formats call the method {@link global_navigation::load_generic_course_sections()}
1820 * @param stdClass $course Database record for the course
1821 * @param navigation_node $coursenode The course node within the navigation
1822 * @param null|int $sectionnum If specified load the contents of section with this relative number
1823 * @param null|cm_info $cm If specified make sure that activity node is created (either
1824 * in containg section or by calling load_stealth_activity() )
1826 protected function load_course_sections(stdClass
$course, navigation_node
$coursenode, $sectionnum = null, $cm = null) {
1828 require_once($CFG->dirroot
.'/course/lib.php');
1829 if (isset($cm->sectionnum
)) {
1830 $sectionnum = $cm->sectionnum
;
1832 if ($sectionnum !== null) {
1833 $this->includesectionnum
= $sectionnum;
1835 course_get_format($course)->extend_course_navigation($this, $coursenode, $sectionnum, $cm);
1836 if (isset($cm->id
)) {
1837 $activity = $coursenode->find($cm->id
, self
::TYPE_ACTIVITY
);
1838 if (empty($activity)) {
1839 $activity = $this->load_stealth_activity($coursenode, get_fast_modinfo($course));
1845 * Generates an array of sections and an array of activities for the given course.
1847 * This method uses the cache to improve performance and avoid the get_fast_modinfo call
1849 * @param stdClass $course
1850 * @return array Array($sections, $activities)
1852 protected function generate_sections_and_activities(stdClass
$course) {
1854 require_once($CFG->dirroot
.'/course/lib.php');
1856 $modinfo = get_fast_modinfo($course);
1857 $sections = $modinfo->get_section_info_all();
1859 // For course formats using 'numsections' trim the sections list
1860 $courseformatoptions = course_get_format($course)->get_format_options();
1861 if (isset($courseformatoptions['numsections'])) {
1862 $sections = array_slice($sections, 0, $courseformatoptions['numsections']+
1, true);
1865 $activities = array();
1867 foreach ($sections as $key => $section) {
1868 // Clone and unset summary to prevent $SESSION bloat (MDL-31802).
1869 $sections[$key] = clone($section);
1870 unset($sections[$key]->summary
);
1871 $sections[$key]->hasactivites
= false;
1872 if (!array_key_exists($section->section
, $modinfo->sections
)) {
1875 foreach ($modinfo->sections
[$section->section
] as $cmid) {
1876 $cm = $modinfo->cms
[$cmid];
1877 $activity = new stdClass
;
1878 $activity->id
= $cm->id
;
1879 $activity->course
= $course->id
;
1880 $activity->section
= $section->section
;
1881 $activity->name
= $cm->name
;
1882 $activity->icon
= $cm->icon
;
1883 $activity->iconcomponent
= $cm->iconcomponent
;
1884 $activity->hidden
= (!$cm->visible
);
1885 $activity->modname
= $cm->modname
;
1886 $activity->nodetype
= navigation_node
::NODETYPE_LEAF
;
1887 $activity->onclick
= $cm->onclick
;
1890 $activity->url
= null;
1891 $activity->display
= false;
1893 $activity->url
= $url->out();
1894 $activity->display
= $cm->uservisible ?
true : false;
1895 if (self
::module_extends_navigation($cm->modname
)) {
1896 $activity->nodetype
= navigation_node
::NODETYPE_BRANCH
;
1899 $activities[$cmid] = $activity;
1900 if ($activity->display
) {
1901 $sections[$key]->hasactivites
= true;
1906 return array($sections, $activities);
1910 * Generically loads the course sections into the course's navigation.
1912 * @param stdClass $course
1913 * @param navigation_node $coursenode
1914 * @return array An array of course section nodes
1916 public function load_generic_course_sections(stdClass
$course, navigation_node
$coursenode) {
1917 global $CFG, $DB, $USER, $SITE;
1918 require_once($CFG->dirroot
.'/course/lib.php');
1920 list($sections, $activities) = $this->generate_sections_and_activities($course);
1922 $navigationsections = array();
1923 foreach ($sections as $sectionid => $section) {
1924 $section = clone($section);
1925 if ($course->id
== $SITE->id
) {
1926 $this->load_section_activities($coursenode, $section->section
, $activities);
1928 if (!$section->uservisible ||
(!$this->showemptysections
&&
1929 !$section->hasactivites
&& $this->includesectionnum
!== $section->section
)) {
1933 $sectionname = get_section_name($course, $section);
1934 $url = course_get_url($course, $section->section
, array('navigation' => true));
1936 $sectionnode = $coursenode->add($sectionname, $url, navigation_node
::TYPE_SECTION
, null, $section->id
);
1937 $sectionnode->nodetype
= navigation_node
::NODETYPE_BRANCH
;
1938 $sectionnode->hidden
= (!$section->visible ||
!$section->available
);
1939 if ($this->includesectionnum
!== false && $this->includesectionnum
== $section->section
) {
1940 $this->load_section_activities($sectionnode, $section->section
, $activities);
1942 $section->sectionnode
= $sectionnode;
1943 $navigationsections[$sectionid] = $section;
1946 return $navigationsections;
1950 * Loads all of the activities for a section into the navigation structure.
1952 * @param navigation_node $sectionnode
1953 * @param int $sectionnumber
1954 * @param array $activities An array of activites as returned by {@link global_navigation::generate_sections_and_activities()}
1955 * @param stdClass $course The course object the section and activities relate to.
1956 * @return array Array of activity nodes
1958 protected function load_section_activities(navigation_node
$sectionnode, $sectionnumber, array $activities, $course = null) {
1960 // A static counter for JS function naming
1961 static $legacyonclickcounter = 0;
1963 $activitynodes = array();
1964 if (empty($activities)) {
1965 return $activitynodes;
1968 if (!is_object($course)) {
1969 $activity = reset($activities);
1970 $courseid = $activity->course
;
1972 $courseid = $course->id
;
1974 $showactivities = ($courseid != $SITE->id ||
!empty($CFG->navshowfrontpagemods
));
1976 foreach ($activities as $activity) {
1977 if ($activity->section
!= $sectionnumber) {
1980 if ($activity->icon
) {
1981 $icon = new pix_icon($activity->icon
, get_string('modulename', $activity->modname
), $activity->iconcomponent
);
1983 $icon = new pix_icon('icon', get_string('modulename', $activity->modname
), $activity->modname
);
1986 // Prepare the default name and url for the node
1987 $activityname = format_string($activity->name
, true, array('context' => context_module
::instance($activity->id
)));
1988 $action = new moodle_url($activity->url
);
1990 // Check if the onclick property is set (puke!)
1991 if (!empty($activity->onclick
)) {
1992 // Increment the counter so that we have a unique number.
1993 $legacyonclickcounter++
;
1994 // Generate the function name we will use
1995 $functionname = 'legacy_activity_onclick_handler_'.$legacyonclickcounter;
1996 $propogrationhandler = '';
1997 // Check if we need to cancel propogation. Remember inline onclick
1998 // events would return false if they wanted to prevent propogation and the
2000 if (strpos($activity->onclick
, 'return false')) {
2001 $propogrationhandler = 'e.halt();';
2003 // Decode the onclick - it has already been encoded for display (puke)
2004 $onclick = htmlspecialchars_decode($activity->onclick
, ENT_QUOTES
);
2005 // Build the JS function the click event will call
2006 $jscode = "function {$functionname}(e) { $propogrationhandler $onclick }";
2007 $this->page
->requires
->js_init_code($jscode);
2008 // Override the default url with the new action link
2009 $action = new action_link($action, $activityname, new component_action('click', $functionname));
2012 $activitynode = $sectionnode->add($activityname, $action, navigation_node
::TYPE_ACTIVITY
, null, $activity->id
, $icon);
2013 $activitynode->title(get_string('modulename', $activity->modname
));
2014 $activitynode->hidden
= $activity->hidden
;
2015 $activitynode->display
= $showactivities && $activity->display
;
2016 $activitynode->nodetype
= $activity->nodetype
;
2017 $activitynodes[$activity->id
] = $activitynode;
2020 return $activitynodes;
2023 * Loads a stealth module from unavailable section
2024 * @param navigation_node $coursenode
2025 * @param stdClass $modinfo
2026 * @return navigation_node or null if not accessible
2028 protected function load_stealth_activity(navigation_node
$coursenode, $modinfo) {
2029 if (empty($modinfo->cms
[$this->page
->cm
->id
])) {
2032 $cm = $modinfo->cms
[$this->page
->cm
->id
];
2034 $icon = new pix_icon($cm->icon
, get_string('modulename', $cm->modname
), $cm->iconcomponent
);
2036 $icon = new pix_icon('icon', get_string('modulename', $cm->modname
), $cm->modname
);
2039 $activitynode = $coursenode->add(format_string($cm->name
), $url, navigation_node
::TYPE_ACTIVITY
, null, $cm->id
, $icon);
2040 $activitynode->title(get_string('modulename', $cm->modname
));
2041 $activitynode->hidden
= (!$cm->visible
);
2042 if (!$cm->uservisible
) {
2043 // Do not show any error here, let the page handle exception that activity is not visible for the current user.
2044 // Also there may be no exception at all in case when teacher is logged in as student.
2045 $activitynode->display
= false;
2047 // Don't show activities that don't have links!
2048 $activitynode->display
= false;
2049 } else if (self
::module_extends_navigation($cm->modname
)) {
2050 $activitynode->nodetype
= navigation_node
::NODETYPE_BRANCH
;
2052 return $activitynode;
2055 * Loads the navigation structure for the given activity into the activities node.
2057 * This method utilises a callback within the modules lib.php file to load the
2058 * content specific to activity given.
2060 * The callback is a method: {modulename}_extend_navigation()
2062 * * {@link forum_extend_navigation()}
2063 * * {@link workshop_extend_navigation()}
2065 * @param cm_info|stdClass $cm
2066 * @param stdClass $course
2067 * @param navigation_node $activity
2070 protected function load_activity($cm, stdClass
$course, navigation_node
$activity) {
2073 // make sure we have a $cm from get_fast_modinfo as this contains activity access details
2074 if (!($cm instanceof cm_info
)) {
2075 $modinfo = get_fast_modinfo($course);
2076 $cm = $modinfo->get_cm($cm->id
);
2078 $activity->nodetype
= navigation_node
::NODETYPE_LEAF
;
2079 $activity->make_active();
2080 $file = $CFG->dirroot
.'/mod/'.$cm->modname
.'/lib.php';
2081 $function = $cm->modname
.'_extend_navigation';
2083 if (file_exists($file)) {
2084 require_once($file);
2085 if (function_exists($function)) {
2086 $activtyrecord = $DB->get_record($cm->modname
, array('id' => $cm->instance
), '*', MUST_EXIST
);
2087 $function($activity, $course, $activtyrecord, $cm);
2091 // Allow the active advanced grading method plugin to append module navigation
2092 $featuresfunc = $cm->modname
.'_supports';
2093 if (function_exists($featuresfunc) && $featuresfunc(FEATURE_ADVANCED_GRADING
)) {
2094 require_once($CFG->dirroot
.'/grade/grading/lib.php');
2095 $gradingman = get_grading_manager($cm->context
, $cm->modname
);
2096 $gradingman->extend_navigation($this, $activity);
2099 return $activity->has_children();
2102 * Loads user specific information into the navigation in the appropriate place.
2104 * If no user is provided the current user is assumed.
2106 * @param stdClass $user
2107 * @param bool $forceforcontext probably force something to be loaded somewhere (ask SamH if not sure what this means)
2110 protected function load_for_user($user=null, $forceforcontext=false) {
2111 global $DB, $CFG, $USER, $SITE;
2113 if ($user === null) {
2114 // We can't require login here but if the user isn't logged in we don't
2115 // want to show anything
2116 if (!isloggedin() ||
isguestuser()) {
2120 } else if (!is_object($user)) {
2121 // If the user is not an object then get them from the database
2122 $select = context_helper
::get_preload_record_columns_sql('ctx');
2123 $sql = "SELECT u.*, $select
2125 JOIN {context} ctx ON u.id = ctx.instanceid
2126 WHERE u.id = :userid AND
2127 ctx.contextlevel = :contextlevel";
2128 $user = $DB->get_record_sql($sql, array('userid' => (int)$user, 'contextlevel' => CONTEXT_USER
), MUST_EXIST
);
2129 context_helper
::preload_from_record($user);
2132 $iscurrentuser = ($user->id
== $USER->id
);
2134 $usercontext = context_user
::instance($user->id
);
2136 // Get the course set against the page, by default this will be the site
2137 $course = $this->page
->course
;
2138 $baseargs = array('id'=>$user->id
);
2139 if ($course->id
!= $SITE->id
&& (!$iscurrentuser ||
$forceforcontext)) {
2140 $coursenode = $this->add_course($course, false, self
::COURSE_CURRENT
);
2141 $baseargs['course'] = $course->id
;
2142 $coursecontext = context_course
::instance($course->id
);
2143 $issitecourse = false;
2145 // Load all categories and get the context for the system
2146 $coursecontext = context_system
::instance();
2147 $issitecourse = true;
2150 // Create a node to add user information under.
2151 if ($iscurrentuser && !$forceforcontext) {
2152 // If it's the current user the information will go under the profile root node
2153 $usernode = $this->rootnodes
['myprofile'];
2154 $course = get_site();
2155 $coursecontext = context_course
::instance($course->id
);
2156 $issitecourse = true;
2158 if (!$issitecourse) {
2159 // Not the current user so add it to the participants node for the current course
2160 $usersnode = $coursenode->get('participants', navigation_node
::TYPE_CONTAINER
);
2161 $userviewurl = new moodle_url('/user/view.php', $baseargs);
2163 // This is the site so add a users node to the root branch
2164 $usersnode = $this->rootnodes
['users'];
2165 if (has_capability('moodle/course:viewparticipants', $coursecontext)) {
2166 $usersnode->action
= new moodle_url('/user/index.php', array('id'=>$course->id
));
2168 $userviewurl = new moodle_url('/user/profile.php', $baseargs);
2171 // We should NEVER get here, if the course hasn't been populated
2172 // with a participants node then the navigaiton either wasn't generated
2173 // for it (you are missing a require_login or set_context call) or
2174 // you don't have access.... in the interests of no leaking informatin
2175 // we simply quit...
2178 // Add a branch for the current user
2179 $canseefullname = has_capability('moodle/site:viewfullnames', $coursecontext);
2180 $usernode = $usersnode->add(fullname($user, $canseefullname), $userviewurl, self
::TYPE_USER
, null, $user->id
);
2182 if ($this->page
->context
->contextlevel
== CONTEXT_USER
&& $user->id
== $this->page
->context
->instanceid
) {
2183 $usernode->make_active();
2187 // If the user is the current user or has permission to view the details of the requested
2188 // user than add a view profile link.
2189 if ($iscurrentuser ||
has_capability('moodle/user:viewdetails', $coursecontext) ||
has_capability('moodle/user:viewdetails', $usercontext)) {
2190 if ($issitecourse ||
($iscurrentuser && !$forceforcontext)) {
2191 $usernode->add(get_string('viewprofile'), new moodle_url('/user/profile.php',$baseargs));
2193 $usernode->add(get_string('viewprofile'), new moodle_url('/user/view.php',$baseargs));
2197 if (!empty($CFG->navadduserpostslinks
)) {
2198 // Add nodes for forum posts and discussions if the user can view either or both
2199 // There are no capability checks here as the content of the page is based
2200 // purely on the forums the current user has access too.
2201 $forumtab = $usernode->add(get_string('forumposts', 'forum'));
2202 $forumtab->add(get_string('posts', 'forum'), new moodle_url('/mod/forum/user.php', $baseargs));
2203 $forumtab->add(get_string('discussions', 'forum'), new moodle_url('/mod/forum/user.php', array_merge($baseargs, array('mode'=>'discussions'))));
2207 if (!empty($CFG->enableblogs
)) {
2208 if (!$this->cache
->cached('userblogoptions'.$user->id
)) {
2209 require_once($CFG->dirroot
.'/blog/lib.php');
2210 // Get all options for the user
2211 $options = blog_get_options_for_user($user);
2212 $this->cache
->set('userblogoptions'.$user->id
, $options);
2214 $options = $this->cache
->{'userblogoptions'.$user->id
};
2217 if (count($options) > 0) {
2218 $blogs = $usernode->add(get_string('blogs', 'blog'), null, navigation_node
::TYPE_CONTAINER
);
2219 foreach ($options as $type => $option) {
2220 if ($type == "rss") {
2221 $blogs->add($option['string'], $option['link'], settings_navigation
::TYPE_SETTING
, null, null, new pix_icon('i/rss', ''));
2223 $blogs->add($option['string'], $option['link']);
2229 if (!empty($CFG->messaging
)) {
2230 $messageargs = array('user1' => $USER->id
);
2231 if ($USER->id
!= $user->id
) {
2232 $messageargs['user2'] = $user->id
;
2234 if ($course->id
!= $SITE->id
) {
2235 $messageargs['viewing'] = MESSAGE_VIEW_COURSE
. $course->id
;
2237 $url = new moodle_url('/message/index.php',$messageargs);
2238 $usernode->add(get_string('messages', 'message'), $url, self
::TYPE_SETTING
, null, 'messages');
2241 if ($iscurrentuser && has_capability('moodle/user:manageownfiles', context_user
::instance($USER->id
))) {
2242 $url = new moodle_url('/user/files.php');
2243 $usernode->add(get_string('myfiles'), $url, self
::TYPE_SETTING
);
2246 if (!empty($CFG->enablebadges
) && $iscurrentuser &&
2247 has_capability('moodle/badges:manageownbadges', context_user
::instance($USER->id
))) {
2248 $url = new moodle_url('/badges/mybadges.php');
2249 $usernode->add(get_string('mybadges', 'badges'), $url, self
::TYPE_SETTING
);
2252 // Add a node to view the users notes if permitted
2253 if (!empty($CFG->enablenotes
) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $coursecontext)) {
2254 $url = new moodle_url('/notes/index.php',array('user'=>$user->id
));
2255 if ($coursecontext->instanceid
!= SITEID
) {
2256 $url->param('course', $coursecontext->instanceid
);
2258 $usernode->add(get_string('notes', 'notes'), $url);
2261 // If the user is the current user add the repositories for the current user
2262 $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields
));
2263 if ($iscurrentuser) {
2264 if (!$this->cache
->cached('contexthasrepos'.$usercontext->id
)) {
2265 require_once($CFG->dirroot
. '/repository/lib.php');
2266 $editabletypes = repository
::get_editable_types($usercontext);
2267 $haseditabletypes = !empty($editabletypes);
2268 unset($editabletypes);
2269 $this->cache
->set('contexthasrepos'.$usercontext->id
, $haseditabletypes);
2271 $haseditabletypes = $this->cache
->{'contexthasrepos'.$usercontext->id
};
2273 if ($haseditabletypes) {
2274 $usernode->add(get_string('repositories', 'repository'), new moodle_url('/repository/manage_instances.php', array('contextid' => $usercontext->id
)));
2276 } else if ($course->id
== $SITE->id
&& has_capability('moodle/user:viewdetails', $usercontext) && (!in_array('mycourses', $hiddenfields) ||
has_capability('moodle/user:viewhiddendetails', $coursecontext))) {
2278 // Add view grade report is permitted
2279 $reports = core_component
::get_plugin_list('gradereport');
2280 arsort($reports); // user is last, we want to test it first
2282 $userscourses = enrol_get_users_courses($user->id
);
2283 $userscoursesnode = $usernode->add(get_string('courses'));
2285 foreach ($userscourses as $usercourse) {
2286 $usercoursecontext = context_course
::instance($usercourse->id
);
2287 $usercourseshortname = format_string($usercourse->shortname
, true, array('context' => $usercoursecontext));
2288 $usercoursenode = $userscoursesnode->add($usercourseshortname, new moodle_url('/user/view.php', array('id'=>$user->id
, 'course'=>$usercourse->id
)), self
::TYPE_CONTAINER
);
2290 $gradeavailable = has_capability('moodle/grade:viewall', $usercoursecontext);
2291 if (!$gradeavailable && !empty($usercourse->showgrades
) && is_array($reports) && !empty($reports)) {
2292 foreach ($reports as $plugin => $plugindir) {
2293 if (has_capability('gradereport/'.$plugin.':view', $usercoursecontext)) {
2294 //stop when the first visible plugin is found
2295 $gradeavailable = true;
2301 if ($gradeavailable) {
2302 $url = new moodle_url('/grade/report/index.php', array('id'=>$usercourse->id
));
2303 $usercoursenode->add(get_string('grades'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/grades', ''));
2306 // Add a node to view the users notes if permitted
2307 if (!empty($CFG->enablenotes
) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $usercoursecontext)) {
2308 $url = new moodle_url('/notes/index.php',array('user'=>$user->id
, 'course'=>$usercourse->id
));
2309 $usercoursenode->add(get_string('notes', 'notes'), $url, self
::TYPE_SETTING
);
2312 if (can_access_course($usercourse, $user->id
)) {
2313 $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', ''));
2316 $reporttab = $usercoursenode->add(get_string('activityreports'));
2318 $reports = get_plugin_list_with_function('report', 'extend_navigation_user', 'lib.php');
2319 foreach ($reports as $reportfunction) {
2320 $reportfunction($reporttab, $user, $usercourse);
2323 $reporttab->trim_if_empty();
2330 * This method simply checks to see if a given module can extend the navigation.
2332 * @todo (MDL-25290) A shared caching solution should be used to save details on what extends navigation.
2334 * @param string $modname
2337 public static function module_extends_navigation($modname) {
2339 static $extendingmodules = array();
2340 if (!array_key_exists($modname, $extendingmodules)) {
2341 $extendingmodules[$modname] = false;
2342 $file = $CFG->dirroot
.'/mod/'.$modname.'/lib.php';
2343 if (file_exists($file)) {
2344 $function = $modname.'_extend_navigation';
2345 require_once($file);
2346 $extendingmodules[$modname] = (function_exists($function));
2349 return $extendingmodules[$modname];
2352 * Extends the navigation for the given user.
2354 * @param stdClass $user A user from the database
2356 public function extend_for_user($user) {
2357 $this->extendforuser
[] = $user;
2361 * Returns all of the users the navigation is being extended for
2363 * @return array An array of extending users.
2365 public function get_extending_users() {
2366 return $this->extendforuser
;
2369 * Adds the given course to the navigation structure.
2371 * @param stdClass $course
2372 * @param bool $forcegeneric
2373 * @param bool $ismycourse
2374 * @return navigation_node
2376 public function add_course(stdClass
$course, $forcegeneric = false, $coursetype = self
::COURSE_OTHER
) {
2379 // We found the course... we can return it now :)
2380 if (!$forcegeneric && array_key_exists($course->id
, $this->addedcourses
)) {
2381 return $this->addedcourses
[$course->id
];
2384 $coursecontext = context_course
::instance($course->id
);
2386 if ($course->id
!= $SITE->id
&& !$course->visible
) {
2387 if (is_role_switched($course->id
)) {
2388 // user has to be able to access course in order to switch, let's skip the visibility test here
2389 } else if (!has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2394 $issite = ($course->id
== $SITE->id
);
2395 $shortname = format_string($course->shortname
, true, array('context' => $coursecontext));
2396 $fullname = format_string($course->fullname
, true, array('context' => $coursecontext));
2397 // This is the name that will be shown for the course.
2398 $coursename = empty($CFG->navshowfullcoursenames
) ?
$shortname : $fullname;
2400 // Can the user expand the course to see its content.
2401 $canexpandcourse = true;
2405 if (empty($CFG->usesitenameforsitepages
)) {
2406 $coursename = get_string('sitepages');
2408 } else if ($coursetype == self
::COURSE_CURRENT
) {
2409 $parent = $this->rootnodes
['currentcourse'];
2410 $url = new moodle_url('/course/view.php', array('id'=>$course->id
));
2411 } else if ($coursetype == self
::COURSE_MY
&& !$forcegeneric) {
2412 if (!empty($CFG->navshowmycoursecategories
) && ($parent = $this->rootnodes
['mycourses']->find($course->category
, self
::TYPE_MY_CATEGORY
))) {
2413 // Nothing to do here the above statement set $parent to the category within mycourses.
2415 $parent = $this->rootnodes
['mycourses'];
2417 $url = new moodle_url('/course/view.php', array('id'=>$course->id
));
2419 $parent = $this->rootnodes
['courses'];
2420 $url = new moodle_url('/course/view.php', array('id'=>$course->id
));
2421 // They can only expand the course if they can access it.
2422 $canexpandcourse = $this->can_expand_course($course);
2423 if (!empty($course->category
) && $this->show_categories($coursetype == self
::COURSE_MY
)) {
2424 if (!$this->is_category_fully_loaded($course->category
)) {
2425 // We need to load the category structure for this course
2426 $this->load_all_categories($course->category
, false);
2428 if (array_key_exists($course->category
, $this->addedcategories
)) {
2429 $parent = $this->addedcategories
[$course->category
];
2430 // This could lead to the course being created so we should check whether it is the case again
2431 if (!$forcegeneric && array_key_exists($course->id
, $this->addedcourses
)) {
2432 return $this->addedcourses
[$course->id
];
2438 $coursenode = $parent->add($coursename, $url, self
::TYPE_COURSE
, $shortname, $course->id
);
2439 $coursenode->hidden
= (!$course->visible
);
2440 // We need to decode &'s here as they will have been added by format_string above and attributes will be encoded again
2442 $coursenode->title(str_replace('&', '&', $fullname));
2443 if ($canexpandcourse) {
2444 // This course can be expanded by the user, make it a branch to make the system aware that its expandable by ajax.
2445 $coursenode->nodetype
= self
::NODETYPE_BRANCH
;
2446 $coursenode->isexpandable
= true;
2448 $coursenode->nodetype
= self
::NODETYPE_LEAF
;
2449 $coursenode->isexpandable
= false;
2451 if (!$forcegeneric) {
2452 $this->addedcourses
[$course->id
] = $coursenode;
2459 * Returns a cache instance to use for the expand course cache.
2460 * @return cache_session
2462 protected function get_expand_course_cache() {
2463 if ($this->cacheexpandcourse
=== null) {
2464 $this->cacheexpandcourse
= cache
::make('core', 'navigation_expandcourse');
2466 return $this->cacheexpandcourse
;
2470 * Checks if a user can expand a course in the navigation.
2472 * We use a cache here because in order to be accurate we need to call can_access_course which is a costly function.
2473 * Because this functionality is basic + non-essential and because we lack good event triggering this cache
2474 * permits stale data.
2475 * In the situation the user is granted access to a course after we've initialised this session cache the cache
2477 * It is brought up to date in only one of two ways.
2478 * 1. The user logs out and in again.
2479 * 2. The user browses to the course they've just being given access to.
2481 * Really all this controls is whether the node is shown as expandable or not. It is uber un-important.
2483 * @param stdClass $course
2486 protected function can_expand_course($course) {
2487 $cache = $this->get_expand_course_cache();
2488 $canexpand = $cache->get($course->id
);
2489 if ($canexpand === false) {
2490 $canexpand = isloggedin() && can_access_course($course);
2491 $canexpand = (int)$canexpand;
2492 $cache->set($course->id
, $canexpand);
2494 return ($canexpand === 1);
2498 * Returns true if the category has already been loaded as have any child categories
2500 * @param int $categoryid
2503 protected function is_category_fully_loaded($categoryid) {
2504 return (array_key_exists($categoryid, $this->addedcategories
) && ($this->allcategoriesloaded ||
$this->addedcategories
[$categoryid]->children
->count() > 0));
2508 * Adds essential course nodes to the navigation for the given course.
2510 * This method adds nodes such as reports, blogs and participants
2512 * @param navigation_node $coursenode
2513 * @param stdClass $course
2514 * @return bool returns true on successful addition of a node.
2516 public function add_course_essentials($coursenode, stdClass
$course) {
2519 if ($course->id
== $SITE->id
) {
2520 return $this->add_front_page_course_essentials($coursenode, $course);
2523 if ($coursenode == false ||
!($coursenode instanceof navigation_node
) ||
$coursenode->get('participants', navigation_node
::TYPE_CONTAINER
)) {
2528 if (has_capability('moodle/course:viewparticipants', $this->page
->context
)) {
2529 $participants = $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id
), self
::TYPE_CONTAINER
, get_string('participants'), 'participants');
2530 if (!empty($CFG->enableblogs
)) {
2531 if (($CFG->bloglevel
== BLOG_GLOBAL_LEVEL
or ($CFG->bloglevel
== BLOG_SITE_LEVEL
and (isloggedin() and !isguestuser())))
2532 and has_capability('moodle/blog:view', context_system
::instance())) {
2533 $blogsurls = new moodle_url('/blog/index.php');
2534 if ($course->id
== $SITE->id
) {
2535 $blogsurls->param('courseid', 0);
2536 } else if ($currentgroup = groups_get_course_group($course, true)) {
2537 $blogsurls->param('groupid', $currentgroup);
2539 $blogsurls->param('courseid', $course->id
);
2541 $participants->add(get_string('blogscourse','blog'), $blogsurls->out());
2544 if (!empty($CFG->enablenotes
) && (has_capability('moodle/notes:manage', $this->page
->context
) ||
has_capability('moodle/notes:view', $this->page
->context
))) {
2545 $participants->add(get_string('notes','notes'), new moodle_url('/notes/index.php', array('filtertype'=>'course', 'filterselect'=>$course->id
)));
2547 } else if (count($this->extendforuser
) > 0 ||
$this->page
->course
->id
== $course->id
) {
2548 $participants = $coursenode->add(get_string('participants'), null, self
::TYPE_CONTAINER
, get_string('participants'), 'participants');
2552 if (!empty($CFG->enablebadges
) && !empty($CFG->badges_allowcoursebadges
) &&
2553 has_capability('moodle/badges:viewbadges', $this->page
->context
)) {
2554 $url = new moodle_url('/badges/view.php', array('type' => 2, 'id' => $course->id
));
2556 $coursenode->add(get_string('coursebadges', 'badges'), null,
2557 navigation_node
::TYPE_CONTAINER
, null, 'coursebadges');
2558 $coursenode->get('coursebadges')->add(get_string('badgesview', 'badges'), $url,
2559 navigation_node
::TYPE_SETTING
, null, 'badgesview',
2560 new pix_icon('i/badge', get_string('badgesview', 'badges')));
2566 * This generates the structure of the course that won't be generated when
2567 * the modules and sections are added.
2569 * Things such as the reports branch, the participants branch, blogs... get
2570 * added to the course node by this method.
2572 * @param navigation_node $coursenode
2573 * @param stdClass $course
2574 * @return bool True for successfull generation
2576 public function add_front_page_course_essentials(navigation_node
$coursenode, stdClass
$course) {
2579 if ($coursenode == false ||
$coursenode->get('frontpageloaded', navigation_node
::TYPE_CUSTOM
)) {
2583 // Hidden node that we use to determine if the front page navigation is loaded.
2584 // This required as there are not other guaranteed nodes that may be loaded.
2585 $coursenode->add('frontpageloaded', null, self
::TYPE_CUSTOM
, null, 'frontpageloaded')->display
= false;
2588 if (has_capability('moodle/course:viewparticipants', context_system
::instance())) {
2589 $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id
), self
::TYPE_CUSTOM
, get_string('participants'), 'participants');
2595 if (!empty($CFG->enableblogs
)
2596 and ($CFG->bloglevel
== BLOG_GLOBAL_LEVEL
or ($CFG->bloglevel
== BLOG_SITE_LEVEL
and (isloggedin() and !isguestuser())))
2597 and has_capability('moodle/blog:view', context_system
::instance())) {
2598 $blogsurls = new moodle_url('/blog/index.php', array('courseid' => $filterselect));
2599 $coursenode->add(get_string('blogssite','blog'), $blogsurls->out());
2603 if (!empty($CFG->enablebadges
) && has_capability('moodle/badges:viewbadges', $this->page
->context
)) {
2604 $url = new moodle_url($CFG->wwwroot
. '/badges/view.php', array('type' => 1));
2605 $coursenode->add(get_string('sitebadges', 'badges'), $url, navigation_node
::TYPE_CUSTOM
);
2609 if (!empty($CFG->enablenotes
) && (has_capability('moodle/notes:manage', $this->page
->context
) ||
has_capability('moodle/notes:view', $this->page
->context
))) {
2610 $coursenode->add(get_string('notes','notes'), new moodle_url('/notes/index.php', array('filtertype'=>'course', 'filterselect'=>$filterselect)));
2614 if (!empty($CFG->usetags
) && isloggedin()) {
2615 $coursenode->add(get_string('tags', 'tag'), new moodle_url('/tag/search.php'));
2620 $calendarurl = new moodle_url('/calendar/view.php', array('view' => 'month'));
2621 $coursenode->add(get_string('calendar', 'calendar'), $calendarurl, self
::TYPE_CUSTOM
, null, 'calendar');
2628 * Clears the navigation cache
2630 public function clear_cache() {
2631 $this->cache
->clear();
2635 * Sets an expansion limit for the navigation
2637 * The expansion limit is used to prevent the display of content that has a type
2638 * greater than the provided $type.
2640 * Can be used to ensure things such as activities or activity content don't get
2641 * shown on the navigation.
2642 * They are still generated in order to ensure the navbar still makes sense.
2644 * @param int $type One of navigation_node::TYPE_*
2645 * @return bool true when complete.
2647 public function set_expansion_limit($type) {
2649 $nodes = $this->find_all_of_type($type);
2651 // We only want to hide specific types of nodes.
2652 // Only nodes that represent "structure" in the navigation tree should be hidden.
2653 // If we hide all nodes then we risk hiding vital information.
2654 $typestohide = array(
2655 self
::TYPE_CATEGORY
,
2661 foreach ($nodes as $node) {
2662 // We need to generate the full site node
2663 if ($type == self
::TYPE_COURSE
&& $node->key
== $SITE->id
) {
2666 foreach ($node->children
as $child) {
2667 $child->hide($typestohide);
2673 * Attempts to get the navigation with the given key from this nodes children.
2675 * This function only looks at this nodes children, it does NOT look recursivily.
2676 * If the node can't be found then false is returned.
2678 * If you need to search recursivily then use the {@link global_navigation::find()} method.
2680 * Note: If you are trying to set the active node {@link navigation_node::override_active_url()}
2681 * may be of more use to you.
2683 * @param string|int $key The key of the node you wish to receive.
2684 * @param int $type One of navigation_node::TYPE_*
2685 * @return navigation_node|false
2687 public function get($key, $type = null) {
2688 if (!$this->initialised
) {
2689 $this->initialise();
2691 return parent
::get($key, $type);
2695 * Searches this nodes children and their children to find a navigation node
2696 * with the matching key and type.
2698 * This method is recursive and searches children so until either a node is
2699 * found or there are no more nodes to search.
2701 * If you know that the node being searched for is a child of this node
2702 * then use the {@link global_navigation::get()} method instead.
2704 * Note: If you are trying to set the active node {@link navigation_node::override_active_url()}
2705 * may be of more use to you.
2707 * @param string|int $key The key of the node you wish to receive.
2708 * @param int $type One of navigation_node::TYPE_*
2709 * @return navigation_node|false
2711 public function find($key, $type) {
2712 if (!$this->initialised
) {
2713 $this->initialise();
2715 if ($type == self
::TYPE_ROOTNODE
&& array_key_exists($key, $this->rootnodes
)) {
2716 return $this->rootnodes
[$key];
2718 return parent
::find($key, $type);
2722 * They've expanded the 'my courses' branch.
2724 protected function load_courses_enrolled() {
2726 $sortorder = 'visible DESC';
2727 // Prevent undefined $CFG->navsortmycoursessort errors.
2728 if (empty($CFG->navsortmycoursessort
)) {
2729 $CFG->navsortmycoursessort
= 'sortorder';
2731 // Append the chosen sortorder.
2732 $sortorder = $sortorder . ',' . $CFG->navsortmycoursessort
. ' ASC';
2733 $courses = enrol_get_my_courses(null, $sortorder);
2734 if (count($courses) && $this->show_my_categories()) {
2735 // OK Actually we are loading categories. We only want to load categories that have a parent of 0.
2736 // In order to make sure we load everything required we must first find the categories that are not
2737 // base categories and work out the bottom category in thier path.
2738 $categoryids = array();
2739 foreach ($courses as $course) {
2740 $categoryids[] = $course->category
;
2742 $categoryids = array_unique($categoryids);
2743 list($sql, $params) = $DB->get_in_or_equal($categoryids);
2744 $categories = $DB->get_recordset_select('course_categories', 'id '.$sql.' AND parent <> 0', $params, 'sortorder, id', 'id, path');
2745 foreach ($categories as $category) {
2746 $bits = explode('/', trim($category->path
,'/'));
2747 $categoryids[] = array_shift($bits);
2749 $categoryids = array_unique($categoryids);
2750 $categories->close();
2752 // Now we load the base categories.
2753 list($sql, $params) = $DB->get_in_or_equal($categoryids);
2754 $categories = $DB->get_recordset_select('course_categories', 'id '.$sql.' AND parent = 0', $params, 'sortorder, id');
2755 foreach ($categories as $category) {
2756 $this->add_category($category, $this->rootnodes
['mycourses'], self
::TYPE_MY_CATEGORY
);
2758 $categories->close();
2760 foreach ($courses as $course) {
2761 $this->add_course($course, false, self
::COURSE_MY
);
2768 * The global navigation class used especially for AJAX requests.
2770 * The primary methods that are used in the global navigation class have been overriden
2771 * to ensure that only the relevant branch is generated at the root of the tree.
2772 * This can be done because AJAX is only used when the backwards structure for the
2773 * requested branch exists.
2774 * This has been done only because it shortens the amounts of information that is generated
2775 * which of course will speed up the response time.. because no one likes laggy AJAX.
2778 * @category navigation
2779 * @copyright 2009 Sam Hemelryk
2780 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2782 class global_navigation_for_ajax
extends global_navigation
{
2784 /** @var int used for determining what type of navigation_node::TYPE_* is being used */
2785 protected $branchtype;
2787 /** @var int the instance id */
2788 protected $instanceid;
2790 /** @var array Holds an array of expandable nodes */
2791 protected $expandable = array();
2794 * Constructs the navigation for use in an AJAX request
2796 * @param moodle_page $page moodle_page object
2797 * @param int $branchtype
2800 public function __construct($page, $branchtype, $id) {
2801 $this->page
= $page;
2802 $this->cache
= new navigation_cache(NAVIGATION_CACHE_NAME
);
2803 $this->children
= new navigation_node_collection();
2804 $this->branchtype
= $branchtype;
2805 $this->instanceid
= $id;
2806 $this->initialise();
2809 * Initialise the navigation given the type and id for the branch to expand.
2811 * @return array An array of the expandable nodes
2813 public function initialise() {
2816 if ($this->initialised ||
during_initial_install()) {
2817 return $this->expandable
;
2819 $this->initialised
= true;
2821 $this->rootnodes
= array();
2822 $this->rootnodes
['site'] = $this->add_course($SITE);
2823 $this->rootnodes
['mycourses'] = $this->add(get_string('mycourses'), new moodle_url('/my'), self
::TYPE_ROOTNODE
, null, 'mycourses');
2824 $this->rootnodes
['courses'] = $this->add(get_string('courses'), null, self
::TYPE_ROOTNODE
, null, 'courses');
2825 // The courses branch is always displayed, and is always expandable (although may be empty).
2826 // This mimicks what is done during {@link global_navigation::initialise()}.
2827 $this->rootnodes
['courses']->isexpandable
= true;
2829 // Branchtype will be one of navigation_node::TYPE_*
2830 switch ($this->branchtype
) {
2832 if ($this->instanceid
=== 'mycourses') {
2833 $this->load_courses_enrolled();
2834 } else if ($this->instanceid
=== 'courses') {
2835 $this->load_courses_other();
2838 case self
::TYPE_CATEGORY
:
2839 $this->load_category($this->instanceid
);
2841 case self
::TYPE_MY_CATEGORY
:
2842 $this->load_category($this->instanceid
, self
::TYPE_MY_CATEGORY
);
2844 case self
::TYPE_COURSE
:
2845 $course = $DB->get_record('course', array('id' => $this->instanceid
), '*', MUST_EXIST
);
2846 if (!can_access_course($course)) {
2847 // Thats OK all courses are expandable by default. We don't need to actually expand it we can just
2848 // add the course node and break. This leads to an empty node.
2849 $this->add_course($course);
2852 require_course_login($course, true, null, false, true);
2853 $this->page
->set_context(context_course
::instance($course->id
));
2854 $coursenode = $this->add_course($course);
2855 $this->add_course_essentials($coursenode, $course);
2856 $this->load_course_sections($course, $coursenode);
2858 case self
::TYPE_SECTION
:
2859 $sql = 'SELECT c.*, cs.section AS sectionnumber
2861 LEFT JOIN {course_sections} cs ON cs.course = c.id
2863 $course = $DB->get_record_sql($sql, array($this->instanceid
), MUST_EXIST
);
2864 require_course_login($course, true, null, false, true);
2865 $this->page
->set_context(context_course
::instance($course->id
));
2866 $coursenode = $this->add_course($course);
2867 $this->add_course_essentials($coursenode, $course);
2868 $this->load_course_sections($course, $coursenode, $course->sectionnumber
);
2870 case self
::TYPE_ACTIVITY
:
2873 JOIN {course_modules} cm ON cm.course = c.id
2874 WHERE cm.id = :cmid";
2875 $params = array('cmid' => $this->instanceid
);
2876 $course = $DB->get_record_sql($sql, $params, MUST_EXIST
);
2877 $modinfo = get_fast_modinfo($course);
2878 $cm = $modinfo->get_cm($this->instanceid
);
2879 require_course_login($course, true, $cm, false, true);
2880 $this->page
->set_context(context_module
::instance($cm->id
));
2881 $coursenode = $this->load_course($course);
2882 if ($course->id
!= $SITE->id
) {
2883 $this->load_course_sections($course, $coursenode, null, $cm);
2885 $modulenode = $this->load_activity($cm, $course, $coursenode->find($cm->id
, self
::TYPE_ACTIVITY
));
2888 throw new Exception('Unknown type');
2889 return $this->expandable
;
2892 if ($this->page
->context
->contextlevel
== CONTEXT_COURSE
&& $this->page
->context
->instanceid
!= $SITE->id
) {
2893 $this->load_for_user(null, true);
2896 $this->find_expandable($this->expandable
);
2897 return $this->expandable
;
2901 * They've expanded the general 'courses' branch.
2903 protected function load_courses_other() {
2904 $this->load_all_courses();
2908 * Loads a single category into the AJAX navigation.
2910 * This function is special in that it doesn't concern itself with the parent of
2911 * the requested category or its siblings.
2912 * This is because with the AJAX navigation we know exactly what is wanted and only need to
2915 * @global moodle_database $DB
2916 * @param int $categoryid id of category to load in navigation.
2917 * @param int $nodetype type of node, if category is under MyHome then it's TYPE_MY_CATEGORY
2920 protected function load_category($categoryid, $nodetype = self
::TYPE_CATEGORY
) {
2924 if (!empty($CFG->navcourselimit
)) {
2925 $limit = (int)$CFG->navcourselimit
;
2928 $catcontextsql = context_helper
::get_preload_record_columns_sql('ctx');
2929 $sql = "SELECT cc.*, $catcontextsql
2930 FROM {course_categories} cc
2931 JOIN {context} ctx ON cc.id = ctx.instanceid
2932 WHERE ctx.contextlevel = ".CONTEXT_COURSECAT
." AND
2933 (cc.id = :categoryid1 OR cc.parent = :categoryid2)
2934 ORDER BY cc.depth ASC, cc.sortorder ASC, cc.id ASC";
2935 $params = array('categoryid1' => $categoryid, 'categoryid2' => $categoryid);
2936 $categories = $DB->get_recordset_sql($sql, $params, 0, $limit);
2937 $categorylist = array();
2938 $subcategories = array();
2939 $basecategory = null;
2940 foreach ($categories as $category) {
2941 $categorylist[] = $category->id
;
2942 context_helper
::preload_from_record($category);
2943 if ($category->id
== $categoryid) {
2944 $this->add_category($category, $this, $nodetype);
2945 $basecategory = $this->addedcategories
[$category->id
];
2947 $subcategories[$category->id
] = $category;
2950 $categories->close();
2953 // If category is shown in MyHome then only show enrolled courses and hide empty subcategories,
2954 // else show all courses.
2955 if ($nodetype === self
::TYPE_MY_CATEGORY
) {
2956 $courses = enrol_get_my_courses();
2957 $categoryids = array();
2959 // Only search for categories if basecategory was found.
2960 if (!is_null($basecategory)) {
2961 // Get course parent category ids.
2962 foreach ($courses as $course) {
2963 $categoryids[] = $course->category
;
2966 // Get a unique list of category ids which a part of the path
2967 // to user's courses.
2968 $coursesubcategories = array();
2969 $addedsubcategories = array();
2971 list($sql, $params) = $DB->get_in_or_equal($categoryids);
2972 $categories = $DB->get_recordset_select('course_categories', 'id '.$sql, $params, 'sortorder, id', 'id, path');
2974 foreach ($categories as $category){
2975 $coursesubcategories = array_merge($coursesubcategories, explode('/', trim($category->path
, "/")));
2977 $coursesubcategories = array_unique($coursesubcategories);
2979 // Only add a subcategory if it is part of the path to user's course and
2980 // wasn't already added.
2981 foreach ($subcategories as $subid => $subcategory) {
2982 if (in_array($subid, $coursesubcategories) &&
2983 !in_array($subid, $addedsubcategories)) {
2984 $this->add_category($subcategory, $basecategory, $nodetype);
2985 $addedsubcategories[] = $subid;
2990 foreach ($courses as $course) {
2991 // Add course if it's in category.
2992 if (in_array($course->category
, $categorylist)) {
2993 $this->add_course($course, true, self
::COURSE_MY
);
2997 if (!is_null($basecategory)) {
2998 foreach ($subcategories as $key=>$category) {
2999 $this->add_category($category, $basecategory, $nodetype);
3002 $courses = $DB->get_recordset('course', array('category' => $categoryid), 'sortorder', '*' , 0, $limit);
3003 foreach ($courses as $course) {
3004 $this->add_course($course);
3011 * Returns an array of expandable nodes
3014 public function get_expandable() {
3015 return $this->expandable
;
3022 * This class is used to manage the navbar, which is initialised from the navigation
3023 * object held by PAGE
3026 * @category navigation
3027 * @copyright 2009 Sam Hemelryk
3028 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3030 class navbar
extends navigation_node
{
3031 /** @var bool A switch for whether the navbar is initialised or not */
3032 protected $initialised = false;
3033 /** @var mixed keys used to reference the nodes on the navbar */
3034 protected $keys = array();
3035 /** @var null|string content of the navbar */
3036 protected $content = null;
3037 /** @var moodle_page object the moodle page that this navbar belongs to */
3039 /** @var bool A switch for whether to ignore the active navigation information */
3040 protected $ignoreactive = false;
3041 /** @var bool A switch to let us know if we are in the middle of an install */
3042 protected $duringinstall = false;
3043 /** @var bool A switch for whether the navbar has items */
3044 protected $hasitems = false;
3045 /** @var array An array of navigation nodes for the navbar */
3047 /** @var array An array of child node objects */
3048 public $children = array();
3049 /** @var bool A switch for whether we want to include the root node in the navbar */
3050 public $includesettingsbase = false;
3051 /** @var navigation_node[] $prependchildren */
3052 protected $prependchildren = array();
3054 * The almighty constructor
3056 * @param moodle_page $page
3058 public function __construct(moodle_page
$page) {
3060 if (during_initial_install()) {
3061 $this->duringinstall
= true;
3064 $this->page
= $page;
3065 $this->text
= get_string('home');
3066 $this->shorttext
= get_string('home');
3067 $this->action
= new moodle_url($CFG->wwwroot
);
3068 $this->nodetype
= self
::NODETYPE_BRANCH
;
3069 $this->type
= self
::TYPE_SYSTEM
;
3073 * Quick check to see if the navbar will have items in.
3075 * @return bool Returns true if the navbar will have items, false otherwise
3077 public function has_items() {
3078 if ($this->duringinstall
) {
3080 } else if ($this->hasitems
!== false) {
3083 $this->page
->navigation
->initialise($this->page
);
3085 $activenodefound = ($this->page
->navigation
->contains_active_node() ||
3086 $this->page
->settingsnav
->contains_active_node());
3088 $outcome = (count($this->children
) > 0 ||
count($this->prependchildren
) ||
(!$this->ignoreactive
&& $activenodefound));
3089 $this->hasitems
= $outcome;
3094 * Turn on/off ignore active
3096 * @param bool $setting
3098 public function ignore_active($setting=true) {
3099 $this->ignoreactive
= ($setting);
3103 * Gets a navigation node
3105 * @param string|int $key for referencing the navbar nodes
3106 * @param int $type navigation_node::TYPE_*
3107 * @return navigation_node|bool
3109 public function get($key, $type = null) {
3110 foreach ($this->children
as &$child) {
3111 if ($child->key
=== $key && ($type == null ||
$type == $child->type
)) {
3115 foreach ($this->prependchildren
as &$child) {
3116 if ($child->key
=== $key && ($type == null ||
$type == $child->type
)) {
3123 * Returns an array of navigation_node's that make up the navbar.
3127 public function get_items() {
3130 // Make sure that navigation is initialised
3131 if (!$this->has_items()) {
3134 if ($this->items
!== null) {
3135 return $this->items
;
3138 if (count($this->children
) > 0) {
3139 // Add the custom children.
3140 $items = array_reverse($this->children
);
3143 $navigationactivenode = $this->page
->navigation
->find_active_node();
3144 $settingsactivenode = $this->page
->settingsnav
->find_active_node();
3146 // Check if navigation contains the active node
3147 if (!$this->ignoreactive
) {
3149 if ($navigationactivenode && $settingsactivenode) {
3150 // Parse a combined navigation tree
3151 while ($settingsactivenode && $settingsactivenode->parent
!== null) {
3152 if (!$settingsactivenode->mainnavonly
) {
3153 $items[] = $settingsactivenode;
3155 $settingsactivenode = $settingsactivenode->parent
;
3157 if (!$this->includesettingsbase
) {
3158 // Removes the first node from the settings (root node) from the list
3161 while ($navigationactivenode && $navigationactivenode->parent
!== null) {
3162 if (!$navigationactivenode->mainnavonly
) {
3163 $items[] = $navigationactivenode;
3165 if (!empty($CFG->navshowcategories
) &&
3166 $navigationactivenode->type
=== self
::TYPE_COURSE
&&
3167 $navigationactivenode->parent
->key
=== 'currentcourse') {
3168 $items = array_merge($items, $this->get_course_categories());
3170 $navigationactivenode = $navigationactivenode->parent
;
3172 } else if ($navigationactivenode) {
3173 // Parse the navigation tree to get the active node
3174 while ($navigationactivenode && $navigationactivenode->parent
!== null) {
3175 if (!$navigationactivenode->mainnavonly
) {
3176 $items[] = $navigationactivenode;
3178 if (!empty($CFG->navshowcategories
) &&
3179 $navigationactivenode->type
=== self
::TYPE_COURSE
&&
3180 $navigationactivenode->parent
->key
=== 'currentcourse') {
3181 $items = array_merge($items, $this->get_course_categories());
3183 $navigationactivenode = $navigationactivenode->parent
;
3185 } else if ($settingsactivenode) {
3186 // Parse the settings navigation to get the active node
3187 while ($settingsactivenode && $settingsactivenode->parent
!== null) {
3188 if (!$settingsactivenode->mainnavonly
) {
3189 $items[] = $settingsactivenode;
3191 $settingsactivenode = $settingsactivenode->parent
;
3196 $items[] = new navigation_node(array(
3197 'text'=>$this->page
->navigation
->text
,
3198 'shorttext'=>$this->page
->navigation
->shorttext
,
3199 'key'=>$this->page
->navigation
->key
,
3200 'action'=>$this->page
->navigation
->action
3203 if (count($this->prependchildren
) > 0) {
3204 // Add the custom children
3205 $items = array_merge($items, array_reverse($this->prependchildren
));
3208 $this->items
= array_reverse($items);
3209 return $this->items
;
3213 * Get the list of categories leading to this course.
3215 * This function is used by {@link navbar::get_items()} to add back the "courses"
3216 * node and category chain leading to the current course. Note that this is only ever
3217 * called for the current course, so we don't need to bother taking in any parameters.
3221 private function get_course_categories() {
3224 require_once($CFG->dirroot
.'/course/lib.php');
3225 $categories = array();
3226 $cap = 'moodle/category:viewhiddencategories';
3227 foreach ($this->page
->categories
as $category) {
3228 if (!$category->visible
&& !has_capability($cap, get_category_or_system_context($category->parent
))) {
3231 $url = new moodle_url('/course/index.php', array('categoryid' => $category->id
));
3232 $name = format_string($category->name
, true, array('context' => context_coursecat
::instance($category->id
)));
3233 $categorynode = navigation_node
::create($name, $url, self
::TYPE_CATEGORY
, null, $category->id
);
3234 if (!$category->visible
) {
3235 $categorynode->hidden
= true;
3237 $categories[] = $categorynode;
3239 if (is_enrolled(context_course
::instance($this->page
->course
->id
))) {
3240 $courses = $this->page
->navigation
->get('mycourses');
3242 $courses = $this->page
->navigation
->get('courses');
3245 // Courses node may not be present.
3246 $courses = navigation_node
::create(
3247 get_string('courses'),
3248 new moodle_url('/course/index.php'),
3249 self
::TYPE_CONTAINER
3252 $categories[] = $courses;
3257 * Add a new navigation_node to the navbar, overrides parent::add
3259 * This function overrides {@link navigation_node::add()} so that we can change
3260 * the way nodes get added to allow us to simply call add and have the node added to the
3263 * @param string $text
3264 * @param string|moodle_url|action_link $action An action to associate with this node.
3265 * @param int $type One of navigation_node::TYPE_*
3266 * @param string $shorttext
3267 * @param string|int $key A key to identify this node with. Key + type is unique to a parent.
3268 * @param pix_icon $icon An optional icon to use for this node.
3269 * @return navigation_node
3271 public function add($text, $action=null, $type=self
::TYPE_CUSTOM
, $shorttext=null, $key=null, pix_icon
$icon=null) {
3272 if ($this->content
!== null) {
3273 debugging('Nav bar items must be printed before $OUTPUT->header() has been called', DEBUG_DEVELOPER
);
3276 // Properties array used when creating the new navigation node
3281 // Set the action if one was provided
3282 if ($action!==null) {
3283 $itemarray['action'] = $action;
3285 // Set the shorttext if one was provided
3286 if ($shorttext!==null) {
3287 $itemarray['shorttext'] = $shorttext;
3289 // Set the icon if one was provided
3291 $itemarray['icon'] = $icon;
3293 // Default the key to the number of children if not provided
3294 if ($key === null) {
3295 $key = count($this->children
);
3298 $itemarray['key'] = $key;
3299 // Set the parent to this node
3300 $itemarray['parent'] = $this;
3301 // Add the child using the navigation_node_collections add method
3302 $this->children
[] = new navigation_node($itemarray);
3307 * Prepends a new navigation_node to the start of the navbar
3309 * @param string $text
3310 * @param string|moodle_url|action_link $action An action to associate with this node.
3311 * @param int $type One of navigation_node::TYPE_*
3312 * @param string $shorttext
3313 * @param string|int $key A key to identify this node with. Key + type is unique to a parent.
3314 * @param pix_icon $icon An optional icon to use for this node.
3315 * @return navigation_node
3317 public function prepend($text, $action=null, $type=self
::TYPE_CUSTOM
, $shorttext=null, $key=null, pix_icon
$icon=null) {
3318 if ($this->content
!== null) {
3319 debugging('Nav bar items must be printed before $OUTPUT->header() has been called', DEBUG_DEVELOPER
);
3321 // Properties array used when creating the new navigation node.
3326 // Set the action if one was provided.
3327 if ($action!==null) {
3328 $itemarray['action'] = $action;
3330 // Set the shorttext if one was provided.
3331 if ($shorttext!==null) {
3332 $itemarray['shorttext'] = $shorttext;
3334 // Set the icon if one was provided.
3336 $itemarray['icon'] = $icon;
3338 // Default the key to the number of children if not provided.
3339 if ($key === null) {
3340 $key = count($this->children
);
3343 $itemarray['key'] = $key;
3344 // Set the parent to this node.
3345 $itemarray['parent'] = $this;
3346 // Add the child node to the prepend list.
3347 $this->prependchildren
[] = new navigation_node($itemarray);
3353 * Class used to manage the settings option for the current page
3355 * This class is used to manage the settings options in a tree format (recursively)
3356 * and was created initially for use with the settings blocks.
3359 * @category navigation
3360 * @copyright 2009 Sam Hemelryk
3361 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3363 class settings_navigation
extends navigation_node
{
3364 /** @var stdClass the current context */
3366 /** @var moodle_page the moodle page that the navigation belongs to */
3368 /** @var string contains administration section navigation_nodes */
3369 protected $adminsection;
3370 /** @var bool A switch to see if the navigation node is initialised */
3371 protected $initialised = false;
3372 /** @var array An array of users that the nodes can extend for. */
3373 protected $userstoextendfor = array();
3374 /** @var navigation_cache **/
3378 * Sets up the object with basic settings and preparse it for use
3380 * @param moodle_page $page
3382 public function __construct(moodle_page
&$page) {
3383 if (during_initial_install()) {
3386 $this->page
= $page;
3387 // Initialise the main navigation. It is most important that this is done
3388 // before we try anything
3389 $this->page
->navigation
->initialise();
3390 // Initialise the navigation cache
3391 $this->cache
= new navigation_cache(NAVIGATION_CACHE_NAME
);
3392 $this->children
= new navigation_node_collection();
3395 * Initialise the settings navigation based on the current context
3397 * This function initialises the settings navigation tree for a given context
3398 * by calling supporting functions to generate major parts of the tree.
3401 public function initialise() {
3402 global $DB, $SESSION, $SITE;
3404 if (during_initial_install()) {
3406 } else if ($this->initialised
) {
3409 $this->id
= 'settingsnav';
3410 $this->context
= $this->page
->context
;
3412 $context = $this->context
;
3413 if ($context->contextlevel
== CONTEXT_BLOCK
) {
3414 $this->load_block_settings();
3415 $context = $context->get_parent_context();
3417 switch ($context->contextlevel
) {
3418 case CONTEXT_SYSTEM
:
3419 if ($this->page
->url
->compare(new moodle_url('/admin/settings.php', array('section'=>'frontpagesettings')))) {
3420 $this->load_front_page_settings(($context->id
== $this->context
->id
));
3423 case CONTEXT_COURSECAT
:
3424 $this->load_category_settings();
3426 case CONTEXT_COURSE
:
3427 if ($this->page
->course
->id
!= $SITE->id
) {
3428 $this->load_course_settings(($context->id
== $this->context
->id
));
3430 $this->load_front_page_settings(($context->id
== $this->context
->id
));
3433 case CONTEXT_MODULE
:
3434 $this->load_module_settings();
3435 $this->load_course_settings();
3438 if ($this->page
->course
->id
!= $SITE->id
) {
3439 $this->load_course_settings();
3444 $usersettings = $this->load_user_settings($this->page
->course
->id
);
3446 $adminsettings = false;
3447 if (isloggedin() && !isguestuser() && (!isset($SESSION->load_navigation_admin
) ||
$SESSION->load_navigation_admin
)) {
3448 $isadminpage = $this->is_admin_tree_needed();
3450 if (has_capability('moodle/site:config', context_system
::instance())) {
3451 // Make sure this works even if config capability changes on the fly
3452 // and also make it fast for admin right after login.
3453 $SESSION->load_navigation_admin
= 1;
3455 $adminsettings = $this->load_administration_settings();
3458 } else if (!isset($SESSION->load_navigation_admin
)) {
3459 $adminsettings = $this->load_administration_settings();
3460 $SESSION->load_navigation_admin
= (int)($adminsettings->children
->count() > 0);
3462 } else if ($SESSION->load_navigation_admin
) {
3464 $adminsettings = $this->load_administration_settings();
3468 // Print empty navigation node, if needed.
3469 if ($SESSION->load_navigation_admin
&& !$isadminpage) {
3470 if ($adminsettings) {
3471 // Do not print settings tree on pages that do not need it, this helps with performance.
3472 $adminsettings->remove();
3473 $adminsettings = false;
3475 $siteadminnode = $this->add(get_string('administrationsite'), new moodle_url('/admin'), self
::TYPE_SITE_ADMIN
, null, 'siteadministration');
3476 $siteadminnode->id
= 'expandable_branch_'.$siteadminnode->type
.'_'.clean_param($siteadminnode->key
, PARAM_ALPHANUMEXT
);
3477 $this->page
->requires
->data_for_js('siteadminexpansion', $siteadminnode);
3481 if ($context->contextlevel
== CONTEXT_SYSTEM
&& $adminsettings) {
3482 $adminsettings->force_open();
3483 } else if ($context->contextlevel
== CONTEXT_USER
&& $usersettings) {
3484 $usersettings->force_open();
3487 // Check if the user is currently logged in as another user
3488 if (\core\session\manager
::is_loggedinas()) {
3489 // Get the actual user, we need this so we can display an informative return link
3490 $realuser = \core\session\manager
::get_realuser();
3491 // Add the informative return to original user link
3492 $url = new moodle_url('/course/loginas.php',array('id'=>$this->page
->course
->id
, 'return'=>1,'sesskey'=>sesskey()));
3493 $this->add(get_string('returntooriginaluser', 'moodle', fullname($realuser, true)), $url, self
::TYPE_SETTING
, null, null, new pix_icon('t/left', ''));
3496 // At this point we give any local plugins the ability to extend/tinker with the navigation settings.
3497 $this->load_local_plugin_settings();
3499 foreach ($this->children
as $key=>$node) {
3500 if ($node->nodetype
!= self
::NODETYPE_BRANCH ||
$node->children
->count()===0) {
3501 // Site administration is shown as link.
3502 if (!empty($SESSION->load_navigation_admin
) && ($node->type
=== self
::TYPE_SITE_ADMIN
)) {
3508 $this->initialised
= true;
3511 * Override the parent function so that we can add preceeding hr's and set a
3512 * root node class against all first level element
3514 * It does this by first calling the parent's add method {@link navigation_node::add()}
3515 * and then proceeds to use the key to set class and hr
3517 * @param string $text text to be used for the link.
3518 * @param string|moodle_url $url url for the new node
3519 * @param int $type the type of node navigation_node::TYPE_*
3520 * @param string $shorttext
3521 * @param string|int $key a key to access the node by.
3522 * @param pix_icon $icon An icon that appears next to the node.
3523 * @return navigation_node with the new node added to it.
3525 public function add($text, $url=null, $type=null, $shorttext=null, $key=null, pix_icon
$icon=null) {
3526 $node = parent
::add($text, $url, $type, $shorttext, $key, $icon);
3527 $node->add_class('root_node');
3532 * This function allows the user to add something to the start of the settings
3533 * navigation, which means it will be at the top of the settings navigation block
3535 * @param string $text text to be used for the link.
3536 * @param string|moodle_url $url url for the new node
3537 * @param int $type the type of node navigation_node::TYPE_*
3538 * @param string $shorttext
3539 * @param string|int $key a key to access the node by.
3540 * @param pix_icon $icon An icon that appears next to the node.
3541 * @return navigation_node $node with the new node added to it.
3543 public function prepend($text, $url=null, $type=null, $shorttext=null, $key=null, pix_icon
$icon=null) {
3544 $children = $this->children
;
3545 $childrenclass = get_class($children);
3546 $this->children
= new $childrenclass;
3547 $node = $this->add($text, $url, $type, $shorttext, $key, $icon);
3548 foreach ($children as $child) {
3549 $this->children
->add($child);
3555 * Does this page require loading of full admin tree or is
3556 * it enough rely on AJAX?
3560 protected function is_admin_tree_needed() {
3561 if (self
::$loadadmintree) {
3562 // Usually external admin page or settings page.
3566 if ($this->page
->pagelayout
=== 'admin' or strpos($this->page
->pagetype
, 'admin-') === 0) {
3567 // Admin settings tree is intended for system level settings and management only, use navigation for the rest!
3568 if ($this->page
->context
->contextlevel
!= CONTEXT_SYSTEM
) {
3578 * Load the site administration tree
3580 * This function loads the site administration tree by using the lib/adminlib library functions
3582 * @param navigation_node $referencebranch A reference to a branch in the settings
3584 * @param part_of_admin_tree $adminbranch The branch to add, if null generate the admin
3585 * tree and start at the beginning
3586 * @return mixed A key to access the admin tree by
3588 protected function load_administration_settings(navigation_node
$referencebranch=null, part_of_admin_tree
$adminbranch=null) {
3591 // Check if we are just starting to generate this navigation.
3592 if ($referencebranch === null) {
3594 // Require the admin lib then get an admin structure
3595 if (!function_exists('admin_get_root')) {
3596 require_once($CFG->dirroot
.'/lib/adminlib.php');
3598 $adminroot = admin_get_root(false, false);
3599 // This is the active section identifier
3600 $this->adminsection
= $this->page
->url
->param('section');
3602 // Disable the navigation from automatically finding the active node
3603 navigation_node
::$autofindactive = false;
3604 $referencebranch = $this->add(get_string('administrationsite'), null, self
::TYPE_SITE_ADMIN
, null, 'root');
3605 foreach ($adminroot->children
as $adminbranch) {
3606 $this->load_administration_settings($referencebranch, $adminbranch);
3608 navigation_node
::$autofindactive = true;
3610 // Use the admin structure to locate the active page
3611 if (!$this->contains_active_node() && $current = $adminroot->locate($this->adminsection
, true)) {
3612 $currentnode = $this;
3613 while (($pathkey = array_pop($current->path
))!==null && $currentnode) {
3614 $currentnode = $currentnode->get($pathkey);
3617 $currentnode->make_active();
3620 $this->scan_for_active_node($referencebranch);
3622 return $referencebranch;
3623 } else if ($adminbranch->check_access()) {
3624 // We have a reference branch that we can access and is not hidden `hurrah`
3625 // Now we need to display it and any children it may have
3628 if ($adminbranch instanceof admin_settingpage
) {
3629 $url = new moodle_url('/'.$CFG->admin
.'/settings.php', array('section'=>$adminbranch->name
));
3630 } else if ($adminbranch instanceof admin_externalpage
) {
3631 $url = $adminbranch->url
;
3632 } else if (!empty($CFG->linkadmincategories
) && $adminbranch instanceof admin_category
) {
3633 $url = new moodle_url('/'.$CFG->admin
.'/category.php', array('category' => $adminbranch->name
));
3637 $reference = $referencebranch->add($adminbranch->visiblename
, $url, self
::TYPE_SETTING
, null, $adminbranch->name
, $icon);
3639 if ($adminbranch->is_hidden()) {
3640 if (($adminbranch instanceof admin_externalpage ||
$adminbranch instanceof admin_settingpage
) && $adminbranch->name
== $this->adminsection
) {
3641 $reference->add_class('hidden');
3643 $reference->display
= false;
3647 // Check if we are generating the admin notifications and whether notificiations exist
3648 if ($adminbranch->name
=== 'adminnotifications' && admin_critical_warnings_present()) {
3649 $reference->add_class('criticalnotification');
3651 // Check if this branch has children
3652 if ($reference && isset($adminbranch->children
) && is_array($adminbranch->children
) && count($adminbranch->children
)>0) {
3653 foreach ($adminbranch->children
as $branch) {
3654 // Generate the child branches as well now using this branch as the reference
3655 $this->load_administration_settings($reference, $branch);
3658 $reference->icon
= new pix_icon('i/settings', '');
3664 * This function recursivily scans nodes until it finds the active node or there
3665 * are no more nodes.
3666 * @param navigation_node $node
3668 protected function scan_for_active_node(navigation_node
$node) {
3669 if (!$node->check_if_active() && $node->children
->count()>0) {
3670 foreach ($node->children
as &$child) {
3671 $this->scan_for_active_node($child);
3677 * Gets a navigation node given an array of keys that represent the path to
3680 * @param array $path
3681 * @return navigation_node|false
3683 protected function get_by_path(array $path) {
3684 $node = $this->get(array_shift($path));
3685 foreach ($path as $key) {
3692 * This function loads the course settings that are available for the user
3694 * @param bool $forceopen If set to true the course node will be forced open
3695 * @return navigation_node|false
3697 protected function load_course_settings($forceopen = false) {
3700 $course = $this->page
->course
;
3701 $coursecontext = context_course
::instance($course->id
);
3703 // note: do not test if enrolled or viewing here because we need the enrol link in Course administration section
3705 $coursenode = $this->add(get_string('courseadministration'), null, self
::TYPE_COURSE
, null, 'courseadmin');
3707 $coursenode->force_open();
3710 if ($this->page
->user_allowed_editing()) {
3711 // Add the turn on/off settings
3713 if ($this->page
->url
->compare(new moodle_url('/course/view.php'), URL_MATCH_BASE
)) {
3714 // We are on the course page, retain the current page params e.g. section.
3715 $baseurl = clone($this->page
->url
);
3716 $baseurl->param('sesskey', sesskey());
3718 // Edit on the main course page.
3719 $baseurl = new moodle_url('/course/view.php', array('id'=>$course->id
, 'return'=>$this->page
->url
->out_as_local_url(false), 'sesskey'=>sesskey()));
3722 $editurl = clone($baseurl);
3723 if ($this->page
->user_is_editing()) {
3724 $editurl->param('edit', 'off');
3725 $editstring = get_string('turneditingoff');
3727 $editurl->param('edit', 'on');
3728 $editstring = get_string('turneditingon');
3730 $coursenode->add($editstring, $editurl, self
::TYPE_SETTING
, null, 'turneditingonoff', new pix_icon('i/edit', ''));
3733 if (has_capability('moodle/course:update', $coursecontext)) {
3734 // Add the course settings link
3735 $url = new moodle_url('/course/edit.php', array('id'=>$course->id
));
3736 $coursenode->add(get_string('editsettings'), $url, self
::TYPE_SETTING
, null, 'editsettings', new pix_icon('i/settings', ''));
3738 // Add the course completion settings link
3739 if ($CFG->enablecompletion
&& $course->enablecompletion
) {
3740 $url = new moodle_url('/course/completion.php', array('id'=>$course->id
));
3741 $coursenode->add(get_string('coursecompletion', 'completion'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/settings', ''));
3746 enrol_add_course_navigation($coursenode, $course);
3749 if (has_capability('moodle/filter:manage', $coursecontext) && count(filter_get_available_in_context($coursecontext))>0) {
3750 $url = new moodle_url('/filter/manage.php', array('contextid'=>$coursecontext->id
));
3751 $coursenode->add(get_string('filters', 'admin'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/filter', ''));
3754 // View course reports.
3755 if (has_capability('moodle/site:viewreports', $coursecontext)) { // Basic capability for listing of reports.
3756 $reportnav = $coursenode->add(get_string('reports'), null, self
::TYPE_CONTAINER
, null, null,
3757 new pix_icon('i/stats', ''));
3758 $coursereports = core_component
::get_plugin_list('coursereport');
3759 foreach ($coursereports as $report => $dir) {
3760 $libfile = $CFG->dirroot
.'/course/report/'.$report.'/lib.php';
3761 if (file_exists($libfile)) {
3762 require_once($libfile);
3763 $reportfunction = $report.'_report_extend_navigation';
3764 if (function_exists($report.'_report_extend_navigation')) {
3765 $reportfunction($reportnav, $course, $coursecontext);
3770 $reports = get_plugin_list_with_function('report', 'extend_navigation_course', 'lib.php');
3771 foreach ($reports as $reportfunction) {
3772 $reportfunction($reportnav, $course, $coursecontext);
3776 // Add view grade report is permitted
3777 $reportavailable = false;
3778 if (has_capability('moodle/grade:viewall', $coursecontext)) {
3779 $reportavailable = true;
3780 } else if (!empty($course->showgrades
)) {
3781 $reports = core_component
::get_plugin_list('gradereport');
3782 if (is_array($reports) && count($reports)>0) { // Get all installed reports
3783 arsort($reports); // user is last, we want to test it first
3784 foreach ($reports as $plugin => $plugindir) {
3785 if (has_capability('gradereport/'.$plugin.':view', $coursecontext)) {
3786 //stop when the first visible plugin is found
3787 $reportavailable = true;
3793 if ($reportavailable) {
3794 $url = new moodle_url('/grade/report/index.php', array('id'=>$course->id
));
3795 $gradenode = $coursenode->add(get_string('grades'), $url, self
::TYPE_SETTING
, null, 'grades', new pix_icon('i/grades', ''));
3798 // Add outcome if permitted
3799 if (!empty($CFG->enableoutcomes
) && has_capability('moodle/course:update', $coursecontext)) {
3800 $url = new moodle_url('/grade/edit/outcome/course.php', array('id'=>$course->id
));
3801 $coursenode->add(get_string('outcomes', 'grades'), $url, self
::TYPE_SETTING
, null, 'outcomes', new pix_icon('i/outcomes', ''));
3804 //Add badges navigation
3805 require_once($CFG->libdir
.'/badgeslib.php');
3806 badges_add_course_navigation($coursenode, $course);
3808 // Backup this course
3809 if (has_capability('moodle/backup:backupcourse', $coursecontext)) {
3810 $url = new moodle_url('/backup/backup.php', array('id'=>$course->id
));
3811 $coursenode->add(get_string('backup'), $url, self
::TYPE_SETTING
, null, 'backup', new pix_icon('i/backup', ''));
3814 // Restore to this course
3815 if (has_capability('moodle/restore:restorecourse', $coursecontext)) {
3816 $url = new moodle_url('/backup/restorefile.php', array('contextid'=>$coursecontext->id
));
3817 $coursenode->add(get_string('restore'), $url, self
::TYPE_SETTING
, null, 'restore', new pix_icon('i/restore', ''));
3820 // Import data from other courses
3821 if (has_capability('moodle/restore:restoretargetimport', $coursecontext)) {
3822 $url = new moodle_url('/backup/import.php', array('id'=>$course->id
));
3823 $coursenode->add(get_string('import'), $url, self
::TYPE_SETTING
, null, 'import', new pix_icon('i/import', ''));
3826 // Publish course on a hub
3827 if (has_capability('moodle/course:publish', $coursecontext)) {
3828 $url = new moodle_url('/course/publish/index.php', array('id'=>$course->id
));
3829 $coursenode->add(get_string('publish'), $url, self
::TYPE_SETTING
, null, 'publish', new pix_icon('i/publish', ''));
3832 // Reset this course
3833 if (has_capability('moodle/course:reset', $coursecontext)) {
3834 $url = new moodle_url('/course/reset.php', array('id'=>$course->id
));
3835 $coursenode->add(get_string('reset'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/return', ''));
3839 require_once($CFG->libdir
. '/questionlib.php');
3840 question_extend_settings_navigation($coursenode, $coursecontext)->trim_if_empty();
3842 if (has_capability('moodle/course:update', $coursecontext)) {
3843 // Repository Instances
3844 if (!$this->cache
->cached('contexthasrepos'.$coursecontext->id
)) {
3845 require_once($CFG->dirroot
. '/repository/lib.php');
3846 $editabletypes = repository
::get_editable_types($coursecontext);
3847 $haseditabletypes = !empty($editabletypes);
3848 unset($editabletypes);
3849 $this->cache
->set('contexthasrepos'.$coursecontext->id
, $haseditabletypes);
3851 $haseditabletypes = $this->cache
->{'contexthasrepos'.$coursecontext->id
};
3853 if ($haseditabletypes) {
3854 $url = new moodle_url('/repository/manage_instances.php', array('contextid' => $coursecontext->id
));
3855 $coursenode->add(get_string('repositories'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/repository', ''));
3860 if ($course->legacyfiles
== 2 and has_capability('moodle/course:managefiles', $coursecontext)) {
3861 // hidden in new courses and courses where legacy files were turned off
3862 $url = new moodle_url('/files/index.php', array('contextid'=>$coursecontext->id
));
3863 $coursenode->add(get_string('courselegacyfiles'), $url, self
::TYPE_SETTING
, null, 'coursefiles', new pix_icon('i/folder', ''));
3869 $assumedrole = $this->in_alternative_role();
3870 if ($assumedrole !== false) {
3871 $roles[0] = get_string('switchrolereturn');
3873 if (has_capability('moodle/role:switchroles', $coursecontext)) {
3874 $availableroles = get_switchable_roles($coursecontext);
3875 if (is_array($availableroles)) {
3876 foreach ($availableroles as $key=>$role) {
3877 if ($assumedrole == (int)$key) {
3880 $roles[$key] = $role;
3884 if (is_array($roles) && count($roles)>0) {
3885 $switchroles = $this->add(get_string('switchroleto'));
3886 if ((count($roles)==1 && array_key_exists(0, $roles))||
$assumedrole!==false) {
3887 $switchroles->force_open();
3889 foreach ($roles as $key => $name) {
3890 $url = new moodle_url('/course/switchrole.php', array('id'=>$course->id
, 'sesskey'=>sesskey(), 'switchrole'=>$key, 'returnurl'=>$this->page
->url
->out_as_local_url(false)));
3891 $switchroles->add($name, $url, self
::TYPE_SETTING
, null, $key, new pix_icon('i/switchrole', ''));
3894 // Return we are done
3899 * This function calls the module function to inject module settings into the
3900 * settings navigation tree.
3902 * This only gets called if there is a corrosponding function in the modules
3905 * For examples mod/forum/lib.php {@link forum_extend_settings_navigation()}
3907 * @return navigation_node|false
3909 protected function load_module_settings() {
3912 if (!$this->page
->cm
&& $this->context
->contextlevel
== CONTEXT_MODULE
&& $this->context
->instanceid
) {
3913 $cm = get_coursemodule_from_id(false, $this->context
->instanceid
, 0, false, MUST_EXIST
);
3914 $this->page
->set_cm($cm, $this->page
->course
);
3917 $file = $CFG->dirroot
.'/mod/'.$this->page
->activityname
.'/lib.php';
3918 if (file_exists($file)) {
3919 require_once($file);
3922 $modulenode = $this->add(get_string('pluginadministration', $this->page
->activityname
), null, self
::TYPE_SETTING
, null, 'modulesettings');
3923 $modulenode->force_open();
3925 // Settings for the module
3926 if (has_capability('moodle/course:manageactivities', $this->page
->cm
->context
)) {
3927 $url = new moodle_url('/course/modedit.php', array('update' => $this->page
->cm
->id
, 'return' => 1));
3928 $modulenode->add(get_string('editsettings'), $url, navigation_node
::TYPE_SETTING
, null, 'modedit');
3930 // Assign local roles
3931 if (count(get_assignable_roles($this->page
->cm
->context
))>0) {
3932 $url = new moodle_url('/'.$CFG->admin
.'/roles/assign.php', array('contextid'=>$this->page
->cm
->context
->id
));
3933 $modulenode->add(get_string('localroles', 'role'), $url, self
::TYPE_SETTING
, null, 'roleassign');
3936 if (has_capability('moodle/role:review', $this->page
->cm
->context
) or count(get_overridable_roles($this->page
->cm
->context
))>0) {
3937 $url = new moodle_url('/'.$CFG->admin
.'/roles/permissions.php', array('contextid'=>$this->page
->cm
->context
->id
));
3938 $modulenode->add(get_string('permissions', 'role'), $url, self
::TYPE_SETTING
, null, 'roleoverride');
3940 // Check role permissions
3941 if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:assign'), $this->page
->cm
->context
)) {
3942 $url = new moodle_url('/'.$CFG->admin
.'/roles/check.php', array('contextid'=>$this->page
->cm
->context
->id
));
3943 $modulenode->add(get_string('checkpermissions', 'role'), $url, self
::TYPE_SETTING
, null, 'rolecheck');
3946 if (has_capability('moodle/filter:manage', $this->page
->cm
->context
) && count(filter_get_available_in_context($this->page
->cm
->context
))>0) {
3947 $url = new moodle_url('/filter/manage.php', array('contextid'=>$this->page
->cm
->context
->id
));
3948 $modulenode->add(get_string('filters', 'admin'), $url, self
::TYPE_SETTING
, null, 'filtermanage');
3951 $reports = get_plugin_list_with_function('report', 'extend_navigation_module', 'lib.php');
3952 foreach ($reports as $reportfunction) {
3953 $reportfunction($modulenode, $this->page
->cm
);
3955 // Add a backup link
3956 $featuresfunc = $this->page
->activityname
.'_supports';
3957 if (function_exists($featuresfunc) && $featuresfunc(FEATURE_BACKUP_MOODLE2
) && has_capability('moodle/backup:backupactivity', $this->page
->cm
->context
)) {
3958 $url = new moodle_url('/backup/backup.php', array('id'=>$this->page
->cm
->course
, 'cm'=>$this->page
->cm
->id
));
3959 $modulenode->add(get_string('backup'), $url, self
::TYPE_SETTING
, null, 'backup');
3962 // Restore this activity
3963 $featuresfunc = $this->page
->activityname
.'_supports';
3964 if (function_exists($featuresfunc) && $featuresfunc(FEATURE_BACKUP_MOODLE2
) && has_capability('moodle/restore:restoreactivity', $this->page
->cm
->context
)) {
3965 $url = new moodle_url('/backup/restorefile.php', array('contextid'=>$this->page
->cm
->context
->id
));
3966 $modulenode->add(get_string('restore'), $url, self
::TYPE_SETTING
, null, 'restore');
3969 // Allow the active advanced grading method plugin to append its settings
3970 $featuresfunc = $this->page
->activityname
.'_supports';
3971 if (function_exists($featuresfunc) && $featuresfunc(FEATURE_ADVANCED_GRADING
) && has_capability('moodle/grade:managegradingforms', $this->page
->cm
->context
)) {
3972 require_once($CFG->dirroot
.'/grade/grading/lib.php');
3973 $gradingman = get_grading_manager($this->page
->cm
->context
, $this->page
->activityname
);
3974 $gradingman->extend_settings_navigation($this, $modulenode);
3977 $function = $this->page
->activityname
.'_extend_settings_navigation';
3978 if (!function_exists($function)) {
3982 $function($this, $modulenode);
3984 // Remove the module node if there are no children
3985 if (empty($modulenode->children
)) {
3986 $modulenode->remove();
3993 * Loads the user settings block of the settings nav
3995 * This function is simply works out the userid and whether we need to load
3996 * just the current users profile settings, or the current user and the user the
3997 * current user is viewing.
3999 * This function has some very ugly code to work out the user, if anyone has
4000 * any bright ideas please feel free to intervene.
4002 * @param int $courseid The course id of the current course
4003 * @return navigation_node|false
4005 protected function load_user_settings($courseid = SITEID
) {
4008 if (isguestuser() ||
!isloggedin()) {
4012 $navusers = $this->page
->navigation
->get_extending_users();
4014 if (count($this->userstoextendfor
) > 0 ||
count($navusers) > 0) {
4016 foreach ($this->userstoextendfor
as $userid) {
4017 if ($userid == $USER->id
) {
4020 $node = $this->generate_user_settings($courseid, $userid, 'userviewingsettings');
4021 if (is_null($usernode)) {
4025 foreach ($navusers as $user) {
4026 if ($user->id
== $USER->id
) {
4029 $node = $this->generate_user_settings($courseid, $user->id
, 'userviewingsettings');
4030 if (is_null($usernode)) {
4034 $this->generate_user_settings($courseid, $USER->id
);
4036 $usernode = $this->generate_user_settings($courseid, $USER->id
);
4042 * Extends the settings navigation for the given user.
4044 * Note: This method gets called automatically if you call
4045 * $PAGE->navigation->extend_for_user($userid)
4047 * @param int $userid
4049 public function extend_for_user($userid) {
4052 if (!in_array($userid, $this->userstoextendfor
)) {
4053 $this->userstoextendfor
[] = $userid;
4054 if ($this->initialised
) {
4055 $this->generate_user_settings($this->page
->course
->id
, $userid, 'userviewingsettings');
4056 $children = array();
4057 foreach ($this->children
as $child) {
4058 $children[] = $child;
4060 array_unshift($children, array_pop($children));
4061 $this->children
= new navigation_node_collection();
4062 foreach ($children as $child) {
4063 $this->children
->add($child);
4070 * This function gets called by {@link settings_navigation::load_user_settings()} and actually works out
4071 * what can be shown/done
4073 * @param int $courseid The current course' id
4074 * @param int $userid The user id to load for
4075 * @param string $gstitle The string to pass to get_string for the branch title
4076 * @return navigation_node|false
4078 protected function generate_user_settings($courseid, $userid, $gstitle='usercurrentsettings') {
4079 global $DB, $CFG, $USER, $SITE;
4081 if ($courseid != $SITE->id
) {
4082 if (!empty($this->page
->course
->id
) && $this->page
->course
->id
== $courseid) {
4083 $course = $this->page
->course
;
4085 $select = context_helper
::get_preload_record_columns_sql('ctx');
4086 $sql = "SELECT c.*, $select
4088 JOIN {context} ctx ON c.id = ctx.instanceid
4089 WHERE c.id = :courseid AND ctx.contextlevel = :contextlevel";
4090 $params = array('courseid' => $courseid, 'contextlevel' => CONTEXT_COURSE
);
4091 $course = $DB->get_record_sql($sql, $params, MUST_EXIST
);
4092 context_helper
::preload_from_record($course);
4098 $coursecontext = context_course
::instance($course->id
); // Course context
4099 $systemcontext = context_system
::instance();
4100 $currentuser = ($USER->id
== $userid);
4104 $usercontext = context_user
::instance($user->id
); // User context
4106 $select = context_helper
::get_preload_record_columns_sql('ctx');
4107 $sql = "SELECT u.*, $select
4109 JOIN {context} ctx ON u.id = ctx.instanceid
4110 WHERE u.id = :userid AND ctx.contextlevel = :contextlevel";
4111 $params = array('userid' => $userid, 'contextlevel' => CONTEXT_USER
);
4112 $user = $DB->get_record_sql($sql, $params, IGNORE_MISSING
);
4116 context_helper
::preload_from_record($user);
4118 // Check that the user can view the profile
4119 $usercontext = context_user
::instance($user->id
); // User context
4120 $canviewuser = has_capability('moodle/user:viewdetails', $usercontext);
4122 if ($course->id
== $SITE->id
) {
4123 if ($CFG->forceloginforprofiles
&& !has_coursecontact_role($user->id
) && !$canviewuser) { // Reduce possibility of "browsing" userbase at site level
4124 // Teachers can browse and be browsed at site level. If not forceloginforprofiles, allow access (bug #4366)
4128 $canviewusercourse = has_capability('moodle/user:viewdetails', $coursecontext);
4129 $userisenrolled = is_enrolled($coursecontext, $user->id
);
4130 if ((!$canviewusercourse && !$canviewuser) ||
!$userisenrolled) {
4133 $canaccessallgroups = has_capability('moodle/site:accessallgroups', $coursecontext);
4134 if (!$canaccessallgroups && groups_get_course_groupmode($course) == SEPARATEGROUPS
) {
4135 // If groups are in use, make sure we can see that group (MDL-45874).
4136 if ($courseid == $this->page
->course
->id
) {
4137 $mygroups = get_fast_modinfo($this->page
->course
)->groups
;
4139 $mygroups = groups_get_user_groups($courseid);
4141 $usergroups = groups_get_user_groups($courseid, $userid);
4142 if (!array_intersect_key($mygroups[0], $usergroups[0])) {
4149 $fullname = fullname($user, has_capability('moodle/site:viewfullnames', $this->page
->context
));
4152 if ($gstitle != 'usercurrentsettings') {
4156 // Add a user setting branch
4157 $usersetting = $this->add(get_string($gstitle, 'moodle', $fullname), null, self
::TYPE_CONTAINER
, null, $key);
4158 $usersetting->id
= 'usersettings';
4159 if ($this->page
->context
->contextlevel
== CONTEXT_USER
&& $this->page
->context
->instanceid
== $user->id
) {
4160 // Automatically start by making it active
4161 $usersetting->make_active();
4164 // Check if the user has been deleted
4165 if ($user->deleted
) {
4166 if (!has_capability('moodle/user:update', $coursecontext)) {
4167 // We can't edit the user so just show the user deleted message
4168 $usersetting->add(get_string('userdeleted'), null, self
::TYPE_SETTING
);
4170 // We can edit the user so show the user deleted message and link it to the profile
4171 if ($course->id
== $SITE->id
) {
4172 $profileurl = new moodle_url('/user/profile.php', array('id'=>$user->id
));
4174 $profileurl = new moodle_url('/user/view.php', array('id'=>$user->id
, 'course'=>$course->id
));
4176 $usersetting->add(get_string('userdeleted'), $profileurl, self
::TYPE_SETTING
);
4181 $userauthplugin = false;
4182 if (!empty($user->auth
)) {
4183 $userauthplugin = get_auth_plugin($user->auth
);
4186 // Add the profile edit link
4187 if (isloggedin() && !isguestuser($user) && !is_mnet_remote_user($user)) {
4188 if (($currentuser ||
is_siteadmin($USER) ||
!is_siteadmin($user)) && has_capability('moodle/user:update', $systemcontext)) {
4189 $url = new moodle_url('/user/editadvanced.php', array('id'=>$user->id
, 'course'=>$course->id
));
4190 $usersetting->add(get_string('editmyprofile'), $url, self
::TYPE_SETTING
);
4191 } else if ((has_capability('moodle/user:editprofile', $usercontext) && !is_siteadmin($user)) ||
($currentuser && has_capability('moodle/user:editownprofile', $systemcontext))) {
4192 if ($userauthplugin && $userauthplugin->can_edit_profile()) {
4193 $url = $userauthplugin->edit_profile_url();
4195 $url = new moodle_url('/user/edit.php', array('id'=>$user->id
, 'course'=>$course->id
));
4197 $usersetting->add(get_string('editmyprofile'), $url, self
::TYPE_SETTING
);
4202 // Change password link
4203 if ($userauthplugin && $currentuser && !\core\session\manager
::is_loggedinas() && !isguestuser() && has_capability('moodle/user:changeownpassword', $systemcontext) && $userauthplugin->can_change_password()) {
4204 $passwordchangeurl = $userauthplugin->change_password_url();
4205 if (empty($passwordchangeurl)) {
4206 $passwordchangeurl = new moodle_url('/login/change_password.php', array('id'=>$course->id
));
4208 $usersetting->add(get_string("changepassword"), $passwordchangeurl, self
::TYPE_SETTING
);
4211 // View the roles settings
4212 if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:manage'), $usercontext)) {
4213 $roles = $usersetting->add(get_string('roles'), null, self
::TYPE_SETTING
);
4215 $url = new moodle_url('/admin/roles/usersroles.php', array('userid'=>$user->id
, 'courseid'=>$course->id
));
4216 $roles->add(get_string('thisusersroles', 'role'), $url, self
::TYPE_SETTING
);
4218 $assignableroles = get_assignable_roles($usercontext, ROLENAME_BOTH
);
4220 if (!empty($assignableroles)) {
4221 $url = new moodle_url('/admin/roles/assign.php', array('contextid'=>$usercontext->id
,'userid'=>$user->id
, 'courseid'=>$course->id
));
4222 $roles->add(get_string('assignrolesrelativetothisuser', 'role'), $url, self
::TYPE_SETTING
);
4225 if (has_capability('moodle/role:review', $usercontext) ||
count(get_overridable_roles($usercontext, ROLENAME_BOTH
))>0) {
4226 $url = new moodle_url('/admin/roles/permissions.php', array('contextid'=>$usercontext->id
,'userid'=>$user->id
, 'courseid'=>$course->id
));
4227 $roles->add(get_string('permissions', 'role'), $url, self
::TYPE_SETTING
);
4230 $url = new moodle_url('/admin/roles/check.php', array('contextid'=>$usercontext->id
,'userid'=>$user->id
, 'courseid'=>$course->id
));
4231 $roles->add(get_string('checkpermissions', 'role'), $url, self
::TYPE_SETTING
);
4235 if ($currentuser && !empty($CFG->enableportfolios
) && has_capability('moodle/portfolio:export', $systemcontext)) {
4236 require_once($CFG->libdir
. '/portfoliolib.php');
4237 if (portfolio_has_visible_instances()) {
4238 $portfolio = $usersetting->add(get_string('portfolios', 'portfolio'), null, self
::TYPE_SETTING
);
4240 $url = new moodle_url('/user/portfolio.php', array('courseid'=>$course->id
));
4241 $portfolio->add(get_string('configure', 'portfolio'), $url, self
::TYPE_SETTING
);
4243 $url = new moodle_url('/user/portfoliologs.php', array('courseid'=>$course->id
));
4244 $portfolio->add(get_string('logs', 'portfolio'), $url, self
::TYPE_SETTING
);
4248 $enablemanagetokens = false;
4249 if (!empty($CFG->enablerssfeeds
)) {
4250 $enablemanagetokens = true;
4251 } else if (!is_siteadmin($USER->id
)
4252 && !empty($CFG->enablewebservices
)
4253 && has_capability('moodle/webservice:createtoken', context_system
::instance()) ) {
4254 $enablemanagetokens = true;
4257 if ($currentuser && $enablemanagetokens) {
4258 $url = new moodle_url('/user/managetoken.php', array('sesskey'=>sesskey()));
4259 $usersetting->add(get_string('securitykeys', 'webservice'), $url, self
::TYPE_SETTING
);
4263 if (($currentuser && has_capability('moodle/user:editownmessageprofile', $systemcontext)) ||
(!isguestuser($user) && has_capability('moodle/user:editmessageprofile', $usercontext) && !is_primary_admin($user->id
))) {
4264 $url = new moodle_url('/message/edit.php', array('id'=>$user->id
));
4265 $usersetting->add(get_string('messaging', 'message'), $url, self
::TYPE_SETTING
);
4269 if ($currentuser && !empty($CFG->enableblogs
)) {
4270 $blog = $usersetting->add(get_string('blogs', 'blog'), null, navigation_node
::TYPE_CONTAINER
, null, 'blogs');
4271 $blog->add(get_string('preferences', 'blog'), new moodle_url('/blog/preferences.php'), navigation_node
::TYPE_SETTING
);
4272 if (!empty($CFG->useexternalblogs
) && $CFG->maxexternalblogsperuser
> 0 && has_capability('moodle/blog:manageexternal', context_system
::instance())) {
4273 $blog->add(get_string('externalblogs', 'blog'), new moodle_url('/blog/external_blogs.php'), navigation_node
::TYPE_SETTING
);
4274 $blog->add(get_string('addnewexternalblog', 'blog'), new moodle_url('/blog/external_blog_edit.php'), navigation_node
::TYPE_SETTING
);
4279 if ($currentuser && !empty($CFG->enablebadges
)) {
4280 $badges = $usersetting->add(get_string('badges'), null, navigation_node
::TYPE_CONTAINER
, null, 'badges');
4281 $badges->add(get_string('preferences'), new moodle_url('/badges/preferences.php'), navigation_node
::TYPE_SETTING
);
4282 if (!empty($CFG->badges_allowexternalbackpack
)) {
4283 $badges->add(get_string('backpackdetails', 'badges'), new moodle_url('/badges/mybackpack.php'), navigation_node
::TYPE_SETTING
);
4287 // Add reports node.
4288 $reporttab = $usersetting->add(get_string('activityreports'));
4289 $reports = get_plugin_list_with_function('report', 'extend_navigation_user', 'lib.php');
4290 foreach ($reports as $reportfunction) {
4291 $reportfunction($reporttab, $user, $course);
4293 $anyreport = has_capability('moodle/user:viewuseractivitiesreport', $usercontext);
4294 if ($anyreport ||
($course->showreports
&& $currentuser)) {
4295 // Add grade hardcoded grade report if necessary.
4296 $gradeaccess = false;
4297 if (has_capability('moodle/grade:viewall', $coursecontext)) {
4298 // Can view all course grades.
4299 $gradeaccess = true;
4300 } else if ($course->showgrades
) {
4301 if ($currentuser && has_capability('moodle/grade:view', $coursecontext)) {
4302 // Can view own grades.
4303 $gradeaccess = true;
4304 } else if (has_capability('moodle/grade:viewall', $usercontext)) {
4305 // Can view grades of this user - parent most probably.
4306 $gradeaccess = true;
4307 } else if ($anyreport) {
4308 // Can view grades of this user - parent most probably.
4309 $gradeaccess = true;
4313 $reporttab->add(get_string('grade'), new moodle_url('/course/user.php', array('mode'=>'grade', 'id'=>$course->id
,
4314 'user'=>$usercontext->instanceid
)));
4317 // Check the number of nodes in the report node... if there are none remove the node
4318 $reporttab->trim_if_empty();
4321 if (!$user->deleted
and !$currentuser && !\core\session\manager
::is_loggedinas() && has_capability('moodle/user:loginas', $coursecontext) && !is_siteadmin($user->id
)) {
4322 $url = new moodle_url('/course/loginas.php', array('id'=>$course->id
, 'user'=>$user->id
, 'sesskey'=>sesskey()));
4323 $usersetting->add(get_string('loginas'), $url, self
::TYPE_SETTING
);
4326 return $usersetting;
4330 * Loads block specific settings in the navigation
4332 * @return navigation_node
4334 protected function load_block_settings() {
4337 $blocknode = $this->add($this->context
->get_context_name(), null, self
::TYPE_SETTING
, null, 'blocksettings');
4338 $blocknode->force_open();
4340 // Assign local roles
4341 $assignurl = new moodle_url('/'.$CFG->admin
.'/roles/assign.php', array('contextid'=>$this->context
->id
));
4342 $blocknode->add(get_string('assignroles', 'role'), $assignurl, self
::TYPE_SETTING
);
4345 if (has_capability('moodle/role:review', $this->context
) or count(get_overridable_roles($this->context
))>0) {
4346 $url = new moodle_url('/'.$CFG->admin
.'/roles/permissions.php', array('contextid'=>$this->context
->id
));
4347 $blocknode->add(get_string('permissions', 'role'), $url, self
::TYPE_SETTING
);
4349 // Check role permissions
4350 if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:assign'), $this->context
)) {
4351 $url = new moodle_url('/'.$CFG->admin
.'/roles/check.php', array('contextid'=>$this->context
->id
));
4352 $blocknode->add(get_string('checkpermissions', 'role'), $url, self
::TYPE_SETTING
);
4359 * Loads category specific settings in the navigation
4361 * @return navigation_node
4363 protected function load_category_settings() {
4366 $categorynode = $this->add($this->context
->get_context_name(), null, null, null, 'categorysettings');
4367 $categorynode->force_open();
4369 if (can_edit_in_category($this->context
->instanceid
)) {
4370 $url = new moodle_url('/course/management.php', array('categoryid' => $this->context
->instanceid
));
4371 $editstring = get_string('managecategorythis');
4372 $categorynode->add($editstring, $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/edit', ''));
4375 if (has_capability('moodle/category:manage', $this->context
)) {
4376 $editurl = new moodle_url('/course/editcategory.php', array('id' => $this->context
->instanceid
));
4377 $categorynode->add(get_string('editcategorythis'), $editurl, self
::TYPE_SETTING
, null, 'edit', new pix_icon('i/edit', ''));
4379 $addsubcaturl = new moodle_url('/course/editcategory.php', array('parent' => $this->context
->instanceid
));
4380 $categorynode->add(get_string('addsubcategory'), $addsubcaturl, self
::TYPE_SETTING
, null, 'addsubcat', new pix_icon('i/withsubcat', ''));
4383 // Assign local roles
4384 if (has_capability('moodle/role:assign', $this->context
)) {
4385 $assignurl = new moodle_url('/'.$CFG->admin
.'/roles/assign.php', array('contextid'=>$this->context
->id
));
4386 $categorynode->add(get_string('assignroles', 'role'), $assignurl, self
::TYPE_SETTING
, null, 'roles', new pix_icon('i/assignroles', ''));
4390 if (has_capability('moodle/role:review', $this->context
) or count(get_overridable_roles($this->context
))>0) {
4391 $url = new moodle_url('/'.$CFG->admin
.'/roles/permissions.php', array('contextid'=>$this->context
->id
));
4392 $categorynode->add(get_string('permissions', 'role'), $url, self
::TYPE_SETTING
, null, 'permissions', new pix_icon('i/permissions', ''));
4394 // Check role permissions
4395 if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:assign'), $this->context
)) {
4396 $url = new moodle_url('/'.$CFG->admin
.'/roles/check.php', array('contextid'=>$this->context
->id
));
4397 $categorynode->add(get_string('checkpermissions', 'role'), $url, self
::TYPE_SETTING
, null, 'checkpermissions', new pix_icon('i/checkpermissions', ''));
4401 if (has_any_capability(array('moodle/cohort:view', 'moodle/cohort:manage'), $this->context
)) {
4402 $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', ''));
4406 if (has_capability('moodle/filter:manage', $this->context
) && count(filter_get_available_in_context($this->context
))>0) {
4407 $url = new moodle_url('/filter/manage.php', array('contextid'=>$this->context
->id
));
4408 $categorynode->add(get_string('filters', 'admin'), $url, self
::TYPE_SETTING
, null, 'filters', new pix_icon('i/filter', ''));
4412 if (has_capability('moodle/course:create', $this->context
)) {
4413 $url = new moodle_url('/backup/restorefile.php', array('contextid' => $this->context
->id
));
4414 $categorynode->add(get_string('restorecourse', 'admin'), $url, self
::TYPE_SETTING
, null, 'restorecourse', new pix_icon('i/restore', ''));
4417 return $categorynode;
4421 * Determine whether the user is assuming another role
4423 * This function checks to see if the user is assuming another role by means of
4424 * role switching. In doing this we compare each RSW key (context path) against
4425 * the current context path. This ensures that we can provide the switching
4426 * options against both the course and any page shown under the course.
4428 * @return bool|int The role(int) if the user is in another role, false otherwise
4430 protected function in_alternative_role() {
4432 if (!empty($USER->access
['rsw']) && is_array($USER->access
['rsw'])) {
4433 if (!empty($this->page
->context
) && !empty($USER->access
['rsw'][$this->page
->context
->path
])) {
4434 return $USER->access
['rsw'][$this->page
->context
->path
];
4436 foreach ($USER->access
['rsw'] as $key=>$role) {
4437 if (strpos($this->context
->path
,$key)===0) {
4446 * This function loads all of the front page settings into the settings navigation.
4447 * This function is called when the user is on the front page, or $COURSE==$SITE
4448 * @param bool $forceopen (optional)
4449 * @return navigation_node
4451 protected function load_front_page_settings($forceopen = false) {
4454 $course = clone($SITE);
4455 $coursecontext = context_course
::instance($course->id
); // Course context
4457 $frontpage = $this->add(get_string('frontpagesettings'), null, self
::TYPE_SETTING
, null, 'frontpage');
4459 $frontpage->force_open();
4461 $frontpage->id
= 'frontpagesettings';
4463 if ($this->page
->user_allowed_editing()) {
4465 // Add the turn on/off settings
4466 $url = new moodle_url('/course/view.php', array('id'=>$course->id
, 'sesskey'=>sesskey()));
4467 if ($this->page
->user_is_editing()) {
4468 $url->param('edit', 'off');
4469 $editstring = get_string('turneditingoff');
4471 $url->param('edit', 'on');
4472 $editstring = get_string('turneditingon');
4474 $frontpage->add($editstring, $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/edit', ''));
4477 if (has_capability('moodle/course:update', $coursecontext)) {
4478 // Add the course settings link
4479 $url = new moodle_url('/admin/settings.php', array('section'=>'frontpagesettings'));
4480 $frontpage->add(get_string('editsettings'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/settings', ''));
4484 enrol_add_course_navigation($frontpage, $course);
4487 if (has_capability('moodle/filter:manage', $coursecontext) && count(filter_get_available_in_context($coursecontext))>0) {
4488 $url = new moodle_url('/filter/manage.php', array('contextid'=>$coursecontext->id
));
4489 $frontpage->add(get_string('filters', 'admin'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/filter', ''));
4492 // View course reports.
4493 if (has_capability('moodle/site:viewreports', $coursecontext)) { // Basic capability for listing of reports.
4494 $frontpagenav = $frontpage->add(get_string('reports'), null, self
::TYPE_CONTAINER
, null, null,
4495 new pix_icon('i/stats', ''));
4496 $coursereports = core_component
::get_plugin_list('coursereport');
4497 foreach ($coursereports as $report=>$dir) {
4498 $libfile = $CFG->dirroot
.'/course/report/'.$report.'/lib.php';
4499 if (file_exists($libfile)) {
4500 require_once($libfile);
4501 $reportfunction = $report.'_report_extend_navigation';
4502 if (function_exists($report.'_report_extend_navigation')) {
4503 $reportfunction($frontpagenav, $course, $coursecontext);
4508 $reports = get_plugin_list_with_function('report', 'extend_navigation_course', 'lib.php');
4509 foreach ($reports as $reportfunction) {
4510 $reportfunction($frontpagenav, $course, $coursecontext);
4514 // Backup this course
4515 if (has_capability('moodle/backup:backupcourse', $coursecontext)) {
4516 $url = new moodle_url('/backup/backup.php', array('id'=>$course->id
));
4517 $frontpage->add(get_string('backup'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/backup', ''));
4520 // Restore to this course
4521 if (has_capability('moodle/restore:restorecourse', $coursecontext)) {
4522 $url = new moodle_url('/backup/restorefile.php', array('contextid'=>$coursecontext->id
));
4523 $frontpage->add(get_string('restore'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/restore', ''));
4527 require_once($CFG->libdir
. '/questionlib.php');
4528 question_extend_settings_navigation($frontpage, $coursecontext)->trim_if_empty();
4531 if ($course->legacyfiles
== 2 and has_capability('moodle/course:managefiles', $this->context
)) {
4532 //hiden in new installs
4533 $url = new moodle_url('/files/index.php', array('contextid'=>$coursecontext->id
));
4534 $frontpage->add(get_string('sitelegacyfiles'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/folder', ''));
4540 * This function gives local plugins an opportunity to modify the settings navigation.
4542 protected function load_local_plugin_settings() {
4543 // Get all local plugins with an extend_settings_navigation function in their lib.php file
4544 foreach (get_plugin_list_with_function('local', 'extends_settings_navigation') as $function) {
4545 // Call each function providing this (the settings navigation) and the current context.
4546 $function($this, $this->context
);
4551 * This function marks the cache as volatile so it is cleared during shutdown
4553 public function clear_cache() {
4554 $this->cache
->volatile();
4559 * Class used to populate site admin navigation for ajax.
4562 * @category navigation
4563 * @copyright 2013 Rajesh Taneja <rajesh@moodle.com>
4564 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4566 class settings_navigation_ajax
extends settings_navigation
{
4568 * Constructs the navigation for use in an AJAX request
4570 * @param moodle_page $page
4572 public function __construct(moodle_page
&$page) {
4573 $this->page
= $page;
4574 $this->cache
= new navigation_cache(NAVIGATION_CACHE_NAME
);
4575 $this->children
= new navigation_node_collection();
4576 $this->initialise();
4580 * Initialise the site admin navigation.
4582 * @return array An array of the expandable nodes
4584 public function initialise() {
4585 if ($this->initialised ||
during_initial_install()) {
4588 $this->context
= $this->page
->context
;
4589 $this->load_administration_settings();
4591 // Check if local plugins is adding node to site admin.
4592 $this->load_local_plugin_settings();
4594 $this->initialised
= true;
4599 * Simple class used to output a navigation branch in XML
4602 * @category navigation
4603 * @copyright 2009 Sam Hemelryk
4604 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4606 class navigation_json
{
4607 /** @var array An array of different node types */
4608 protected $nodetype = array('node','branch');
4609 /** @var array An array of node keys and types */
4610 protected $expandable = array();
4612 * Turns a branch and all of its children into XML
4614 * @param navigation_node $branch
4615 * @return string XML string
4617 public function convert($branch) {
4618 $xml = $this->convert_child($branch);
4622 * Set the expandable items in the array so that we have enough information
4623 * to attach AJAX events
4624 * @param array $expandable
4626 public function set_expandable($expandable) {
4627 foreach ($expandable as $node) {
4628 $this->expandable
[$node['key'].':'.$node['type']] = $node;
4632 * Recusively converts a child node and its children to XML for output
4634 * @param navigation_node $child The child to convert
4635 * @param int $depth Pointlessly used to track the depth of the XML structure
4636 * @return string JSON
4638 protected function convert_child($child, $depth=1) {
4639 if (!$child->display
) {
4642 $attributes = array();
4643 $attributes['id'] = $child->id
;
4644 $attributes['name'] = (string)$child->text
; // This can be lang_string object so typecast it.
4645 $attributes['type'] = $child->type
;
4646 $attributes['key'] = $child->key
;
4647 $attributes['class'] = $child->get_css_type();
4649 if ($child->icon
instanceof pix_icon
) {
4650 $attributes['icon'] = array(
4651 'component' => $child->icon
->component
,
4652 'pix' => $child->icon
->pix
,
4654 foreach ($child->icon
->attributes
as $key=>$value) {
4655 if ($key == 'class') {
4656 $attributes['icon']['classes'] = explode(' ', $value);
4657 } else if (!array_key_exists($key, $attributes['icon'])) {
4658 $attributes['icon'][$key] = $value;
4662 } else if (!empty($child->icon
)) {
4663 $attributes['icon'] = (string)$child->icon
;
4666 if ($child->forcetitle ||
$child->title
!== $child->text
) {
4667 $attributes['title'] = htmlentities($child->title
, ENT_QUOTES
, 'UTF-8');
4669 if (array_key_exists($child->key
.':'.$child->type
, $this->expandable
)) {
4670 $attributes['expandable'] = $child->key
;
4671 $child->add_class($this->expandable
[$child->key
.':'.$child->type
]['id']);
4674 if (count($child->classes
)>0) {
4675 $attributes['class'] .= ' '.join(' ',$child->classes
);
4677 if (is_string($child->action
)) {
4678 $attributes['link'] = $child->action
;
4679 } else if ($child->action
instanceof moodle_url
) {
4680 $attributes['link'] = $child->action
->out();
4681 } else if ($child->action
instanceof action_link
) {
4682 $attributes['link'] = $child->action
->url
->out();
4684 $attributes['hidden'] = ($child->hidden
);
4685 $attributes['haschildren'] = ($child->children
->count()>0 ||
$child->type
== navigation_node
::TYPE_CATEGORY
);
4686 $attributes['haschildren'] = $attributes['haschildren'] ||
$child->type
== navigation_node
::TYPE_MY_CATEGORY
;
4688 if ($child->children
->count() > 0) {
4689 $attributes['children'] = array();
4690 foreach ($child->children
as $subchild) {
4691 $attributes['children'][] = $this->convert_child($subchild, $depth+
1);
4698 return json_encode($attributes);
4704 * The cache class used by global navigation and settings navigation.
4706 * It is basically an easy access point to session with a bit of smarts to make
4707 * sure that the information that is cached is valid still.
4711 * if (!$cache->viewdiscussion()) {
4712 * // Code to do stuff and produce cachable content
4713 * $cache->viewdiscussion = has_capability('mod/forum:viewdiscussion', $coursecontext);
4715 * $content = $cache->viewdiscussion;
4719 * @category navigation
4720 * @copyright 2009 Sam Hemelryk
4721 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4723 class navigation_cache
{
4724 /** @var int represents the time created */
4725 protected $creation;
4726 /** @var array An array of session keys */
4729 * The string to use to segregate this particular cache. It can either be
4730 * unique to start a fresh cache or if you want to share a cache then make
4731 * it the string used in the original cache.
4735 /** @var int a time that the information will time out */
4737 /** @var stdClass The current context */
4738 protected $currentcontext;
4739 /** @var int cache time information */
4740 const CACHETIME
= 0;
4741 /** @var int cache user id */
4742 const CACHEUSERID
= 1;
4743 /** @var int cache value */
4744 const CACHEVALUE
= 2;
4745 /** @var null|array An array of navigation cache areas to expire on shutdown */
4746 public static $volatilecaches;
4749 * Contructor for the cache. Requires two arguments
4751 * @param string $area The string to use to segregate this particular cache
4752 * it can either be unique to start a fresh cache or if you want
4753 * to share a cache then make it the string used in the original
4755 * @param int $timeout The number of seconds to time the information out after
4757 public function __construct($area, $timeout=1800) {
4758 $this->creation
= time();
4759 $this->area
= $area;
4760 $this->timeout
= time() - $timeout;
4761 if (rand(0,100) === 0) {
4762 $this->garbage_collection();
4767 * Used to set up the cache within the SESSION.
4769 * This is called for each access and ensure that we don't put anything into the session before
4772 protected function ensure_session_cache_initialised() {
4774 if (empty($this->session
)) {
4775 if (!isset($SESSION->navcache
)) {
4776 $SESSION->navcache
= new stdClass
;
4778 if (!isset($SESSION->navcache
->{$this->area
})) {
4779 $SESSION->navcache
->{$this->area
} = array();
4781 $this->session
= &$SESSION->navcache
->{$this->area
}; // pointer to array, =& is correct here
4786 * Magic Method to retrieve something by simply calling using = cache->key
4788 * @param mixed $key The identifier for the information you want out again
4789 * @return void|mixed Either void or what ever was put in
4791 public function __get($key) {
4792 if (!$this->cached($key)) {
4795 $information = $this->session
[$key][self
::CACHEVALUE
];
4796 return unserialize($information);
4800 * Magic method that simply uses {@link set();} to store something in the cache
4802 * @param string|int $key
4803 * @param mixed $information
4805 public function __set($key, $information) {
4806 $this->set($key, $information);
4810 * Sets some information against the cache (session) for later retrieval
4812 * @param string|int $key
4813 * @param mixed $information
4815 public function set($key, $information) {
4817 $this->ensure_session_cache_initialised();
4818 $information = serialize($information);
4819 $this->session
[$key]= array(self
::CACHETIME
=>time(), self
::CACHEUSERID
=>$USER->id
, self
::CACHEVALUE
=>$information);
4822 * Check the existence of the identifier in the cache
4824 * @param string|int $key
4827 public function cached($key) {
4829 $this->ensure_session_cache_initialised();
4830 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
) {
4836 * Compare something to it's equivilant in the cache
4838 * @param string $key
4839 * @param mixed $value
4840 * @param bool $serialise Whether to serialise the value before comparison
4841 * this should only be set to false if the value is already
4843 * @return bool If the value is the same false if it is not set or doesn't match
4845 public function compare($key, $value, $serialise = true) {
4846 if ($this->cached($key)) {
4848 $value = serialize($value);
4850 if ($this->session
[$key][self
::CACHEVALUE
] === $value) {
4857 * Wipes the entire cache, good to force regeneration
4859 public function clear() {
4861 unset($SESSION->navcache
);
4862 $this->session
= null;
4865 * Checks all cache entries and removes any that have expired, good ole cleanup
4867 protected function garbage_collection() {
4868 if (empty($this->session
)) {
4871 foreach ($this->session
as $key=>$cachedinfo) {
4872 if (is_array($cachedinfo) && $cachedinfo[self
::CACHETIME
]<$this->timeout
) {
4873 unset($this->session
[$key]);
4879 * Marks the cache as being volatile (likely to change)
4881 * Any caches marked as volatile will be destroyed at the on shutdown by
4882 * {@link navigation_node::destroy_volatile_caches()} which is registered
4883 * as a shutdown function if any caches are marked as volatile.
4885 * @param bool $setting True to destroy the cache false not too
4887 public function volatile($setting = true) {
4888 if (self
::$volatilecaches===null) {
4889 self
::$volatilecaches = array();
4890 core_shutdown_manager
::register_function(array('navigation_cache','destroy_volatile_caches'));
4894 self
::$volatilecaches[$this->area
] = $this->area
;
4895 } else if (array_key_exists($this->area
, self
::$volatilecaches)) {
4896 unset(self
::$volatilecaches[$this->area
]);
4901 * Destroys all caches marked as volatile
4903 * This function is static and works in conjunction with the static volatilecaches
4904 * property of navigation cache.
4905 * Because this function is static it manually resets the cached areas back to an
4908 public static function destroy_volatile_caches() {
4910 if (is_array(self
::$volatilecaches) && count(self
::$volatilecaches)>0) {
4911 foreach (self
::$volatilecaches as $area) {
4912 $SESSION->navcache
->{$area} = array();
4915 $SESSION->navcache
= new stdClass
;