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 + their 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 && (is_null($type) ||
$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('profile'), 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'), null, 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->page
->pagelayout
=== 'mydashboard'){
1139 $this->rootnodes
['mycourses']->forceopen
= true;
1140 $this->load_courses_enrolled();
1142 $this->rootnodes
['mycourses']->collapse
= true;
1143 $this->rootnodes
['mycourses']->make_inactive();
1146 $canviewcourseprofile = true;
1148 // Next load context specific content into the navigation
1149 switch ($this->page
->context
->contextlevel
) {
1150 case CONTEXT_SYSTEM
:
1151 // Nothing left to do here I feel.
1153 case CONTEXT_COURSECAT
:
1154 // This is essential, we must load categories.
1155 $this->load_all_categories($this->page
->context
->instanceid
, true);
1157 case CONTEXT_BLOCK
:
1158 case CONTEXT_COURSE
:
1160 // Nothing left to do here.
1164 // Load the course associated with the current page into the navigation.
1165 $coursenode = $this->add_course($course, false, self
::COURSE_CURRENT
);
1166 // If the course wasn't added then don't try going any further.
1168 $canviewcourseprofile = false;
1172 // If the user is not enrolled then we only want to show the
1173 // course node and not populate it.
1175 // Not enrolled, can't view, and hasn't switched roles
1176 if (!can_access_course($course, null, '', true)) {
1177 if ($coursenode->isexpandable
=== true) {
1178 // Obviously the situation has changed, update the cache and adjust the node.
1179 // This occurs if the user access to a course has been revoked (one way or another) after
1180 // initially logging in for this session.
1181 $this->get_expand_course_cache()->set($course->id
, 1);
1182 $coursenode->isexpandable
= true;
1183 $coursenode->nodetype
= self
::NODETYPE_BRANCH
;
1185 // Very ugly hack - do not force "parents" to enrol into course their child is enrolled in,
1186 // this hack has been propagated from user/view.php to display the navigation node. (MDL-25805)
1187 if (!$this->current_user_is_parent_role()) {
1188 $coursenode->make_active();
1189 $canviewcourseprofile = false;
1192 } else if ($coursenode->isexpandable
=== false) {
1193 // Obviously the situation has changed, update the cache and adjust the node.
1194 // This occurs if the user has been granted access to a course (one way or another) after initially
1195 // logging in for this session.
1196 $this->get_expand_course_cache()->set($course->id
, 1);
1197 $coursenode->isexpandable
= true;
1198 $coursenode->nodetype
= self
::NODETYPE_BRANCH
;
1201 // Add the essentials such as reports etc...
1202 $this->add_course_essentials($coursenode, $course);
1203 // Extend course navigation with it's sections/activities
1204 $this->load_course_sections($course, $coursenode);
1205 if (!$coursenode->contains_active_node() && !$coursenode->search_for_active_node()) {
1206 $coursenode->make_active();
1210 case CONTEXT_MODULE
:
1212 // If this is the site course then most information will have
1213 // already been loaded.
1214 // However we need to check if there is more content that can
1215 // yet be loaded for the specific module instance.
1216 $activitynode = $this->rootnodes
['site']->find($this->page
->cm
->id
, navigation_node
::TYPE_ACTIVITY
);
1217 if ($activitynode) {
1218 $this->load_activity($this->page
->cm
, $this->page
->course
, $activitynode);
1223 $course = $this->page
->course
;
1224 $cm = $this->page
->cm
;
1226 // Load the course associated with the page into the navigation
1227 $coursenode = $this->add_course($course, false, self
::COURSE_CURRENT
);
1229 // If the course wasn't added then don't try going any further.
1231 $canviewcourseprofile = false;
1235 // If the user is not enrolled then we only want to show the
1236 // course node and not populate it.
1237 if (!can_access_course($course, null, '', true)) {
1238 $coursenode->make_active();
1239 $canviewcourseprofile = false;
1243 $this->add_course_essentials($coursenode, $course);
1245 // Load the course sections into the page
1246 $this->load_course_sections($course, $coursenode, null, $cm);
1247 $activity = $coursenode->find($cm->id
, navigation_node
::TYPE_ACTIVITY
);
1248 if (!empty($activity)) {
1249 // Finally load the cm specific navigaton information
1250 $this->load_activity($cm, $course, $activity);
1251 // Check if we have an active ndoe
1252 if (!$activity->contains_active_node() && !$activity->search_for_active_node()) {
1253 // And make the activity node active.
1254 $activity->make_active();
1260 // The users profile information etc is already loaded
1261 // for the front page.
1264 $course = $this->page
->course
;
1265 // Load the course associated with the user into the navigation
1266 $coursenode = $this->add_course($course, false, self
::COURSE_CURRENT
);
1268 // If the course wasn't added then don't try going any further.
1270 $canviewcourseprofile = false;
1274 // If the user is not enrolled then we only want to show the
1275 // course node and not populate it.
1276 if (!can_access_course($course, null, '', true)) {
1277 $coursenode->make_active();
1278 $canviewcourseprofile = false;
1281 $this->add_course_essentials($coursenode, $course);
1282 $this->load_course_sections($course, $coursenode);
1286 // Load for the current user
1287 $this->load_for_user();
1288 if ($this->page
->context
->contextlevel
>= CONTEXT_COURSE
&& $this->page
->context
->instanceid
!= $SITE->id
&& $canviewcourseprofile) {
1289 $this->load_for_user(null, true);
1291 // Load each extending user into the navigation.
1292 foreach ($this->extendforuser
as $user) {
1293 if ($user->id
!= $USER->id
) {
1294 $this->load_for_user($user);
1298 // Give the local plugins a chance to include some navigation if they want.
1299 foreach (core_component
::get_plugin_list_with_file('local', 'lib.php', true) as $plugin => $unused) {
1300 $function = "local_{$plugin}_extend_navigation";
1301 $oldfunction = "local_{$plugin}_extends_navigation";
1303 if (function_exists($function)) {
1306 } else if (function_exists($oldfunction)) {
1307 debugging("Deprecated local plugin navigation callback: Please rename '{$oldfunction}' to '{$function}'. ".
1308 "Support for the old callback will be dropped in Moodle 3.1", 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 $addedcategories = $this->addedcategories
;
1643 unset($addedcategories[$categoryid]);
1644 if (count($addedcategories) > 0) {
1645 list($sql, $params) = $DB->get_in_or_equal(array_keys($addedcategories), SQL_PARAMS_NAMED
, 'parent', false);
1646 if ($showbasecategories) {
1647 // We need to include categories with parent = 0 as well
1648 $sqlwhere .= " AND (cc.parent = :categoryid OR cc.parent = 0) AND cc.parent {$sql}";
1650 // All we need is categories that match the parent
1651 $sqlwhere .= " AND cc.parent = :categoryid AND cc.parent {$sql}";
1654 $params['categoryid'] = $categoryid;
1656 // This category hasn't been loaded yet so we need to fetch it, work out its category path
1657 // and load this category plus all its parents and subcategories
1658 $category = $DB->get_record('course_categories', array('id' => $categoryid), 'path', MUST_EXIST
);
1659 $categoriestoload = explode('/', trim($category->path
, '/'));
1660 list($select, $params) = $DB->get_in_or_equal($categoriestoload);
1661 // We are going to use select twice so double the params
1662 $params = array_merge($params, $params);
1663 $basecategorysql = ($showbasecategories)?
' OR cc.depth = 1':'';
1664 $sqlwhere .= " AND (cc.id {$select} OR cc.parent {$select}{$basecategorysql})";
1667 $categoriesrs = $DB->get_recordset_sql("$sqlselect $sqlwhere $sqlorder", $params);
1668 $categories = array();
1669 foreach ($categoriesrs as $category) {
1670 // Preload the context.. we'll need it when adding the category in order
1671 // to format the category name.
1672 context_helper
::preload_from_record($category);
1673 if (array_key_exists($category->id
, $this->addedcategories
)) {
1674 // Do nothing, its already been added.
1675 } else if ($category->parent
== '0') {
1676 // This is a root category lets add it immediately
1677 $this->add_category($category, $this->rootnodes
['courses']);
1678 } else if (array_key_exists($category->parent
, $this->addedcategories
)) {
1679 // This categories parent has already been added we can add this immediately
1680 $this->add_category($category, $this->addedcategories
[$category->parent
]);
1682 $categories[] = $category;
1685 $categoriesrs->close();
1687 // Now we have an array of categories we need to add them to the navigation.
1688 while (!empty($categories)) {
1689 $category = reset($categories);
1690 if (array_key_exists($category->id
, $this->addedcategories
)) {
1692 } else if ($category->parent
== '0') {
1693 $this->add_category($category, $this->rootnodes
['courses']);
1694 } else if (array_key_exists($category->parent
, $this->addedcategories
)) {
1695 $this->add_category($category, $this->addedcategories
[$category->parent
]);
1697 // This category isn't in the navigation and niether is it's parent (yet).
1698 // We need to go through the category path and add all of its components in order.
1699 $path = explode('/', trim($category->path
, '/'));
1700 foreach ($path as $catid) {
1701 if (!array_key_exists($catid, $this->addedcategories
)) {
1702 // This category isn't in the navigation yet so add it.
1703 $subcategory = $categories[$catid];
1704 if ($subcategory->parent
== '0') {
1705 // Yay we have a root category - this likely means we will now be able
1706 // to add categories without problems.
1707 $this->add_category($subcategory, $this->rootnodes
['courses']);
1708 } else if (array_key_exists($subcategory->parent
, $this->addedcategories
)) {
1709 // The parent is in the category (as we'd expect) so add it now.
1710 $this->add_category($subcategory, $this->addedcategories
[$subcategory->parent
]);
1711 // Remove the category from the categories array.
1712 unset($categories[$catid]);
1714 // We should never ever arrive here - if we have then there is a bigger
1716 throw new coding_exception('Category path order is incorrect and/or there are missing categories');
1721 // Remove the category from the categories array now that we know it has been added.
1722 unset($categories[$category->id
]);
1724 if ($categoryid === self
::LOAD_ALL_CATEGORIES
) {
1725 $this->allcategoriesloaded
= true;
1727 // Check if there are any categories to load.
1728 if (count($categoriestoload) > 0) {
1729 $readytoloadcourses = array();
1730 foreach ($categoriestoload as $category) {
1731 if ($this->can_add_more_courses_to_category($category)) {
1732 $readytoloadcourses[] = $category;
1735 if (count($readytoloadcourses)) {
1736 $this->load_all_courses($readytoloadcourses);
1740 // Look for all categories which have been loaded
1741 if (!empty($this->addedcategories
)) {
1742 $categoryids = array();
1743 foreach ($this->addedcategories
as $category) {
1744 if ($this->can_add_more_courses_to_category($category)) {
1745 $categoryids[] = $category->key
;
1749 list($categoriessql, $params) = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED
);
1750 $params['limit'] = (!empty($CFG->navcourselimit
))?
$CFG->navcourselimit
:20;
1751 $sql = "SELECT cc.id, COUNT(c.id) AS coursecount
1752 FROM {course_categories} cc
1753 JOIN {course} c ON c.category = cc.id
1754 WHERE cc.id {$categoriessql}
1756 HAVING COUNT(c.id) > :limit";
1757 $excessivecategories = $DB->get_records_sql($sql, $params);
1758 foreach ($categories as &$category) {
1759 if (array_key_exists($category->key
, $excessivecategories) && !$this->can_add_more_courses_to_category($category)) {
1760 $url = new moodle_url('/course/index.php', array('categoryid' => $category->key
));
1761 $category->add(get_string('viewallcourses'), $url, self
::TYPE_SETTING
);
1769 * Adds a structured category to the navigation in the correct order/place
1771 * @param stdClass $category category to be added in navigation.
1772 * @param navigation_node $parent parent navigation node
1773 * @param int $nodetype type of node, if category is under MyHome then it's TYPE_MY_CATEGORY
1776 protected function add_category(stdClass
$category, navigation_node
$parent, $nodetype = self
::TYPE_CATEGORY
) {
1777 if (array_key_exists($category->id
, $this->addedcategories
)) {
1780 $url = new moodle_url('/course/index.php', array('categoryid' => $category->id
));
1781 $context = context_coursecat
::instance($category->id
);
1782 $categoryname = format_string($category->name
, true, array('context' => $context));
1783 $categorynode = $parent->add($categoryname, $url, $nodetype, $categoryname, $category->id
);
1784 if (empty($category->visible
)) {
1785 if (has_capability('moodle/category:viewhiddencategories', context_system
::instance())) {
1786 $categorynode->hidden
= true;
1788 $categorynode->display
= false;
1791 $this->addedcategories
[$category->id
] = $categorynode;
1795 * Loads the given course into the navigation
1797 * @param stdClass $course
1798 * @return navigation_node
1800 protected function load_course(stdClass
$course) {
1802 if ($course->id
== $SITE->id
) {
1803 // This is always loaded during initialisation
1804 return $this->rootnodes
['site'];
1805 } else if (array_key_exists($course->id
, $this->addedcourses
)) {
1806 // The course has already been loaded so return a reference
1807 return $this->addedcourses
[$course->id
];
1810 return $this->add_course($course);
1815 * Loads all of the courses section into the navigation.
1817 * This function calls method from current course format, see
1818 * {@link format_base::extend_course_navigation()}
1819 * If course module ($cm) is specified but course format failed to create the node,
1820 * the activity node is created anyway.
1822 * By default course formats call the method {@link global_navigation::load_generic_course_sections()}
1824 * @param stdClass $course Database record for the course
1825 * @param navigation_node $coursenode The course node within the navigation
1826 * @param null|int $sectionnum If specified load the contents of section with this relative number
1827 * @param null|cm_info $cm If specified make sure that activity node is created (either
1828 * in containg section or by calling load_stealth_activity() )
1830 protected function load_course_sections(stdClass
$course, navigation_node
$coursenode, $sectionnum = null, $cm = null) {
1832 require_once($CFG->dirroot
.'/course/lib.php');
1833 if (isset($cm->sectionnum
)) {
1834 $sectionnum = $cm->sectionnum
;
1836 if ($sectionnum !== null) {
1837 $this->includesectionnum
= $sectionnum;
1839 course_get_format($course)->extend_course_navigation($this, $coursenode, $sectionnum, $cm);
1840 if (isset($cm->id
)) {
1841 $activity = $coursenode->find($cm->id
, self
::TYPE_ACTIVITY
);
1842 if (empty($activity)) {
1843 $activity = $this->load_stealth_activity($coursenode, get_fast_modinfo($course));
1849 * Generates an array of sections and an array of activities for the given course.
1851 * This method uses the cache to improve performance and avoid the get_fast_modinfo call
1853 * @param stdClass $course
1854 * @return array Array($sections, $activities)
1856 protected function generate_sections_and_activities(stdClass
$course) {
1858 require_once($CFG->dirroot
.'/course/lib.php');
1860 $modinfo = get_fast_modinfo($course);
1861 $sections = $modinfo->get_section_info_all();
1863 // For course formats using 'numsections' trim the sections list
1864 $courseformatoptions = course_get_format($course)->get_format_options();
1865 if (isset($courseformatoptions['numsections'])) {
1866 $sections = array_slice($sections, 0, $courseformatoptions['numsections']+
1, true);
1869 $activities = array();
1871 foreach ($sections as $key => $section) {
1872 // Clone and unset summary to prevent $SESSION bloat (MDL-31802).
1873 $sections[$key] = clone($section);
1874 unset($sections[$key]->summary
);
1875 $sections[$key]->hasactivites
= false;
1876 if (!array_key_exists($section->section
, $modinfo->sections
)) {
1879 foreach ($modinfo->sections
[$section->section
] as $cmid) {
1880 $cm = $modinfo->cms
[$cmid];
1881 $activity = new stdClass
;
1882 $activity->id
= $cm->id
;
1883 $activity->course
= $course->id
;
1884 $activity->section
= $section->section
;
1885 $activity->name
= $cm->name
;
1886 $activity->icon
= $cm->icon
;
1887 $activity->iconcomponent
= $cm->iconcomponent
;
1888 $activity->hidden
= (!$cm->visible
);
1889 $activity->modname
= $cm->modname
;
1890 $activity->nodetype
= navigation_node
::NODETYPE_LEAF
;
1891 $activity->onclick
= $cm->onclick
;
1894 $activity->url
= null;
1895 $activity->display
= false;
1897 $activity->url
= $url->out();
1898 $activity->display
= $cm->uservisible ?
true : false;
1899 if (self
::module_extends_navigation($cm->modname
)) {
1900 $activity->nodetype
= navigation_node
::NODETYPE_BRANCH
;
1903 $activities[$cmid] = $activity;
1904 if ($activity->display
) {
1905 $sections[$key]->hasactivites
= true;
1910 return array($sections, $activities);
1914 * Generically loads the course sections into the course's navigation.
1916 * @param stdClass $course
1917 * @param navigation_node $coursenode
1918 * @return array An array of course section nodes
1920 public function load_generic_course_sections(stdClass
$course, navigation_node
$coursenode) {
1921 global $CFG, $DB, $USER, $SITE;
1922 require_once($CFG->dirroot
.'/course/lib.php');
1924 list($sections, $activities) = $this->generate_sections_and_activities($course);
1926 $navigationsections = array();
1927 foreach ($sections as $sectionid => $section) {
1928 $section = clone($section);
1929 if ($course->id
== $SITE->id
) {
1930 $this->load_section_activities($coursenode, $section->section
, $activities);
1932 if (!$section->uservisible ||
(!$this->showemptysections
&&
1933 !$section->hasactivites
&& $this->includesectionnum
!== $section->section
)) {
1937 $sectionname = get_section_name($course, $section);
1938 $url = course_get_url($course, $section->section
, array('navigation' => true));
1940 $sectionnode = $coursenode->add($sectionname, $url, navigation_node
::TYPE_SECTION
, null, $section->id
);
1941 $sectionnode->nodetype
= navigation_node
::NODETYPE_BRANCH
;
1942 $sectionnode->hidden
= (!$section->visible ||
!$section->available
);
1943 if ($this->includesectionnum
!== false && $this->includesectionnum
== $section->section
) {
1944 $this->load_section_activities($sectionnode, $section->section
, $activities);
1946 $section->sectionnode
= $sectionnode;
1947 $navigationsections[$sectionid] = $section;
1950 return $navigationsections;
1954 * Loads all of the activities for a section into the navigation structure.
1956 * @param navigation_node $sectionnode
1957 * @param int $sectionnumber
1958 * @param array $activities An array of activites as returned by {@link global_navigation::generate_sections_and_activities()}
1959 * @param stdClass $course The course object the section and activities relate to.
1960 * @return array Array of activity nodes
1962 protected function load_section_activities(navigation_node
$sectionnode, $sectionnumber, array $activities, $course = null) {
1964 // A static counter for JS function naming
1965 static $legacyonclickcounter = 0;
1967 $activitynodes = array();
1968 if (empty($activities)) {
1969 return $activitynodes;
1972 if (!is_object($course)) {
1973 $activity = reset($activities);
1974 $courseid = $activity->course
;
1976 $courseid = $course->id
;
1978 $showactivities = ($courseid != $SITE->id ||
!empty($CFG->navshowfrontpagemods
));
1980 foreach ($activities as $activity) {
1981 if ($activity->section
!= $sectionnumber) {
1984 if ($activity->icon
) {
1985 $icon = new pix_icon($activity->icon
, get_string('modulename', $activity->modname
), $activity->iconcomponent
);
1987 $icon = new pix_icon('icon', get_string('modulename', $activity->modname
), $activity->modname
);
1990 // Prepare the default name and url for the node
1991 $activityname = format_string($activity->name
, true, array('context' => context_module
::instance($activity->id
)));
1992 $action = new moodle_url($activity->url
);
1994 // Check if the onclick property is set (puke!)
1995 if (!empty($activity->onclick
)) {
1996 // Increment the counter so that we have a unique number.
1997 $legacyonclickcounter++
;
1998 // Generate the function name we will use
1999 $functionname = 'legacy_activity_onclick_handler_'.$legacyonclickcounter;
2000 $propogrationhandler = '';
2001 // Check if we need to cancel propogation. Remember inline onclick
2002 // events would return false if they wanted to prevent propogation and the
2004 if (strpos($activity->onclick
, 'return false')) {
2005 $propogrationhandler = 'e.halt();';
2007 // Decode the onclick - it has already been encoded for display (puke)
2008 $onclick = htmlspecialchars_decode($activity->onclick
, ENT_QUOTES
);
2009 // Build the JS function the click event will call
2010 $jscode = "function {$functionname}(e) { $propogrationhandler $onclick }";
2011 $this->page
->requires
->js_init_code($jscode);
2012 // Override the default url with the new action link
2013 $action = new action_link($action, $activityname, new component_action('click', $functionname));
2016 $activitynode = $sectionnode->add($activityname, $action, navigation_node
::TYPE_ACTIVITY
, null, $activity->id
, $icon);
2017 $activitynode->title(get_string('modulename', $activity->modname
));
2018 $activitynode->hidden
= $activity->hidden
;
2019 $activitynode->display
= $showactivities && $activity->display
;
2020 $activitynode->nodetype
= $activity->nodetype
;
2021 $activitynodes[$activity->id
] = $activitynode;
2024 return $activitynodes;
2027 * Loads a stealth module from unavailable section
2028 * @param navigation_node $coursenode
2029 * @param stdClass $modinfo
2030 * @return navigation_node or null if not accessible
2032 protected function load_stealth_activity(navigation_node
$coursenode, $modinfo) {
2033 if (empty($modinfo->cms
[$this->page
->cm
->id
])) {
2036 $cm = $modinfo->cms
[$this->page
->cm
->id
];
2038 $icon = new pix_icon($cm->icon
, get_string('modulename', $cm->modname
), $cm->iconcomponent
);
2040 $icon = new pix_icon('icon', get_string('modulename', $cm->modname
), $cm->modname
);
2043 $activitynode = $coursenode->add(format_string($cm->name
), $url, navigation_node
::TYPE_ACTIVITY
, null, $cm->id
, $icon);
2044 $activitynode->title(get_string('modulename', $cm->modname
));
2045 $activitynode->hidden
= (!$cm->visible
);
2046 if (!$cm->uservisible
) {
2047 // Do not show any error here, let the page handle exception that activity is not visible for the current user.
2048 // Also there may be no exception at all in case when teacher is logged in as student.
2049 $activitynode->display
= false;
2051 // Don't show activities that don't have links!
2052 $activitynode->display
= false;
2053 } else if (self
::module_extends_navigation($cm->modname
)) {
2054 $activitynode->nodetype
= navigation_node
::NODETYPE_BRANCH
;
2056 return $activitynode;
2059 * Loads the navigation structure for the given activity into the activities node.
2061 * This method utilises a callback within the modules lib.php file to load the
2062 * content specific to activity given.
2064 * The callback is a method: {modulename}_extend_navigation()
2066 * * {@link forum_extend_navigation()}
2067 * * {@link workshop_extend_navigation()}
2069 * @param cm_info|stdClass $cm
2070 * @param stdClass $course
2071 * @param navigation_node $activity
2074 protected function load_activity($cm, stdClass
$course, navigation_node
$activity) {
2077 // make sure we have a $cm from get_fast_modinfo as this contains activity access details
2078 if (!($cm instanceof cm_info
)) {
2079 $modinfo = get_fast_modinfo($course);
2080 $cm = $modinfo->get_cm($cm->id
);
2082 $activity->nodetype
= navigation_node
::NODETYPE_LEAF
;
2083 $activity->make_active();
2084 $file = $CFG->dirroot
.'/mod/'.$cm->modname
.'/lib.php';
2085 $function = $cm->modname
.'_extend_navigation';
2087 if (file_exists($file)) {
2088 require_once($file);
2089 if (function_exists($function)) {
2090 $activtyrecord = $DB->get_record($cm->modname
, array('id' => $cm->instance
), '*', MUST_EXIST
);
2091 $function($activity, $course, $activtyrecord, $cm);
2095 // Allow the active advanced grading method plugin to append module navigation
2096 $featuresfunc = $cm->modname
.'_supports';
2097 if (function_exists($featuresfunc) && $featuresfunc(FEATURE_ADVANCED_GRADING
)) {
2098 require_once($CFG->dirroot
.'/grade/grading/lib.php');
2099 $gradingman = get_grading_manager($cm->context
, 'mod_'.$cm->modname
);
2100 $gradingman->extend_navigation($this, $activity);
2103 return $activity->has_children();
2106 * Loads user specific information into the navigation in the appropriate place.
2108 * If no user is provided the current user is assumed.
2110 * @param stdClass $user
2111 * @param bool $forceforcontext probably force something to be loaded somewhere (ask SamH if not sure what this means)
2114 protected function load_for_user($user=null, $forceforcontext=false) {
2115 global $DB, $CFG, $USER, $SITE;
2117 if ($user === null) {
2118 // We can't require login here but if the user isn't logged in we don't
2119 // want to show anything
2120 if (!isloggedin() ||
isguestuser()) {
2124 } else if (!is_object($user)) {
2125 // If the user is not an object then get them from the database
2126 $select = context_helper
::get_preload_record_columns_sql('ctx');
2127 $sql = "SELECT u.*, $select
2129 JOIN {context} ctx ON u.id = ctx.instanceid
2130 WHERE u.id = :userid AND
2131 ctx.contextlevel = :contextlevel";
2132 $user = $DB->get_record_sql($sql, array('userid' => (int)$user, 'contextlevel' => CONTEXT_USER
), MUST_EXIST
);
2133 context_helper
::preload_from_record($user);
2136 $iscurrentuser = ($user->id
== $USER->id
);
2138 $usercontext = context_user
::instance($user->id
);
2140 // Get the course set against the page, by default this will be the site
2141 $course = $this->page
->course
;
2142 $baseargs = array('id'=>$user->id
);
2143 if ($course->id
!= $SITE->id
&& (!$iscurrentuser ||
$forceforcontext)) {
2144 $coursenode = $this->add_course($course, false, self
::COURSE_CURRENT
);
2145 $baseargs['course'] = $course->id
;
2146 $coursecontext = context_course
::instance($course->id
);
2147 $issitecourse = false;
2149 // Load all categories and get the context for the system
2150 $coursecontext = context_system
::instance();
2151 $issitecourse = true;
2154 // Create a node to add user information under.
2156 if (!$issitecourse) {
2157 // Not the current user so add it to the participants node for the current course.
2158 $usersnode = $coursenode->get('participants', navigation_node
::TYPE_CONTAINER
);
2159 $userviewurl = new moodle_url('/user/view.php', $baseargs);
2160 } else if ($USER->id
!= $user->id
) {
2161 // This is the site so add a users node to the root branch.
2162 $usersnode = $this->rootnodes
['users'];
2163 if (has_capability('moodle/course:viewparticipants', $coursecontext)) {
2164 $usersnode->action
= new moodle_url('/user/index.php', array('id' => $course->id
));
2166 $userviewurl = new moodle_url('/user/profile.php', $baseargs);
2169 // We should NEVER get here, if the course hasn't been populated
2170 // with a participants node then the navigaiton either wasn't generated
2171 // for it (you are missing a require_login or set_context call) or
2172 // you don't have access.... in the interests of no leaking informatin
2173 // we simply quit...
2176 // Add a branch for the current user.
2177 $canseefullname = has_capability('moodle/site:viewfullnames', $coursecontext);
2178 $usernode = $usersnode->add(fullname($user, $canseefullname), $userviewurl, self
::TYPE_USER
, null, 'user' . $user->id
);
2179 if ($this->page
->context
->contextlevel
== CONTEXT_USER
&& $user->id
== $this->page
->context
->instanceid
) {
2180 $usernode->make_active();
2183 // Add user information to the participants or user node.
2184 if ($issitecourse) {
2186 // If the user is the current user or has permission to view the details of the requested
2187 // user than add a view profile link.
2188 if ($iscurrentuser ||
has_capability('moodle/user:viewdetails', $coursecontext) ||
2189 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',
2204 array_merge($baseargs, array('mode' => 'discussions'))));
2208 if (!empty($CFG->enableblogs
)) {
2209 if (!$this->cache
->cached('userblogoptions'.$user->id
)) {
2210 require_once($CFG->dirroot
.'/blog/lib.php');
2211 // Get all options for the user.
2212 $options = blog_get_options_for_user($user);
2213 $this->cache
->set('userblogoptions'.$user->id
, $options);
2215 $options = $this->cache
->{'userblogoptions'.$user->id
};
2218 if (count($options) > 0) {
2219 $blogs = $usernode->add(get_string('blogs', 'blog'), null, navigation_node
::TYPE_CONTAINER
);
2220 foreach ($options as $type => $option) {
2221 if ($type == "rss") {
2222 $blogs->add($option['string'], $option['link'], settings_navigation
::TYPE_SETTING
, null, null,
2223 new pix_icon('i/rss', ''));
2225 $blogs->add($option['string'], $option['link']);
2231 // Add the messages link.
2232 // It is context based so can appear in the user's profile and in course participants information.
2233 if (!empty($CFG->messaging
)) {
2234 $messageargs = array('user1' => $USER->id
);
2235 if ($USER->id
!= $user->id
) {
2236 $messageargs['user2'] = $user->id
;
2238 if ($course->id
!= $SITE->id
) {
2239 $messageargs['viewing'] = MESSAGE_VIEW_COURSE
. $course->id
;
2241 $url = new moodle_url('/message/index.php', $messageargs);
2242 $usernode->add(get_string('messages', 'message'), $url, self
::TYPE_SETTING
, null, 'messages');
2245 // Add the "My private files" link.
2246 // This link doesn't have a unique display for course context so only display it under the user's profile.
2247 if ($issitecourse && $iscurrentuser && has_capability('moodle/user:manageownfiles', $usercontext)) {
2248 $url = new moodle_url('/user/files.php');
2249 $usernode->add(get_string('privatefiles'), $url, self
::TYPE_SETTING
);
2252 // Add a node to view the users notes if permitted.
2253 if (!empty($CFG->enablenotes
) &&
2254 has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $coursecontext)) {
2255 $url = new moodle_url('/notes/index.php', array('user' => $user->id
));
2256 if ($coursecontext->instanceid
!= SITEID
) {
2257 $url->param('course', $coursecontext->instanceid
);
2259 $usernode->add(get_string('notes', 'notes'), $url);
2262 // Show the grades node.
2263 if (($issitecourse && $iscurrentuser) ||
has_capability('moodle/user:viewdetails', $usercontext)) {
2264 require_once($CFG->dirroot
. '/user/lib.php');
2265 // Set the grades node to link to the "Grades" page.
2266 if ($course->id
== SITEID
) {
2267 $url = user_mygrades_url($user->id
, $course->id
);
2268 } else { // Otherwise we are in a course and should redirect to the user grade report (Activity report version).
2269 $url = new moodle_url('/course/user.php', array('mode' => 'grade', 'id' => $course->id
, 'user' => $user->id
));
2271 if ($USER->id
!= $user->id
) {
2272 $usernode->add(get_string('grades', 'grades'), $url, self
::TYPE_SETTING
, null, 'usergrades');
2274 $usernode->add(get_string('grades', 'grades'), $url);
2278 // If the user is the current user add the repositories for the current user.
2279 $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields
));
2280 if (!$iscurrentuser &&
2281 $course->id
== $SITE->id
&&
2282 has_capability('moodle/user:viewdetails', $usercontext) &&
2283 (!in_array('mycourses', $hiddenfields) ||
has_capability('moodle/user:viewhiddendetails', $coursecontext))) {
2285 // Add view grade report is permitted.
2286 $reports = core_component
::get_plugin_list('gradereport');
2287 arsort($reports); // User is last, we want to test it first.
2289 $userscourses = enrol_get_users_courses($user->id
);
2290 $userscoursesnode = $usernode->add(get_string('courses'));
2293 foreach ($userscourses as $usercourse) {
2294 if ($count === (int)$CFG->navcourselimit
) {
2295 $url = new moodle_url('/user/profile.php', array('id' => $user->id
, 'showallcourses' => 1));
2296 $userscoursesnode->add(get_string('showallcourses'), $url);
2300 $usercoursecontext = context_course
::instance($usercourse->id
);
2301 $usercourseshortname = format_string($usercourse->shortname
, true, array('context' => $usercoursecontext));
2302 $usercoursenode = $userscoursesnode->add($usercourseshortname, new moodle_url('/user/view.php',
2303 array('id' => $user->id
, 'course' => $usercourse->id
)), self
::TYPE_CONTAINER
);
2305 $gradeavailable = has_capability('moodle/grade:viewall', $usercoursecontext);
2306 if (!$gradeavailable && !empty($usercourse->showgrades
) && is_array($reports) && !empty($reports)) {
2307 foreach ($reports as $plugin => $plugindir) {
2308 if (has_capability('gradereport/'.$plugin.':view', $usercoursecontext)) {
2309 // Stop when the first visible plugin is found.
2310 $gradeavailable = true;
2316 if ($gradeavailable) {
2317 $url = new moodle_url('/grade/report/index.php', array('id' => $usercourse->id
));
2318 $usercoursenode->add(get_string('grades'), $url, self
::TYPE_SETTING
, null, null,
2319 new pix_icon('i/grades', ''));
2322 // Add a node to view the users notes if permitted.
2323 if (!empty($CFG->enablenotes
) &&
2324 has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $usercoursecontext)) {
2325 $url = new moodle_url('/notes/index.php', array('user' => $user->id
, 'course' => $usercourse->id
));
2326 $usercoursenode->add(get_string('notes', 'notes'), $url, self
::TYPE_SETTING
);
2329 if (can_access_course($usercourse, $user->id
, '', true)) {
2330 $usercoursenode->add(get_string('entercourse'), new moodle_url('/course/view.php',
2331 array('id' => $usercourse->id
)), self
::TYPE_SETTING
, null, null, new pix_icon('i/course', ''));
2334 $reporttab = $usercoursenode->add(get_string('activityreports'));
2336 $reports = get_plugin_list_with_function('report', 'extend_navigation_user', 'lib.php');
2337 foreach ($reports as $reportfunction) {
2338 $reportfunction($reporttab, $user, $usercourse);
2341 $reporttab->trim_if_empty();
2350 * This method simply checks to see if a given module can extend the navigation.
2352 * @todo (MDL-25290) A shared caching solution should be used to save details on what extends navigation.
2354 * @param string $modname
2357 public static function module_extends_navigation($modname) {
2359 static $extendingmodules = array();
2360 if (!array_key_exists($modname, $extendingmodules)) {
2361 $extendingmodules[$modname] = false;
2362 $file = $CFG->dirroot
.'/mod/'.$modname.'/lib.php';
2363 if (file_exists($file)) {
2364 $function = $modname.'_extend_navigation';
2365 require_once($file);
2366 $extendingmodules[$modname] = (function_exists($function));
2369 return $extendingmodules[$modname];
2372 * Extends the navigation for the given user.
2374 * @param stdClass $user A user from the database
2376 public function extend_for_user($user) {
2377 $this->extendforuser
[] = $user;
2381 * Returns all of the users the navigation is being extended for
2383 * @return array An array of extending users.
2385 public function get_extending_users() {
2386 return $this->extendforuser
;
2389 * Adds the given course to the navigation structure.
2391 * @param stdClass $course
2392 * @param bool $forcegeneric
2393 * @param bool $ismycourse
2394 * @return navigation_node
2396 public function add_course(stdClass
$course, $forcegeneric = false, $coursetype = self
::COURSE_OTHER
) {
2399 // We found the course... we can return it now :)
2400 if (!$forcegeneric && array_key_exists($course->id
, $this->addedcourses
)) {
2401 return $this->addedcourses
[$course->id
];
2404 $coursecontext = context_course
::instance($course->id
);
2406 if ($course->id
!= $SITE->id
&& !$course->visible
) {
2407 if (is_role_switched($course->id
)) {
2408 // user has to be able to access course in order to switch, let's skip the visibility test here
2409 } else if (!has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2414 $issite = ($course->id
== $SITE->id
);
2415 $shortname = format_string($course->shortname
, true, array('context' => $coursecontext));
2416 $fullname = format_string($course->fullname
, true, array('context' => $coursecontext));
2417 // This is the name that will be shown for the course.
2418 $coursename = empty($CFG->navshowfullcoursenames
) ?
$shortname : $fullname;
2420 // Can the user expand the course to see its content.
2421 $canexpandcourse = true;
2425 if (empty($CFG->usesitenameforsitepages
)) {
2426 $coursename = get_string('sitepages');
2428 } else if ($coursetype == self
::COURSE_CURRENT
) {
2429 $parent = $this->rootnodes
['currentcourse'];
2430 $url = new moodle_url('/course/view.php', array('id'=>$course->id
));
2431 $canexpandcourse = $this->can_expand_course($course);
2432 } else if ($coursetype == self
::COURSE_MY
&& !$forcegeneric) {
2433 if (!empty($CFG->navshowmycoursecategories
) && ($parent = $this->rootnodes
['mycourses']->find($course->category
, self
::TYPE_MY_CATEGORY
))) {
2434 // Nothing to do here the above statement set $parent to the category within mycourses.
2436 $parent = $this->rootnodes
['mycourses'];
2438 $url = new moodle_url('/course/view.php', array('id'=>$course->id
));
2440 $parent = $this->rootnodes
['courses'];
2441 $url = new moodle_url('/course/view.php', array('id'=>$course->id
));
2442 // They can only expand the course if they can access it.
2443 $canexpandcourse = $this->can_expand_course($course);
2444 if (!empty($course->category
) && $this->show_categories($coursetype == self
::COURSE_MY
)) {
2445 if (!$this->is_category_fully_loaded($course->category
)) {
2446 // We need to load the category structure for this course
2447 $this->load_all_categories($course->category
, false);
2449 if (array_key_exists($course->category
, $this->addedcategories
)) {
2450 $parent = $this->addedcategories
[$course->category
];
2451 // This could lead to the course being created so we should check whether it is the case again
2452 if (!$forcegeneric && array_key_exists($course->id
, $this->addedcourses
)) {
2453 return $this->addedcourses
[$course->id
];
2459 $coursenode = $parent->add($coursename, $url, self
::TYPE_COURSE
, $shortname, $course->id
);
2460 $coursenode->hidden
= (!$course->visible
);
2461 // We need to decode &'s here as they will have been added by format_string above and attributes will be encoded again
2463 $coursenode->title(str_replace('&', '&', $fullname));
2464 if ($canexpandcourse) {
2465 // This course can be expanded by the user, make it a branch to make the system aware that its expandable by ajax.
2466 $coursenode->nodetype
= self
::NODETYPE_BRANCH
;
2467 $coursenode->isexpandable
= true;
2469 $coursenode->nodetype
= self
::NODETYPE_LEAF
;
2470 $coursenode->isexpandable
= false;
2472 if (!$forcegeneric) {
2473 $this->addedcourses
[$course->id
] = $coursenode;
2480 * Returns a cache instance to use for the expand course cache.
2481 * @return cache_session
2483 protected function get_expand_course_cache() {
2484 if ($this->cacheexpandcourse
=== null) {
2485 $this->cacheexpandcourse
= cache
::make('core', 'navigation_expandcourse');
2487 return $this->cacheexpandcourse
;
2491 * Checks if a user can expand a course in the navigation.
2493 * We use a cache here because in order to be accurate we need to call can_access_course which is a costly function.
2494 * Because this functionality is basic + non-essential and because we lack good event triggering this cache
2495 * permits stale data.
2496 * In the situation the user is granted access to a course after we've initialised this session cache the cache
2498 * It is brought up to date in only one of two ways.
2499 * 1. The user logs out and in again.
2500 * 2. The user browses to the course they've just being given access to.
2502 * Really all this controls is whether the node is shown as expandable or not. It is uber un-important.
2504 * @param stdClass $course
2507 protected function can_expand_course($course) {
2508 $cache = $this->get_expand_course_cache();
2509 $canexpand = $cache->get($course->id
);
2510 if ($canexpand === false) {
2511 $canexpand = isloggedin() && can_access_course($course, null, '', true);
2512 $canexpand = (int)$canexpand;
2513 $cache->set($course->id
, $canexpand);
2515 return ($canexpand === 1);
2519 * Returns true if the category has already been loaded as have any child categories
2521 * @param int $categoryid
2524 protected function is_category_fully_loaded($categoryid) {
2525 return (array_key_exists($categoryid, $this->addedcategories
) && ($this->allcategoriesloaded ||
$this->addedcategories
[$categoryid]->children
->count() > 0));
2529 * Adds essential course nodes to the navigation for the given course.
2531 * This method adds nodes such as reports, blogs and participants
2533 * @param navigation_node $coursenode
2534 * @param stdClass $course
2535 * @return bool returns true on successful addition of a node.
2537 public function add_course_essentials($coursenode, stdClass
$course) {
2540 if ($course->id
== $SITE->id
) {
2541 return $this->add_front_page_course_essentials($coursenode, $course);
2544 if ($coursenode == false ||
!($coursenode instanceof navigation_node
) ||
$coursenode->get('participants', navigation_node
::TYPE_CONTAINER
)) {
2549 if (has_capability('moodle/course:viewparticipants', $this->page
->context
)) {
2550 $participants = $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id
), self
::TYPE_CONTAINER
, get_string('participants'), 'participants');
2551 if (!empty($CFG->enableblogs
)) {
2552 if (($CFG->bloglevel
== BLOG_GLOBAL_LEVEL
or ($CFG->bloglevel
== BLOG_SITE_LEVEL
and (isloggedin() and !isguestuser())))
2553 and has_capability('moodle/blog:view', context_system
::instance())) {
2554 $blogsurls = new moodle_url('/blog/index.php');
2555 if ($currentgroup = groups_get_course_group($course, true)) {
2556 $blogsurls->param('groupid', $currentgroup);
2558 $blogsurls->param('courseid', $course->id
);
2560 $participants->add(get_string('blogscourse', 'blog'), $blogsurls->out(), self
::TYPE_SETTING
, null, 'courseblogs');
2563 if (!empty($CFG->enablenotes
) && (has_capability('moodle/notes:manage', $this->page
->context
) ||
has_capability('moodle/notes:view', $this->page
->context
))) {
2564 $participants->add(get_string('notes', 'notes'), new moodle_url('/notes/index.php', array('filtertype' => 'course', 'filterselect' => $course->id
)), self
::TYPE_SETTING
, null, 'currentcoursenotes');
2566 } else if (count($this->extendforuser
) > 0 ||
$this->page
->course
->id
== $course->id
) {
2567 $participants = $coursenode->add(get_string('participants'), null, self
::TYPE_CONTAINER
, get_string('participants'), 'participants');
2571 if (!empty($CFG->enablebadges
) && !empty($CFG->badges_allowcoursebadges
) &&
2572 has_capability('moodle/badges:viewbadges', $this->page
->context
)) {
2573 $url = new moodle_url('/badges/view.php', array('type' => 2, 'id' => $course->id
));
2575 $coursenode->add(get_string('coursebadges', 'badges'), null,
2576 navigation_node
::TYPE_CONTAINER
, null, 'coursebadges');
2577 $coursenode->get('coursebadges')->add(get_string('badgesview', 'badges'), $url,
2578 navigation_node
::TYPE_SETTING
, null, 'badgesview',
2579 new pix_icon('i/badge', get_string('badgesview', 'badges')));
2585 * This generates the structure of the course that won't be generated when
2586 * the modules and sections are added.
2588 * Things such as the reports branch, the participants branch, blogs... get
2589 * added to the course node by this method.
2591 * @param navigation_node $coursenode
2592 * @param stdClass $course
2593 * @return bool True for successfull generation
2595 public function add_front_page_course_essentials(navigation_node
$coursenode, stdClass
$course) {
2598 if ($coursenode == false ||
$coursenode->get('frontpageloaded', navigation_node
::TYPE_CUSTOM
)) {
2602 $sitecontext = context_system
::instance();
2604 // Hidden node that we use to determine if the front page navigation is loaded.
2605 // This required as there are not other guaranteed nodes that may be loaded.
2606 $coursenode->add('frontpageloaded', null, self
::TYPE_CUSTOM
, null, 'frontpageloaded')->display
= false;
2609 // If this is the site course, they need to have moodle/site:viewparticipants at the site level.
2610 // If no, then they need to have moodle/course:viewparticipants at the course level.
2611 if ((($course->id
== SITEID
) && has_capability('moodle/site:viewparticipants', $sitecontext)) ||
2612 has_capability('moodle/course:viewparticipants', context_course
::instance($course->id
))) {
2613 $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id
), self
::TYPE_CUSTOM
, get_string('participants'), 'participants');
2617 if (!empty($CFG->enableblogs
)
2618 and ($CFG->bloglevel
== BLOG_GLOBAL_LEVEL
or ($CFG->bloglevel
== BLOG_SITE_LEVEL
and (isloggedin() and !isguestuser())))
2619 and has_capability('moodle/blog:view', $sitecontext)) {
2620 $blogsurls = new moodle_url('/blog/index.php');
2621 $coursenode->add(get_string('blogssite', 'blog'), $blogsurls->out(), self
::TYPE_SYSTEM
, null, 'siteblog');
2627 if (!empty($CFG->enablebadges
) && has_capability('moodle/badges:viewbadges', $sitecontext)) {
2628 $url = new moodle_url($CFG->wwwroot
. '/badges/view.php', array('type' => 1));
2629 $coursenode->add(get_string('sitebadges', 'badges'), $url, navigation_node
::TYPE_CUSTOM
);
2633 if (!empty($CFG->enablenotes
) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $sitecontext)) {
2634 $coursenode->add(get_string('notes', 'notes'), new moodle_url('/notes/index.php',
2635 array('filtertype' => 'course', 'filterselect' => $filterselect)), self
::TYPE_SETTING
, null, 'notes');
2639 if (!empty($CFG->usetags
) && isloggedin()) {
2640 $node = $coursenode->add(get_string('tags', 'tag'), new moodle_url('/tag/search.php'),
2641 self
::TYPE_SETTING
, null, 'tags');
2646 $calendarurl = new moodle_url('/calendar/view.php', array('view' => 'month'));
2647 $coursenode->add(get_string('calendar', 'calendar'), $calendarurl, self
::TYPE_CUSTOM
, null, 'calendar');
2654 * Clears the navigation cache
2656 public function clear_cache() {
2657 $this->cache
->clear();
2661 * Sets an expansion limit for the navigation
2663 * The expansion limit is used to prevent the display of content that has a type
2664 * greater than the provided $type.
2666 * Can be used to ensure things such as activities or activity content don't get
2667 * shown on the navigation.
2668 * They are still generated in order to ensure the navbar still makes sense.
2670 * @param int $type One of navigation_node::TYPE_*
2671 * @return bool true when complete.
2673 public function set_expansion_limit($type) {
2675 $nodes = $this->find_all_of_type($type);
2677 // We only want to hide specific types of nodes.
2678 // Only nodes that represent "structure" in the navigation tree should be hidden.
2679 // If we hide all nodes then we risk hiding vital information.
2680 $typestohide = array(
2681 self
::TYPE_CATEGORY
,
2687 foreach ($nodes as $node) {
2688 // We need to generate the full site node
2689 if ($type == self
::TYPE_COURSE
&& $node->key
== $SITE->id
) {
2692 foreach ($node->children
as $child) {
2693 $child->hide($typestohide);
2699 * Attempts to get the navigation with the given key from this nodes children.
2701 * This function only looks at this nodes children, it does NOT look recursivily.
2702 * If the node can't be found then false is returned.
2704 * If you need to search recursivily then use the {@link global_navigation::find()} method.
2706 * Note: If you are trying to set the active node {@link navigation_node::override_active_url()}
2707 * may be of more use to you.
2709 * @param string|int $key The key of the node you wish to receive.
2710 * @param int $type One of navigation_node::TYPE_*
2711 * @return navigation_node|false
2713 public function get($key, $type = null) {
2714 if (!$this->initialised
) {
2715 $this->initialise();
2717 return parent
::get($key, $type);
2721 * Searches this nodes children and their children to find a navigation node
2722 * with the matching key and type.
2724 * This method is recursive and searches children so until either a node is
2725 * found or there are no more nodes to search.
2727 * If you know that the node being searched for is a child of this node
2728 * then use the {@link global_navigation::get()} method instead.
2730 * Note: If you are trying to set the active node {@link navigation_node::override_active_url()}
2731 * may be of more use to you.
2733 * @param string|int $key The key of the node you wish to receive.
2734 * @param int $type One of navigation_node::TYPE_*
2735 * @return navigation_node|false
2737 public function find($key, $type) {
2738 if (!$this->initialised
) {
2739 $this->initialise();
2741 if ($type == self
::TYPE_ROOTNODE
&& array_key_exists($key, $this->rootnodes
)) {
2742 return $this->rootnodes
[$key];
2744 return parent
::find($key, $type);
2748 * They've expanded the 'my courses' branch.
2750 protected function load_courses_enrolled() {
2752 $sortorder = 'visible DESC';
2753 // Prevent undefined $CFG->navsortmycoursessort errors.
2754 if (empty($CFG->navsortmycoursessort
)) {
2755 $CFG->navsortmycoursessort
= 'sortorder';
2757 // Append the chosen sortorder.
2758 $sortorder = $sortorder . ',' . $CFG->navsortmycoursessort
. ' ASC';
2759 $courses = enrol_get_my_courses(null, $sortorder);
2760 if (count($courses) && $this->show_my_categories()) {
2761 // OK Actually we are loading categories. We only want to load categories that have a parent of 0.
2762 // In order to make sure we load everything required we must first find the categories that are not
2763 // base categories and work out the bottom category in thier path.
2764 $categoryids = array();
2765 foreach ($courses as $course) {
2766 $categoryids[] = $course->category
;
2768 $categoryids = array_unique($categoryids);
2769 list($sql, $params) = $DB->get_in_or_equal($categoryids);
2770 $categories = $DB->get_recordset_select('course_categories', 'id '.$sql.' AND parent <> 0', $params, 'sortorder, id', 'id, path');
2771 foreach ($categories as $category) {
2772 $bits = explode('/', trim($category->path
,'/'));
2773 $categoryids[] = array_shift($bits);
2775 $categoryids = array_unique($categoryids);
2776 $categories->close();
2778 // Now we load the base categories.
2779 list($sql, $params) = $DB->get_in_or_equal($categoryids);
2780 $categories = $DB->get_recordset_select('course_categories', 'id '.$sql.' AND parent = 0', $params, 'sortorder, id');
2781 foreach ($categories as $category) {
2782 $this->add_category($category, $this->rootnodes
['mycourses'], self
::TYPE_MY_CATEGORY
);
2784 $categories->close();
2786 foreach ($courses as $course) {
2787 $this->add_course($course, false, self
::COURSE_MY
);
2794 * The global navigation class used especially for AJAX requests.
2796 * The primary methods that are used in the global navigation class have been overriden
2797 * to ensure that only the relevant branch is generated at the root of the tree.
2798 * This can be done because AJAX is only used when the backwards structure for the
2799 * requested branch exists.
2800 * This has been done only because it shortens the amounts of information that is generated
2801 * which of course will speed up the response time.. because no one likes laggy AJAX.
2804 * @category navigation
2805 * @copyright 2009 Sam Hemelryk
2806 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2808 class global_navigation_for_ajax
extends global_navigation
{
2810 /** @var int used for determining what type of navigation_node::TYPE_* is being used */
2811 protected $branchtype;
2813 /** @var int the instance id */
2814 protected $instanceid;
2816 /** @var array Holds an array of expandable nodes */
2817 protected $expandable = array();
2820 * Constructs the navigation for use in an AJAX request
2822 * @param moodle_page $page moodle_page object
2823 * @param int $branchtype
2826 public function __construct($page, $branchtype, $id) {
2827 $this->page
= $page;
2828 $this->cache
= new navigation_cache(NAVIGATION_CACHE_NAME
);
2829 $this->children
= new navigation_node_collection();
2830 $this->branchtype
= $branchtype;
2831 $this->instanceid
= $id;
2832 $this->initialise();
2835 * Initialise the navigation given the type and id for the branch to expand.
2837 * @return array An array of the expandable nodes
2839 public function initialise() {
2842 if ($this->initialised ||
during_initial_install()) {
2843 return $this->expandable
;
2845 $this->initialised
= true;
2847 $this->rootnodes
= array();
2848 $this->rootnodes
['site'] = $this->add_course($SITE);
2849 $this->rootnodes
['mycourses'] = $this->add(get_string('mycourses'), new moodle_url('/my'), self
::TYPE_ROOTNODE
, null, 'mycourses');
2850 $this->rootnodes
['courses'] = $this->add(get_string('courses'), null, self
::TYPE_ROOTNODE
, null, 'courses');
2851 // The courses branch is always displayed, and is always expandable (although may be empty).
2852 // This mimicks what is done during {@link global_navigation::initialise()}.
2853 $this->rootnodes
['courses']->isexpandable
= true;
2855 // Branchtype will be one of navigation_node::TYPE_*
2856 switch ($this->branchtype
) {
2858 if ($this->instanceid
=== 'mycourses') {
2859 $this->load_courses_enrolled();
2860 } else if ($this->instanceid
=== 'courses') {
2861 $this->load_courses_other();
2864 case self
::TYPE_CATEGORY
:
2865 $this->load_category($this->instanceid
);
2867 case self
::TYPE_MY_CATEGORY
:
2868 $this->load_category($this->instanceid
, self
::TYPE_MY_CATEGORY
);
2870 case self
::TYPE_COURSE
:
2871 $course = $DB->get_record('course', array('id' => $this->instanceid
), '*', MUST_EXIST
);
2872 if (!can_access_course($course, null, '', true)) {
2873 // Thats OK all courses are expandable by default. We don't need to actually expand it we can just
2874 // add the course node and break. This leads to an empty node.
2875 $this->add_course($course);
2878 require_course_login($course, true, null, false, true);
2879 $this->page
->set_context(context_course
::instance($course->id
));
2880 $coursenode = $this->add_course($course);
2881 $this->add_course_essentials($coursenode, $course);
2882 $this->load_course_sections($course, $coursenode);
2884 case self
::TYPE_SECTION
:
2885 $sql = 'SELECT c.*, cs.section AS sectionnumber
2887 LEFT JOIN {course_sections} cs ON cs.course = c.id
2889 $course = $DB->get_record_sql($sql, array($this->instanceid
), MUST_EXIST
);
2890 require_course_login($course, true, null, false, true);
2891 $this->page
->set_context(context_course
::instance($course->id
));
2892 $coursenode = $this->add_course($course);
2893 $this->add_course_essentials($coursenode, $course);
2894 $this->load_course_sections($course, $coursenode, $course->sectionnumber
);
2896 case self
::TYPE_ACTIVITY
:
2899 JOIN {course_modules} cm ON cm.course = c.id
2900 WHERE cm.id = :cmid";
2901 $params = array('cmid' => $this->instanceid
);
2902 $course = $DB->get_record_sql($sql, $params, MUST_EXIST
);
2903 $modinfo = get_fast_modinfo($course);
2904 $cm = $modinfo->get_cm($this->instanceid
);
2905 require_course_login($course, true, $cm, false, true);
2906 $this->page
->set_context(context_module
::instance($cm->id
));
2907 $coursenode = $this->load_course($course);
2908 $this->load_course_sections($course, $coursenode, null, $cm);
2909 $activitynode = $coursenode->find($cm->id
, self
::TYPE_ACTIVITY
);
2910 if ($activitynode) {
2911 $modulenode = $this->load_activity($cm, $course, $activitynode);
2915 throw new Exception('Unknown type');
2916 return $this->expandable
;
2919 if ($this->page
->context
->contextlevel
== CONTEXT_COURSE
&& $this->page
->context
->instanceid
!= $SITE->id
) {
2920 $this->load_for_user(null, true);
2923 $this->find_expandable($this->expandable
);
2924 return $this->expandable
;
2928 * They've expanded the general 'courses' branch.
2930 protected function load_courses_other() {
2931 $this->load_all_courses();
2935 * Loads a single category into the AJAX navigation.
2937 * This function is special in that it doesn't concern itself with the parent of
2938 * the requested category or its siblings.
2939 * This is because with the AJAX navigation we know exactly what is wanted and only need to
2942 * @global moodle_database $DB
2943 * @param int $categoryid id of category to load in navigation.
2944 * @param int $nodetype type of node, if category is under MyHome then it's TYPE_MY_CATEGORY
2947 protected function load_category($categoryid, $nodetype = self
::TYPE_CATEGORY
) {
2951 if (!empty($CFG->navcourselimit
)) {
2952 $limit = (int)$CFG->navcourselimit
;
2955 $catcontextsql = context_helper
::get_preload_record_columns_sql('ctx');
2956 $sql = "SELECT cc.*, $catcontextsql
2957 FROM {course_categories} cc
2958 JOIN {context} ctx ON cc.id = ctx.instanceid
2959 WHERE ctx.contextlevel = ".CONTEXT_COURSECAT
." AND
2960 (cc.id = :categoryid1 OR cc.parent = :categoryid2)
2961 ORDER BY cc.depth ASC, cc.sortorder ASC, cc.id ASC";
2962 $params = array('categoryid1' => $categoryid, 'categoryid2' => $categoryid);
2963 $categories = $DB->get_recordset_sql($sql, $params, 0, $limit);
2964 $categorylist = array();
2965 $subcategories = array();
2966 $basecategory = null;
2967 foreach ($categories as $category) {
2968 $categorylist[] = $category->id
;
2969 context_helper
::preload_from_record($category);
2970 if ($category->id
== $categoryid) {
2971 $this->add_category($category, $this, $nodetype);
2972 $basecategory = $this->addedcategories
[$category->id
];
2974 $subcategories[$category->id
] = $category;
2977 $categories->close();
2980 // If category is shown in MyHome then only show enrolled courses and hide empty subcategories,
2981 // else show all courses.
2982 if ($nodetype === self
::TYPE_MY_CATEGORY
) {
2983 $courses = enrol_get_my_courses();
2984 $categoryids = array();
2986 // Only search for categories if basecategory was found.
2987 if (!is_null($basecategory)) {
2988 // Get course parent category ids.
2989 foreach ($courses as $course) {
2990 $categoryids[] = $course->category
;
2993 // Get a unique list of category ids which a part of the path
2994 // to user's courses.
2995 $coursesubcategories = array();
2996 $addedsubcategories = array();
2998 list($sql, $params) = $DB->get_in_or_equal($categoryids);
2999 $categories = $DB->get_recordset_select('course_categories', 'id '.$sql, $params, 'sortorder, id', 'id, path');
3001 foreach ($categories as $category){
3002 $coursesubcategories = array_merge($coursesubcategories, explode('/', trim($category->path
, "/")));
3004 $coursesubcategories = array_unique($coursesubcategories);
3006 // Only add a subcategory if it is part of the path to user's course and
3007 // wasn't already added.
3008 foreach ($subcategories as $subid => $subcategory) {
3009 if (in_array($subid, $coursesubcategories) &&
3010 !in_array($subid, $addedsubcategories)) {
3011 $this->add_category($subcategory, $basecategory, $nodetype);
3012 $addedsubcategories[] = $subid;
3017 foreach ($courses as $course) {
3018 // Add course if it's in category.
3019 if (in_array($course->category
, $categorylist)) {
3020 $this->add_course($course, true, self
::COURSE_MY
);
3024 if (!is_null($basecategory)) {
3025 foreach ($subcategories as $key=>$category) {
3026 $this->add_category($category, $basecategory, $nodetype);
3029 $courses = $DB->get_recordset('course', array('category' => $categoryid), 'sortorder', '*' , 0, $limit);
3030 foreach ($courses as $course) {
3031 $this->add_course($course);
3038 * Returns an array of expandable nodes
3041 public function get_expandable() {
3042 return $this->expandable
;
3049 * This class is used to manage the navbar, which is initialised from the navigation
3050 * object held by PAGE
3053 * @category navigation
3054 * @copyright 2009 Sam Hemelryk
3055 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3057 class navbar
extends navigation_node
{
3058 /** @var bool A switch for whether the navbar is initialised or not */
3059 protected $initialised = false;
3060 /** @var mixed keys used to reference the nodes on the navbar */
3061 protected $keys = array();
3062 /** @var null|string content of the navbar */
3063 protected $content = null;
3064 /** @var moodle_page object the moodle page that this navbar belongs to */
3066 /** @var bool A switch for whether to ignore the active navigation information */
3067 protected $ignoreactive = false;
3068 /** @var bool A switch to let us know if we are in the middle of an install */
3069 protected $duringinstall = false;
3070 /** @var bool A switch for whether the navbar has items */
3071 protected $hasitems = false;
3072 /** @var array An array of navigation nodes for the navbar */
3074 /** @var array An array of child node objects */
3075 public $children = array();
3076 /** @var bool A switch for whether we want to include the root node in the navbar */
3077 public $includesettingsbase = false;
3078 /** @var navigation_node[] $prependchildren */
3079 protected $prependchildren = array();
3081 * The almighty constructor
3083 * @param moodle_page $page
3085 public function __construct(moodle_page
$page) {
3087 if (during_initial_install()) {
3088 $this->duringinstall
= true;
3091 $this->page
= $page;
3092 $this->text
= get_string('home');
3093 $this->shorttext
= get_string('home');
3094 $this->action
= new moodle_url($CFG->wwwroot
);
3095 $this->nodetype
= self
::NODETYPE_BRANCH
;
3096 $this->type
= self
::TYPE_SYSTEM
;
3100 * Quick check to see if the navbar will have items in.
3102 * @return bool Returns true if the navbar will have items, false otherwise
3104 public function has_items() {
3105 if ($this->duringinstall
) {
3107 } else if ($this->hasitems
!== false) {
3110 if (count($this->children
) > 0 ||
count($this->prependchildren
) > 0) {
3111 // There have been manually added items - there are definitely items.
3113 } else if (!$this->ignoreactive
) {
3114 // We will need to initialise the navigation structure to check if there are active items.
3115 $this->page
->navigation
->initialise($this->page
);
3116 $outcome = ($this->page
->navigation
->contains_active_node() ||
$this->page
->settingsnav
->contains_active_node());
3118 $this->hasitems
= $outcome;
3123 * Turn on/off ignore active
3125 * @param bool $setting
3127 public function ignore_active($setting=true) {
3128 $this->ignoreactive
= ($setting);
3132 * Gets a navigation node
3134 * @param string|int $key for referencing the navbar nodes
3135 * @param int $type navigation_node::TYPE_*
3136 * @return navigation_node|bool
3138 public function get($key, $type = null) {
3139 foreach ($this->children
as &$child) {
3140 if ($child->key
=== $key && ($type == null ||
$type == $child->type
)) {
3144 foreach ($this->prependchildren
as &$child) {
3145 if ($child->key
=== $key && ($type == null ||
$type == $child->type
)) {
3152 * Returns an array of navigation_node's that make up the navbar.
3156 public function get_items() {
3159 // Make sure that navigation is initialised
3160 if (!$this->has_items()) {
3163 if ($this->items
!== null) {
3164 return $this->items
;
3167 if (count($this->children
) > 0) {
3168 // Add the custom children.
3169 $items = array_reverse($this->children
);
3172 // Check if navigation contains the active node
3173 if (!$this->ignoreactive
) {
3174 // We will need to ensure the navigation has been initialised.
3175 $this->page
->navigation
->initialise($this->page
);
3176 // Now find the active nodes on both the navigation and settings.
3177 $navigationactivenode = $this->page
->navigation
->find_active_node();
3178 $settingsactivenode = $this->page
->settingsnav
->find_active_node();
3180 if ($navigationactivenode && $settingsactivenode) {
3181 // Parse a combined navigation tree
3182 while ($settingsactivenode && $settingsactivenode->parent
!== null) {
3183 if (!$settingsactivenode->mainnavonly
) {
3184 $items[] = $settingsactivenode;
3186 $settingsactivenode = $settingsactivenode->parent
;
3188 if (!$this->includesettingsbase
) {
3189 // Removes the first node from the settings (root node) from the list
3192 while ($navigationactivenode && $navigationactivenode->parent
!== null) {
3193 if (!$navigationactivenode->mainnavonly
) {
3194 $items[] = $navigationactivenode;
3196 if (!empty($CFG->navshowcategories
) &&
3197 $navigationactivenode->type
=== self
::TYPE_COURSE
&&
3198 $navigationactivenode->parent
->key
=== 'currentcourse') {
3199 $items = array_merge($items, $this->get_course_categories());
3201 $navigationactivenode = $navigationactivenode->parent
;
3203 } else if ($navigationactivenode) {
3204 // Parse the navigation tree to get the active node
3205 while ($navigationactivenode && $navigationactivenode->parent
!== null) {
3206 if (!$navigationactivenode->mainnavonly
) {
3207 $items[] = $navigationactivenode;
3209 if (!empty($CFG->navshowcategories
) &&
3210 $navigationactivenode->type
=== self
::TYPE_COURSE
&&
3211 $navigationactivenode->parent
->key
=== 'currentcourse') {
3212 $items = array_merge($items, $this->get_course_categories());
3214 $navigationactivenode = $navigationactivenode->parent
;
3216 } else if ($settingsactivenode) {
3217 // Parse the settings navigation to get the active node
3218 while ($settingsactivenode && $settingsactivenode->parent
!== null) {
3219 if (!$settingsactivenode->mainnavonly
) {
3220 $items[] = $settingsactivenode;
3222 $settingsactivenode = $settingsactivenode->parent
;
3227 $items[] = new navigation_node(array(
3228 'text'=>$this->page
->navigation
->text
,
3229 'shorttext'=>$this->page
->navigation
->shorttext
,
3230 'key'=>$this->page
->navigation
->key
,
3231 'action'=>$this->page
->navigation
->action
3234 if (count($this->prependchildren
) > 0) {
3235 // Add the custom children
3236 $items = array_merge($items, array_reverse($this->prependchildren
));
3239 $this->items
= array_reverse($items);
3240 return $this->items
;
3244 * Get the list of categories leading to this course.
3246 * This function is used by {@link navbar::get_items()} to add back the "courses"
3247 * node and category chain leading to the current course. Note that this is only ever
3248 * called for the current course, so we don't need to bother taking in any parameters.
3252 private function get_course_categories() {
3254 require_once($CFG->dirroot
.'/course/lib.php');
3255 require_once($CFG->libdir
.'/coursecatlib.php');
3257 $categories = array();
3258 $cap = 'moodle/category:viewhiddencategories';
3259 $showcategories = coursecat
::count_all() > 1;
3261 if ($showcategories) {
3262 foreach ($this->page
->categories
as $category) {
3263 if (!$category->visible
&& !has_capability($cap, get_category_or_system_context($category->parent
))) {
3266 $url = new moodle_url('/course/index.php', array('categoryid' => $category->id
));
3267 $name = format_string($category->name
, true, array('context' => context_coursecat
::instance($category->id
)));
3268 $categorynode = navigation_node
::create($name, $url, self
::TYPE_CATEGORY
, null, $category->id
);
3269 if (!$category->visible
) {
3270 $categorynode->hidden
= true;
3272 $categories[] = $categorynode;
3276 // Don't show the 'course' node if enrolled in this course.
3277 if (!is_enrolled(context_course
::instance($this->page
->course
->id
, null, '', true))) {
3278 $courses = $this->page
->navigation
->get('courses');
3280 // Courses node may not be present.
3281 $courses = navigation_node
::create(
3282 get_string('courses'),
3283 new moodle_url('/course/index.php'),
3284 self
::TYPE_CONTAINER
3287 $categories[] = $courses;
3294 * Add a new navigation_node to the navbar, overrides parent::add
3296 * This function overrides {@link navigation_node::add()} so that we can change
3297 * the way nodes get added to allow us to simply call add and have the node added to the
3300 * @param string $text
3301 * @param string|moodle_url|action_link $action An action to associate with this node.
3302 * @param int $type One of navigation_node::TYPE_*
3303 * @param string $shorttext
3304 * @param string|int $key A key to identify this node with. Key + type is unique to a parent.
3305 * @param pix_icon $icon An optional icon to use for this node.
3306 * @return navigation_node
3308 public function add($text, $action=null, $type=self
::TYPE_CUSTOM
, $shorttext=null, $key=null, pix_icon
$icon=null) {
3309 if ($this->content
!== null) {
3310 debugging('Nav bar items must be printed before $OUTPUT->header() has been called', DEBUG_DEVELOPER
);
3313 // Properties array used when creating the new navigation node
3318 // Set the action if one was provided
3319 if ($action!==null) {
3320 $itemarray['action'] = $action;
3322 // Set the shorttext if one was provided
3323 if ($shorttext!==null) {
3324 $itemarray['shorttext'] = $shorttext;
3326 // Set the icon if one was provided
3328 $itemarray['icon'] = $icon;
3330 // Default the key to the number of children if not provided
3331 if ($key === null) {
3332 $key = count($this->children
);
3335 $itemarray['key'] = $key;
3336 // Set the parent to this node
3337 $itemarray['parent'] = $this;
3338 // Add the child using the navigation_node_collections add method
3339 $this->children
[] = new navigation_node($itemarray);
3344 * Prepends a new navigation_node to the start of the navbar
3346 * @param string $text
3347 * @param string|moodle_url|action_link $action An action to associate with this node.
3348 * @param int $type One of navigation_node::TYPE_*
3349 * @param string $shorttext
3350 * @param string|int $key A key to identify this node with. Key + type is unique to a parent.
3351 * @param pix_icon $icon An optional icon to use for this node.
3352 * @return navigation_node
3354 public function prepend($text, $action=null, $type=self
::TYPE_CUSTOM
, $shorttext=null, $key=null, pix_icon
$icon=null) {
3355 if ($this->content
!== null) {
3356 debugging('Nav bar items must be printed before $OUTPUT->header() has been called', DEBUG_DEVELOPER
);
3358 // Properties array used when creating the new navigation node.
3363 // Set the action if one was provided.
3364 if ($action!==null) {
3365 $itemarray['action'] = $action;
3367 // Set the shorttext if one was provided.
3368 if ($shorttext!==null) {
3369 $itemarray['shorttext'] = $shorttext;
3371 // Set the icon if one was provided.
3373 $itemarray['icon'] = $icon;
3375 // Default the key to the number of children if not provided.
3376 if ($key === null) {
3377 $key = count($this->children
);
3380 $itemarray['key'] = $key;
3381 // Set the parent to this node.
3382 $itemarray['parent'] = $this;
3383 // Add the child node to the prepend list.
3384 $this->prependchildren
[] = new navigation_node($itemarray);
3390 * Class used to manage the settings option for the current page
3392 * This class is used to manage the settings options in a tree format (recursively)
3393 * and was created initially for use with the settings blocks.
3396 * @category navigation
3397 * @copyright 2009 Sam Hemelryk
3398 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3400 class settings_navigation
extends navigation_node
{
3401 /** @var stdClass the current context */
3403 /** @var moodle_page the moodle page that the navigation belongs to */
3405 /** @var string contains administration section navigation_nodes */
3406 protected $adminsection;
3407 /** @var bool A switch to see if the navigation node is initialised */
3408 protected $initialised = false;
3409 /** @var array An array of users that the nodes can extend for. */
3410 protected $userstoextendfor = array();
3411 /** @var navigation_cache **/
3415 * Sets up the object with basic settings and preparse it for use
3417 * @param moodle_page $page
3419 public function __construct(moodle_page
&$page) {
3420 if (during_initial_install()) {
3423 $this->page
= $page;
3424 // Initialise the main navigation. It is most important that this is done
3425 // before we try anything
3426 $this->page
->navigation
->initialise();
3427 // Initialise the navigation cache
3428 $this->cache
= new navigation_cache(NAVIGATION_CACHE_NAME
);
3429 $this->children
= new navigation_node_collection();
3432 * Initialise the settings navigation based on the current context
3434 * This function initialises the settings navigation tree for a given context
3435 * by calling supporting functions to generate major parts of the tree.
3438 public function initialise() {
3439 global $DB, $SESSION, $SITE;
3441 if (during_initial_install()) {
3443 } else if ($this->initialised
) {
3446 $this->id
= 'settingsnav';
3447 $this->context
= $this->page
->context
;
3449 $context = $this->context
;
3450 if ($context->contextlevel
== CONTEXT_BLOCK
) {
3451 $this->load_block_settings();
3452 $context = $context->get_parent_context();
3454 switch ($context->contextlevel
) {
3455 case CONTEXT_SYSTEM
:
3456 if ($this->page
->url
->compare(new moodle_url('/admin/settings.php', array('section'=>'frontpagesettings')))) {
3457 $this->load_front_page_settings(($context->id
== $this->context
->id
));
3460 case CONTEXT_COURSECAT
:
3461 $this->load_category_settings();
3463 case CONTEXT_COURSE
:
3464 if ($this->page
->course
->id
!= $SITE->id
) {
3465 $this->load_course_settings(($context->id
== $this->context
->id
));
3467 $this->load_front_page_settings(($context->id
== $this->context
->id
));
3470 case CONTEXT_MODULE
:
3471 $this->load_module_settings();
3472 $this->load_course_settings();
3475 if ($this->page
->course
->id
!= $SITE->id
) {
3476 $this->load_course_settings();
3481 $usersettings = $this->load_user_settings($this->page
->course
->id
);
3483 $adminsettings = false;
3484 if (isloggedin() && !isguestuser() && (!isset($SESSION->load_navigation_admin
) ||
$SESSION->load_navigation_admin
)) {
3485 $isadminpage = $this->is_admin_tree_needed();
3487 if (has_capability('moodle/site:config', context_system
::instance())) {
3488 // Make sure this works even if config capability changes on the fly
3489 // and also make it fast for admin right after login.
3490 $SESSION->load_navigation_admin
= 1;
3492 $adminsettings = $this->load_administration_settings();
3495 } else if (!isset($SESSION->load_navigation_admin
)) {
3496 $adminsettings = $this->load_administration_settings();
3497 $SESSION->load_navigation_admin
= (int)($adminsettings->children
->count() > 0);
3499 } else if ($SESSION->load_navigation_admin
) {
3501 $adminsettings = $this->load_administration_settings();
3505 // Print empty navigation node, if needed.
3506 if ($SESSION->load_navigation_admin
&& !$isadminpage) {
3507 if ($adminsettings) {
3508 // Do not print settings tree on pages that do not need it, this helps with performance.
3509 $adminsettings->remove();
3510 $adminsettings = false;
3512 $siteadminnode = $this->add(get_string('administrationsite'), new moodle_url('/admin'), self
::TYPE_SITE_ADMIN
, null, 'siteadministration');
3513 $siteadminnode->id
= 'expandable_branch_'.$siteadminnode->type
.'_'.clean_param($siteadminnode->key
, PARAM_ALPHANUMEXT
);
3514 $this->page
->requires
->data_for_js('siteadminexpansion', $siteadminnode);
3518 if ($context->contextlevel
== CONTEXT_SYSTEM
&& $adminsettings) {
3519 $adminsettings->force_open();
3520 } else if ($context->contextlevel
== CONTEXT_USER
&& $usersettings) {
3521 $usersettings->force_open();
3524 // At this point we give any local plugins the ability to extend/tinker with the navigation settings.
3525 $this->load_local_plugin_settings();
3527 foreach ($this->children
as $key=>$node) {
3528 if ($node->nodetype
== self
::NODETYPE_BRANCH
&& $node->children
->count() == 0) {
3529 // Site administration is shown as link.
3530 if (!empty($SESSION->load_navigation_admin
) && ($node->type
=== self
::TYPE_SITE_ADMIN
)) {
3536 $this->initialised
= true;
3539 * Override the parent function so that we can add preceeding hr's and set a
3540 * root node class against all first level element
3542 * It does this by first calling the parent's add method {@link navigation_node::add()}
3543 * and then proceeds to use the key to set class and hr
3545 * @param string $text text to be used for the link.
3546 * @param string|moodle_url $url url for the new node
3547 * @param int $type the type of node navigation_node::TYPE_*
3548 * @param string $shorttext
3549 * @param string|int $key a key to access the node by.
3550 * @param pix_icon $icon An icon that appears next to the node.
3551 * @return navigation_node with the new node added to it.
3553 public function add($text, $url=null, $type=null, $shorttext=null, $key=null, pix_icon
$icon=null) {
3554 $node = parent
::add($text, $url, $type, $shorttext, $key, $icon);
3555 $node->add_class('root_node');
3560 * This function allows the user to add something to the start of the settings
3561 * navigation, which means it will be at the top of the settings navigation block
3563 * @param string $text text to be used for the link.
3564 * @param string|moodle_url $url url for the new node
3565 * @param int $type the type of node navigation_node::TYPE_*
3566 * @param string $shorttext
3567 * @param string|int $key a key to access the node by.
3568 * @param pix_icon $icon An icon that appears next to the node.
3569 * @return navigation_node $node with the new node added to it.
3571 public function prepend($text, $url=null, $type=null, $shorttext=null, $key=null, pix_icon
$icon=null) {
3572 $children = $this->children
;
3573 $childrenclass = get_class($children);
3574 $this->children
= new $childrenclass;
3575 $node = $this->add($text, $url, $type, $shorttext, $key, $icon);
3576 foreach ($children as $child) {
3577 $this->children
->add($child);
3583 * Does this page require loading of full admin tree or is
3584 * it enough rely on AJAX?
3588 protected function is_admin_tree_needed() {
3589 if (self
::$loadadmintree) {
3590 // Usually external admin page or settings page.
3594 if ($this->page
->pagelayout
=== 'admin' or strpos($this->page
->pagetype
, 'admin-') === 0) {
3595 // Admin settings tree is intended for system level settings and management only, use navigation for the rest!
3596 if ($this->page
->context
->contextlevel
!= CONTEXT_SYSTEM
) {
3606 * Load the site administration tree
3608 * This function loads the site administration tree by using the lib/adminlib library functions
3610 * @param navigation_node $referencebranch A reference to a branch in the settings
3612 * @param part_of_admin_tree $adminbranch The branch to add, if null generate the admin
3613 * tree and start at the beginning
3614 * @return mixed A key to access the admin tree by
3616 protected function load_administration_settings(navigation_node
$referencebranch=null, part_of_admin_tree
$adminbranch=null) {
3619 // Check if we are just starting to generate this navigation.
3620 if ($referencebranch === null) {
3622 // Require the admin lib then get an admin structure
3623 if (!function_exists('admin_get_root')) {
3624 require_once($CFG->dirroot
.'/lib/adminlib.php');
3626 $adminroot = admin_get_root(false, false);
3627 // This is the active section identifier
3628 $this->adminsection
= $this->page
->url
->param('section');
3630 // Disable the navigation from automatically finding the active node
3631 navigation_node
::$autofindactive = false;
3632 $referencebranch = $this->add(get_string('administrationsite'), null, self
::TYPE_SITE_ADMIN
, null, 'root');
3633 foreach ($adminroot->children
as $adminbranch) {
3634 $this->load_administration_settings($referencebranch, $adminbranch);
3636 navigation_node
::$autofindactive = true;
3638 // Use the admin structure to locate the active page
3639 if (!$this->contains_active_node() && $current = $adminroot->locate($this->adminsection
, true)) {
3640 $currentnode = $this;
3641 while (($pathkey = array_pop($current->path
))!==null && $currentnode) {
3642 $currentnode = $currentnode->get($pathkey);
3645 $currentnode->make_active();
3648 $this->scan_for_active_node($referencebranch);
3650 return $referencebranch;
3651 } else if ($adminbranch->check_access()) {
3652 // We have a reference branch that we can access and is not hidden `hurrah`
3653 // Now we need to display it and any children it may have
3656 if ($adminbranch instanceof admin_settingpage
) {
3657 $url = new moodle_url('/'.$CFG->admin
.'/settings.php', array('section'=>$adminbranch->name
));
3658 } else if ($adminbranch instanceof admin_externalpage
) {
3659 $url = $adminbranch->url
;
3660 } else if (!empty($CFG->linkadmincategories
) && $adminbranch instanceof admin_category
) {
3661 $url = new moodle_url('/'.$CFG->admin
.'/category.php', array('category' => $adminbranch->name
));
3665 $reference = $referencebranch->add($adminbranch->visiblename
, $url, self
::TYPE_SETTING
, null, $adminbranch->name
, $icon);
3667 if ($adminbranch->is_hidden()) {
3668 if (($adminbranch instanceof admin_externalpage ||
$adminbranch instanceof admin_settingpage
) && $adminbranch->name
== $this->adminsection
) {
3669 $reference->add_class('hidden');
3671 $reference->display
= false;
3675 // Check if we are generating the admin notifications and whether notificiations exist
3676 if ($adminbranch->name
=== 'adminnotifications' && admin_critical_warnings_present()) {
3677 $reference->add_class('criticalnotification');
3679 // Check if this branch has children
3680 if ($reference && isset($adminbranch->children
) && is_array($adminbranch->children
) && count($adminbranch->children
)>0) {
3681 foreach ($adminbranch->children
as $branch) {
3682 // Generate the child branches as well now using this branch as the reference
3683 $this->load_administration_settings($reference, $branch);
3686 $reference->icon
= new pix_icon('i/settings', '');
3692 * This function recursivily scans nodes until it finds the active node or there
3693 * are no more nodes.
3694 * @param navigation_node $node
3696 protected function scan_for_active_node(navigation_node
$node) {
3697 if (!$node->check_if_active() && $node->children
->count()>0) {
3698 foreach ($node->children
as &$child) {
3699 $this->scan_for_active_node($child);
3705 * Gets a navigation node given an array of keys that represent the path to
3708 * @param array $path
3709 * @return navigation_node|false
3711 protected function get_by_path(array $path) {
3712 $node = $this->get(array_shift($path));
3713 foreach ($path as $key) {
3720 * This function loads the course settings that are available for the user
3722 * @param bool $forceopen If set to true the course node will be forced open
3723 * @return navigation_node|false
3725 protected function load_course_settings($forceopen = false) {
3728 $course = $this->page
->course
;
3729 $coursecontext = context_course
::instance($course->id
);
3731 // note: do not test if enrolled or viewing here because we need the enrol link in Course administration section
3733 $coursenode = $this->add(get_string('courseadministration'), null, self
::TYPE_COURSE
, null, 'courseadmin');
3735 $coursenode->force_open();
3738 if ($this->page
->user_allowed_editing()) {
3739 // Add the turn on/off settings
3741 if ($this->page
->url
->compare(new moodle_url('/course/view.php'), URL_MATCH_BASE
)) {
3742 // We are on the course page, retain the current page params e.g. section.
3743 $baseurl = clone($this->page
->url
);
3744 $baseurl->param('sesskey', sesskey());
3746 // Edit on the main course page.
3747 $baseurl = new moodle_url('/course/view.php', array('id'=>$course->id
, 'return'=>$this->page
->url
->out_as_local_url(false), 'sesskey'=>sesskey()));
3750 $editurl = clone($baseurl);
3751 if ($this->page
->user_is_editing()) {
3752 $editurl->param('edit', 'off');
3753 $editstring = get_string('turneditingoff');
3755 $editurl->param('edit', 'on');
3756 $editstring = get_string('turneditingon');
3758 $coursenode->add($editstring, $editurl, self
::TYPE_SETTING
, null, 'turneditingonoff', new pix_icon('i/edit', ''));
3761 if (has_capability('moodle/course:update', $coursecontext)) {
3762 // Add the course settings link
3763 $url = new moodle_url('/course/edit.php', array('id'=>$course->id
));
3764 $coursenode->add(get_string('editsettings'), $url, self
::TYPE_SETTING
, null, 'editsettings', new pix_icon('i/settings', ''));
3766 // Add the course completion settings link
3767 if ($CFG->enablecompletion
&& $course->enablecompletion
) {
3768 $url = new moodle_url('/course/completion.php', array('id'=>$course->id
));
3769 $coursenode->add(get_string('coursecompletion', 'completion'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/settings', ''));
3771 } else if (has_capability('moodle/course:tag', $coursecontext)) {
3772 $url = new moodle_url('/course/tags.php', array('id' => $course->id
));
3773 $coursenode->add(get_string('coursetags', 'tag'), $url, self
::TYPE_SETTING
, null, 'coursetags', new pix_icon('i/settings', ''));
3777 enrol_add_course_navigation($coursenode, $course);
3780 if (has_capability('moodle/filter:manage', $coursecontext) && count(filter_get_available_in_context($coursecontext))>0) {
3781 $url = new moodle_url('/filter/manage.php', array('contextid'=>$coursecontext->id
));
3782 $coursenode->add(get_string('filters', 'admin'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/filter', ''));
3785 // View course reports.
3786 if (has_capability('moodle/site:viewreports', $coursecontext)) { // Basic capability for listing of reports.
3787 $reportnav = $coursenode->add(get_string('reports'), null, self
::TYPE_CONTAINER
, null, 'coursereports',
3788 new pix_icon('i/stats', ''));
3789 $coursereports = core_component
::get_plugin_list('coursereport');
3790 foreach ($coursereports as $report => $dir) {
3791 $libfile = $CFG->dirroot
.'/course/report/'.$report.'/lib.php';
3792 if (file_exists($libfile)) {
3793 require_once($libfile);
3794 $reportfunction = $report.'_report_extend_navigation';
3795 if (function_exists($report.'_report_extend_navigation')) {
3796 $reportfunction($reportnav, $course, $coursecontext);
3801 $reports = get_plugin_list_with_function('report', 'extend_navigation_course', 'lib.php');
3802 foreach ($reports as $reportfunction) {
3803 $reportfunction($reportnav, $course, $coursecontext);
3807 // Add view grade report is permitted
3808 $reportavailable = false;
3809 if (has_capability('moodle/grade:viewall', $coursecontext)) {
3810 $reportavailable = true;
3811 } else if (!empty($course->showgrades
)) {
3812 $reports = core_component
::get_plugin_list('gradereport');
3813 if (is_array($reports) && count($reports)>0) { // Get all installed reports
3814 arsort($reports); // user is last, we want to test it first
3815 foreach ($reports as $plugin => $plugindir) {
3816 if (has_capability('gradereport/'.$plugin.':view', $coursecontext)) {
3817 //stop when the first visible plugin is found
3818 $reportavailable = true;
3824 if ($reportavailable) {
3825 $url = new moodle_url('/grade/report/index.php', array('id'=>$course->id
));
3826 $gradenode = $coursenode->add(get_string('grades'), $url, self
::TYPE_SETTING
, null, 'grades', new pix_icon('i/grades', ''));
3829 // Check if we can view the gradebook's setup page.
3830 if (has_capability('moodle/grade:manage', $coursecontext)) {
3831 $url = new moodle_url('/grade/edit/tree/index.php', array('id' => $course->id
));
3832 $coursenode->add(get_string('gradebooksetup', 'grades'), $url, self
::TYPE_SETTING
,
3833 null, 'gradebooksetup', new pix_icon('i/settings', ''));
3836 // Add outcome if permitted
3837 if (!empty($CFG->enableoutcomes
) && has_capability('moodle/course:update', $coursecontext)) {
3838 $url = new moodle_url('/grade/edit/outcome/course.php', array('id'=>$course->id
));
3839 $coursenode->add(get_string('outcomes', 'grades'), $url, self
::TYPE_SETTING
, null, 'outcomes', new pix_icon('i/outcomes', ''));
3842 //Add badges navigation
3843 require_once($CFG->libdir
.'/badgeslib.php');
3844 badges_add_course_navigation($coursenode, $course);
3846 // Backup this course
3847 if (has_capability('moodle/backup:backupcourse', $coursecontext)) {
3848 $url = new moodle_url('/backup/backup.php', array('id'=>$course->id
));
3849 $coursenode->add(get_string('backup'), $url, self
::TYPE_SETTING
, null, 'backup', new pix_icon('i/backup', ''));
3852 // Restore to this course
3853 if (has_capability('moodle/restore:restorecourse', $coursecontext)) {
3854 $url = new moodle_url('/backup/restorefile.php', array('contextid'=>$coursecontext->id
));
3855 $coursenode->add(get_string('restore'), $url, self
::TYPE_SETTING
, null, 'restore', new pix_icon('i/restore', ''));
3858 // Import data from other courses
3859 if (has_capability('moodle/restore:restoretargetimport', $coursecontext)) {
3860 $url = new moodle_url('/backup/import.php', array('id'=>$course->id
));
3861 $coursenode->add(get_string('import'), $url, self
::TYPE_SETTING
, null, 'import', new pix_icon('i/import', ''));
3864 // Publish course on a hub
3865 if (has_capability('moodle/course:publish', $coursecontext)) {
3866 $url = new moodle_url('/course/publish/index.php', array('id'=>$course->id
));
3867 $coursenode->add(get_string('publish'), $url, self
::TYPE_SETTING
, null, 'publish', new pix_icon('i/publish', ''));
3870 // Reset this course
3871 if (has_capability('moodle/course:reset', $coursecontext)) {
3872 $url = new moodle_url('/course/reset.php', array('id'=>$course->id
));
3873 $coursenode->add(get_string('reset'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/return', ''));
3877 require_once($CFG->libdir
. '/questionlib.php');
3878 question_extend_settings_navigation($coursenode, $coursecontext)->trim_if_empty();
3880 if (has_capability('moodle/course:update', $coursecontext)) {
3881 // Repository Instances
3882 if (!$this->cache
->cached('contexthasrepos'.$coursecontext->id
)) {
3883 require_once($CFG->dirroot
. '/repository/lib.php');
3884 $editabletypes = repository
::get_editable_types($coursecontext);
3885 $haseditabletypes = !empty($editabletypes);
3886 unset($editabletypes);
3887 $this->cache
->set('contexthasrepos'.$coursecontext->id
, $haseditabletypes);
3889 $haseditabletypes = $this->cache
->{'contexthasrepos'.$coursecontext->id
};
3891 if ($haseditabletypes) {
3892 $url = new moodle_url('/repository/manage_instances.php', array('contextid' => $coursecontext->id
));
3893 $coursenode->add(get_string('repositories'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/repository', ''));
3898 if ($course->legacyfiles
== 2 and has_capability('moodle/course:managefiles', $coursecontext)) {
3899 // hidden in new courses and courses where legacy files were turned off
3900 $url = new moodle_url('/files/index.php', array('contextid'=>$coursecontext->id
));
3901 $coursenode->add(get_string('courselegacyfiles'), $url, self
::TYPE_SETTING
, null, 'coursefiles', new pix_icon('i/folder', ''));
3907 $assumedrole = $this->in_alternative_role();
3908 if ($assumedrole !== false) {
3909 $roles[0] = get_string('switchrolereturn');
3911 if (has_capability('moodle/role:switchroles', $coursecontext)) {
3912 $availableroles = get_switchable_roles($coursecontext);
3913 if (is_array($availableroles)) {
3914 foreach ($availableroles as $key=>$role) {
3915 if ($assumedrole == (int)$key) {
3918 $roles[$key] = $role;
3922 if (is_array($roles) && count($roles)>0) {
3923 $switchroles = $this->add(get_string('switchroleto'));
3924 if ((count($roles)==1 && array_key_exists(0, $roles))||
$assumedrole!==false) {
3925 $switchroles->force_open();
3927 foreach ($roles as $key => $name) {
3928 $url = new moodle_url('/course/switchrole.php', array('id'=>$course->id
, 'sesskey'=>sesskey(), 'switchrole'=>$key, 'returnurl'=>$this->page
->url
->out_as_local_url(false)));
3929 $switchroles->add($name, $url, self
::TYPE_SETTING
, null, $key, new pix_icon('i/switchrole', ''));
3933 // Let plugins hook into course navigation.
3934 $pluginsfunction = get_plugins_with_function('extend_navigation_course', 'lib.php');
3935 foreach ($pluginsfunction as $plugintype => $plugins) {
3936 // Ignore the report plugin as it was already loaded above.
3937 if ($plugintype == 'report') {
3940 foreach ($plugins as $pluginfunction) {
3941 $pluginfunction($coursenode, $course, $coursecontext);
3945 // Return we are done
3950 * This function calls the module function to inject module settings into the
3951 * settings navigation tree.
3953 * This only gets called if there is a corrosponding function in the modules
3956 * For examples mod/forum/lib.php {@link forum_extend_settings_navigation()}
3958 * @return navigation_node|false
3960 protected function load_module_settings() {
3963 if (!$this->page
->cm
&& $this->context
->contextlevel
== CONTEXT_MODULE
&& $this->context
->instanceid
) {
3964 $cm = get_coursemodule_from_id(false, $this->context
->instanceid
, 0, false, MUST_EXIST
);
3965 $this->page
->set_cm($cm, $this->page
->course
);
3968 $file = $CFG->dirroot
.'/mod/'.$this->page
->activityname
.'/lib.php';
3969 if (file_exists($file)) {
3970 require_once($file);
3973 $modulenode = $this->add(get_string('pluginadministration', $this->page
->activityname
), null, self
::TYPE_SETTING
, null, 'modulesettings');
3974 $modulenode->nodetype
= navigation_node
::NODETYPE_BRANCH
;
3975 $modulenode->force_open();
3977 // Settings for the module
3978 if (has_capability('moodle/course:manageactivities', $this->page
->cm
->context
)) {
3979 $url = new moodle_url('/course/modedit.php', array('update' => $this->page
->cm
->id
, 'return' => 1));
3980 $modulenode->add(get_string('editsettings'), $url, navigation_node
::TYPE_SETTING
, null, 'modedit');
3982 // Assign local roles
3983 if (count(get_assignable_roles($this->page
->cm
->context
))>0) {
3984 $url = new moodle_url('/'.$CFG->admin
.'/roles/assign.php', array('contextid'=>$this->page
->cm
->context
->id
));
3985 $modulenode->add(get_string('localroles', 'role'), $url, self
::TYPE_SETTING
, null, 'roleassign');
3988 if (has_capability('moodle/role:review', $this->page
->cm
->context
) or count(get_overridable_roles($this->page
->cm
->context
))>0) {
3989 $url = new moodle_url('/'.$CFG->admin
.'/roles/permissions.php', array('contextid'=>$this->page
->cm
->context
->id
));
3990 $modulenode->add(get_string('permissions', 'role'), $url, self
::TYPE_SETTING
, null, 'roleoverride');
3992 // Check role permissions
3993 if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:assign'), $this->page
->cm
->context
)) {
3994 $url = new moodle_url('/'.$CFG->admin
.'/roles/check.php', array('contextid'=>$this->page
->cm
->context
->id
));
3995 $modulenode->add(get_string('checkpermissions', 'role'), $url, self
::TYPE_SETTING
, null, 'rolecheck');
3998 if (has_capability('moodle/filter:manage', $this->page
->cm
->context
) && count(filter_get_available_in_context($this->page
->cm
->context
))>0) {
3999 $url = new moodle_url('/filter/manage.php', array('contextid'=>$this->page
->cm
->context
->id
));
4000 $modulenode->add(get_string('filters', 'admin'), $url, self
::TYPE_SETTING
, null, 'filtermanage');
4003 $reports = get_plugin_list_with_function('report', 'extend_navigation_module', 'lib.php');
4004 foreach ($reports as $reportfunction) {
4005 $reportfunction($modulenode, $this->page
->cm
);
4007 // Add a backup link
4008 $featuresfunc = $this->page
->activityname
.'_supports';
4009 if (function_exists($featuresfunc) && $featuresfunc(FEATURE_BACKUP_MOODLE2
) && has_capability('moodle/backup:backupactivity', $this->page
->cm
->context
)) {
4010 $url = new moodle_url('/backup/backup.php', array('id'=>$this->page
->cm
->course
, 'cm'=>$this->page
->cm
->id
));
4011 $modulenode->add(get_string('backup'), $url, self
::TYPE_SETTING
, null, 'backup');
4014 // Restore this activity
4015 $featuresfunc = $this->page
->activityname
.'_supports';
4016 if (function_exists($featuresfunc) && $featuresfunc(FEATURE_BACKUP_MOODLE2
) && has_capability('moodle/restore:restoreactivity', $this->page
->cm
->context
)) {
4017 $url = new moodle_url('/backup/restorefile.php', array('contextid'=>$this->page
->cm
->context
->id
));
4018 $modulenode->add(get_string('restore'), $url, self
::TYPE_SETTING
, null, 'restore');
4021 // Allow the active advanced grading method plugin to append its settings
4022 $featuresfunc = $this->page
->activityname
.'_supports';
4023 if (function_exists($featuresfunc) && $featuresfunc(FEATURE_ADVANCED_GRADING
) && has_capability('moodle/grade:managegradingforms', $this->page
->cm
->context
)) {
4024 require_once($CFG->dirroot
.'/grade/grading/lib.php');
4025 $gradingman = get_grading_manager($this->page
->cm
->context
, 'mod_'.$this->page
->activityname
);
4026 $gradingman->extend_settings_navigation($this, $modulenode);
4029 $function = $this->page
->activityname
.'_extend_settings_navigation';
4030 if (function_exists($function)) {
4031 $function($this, $modulenode);
4034 // Remove the module node if there are no children.
4035 if ($modulenode->children
->count() <= 0) {
4036 $modulenode->remove();
4043 * Loads the user settings block of the settings nav
4045 * This function is simply works out the userid and whether we need to load
4046 * just the current users profile settings, or the current user and the user the
4047 * current user is viewing.
4049 * This function has some very ugly code to work out the user, if anyone has
4050 * any bright ideas please feel free to intervene.
4052 * @param int $courseid The course id of the current course
4053 * @return navigation_node|false
4055 protected function load_user_settings($courseid = SITEID
) {
4058 if (isguestuser() ||
!isloggedin()) {
4062 $navusers = $this->page
->navigation
->get_extending_users();
4064 if (count($this->userstoextendfor
) > 0 ||
count($navusers) > 0) {
4066 foreach ($this->userstoextendfor
as $userid) {
4067 if ($userid == $USER->id
) {
4070 $node = $this->generate_user_settings($courseid, $userid, 'userviewingsettings');
4071 if (is_null($usernode)) {
4075 foreach ($navusers as $user) {
4076 if ($user->id
== $USER->id
) {
4079 $node = $this->generate_user_settings($courseid, $user->id
, 'userviewingsettings');
4080 if (is_null($usernode)) {
4084 $this->generate_user_settings($courseid, $USER->id
);
4086 $usernode = $this->generate_user_settings($courseid, $USER->id
);
4092 * Extends the settings navigation for the given user.
4094 * Note: This method gets called automatically if you call
4095 * $PAGE->navigation->extend_for_user($userid)
4097 * @param int $userid
4099 public function extend_for_user($userid) {
4102 if (!in_array($userid, $this->userstoextendfor
)) {
4103 $this->userstoextendfor
[] = $userid;
4104 if ($this->initialised
) {
4105 $this->generate_user_settings($this->page
->course
->id
, $userid, 'userviewingsettings');
4106 $children = array();
4107 foreach ($this->children
as $child) {
4108 $children[] = $child;
4110 array_unshift($children, array_pop($children));
4111 $this->children
= new navigation_node_collection();
4112 foreach ($children as $child) {
4113 $this->children
->add($child);
4120 * This function gets called by {@link settings_navigation::load_user_settings()} and actually works out
4121 * what can be shown/done
4123 * @param int $courseid The current course' id
4124 * @param int $userid The user id to load for
4125 * @param string $gstitle The string to pass to get_string for the branch title
4126 * @return navigation_node|false
4128 protected function generate_user_settings($courseid, $userid, $gstitle='usercurrentsettings') {
4129 global $DB, $CFG, $USER, $SITE;
4131 if ($courseid != $SITE->id
) {
4132 if (!empty($this->page
->course
->id
) && $this->page
->course
->id
== $courseid) {
4133 $course = $this->page
->course
;
4135 $select = context_helper
::get_preload_record_columns_sql('ctx');
4136 $sql = "SELECT c.*, $select
4138 JOIN {context} ctx ON c.id = ctx.instanceid
4139 WHERE c.id = :courseid AND ctx.contextlevel = :contextlevel";
4140 $params = array('courseid' => $courseid, 'contextlevel' => CONTEXT_COURSE
);
4141 $course = $DB->get_record_sql($sql, $params, MUST_EXIST
);
4142 context_helper
::preload_from_record($course);
4148 $coursecontext = context_course
::instance($course->id
); // Course context
4149 $systemcontext = context_system
::instance();
4150 $currentuser = ($USER->id
== $userid);
4154 $usercontext = context_user
::instance($user->id
); // User context
4156 $select = context_helper
::get_preload_record_columns_sql('ctx');
4157 $sql = "SELECT u.*, $select
4159 JOIN {context} ctx ON u.id = ctx.instanceid
4160 WHERE u.id = :userid AND ctx.contextlevel = :contextlevel";
4161 $params = array('userid' => $userid, 'contextlevel' => CONTEXT_USER
);
4162 $user = $DB->get_record_sql($sql, $params, IGNORE_MISSING
);
4166 context_helper
::preload_from_record($user);
4168 // Check that the user can view the profile
4169 $usercontext = context_user
::instance($user->id
); // User context
4170 $canviewuser = has_capability('moodle/user:viewdetails', $usercontext);
4172 if ($course->id
== $SITE->id
) {
4173 if ($CFG->forceloginforprofiles
&& !has_coursecontact_role($user->id
) && !$canviewuser) { // Reduce possibility of "browsing" userbase at site level
4174 // Teachers can browse and be browsed at site level. If not forceloginforprofiles, allow access (bug #4366)
4178 $canviewusercourse = has_capability('moodle/user:viewdetails', $coursecontext);
4179 $userisenrolled = is_enrolled($coursecontext, $user->id
, '', true);
4180 if ((!$canviewusercourse && !$canviewuser) ||
!$userisenrolled) {
4183 $canaccessallgroups = has_capability('moodle/site:accessallgroups', $coursecontext);
4184 if (!$canaccessallgroups && groups_get_course_groupmode($course) == SEPARATEGROUPS
&& !$canviewuser) {
4185 // If groups are in use, make sure we can see that group (MDL-45874). That does not apply to parents.
4186 if ($courseid == $this->page
->course
->id
) {
4187 $mygroups = get_fast_modinfo($this->page
->course
)->groups
;
4189 $mygroups = groups_get_user_groups($courseid);
4191 $usergroups = groups_get_user_groups($courseid, $userid);
4192 if (!array_intersect_key($mygroups[0], $usergroups[0])) {
4199 $fullname = fullname($user, has_capability('moodle/site:viewfullnames', $this->page
->context
));
4202 $prefurl = new moodle_url('/user/preferences.php');
4203 if ($gstitle != 'usercurrentsettings') {
4205 $prefurl->param('userid', $userid);
4208 // Add a user setting branch.
4209 if ($gstitle == 'usercurrentsettings') {
4210 $dashboard = $this->add(get_string('myhome'), new moodle_url('/my/'), self
::TYPE_CONTAINER
, null, 'dashboard');
4211 // This should be set to false as we don't want to show this to the user. It's only for generating the correct
4213 $dashboard->display
= false;
4214 if (get_home_page() == HOMEPAGE_MY
) {
4215 $dashboard->mainnavonly
= true;
4218 $iscurrentuser = ($user->id
== $USER->id
);
4220 $baseargs = array('id' => $user->id
);
4221 if ($course->id
!= $SITE->id
&& !$iscurrentuser) {
4222 $baseargs['course'] = $course->id
;
4223 $issitecourse = false;
4225 // Load all categories and get the context for the system.
4226 $issitecourse = true;
4229 // Add the user profile to the dashboard.
4230 $profilenode = $dashboard->add(get_string('profile'), new moodle_url('/user/profile.php',
4231 array('id' => $user->id
)), self
::TYPE_SETTING
, null, 'myprofile');
4233 if (!empty($CFG->navadduserpostslinks
)) {
4234 // Add nodes for forum posts and discussions if the user can view either or both
4235 // There are no capability checks here as the content of the page is based
4236 // purely on the forums the current user has access too.
4237 $forumtab = $profilenode->add(get_string('forumposts', 'forum'));
4238 $forumtab->add(get_string('posts', 'forum'), new moodle_url('/mod/forum/user.php', $baseargs), null, 'myposts');
4239 $forumtab->add(get_string('discussions', 'forum'), new moodle_url('/mod/forum/user.php',
4240 array_merge($baseargs, array('mode' => 'discussions'))), null, 'mydiscussions');
4244 if (!empty($CFG->enableblogs
)) {
4245 if (!$this->cache
->cached('userblogoptions'.$user->id
)) {
4246 require_once($CFG->dirroot
.'/blog/lib.php');
4247 // Get all options for the user.
4248 $options = blog_get_options_for_user($user);
4249 $this->cache
->set('userblogoptions'.$user->id
, $options);
4251 $options = $this->cache
->{'userblogoptions'.$user->id
};
4254 if (count($options) > 0) {
4255 $blogs = $profilenode->add(get_string('blogs', 'blog'), null, navigation_node
::TYPE_CONTAINER
);
4256 foreach ($options as $type => $option) {
4257 if ($type == "rss") {
4258 $blogs->add($option['string'], $option['link'], self
::TYPE_SETTING
, null, null,
4259 new pix_icon('i/rss', ''));
4261 $blogs->add($option['string'], $option['link'], self
::TYPE_SETTING
, null, 'blog' . $type);
4267 // Add the messages link.
4268 // It is context based so can appear in the user's profile and in course participants information.
4269 if (!empty($CFG->messaging
)) {
4270 $messageargs = array('user1' => $USER->id
);
4271 if ($USER->id
!= $user->id
) {
4272 $messageargs['user2'] = $user->id
;
4274 if ($course->id
!= $SITE->id
) {
4275 $messageargs['viewing'] = MESSAGE_VIEW_COURSE
. $course->id
;
4277 $url = new moodle_url('/message/index.php', $messageargs);
4278 $dashboard->add(get_string('messages', 'message'), $url, self
::TYPE_SETTING
, null, 'messages');
4281 // Add the "My private files" link.
4282 // This link doesn't have a unique display for course context so only display it under the user's profile.
4283 if ($issitecourse && $iscurrentuser && has_capability('moodle/user:manageownfiles', $usercontext)) {
4284 $url = new moodle_url('/user/files.php');
4285 $dashboard->add(get_string('privatefiles'), $url, self
::TYPE_SETTING
);
4288 // Add a node to view the users notes if permitted.
4289 if (!empty($CFG->enablenotes
) &&
4290 has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $coursecontext)) {
4291 $url = new moodle_url('/notes/index.php', array('user' => $user->id
));
4292 if ($coursecontext->instanceid
!= SITEID
) {
4293 $url->param('course', $coursecontext->instanceid
);
4295 $profilenode->add(get_string('notes', 'notes'), $url);
4298 // Show the grades node.
4299 if (($issitecourse && $iscurrentuser) ||
has_capability('moodle/user:viewdetails', $usercontext)) {
4300 require_once($CFG->dirroot
. '/user/lib.php');
4301 // Set the grades node to link to the "Grades" page.
4302 if ($course->id
== SITEID
) {
4303 $url = user_mygrades_url($user->id
, $course->id
);
4304 } else { // Otherwise we are in a course and should redirect to the user grade report (Activity report version).
4305 $url = new moodle_url('/course/user.php', array('mode' => 'grade', 'id' => $course->id
, 'user' => $user->id
));
4307 $dashboard->add(get_string('grades', 'grades'), $url, self
::TYPE_SETTING
, null, 'mygrades');
4309 $usersetting = navigation_node
::create(get_string('preferences', 'moodle'), $prefurl, self
::TYPE_CONTAINER
, null, $key);
4310 $dashboard->add_node($usersetting);
4312 $usersetting = $this->add(get_string('preferences', 'moodle'), $prefurl, self
::TYPE_CONTAINER
, null, $key);
4313 $usersetting->display
= false;
4315 $usersetting->id
= 'usersettings';
4317 // Check if the user has been deleted.
4318 if ($user->deleted
) {
4319 if (!has_capability('moodle/user:update', $coursecontext)) {
4320 // We can't edit the user so just show the user deleted message.
4321 $usersetting->add(get_string('userdeleted'), null, self
::TYPE_SETTING
);
4323 // We can edit the user so show the user deleted message and link it to the profile.
4324 if ($course->id
== $SITE->id
) {
4325 $profileurl = new moodle_url('/user/profile.php', array('id'=>$user->id
));
4327 $profileurl = new moodle_url('/user/view.php', array('id'=>$user->id
, 'course'=>$course->id
));
4329 $usersetting->add(get_string('userdeleted'), $profileurl, self
::TYPE_SETTING
);
4334 $userauthplugin = false;
4335 if (!empty($user->auth
)) {
4336 $userauthplugin = get_auth_plugin($user->auth
);
4339 $useraccount = $usersetting->add(get_string('useraccount'), null, self
::TYPE_CONTAINER
, null, 'useraccount');
4341 // Add the profile edit link.
4342 if (isloggedin() && !isguestuser($user) && !is_mnet_remote_user($user)) {
4343 if (($currentuser ||
is_siteadmin($USER) ||
!is_siteadmin($user)) &&
4344 has_capability('moodle/user:update', $systemcontext)) {
4345 $url = new moodle_url('/user/editadvanced.php', array('id'=>$user->id
, 'course'=>$course->id
));
4346 $useraccount->add(get_string('editmyprofile'), $url, self
::TYPE_SETTING
);
4347 } else if ((has_capability('moodle/user:editprofile', $usercontext) && !is_siteadmin($user)) ||
4348 ($currentuser && has_capability('moodle/user:editownprofile', $systemcontext))) {
4349 if ($userauthplugin && $userauthplugin->can_edit_profile()) {
4350 $url = $userauthplugin->edit_profile_url();
4352 $url = new moodle_url('/user/edit.php', array('id'=>$user->id
, 'course'=>$course->id
));
4354 $useraccount->add(get_string('editmyprofile'), $url, self
::TYPE_SETTING
);
4359 // Change password link.
4360 if ($userauthplugin && $currentuser && !\core\session\manager
::is_loggedinas() && !isguestuser() &&
4361 has_capability('moodle/user:changeownpassword', $systemcontext) && $userauthplugin->can_change_password()) {
4362 $passwordchangeurl = $userauthplugin->change_password_url();
4363 if (empty($passwordchangeurl)) {
4364 $passwordchangeurl = new moodle_url('/login/change_password.php', array('id'=>$course->id
));
4366 $useraccount->add(get_string("changepassword"), $passwordchangeurl, self
::TYPE_SETTING
, null, 'changepassword');
4369 if (isloggedin() && !isguestuser($user) && !is_mnet_remote_user($user)) {
4370 if ($currentuser && has_capability('moodle/user:editownprofile', $systemcontext) ||
4371 has_capability('moodle/user:editprofile', $usercontext)) {
4372 $url = new moodle_url('/user/language.php', array('id' => $user->id
, 'course' => $course->id
));
4373 $useraccount->add(get_string('preferredlanguage'), $url, self
::TYPE_SETTING
, null, 'preferredlanguage');
4376 $pluginmanager = core_plugin_manager
::instance();
4377 $enabled = $pluginmanager->get_enabled_plugins('mod');
4378 if (isset($enabled['forum']) && isloggedin() && !isguestuser($user) && !is_mnet_remote_user($user)) {
4379 if ($currentuser && has_capability('moodle/user:editownprofile', $systemcontext) ||
4380 has_capability('moodle/user:editprofile', $usercontext)) {
4381 $url = new moodle_url('/user/forum.php', array('id' => $user->id
, 'course' => $course->id
));
4382 $useraccount->add(get_string('forumpreferences'), $url, self
::TYPE_SETTING
);
4385 $editors = editors_get_enabled();
4386 if (count($editors) > 1) {
4387 if (isloggedin() && !isguestuser($user) && !is_mnet_remote_user($user)) {
4388 if ($currentuser && has_capability('moodle/user:editownprofile', $systemcontext) ||
4389 has_capability('moodle/user:editprofile', $usercontext)) {
4390 $url = new moodle_url('/user/editor.php', array('id' => $user->id
, 'course' => $course->id
));
4391 $useraccount->add(get_string('editorpreferences'), $url, self
::TYPE_SETTING
);
4396 // View the roles settings.
4397 if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride', 'moodle/role:override',
4398 'moodle/role:manage'), $usercontext)) {
4399 $roles = $usersetting->add(get_string('roles'), null, self
::TYPE_SETTING
);
4401 $url = new moodle_url('/admin/roles/usersroles.php', array('userid'=>$user->id
, 'courseid'=>$course->id
));
4402 $roles->add(get_string('thisusersroles', 'role'), $url, self
::TYPE_SETTING
);
4404 $assignableroles = get_assignable_roles($usercontext, ROLENAME_BOTH
);
4406 if (!empty($assignableroles)) {
4407 $url = new moodle_url('/admin/roles/assign.php',
4408 array('contextid' => $usercontext->id
, 'userid' => $user->id
, 'courseid' => $course->id
));
4409 $roles->add(get_string('assignrolesrelativetothisuser', 'role'), $url, self
::TYPE_SETTING
);
4412 if (has_capability('moodle/role:review', $usercontext) ||
count(get_overridable_roles($usercontext, ROLENAME_BOTH
))>0) {
4413 $url = new moodle_url('/admin/roles/permissions.php',
4414 array('contextid' => $usercontext->id
, 'userid' => $user->id
, 'courseid' => $course->id
));
4415 $roles->add(get_string('permissions', 'role'), $url, self
::TYPE_SETTING
);
4418 $url = new moodle_url('/admin/roles/check.php',
4419 array('contextid' => $usercontext->id
, 'userid' => $user->id
, 'courseid' => $course->id
));
4420 $roles->add(get_string('checkpermissions', 'role'), $url, self
::TYPE_SETTING
);
4424 if (!$this->cache
->cached('contexthasrepos'.$usercontext->id
)) {
4425 require_once($CFG->dirroot
. '/repository/lib.php');
4426 $editabletypes = repository
::get_editable_types($usercontext);
4427 $haseditabletypes = !empty($editabletypes);
4428 unset($editabletypes);
4429 $this->cache
->set('contexthasrepos'.$usercontext->id
, $haseditabletypes);
4431 $haseditabletypes = $this->cache
->{'contexthasrepos'.$usercontext->id
};
4433 if ($haseditabletypes) {
4434 $repositories = $usersetting->add(get_string('repositories', 'repository'), null, self
::TYPE_SETTING
);
4435 $repositories->add(get_string('manageinstances', 'repository'), new moodle_url('/repository/manage_instances.php',
4436 array('contextid' => $usercontext->id
)));
4440 if ($currentuser && !empty($CFG->enableportfolios
) && has_capability('moodle/portfolio:export', $systemcontext)) {
4441 require_once($CFG->libdir
. '/portfoliolib.php');
4442 if (portfolio_has_visible_instances()) {
4443 $portfolio = $usersetting->add(get_string('portfolios', 'portfolio'), null, self
::TYPE_SETTING
);
4445 $url = new moodle_url('/user/portfolio.php', array('courseid'=>$course->id
));
4446 $portfolio->add(get_string('configure', 'portfolio'), $url, self
::TYPE_SETTING
);
4448 $url = new moodle_url('/user/portfoliologs.php', array('courseid'=>$course->id
));
4449 $portfolio->add(get_string('logs', 'portfolio'), $url, self
::TYPE_SETTING
);
4453 $enablemanagetokens = false;
4454 if (!empty($CFG->enablerssfeeds
)) {
4455 $enablemanagetokens = true;
4456 } else if (!is_siteadmin($USER->id
)
4457 && !empty($CFG->enablewebservices
)
4458 && has_capability('moodle/webservice:createtoken', context_system
::instance()) ) {
4459 $enablemanagetokens = true;
4462 if ($currentuser && $enablemanagetokens) {
4463 $url = new moodle_url('/user/managetoken.php', array('sesskey'=>sesskey()));
4464 $useraccount->add(get_string('securitykeys', 'webservice'), $url, self
::TYPE_SETTING
);
4468 if (($currentuser && has_capability('moodle/user:editownmessageprofile', $systemcontext)) ||
(!isguestuser($user) &&
4469 has_capability('moodle/user:editmessageprofile', $usercontext) && !is_primary_admin($user->id
))) {
4470 $url = new moodle_url('/message/edit.php', array('id'=>$user->id
));
4471 $useraccount->add(get_string('messaging', 'message'), $url, self
::TYPE_SETTING
);
4475 if ($currentuser && !empty($CFG->enableblogs
)) {
4476 $blog = $usersetting->add(get_string('blogs', 'blog'), null, navigation_node
::TYPE_CONTAINER
, null, 'blogs');
4477 if (has_capability('moodle/blog:view', $systemcontext)) {
4478 $blog->add(get_string('preferences', 'blog'), new moodle_url('/blog/preferences.php'),
4479 navigation_node
::TYPE_SETTING
);
4481 if (!empty($CFG->useexternalblogs
) && $CFG->maxexternalblogsperuser
> 0 &&
4482 has_capability('moodle/blog:manageexternal', $systemcontext)) {
4483 $blog->add(get_string('externalblogs', 'blog'), new moodle_url('/blog/external_blogs.php'),
4484 navigation_node
::TYPE_SETTING
);
4485 $blog->add(get_string('addnewexternalblog', 'blog'), new moodle_url('/blog/external_blog_edit.php'),
4486 navigation_node
::TYPE_SETTING
);
4488 // Remove the blog node if empty.
4489 $blog->trim_if_empty();
4493 if ($currentuser && !empty($CFG->enablebadges
)) {
4494 $badges = $usersetting->add(get_string('badges'), null, navigation_node
::TYPE_CONTAINER
, null, 'badges');
4495 if (has_capability('moodle/badges:manageownbadges', $usercontext)) {
4496 $url = new moodle_url('/badges/mybadges.php');
4497 $badges->add(get_string('managebadges', 'badges'), $url, self
::TYPE_SETTING
);
4499 $badges->add(get_string('preferences', 'badges'), new moodle_url('/badges/preferences.php'),
4500 navigation_node
::TYPE_SETTING
);
4501 if (!empty($CFG->badges_allowexternalbackpack
)) {
4502 $badges->add(get_string('backpackdetails', 'badges'), new moodle_url('/badges/mybackpack.php'),
4503 navigation_node
::TYPE_SETTING
);
4507 // Let plugins hook into user settings navigation.
4508 $pluginsfunction = get_plugins_with_function('extend_navigation_user_settings', 'lib.php');
4509 foreach ($pluginsfunction as $plugintype => $plugins) {
4510 foreach ($plugins as $pluginfunction) {
4511 $pluginfunction($usersetting, $user, $usercontext, $course, $coursecontext);
4515 return $usersetting;
4519 * Loads block specific settings in the navigation
4521 * @return navigation_node
4523 protected function load_block_settings() {
4526 $blocknode = $this->add($this->context
->get_context_name(), null, self
::TYPE_SETTING
, null, 'blocksettings');
4527 $blocknode->force_open();
4529 // Assign local roles
4530 if (get_assignable_roles($this->context
, ROLENAME_ORIGINAL
)) {
4531 $assignurl = new moodle_url('/'.$CFG->admin
.'/roles/assign.php', array('contextid' => $this->context
->id
));
4532 $blocknode->add(get_string('assignroles', 'role'), $assignurl, self
::TYPE_SETTING
, null,
4533 'roles', new pix_icon('i/assignroles', ''));
4537 if (has_capability('moodle/role:review', $this->context
) or count(get_overridable_roles($this->context
))>0) {
4538 $url = new moodle_url('/'.$CFG->admin
.'/roles/permissions.php', array('contextid'=>$this->context
->id
));
4539 $blocknode->add(get_string('permissions', 'role'), $url, self
::TYPE_SETTING
, null,
4540 'permissions', new pix_icon('i/permissions', ''));
4542 // Check role permissions
4543 if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:assign'), $this->context
)) {
4544 $url = new moodle_url('/'.$CFG->admin
.'/roles/check.php', array('contextid'=>$this->context
->id
));
4545 $blocknode->add(get_string('checkpermissions', 'role'), $url, self
::TYPE_SETTING
, null,
4546 'checkpermissions', new pix_icon('i/checkpermissions', ''));
4553 * Loads category specific settings in the navigation
4555 * @return navigation_node
4557 protected function load_category_settings() {
4560 // We can land here while being in the context of a block, in which case we
4561 // should get the parent context which should be the category one. See self::initialise().
4562 if ($this->context
->contextlevel
== CONTEXT_BLOCK
) {
4563 $catcontext = $this->context
->get_parent_context();
4565 $catcontext = $this->context
;
4568 // Let's make sure that we always have the right context when getting here.
4569 if ($catcontext->contextlevel
!= CONTEXT_COURSECAT
) {
4570 throw new coding_exception('Unexpected context while loading category settings.');
4573 $categorynode = $this->add($catcontext->get_context_name(), null, null, null, 'categorysettings');
4574 $categorynode->nodetype
= navigation_node
::NODETYPE_BRANCH
;
4575 $categorynode->force_open();
4577 if (can_edit_in_category($catcontext->instanceid
)) {
4578 $url = new moodle_url('/course/management.php', array('categoryid' => $catcontext->instanceid
));
4579 $editstring = get_string('managecategorythis');
4580 $categorynode->add($editstring, $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/edit', ''));
4583 if (has_capability('moodle/category:manage', $catcontext)) {
4584 $editurl = new moodle_url('/course/editcategory.php', array('id' => $catcontext->instanceid
));
4585 $categorynode->add(get_string('editcategorythis'), $editurl, self
::TYPE_SETTING
, null, 'edit', new pix_icon('i/edit', ''));
4587 $addsubcaturl = new moodle_url('/course/editcategory.php', array('parent' => $catcontext->instanceid
));
4588 $categorynode->add(get_string('addsubcategory'), $addsubcaturl, self
::TYPE_SETTING
, null, 'addsubcat', new pix_icon('i/withsubcat', ''));
4591 // Assign local roles
4592 $assignableroles = get_assignable_roles($catcontext);
4593 if (!empty($assignableroles)) {
4594 $assignurl = new moodle_url('/'.$CFG->admin
.'/roles/assign.php', array('contextid' => $catcontext->id
));
4595 $categorynode->add(get_string('assignroles', 'role'), $assignurl, self
::TYPE_SETTING
, null, 'roles', new pix_icon('i/assignroles', ''));
4599 if (has_capability('moodle/role:review', $catcontext) or count(get_overridable_roles($catcontext)) > 0) {
4600 $url = new moodle_url('/'.$CFG->admin
.'/roles/permissions.php', array('contextid' => $catcontext->id
));
4601 $categorynode->add(get_string('permissions', 'role'), $url, self
::TYPE_SETTING
, null, 'permissions', new pix_icon('i/permissions', ''));
4603 // Check role permissions
4604 if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride',
4605 'moodle/role:override', 'moodle/role:assign'), $catcontext)) {
4606 $url = new moodle_url('/'.$CFG->admin
.'/roles/check.php', array('contextid' => $catcontext->id
));
4607 $categorynode->add(get_string('checkpermissions', 'role'), $url, self
::TYPE_SETTING
, null, 'checkpermissions', new pix_icon('i/checkpermissions', ''));
4611 if (has_any_capability(array('moodle/cohort:view', 'moodle/cohort:manage'), $catcontext)) {
4612 $categorynode->add(get_string('cohorts', 'cohort'), new moodle_url('/cohort/index.php',
4613 array('contextid' => $catcontext->id
)), self
::TYPE_SETTING
, null, 'cohort', new pix_icon('i/cohort', ''));
4617 if (has_capability('moodle/filter:manage', $catcontext) && count(filter_get_available_in_context($catcontext)) > 0) {
4618 $url = new moodle_url('/filter/manage.php', array('contextid' => $catcontext->id
));
4619 $categorynode->add(get_string('filters', 'admin'), $url, self
::TYPE_SETTING
, null, 'filters', new pix_icon('i/filter', ''));
4623 if (has_capability('moodle/restore:restorecourse', $catcontext)) {
4624 $url = new moodle_url('/backup/restorefile.php', array('contextid' => $catcontext->id
));
4625 $categorynode->add(get_string('restorecourse', 'admin'), $url, self
::TYPE_SETTING
, null, 'restorecourse', new pix_icon('i/restore', ''));
4628 // Let plugins hook into category settings navigation.
4629 $pluginsfunction = get_plugins_with_function('extend_navigation_category_settings', 'lib.php');
4630 foreach ($pluginsfunction as $plugintype => $plugins) {
4631 foreach ($plugins as $pluginfunction) {
4632 $pluginfunction($categorynode, $catcontext);
4636 return $categorynode;
4640 * Determine whether the user is assuming another role
4642 * This function checks to see if the user is assuming another role by means of
4643 * role switching. In doing this we compare each RSW key (context path) against
4644 * the current context path. This ensures that we can provide the switching
4645 * options against both the course and any page shown under the course.
4647 * @return bool|int The role(int) if the user is in another role, false otherwise
4649 protected function in_alternative_role() {
4651 if (!empty($USER->access
['rsw']) && is_array($USER->access
['rsw'])) {
4652 if (!empty($this->page
->context
) && !empty($USER->access
['rsw'][$this->page
->context
->path
])) {
4653 return $USER->access
['rsw'][$this->page
->context
->path
];
4655 foreach ($USER->access
['rsw'] as $key=>$role) {
4656 if (strpos($this->context
->path
,$key)===0) {
4665 * This function loads all of the front page settings into the settings navigation.
4666 * This function is called when the user is on the front page, or $COURSE==$SITE
4667 * @param bool $forceopen (optional)
4668 * @return navigation_node
4670 protected function load_front_page_settings($forceopen = false) {
4673 $course = clone($SITE);
4674 $coursecontext = context_course
::instance($course->id
); // Course context
4676 $frontpage = $this->add(get_string('frontpagesettings'), null, self
::TYPE_SETTING
, null, 'frontpage');
4678 $frontpage->force_open();
4680 $frontpage->id
= 'frontpagesettings';
4682 if ($this->page
->user_allowed_editing()) {
4684 // Add the turn on/off settings
4685 $url = new moodle_url('/course/view.php', array('id'=>$course->id
, 'sesskey'=>sesskey()));
4686 if ($this->page
->user_is_editing()) {
4687 $url->param('edit', 'off');
4688 $editstring = get_string('turneditingoff');
4690 $url->param('edit', 'on');
4691 $editstring = get_string('turneditingon');
4693 $frontpage->add($editstring, $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/edit', ''));
4696 if (has_capability('moodle/course:update', $coursecontext)) {
4697 // Add the course settings link
4698 $url = new moodle_url('/admin/settings.php', array('section'=>'frontpagesettings'));
4699 $frontpage->add(get_string('editsettings'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/settings', ''));
4703 enrol_add_course_navigation($frontpage, $course);
4706 if (has_capability('moodle/filter:manage', $coursecontext) && count(filter_get_available_in_context($coursecontext))>0) {
4707 $url = new moodle_url('/filter/manage.php', array('contextid'=>$coursecontext->id
));
4708 $frontpage->add(get_string('filters', 'admin'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/filter', ''));
4711 // View course reports.
4712 if (has_capability('moodle/site:viewreports', $coursecontext)) { // Basic capability for listing of reports.
4713 $frontpagenav = $frontpage->add(get_string('reports'), null, self
::TYPE_CONTAINER
, null, 'frontpagereports',
4714 new pix_icon('i/stats', ''));
4715 $coursereports = core_component
::get_plugin_list('coursereport');
4716 foreach ($coursereports as $report=>$dir) {
4717 $libfile = $CFG->dirroot
.'/course/report/'.$report.'/lib.php';
4718 if (file_exists($libfile)) {
4719 require_once($libfile);
4720 $reportfunction = $report.'_report_extend_navigation';
4721 if (function_exists($report.'_report_extend_navigation')) {
4722 $reportfunction($frontpagenav, $course, $coursecontext);
4727 $reports = get_plugin_list_with_function('report', 'extend_navigation_course', 'lib.php');
4728 foreach ($reports as $reportfunction) {
4729 $reportfunction($frontpagenav, $course, $coursecontext);
4733 // Backup this course
4734 if (has_capability('moodle/backup:backupcourse', $coursecontext)) {
4735 $url = new moodle_url('/backup/backup.php', array('id'=>$course->id
));
4736 $frontpage->add(get_string('backup'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/backup', ''));
4739 // Restore to this course
4740 if (has_capability('moodle/restore:restorecourse', $coursecontext)) {
4741 $url = new moodle_url('/backup/restorefile.php', array('contextid'=>$coursecontext->id
));
4742 $frontpage->add(get_string('restore'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/restore', ''));
4746 require_once($CFG->libdir
. '/questionlib.php');
4747 question_extend_settings_navigation($frontpage, $coursecontext)->trim_if_empty();
4750 if ($course->legacyfiles
== 2 and has_capability('moodle/course:managefiles', $this->context
)) {
4751 //hiden in new installs
4752 $url = new moodle_url('/files/index.php', array('contextid'=>$coursecontext->id
));
4753 $frontpage->add(get_string('sitelegacyfiles'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/folder', ''));
4756 // Let plugins hook into frontpage navigation.
4757 $pluginsfunction = get_plugins_with_function('extend_navigation_frontpage', 'lib.php');
4758 foreach ($pluginsfunction as $plugintype => $plugins) {
4759 foreach ($plugins as $pluginfunction) {
4760 $pluginfunction($frontpage, $course, $coursecontext);
4768 * This function gives local plugins an opportunity to modify the settings navigation.
4770 protected function load_local_plugin_settings() {
4772 foreach (core_component
::get_plugin_list_with_file('local', 'lib.php', true) as $plugin => $unused) {
4773 $function = "local_{$plugin}_extend_settings_navigation";
4774 $oldfunction = "local_{$plugin}_extends_settings_navigation";
4776 if (function_exists($function)) {
4777 $function($this, $this->context
);
4779 } else if (function_exists($oldfunction)) {
4780 debugging("Deprecated local plugin navigation callback: Please rename '{$oldfunction}' to '{$function}'. ".
4781 "Support for the old callback will be dropped in Moodle 3.1", DEBUG_DEVELOPER
);
4782 $oldfunction($this, $this->context
);
4788 * This function marks the cache as volatile so it is cleared during shutdown
4790 public function clear_cache() {
4791 $this->cache
->volatile();
4795 * Checks to see if there are child nodes available in the specific user's preference node.
4796 * If so, then they have the appropriate permissions view this user's preferences.
4798 * @since Moodle 2.9.3
4799 * @param int $userid The user's ID.
4800 * @return bool True if child nodes exist to view, otherwise false.
4802 public function can_view_user_preferences($userid) {
4803 if (is_siteadmin()) {
4806 // See if any nodes are present in the preferences section for this user.
4807 $preferencenode = $this->find('userviewingsettings' . $userid, null);
4808 if ($preferencenode && $preferencenode->has_children()) {
4809 // Run through each child node.
4810 foreach ($preferencenode->children
as $childnode) {
4811 // If the child node has children then this user has access to a link in the preferences page.
4812 if ($childnode->has_children()) {
4817 // No links found for the user to access on the preferences page.
4823 * Class used to populate site admin navigation for ajax.
4826 * @category navigation
4827 * @copyright 2013 Rajesh Taneja <rajesh@moodle.com>
4828 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4830 class settings_navigation_ajax
extends settings_navigation
{
4832 * Constructs the navigation for use in an AJAX request
4834 * @param moodle_page $page
4836 public function __construct(moodle_page
&$page) {
4837 $this->page
= $page;
4838 $this->cache
= new navigation_cache(NAVIGATION_CACHE_NAME
);
4839 $this->children
= new navigation_node_collection();
4840 $this->initialise();
4844 * Initialise the site admin navigation.
4846 * @return array An array of the expandable nodes
4848 public function initialise() {
4849 if ($this->initialised ||
during_initial_install()) {
4852 $this->context
= $this->page
->context
;
4853 $this->load_administration_settings();
4855 // Check if local plugins is adding node to site admin.
4856 $this->load_local_plugin_settings();
4858 $this->initialised
= true;
4863 * Simple class used to output a navigation branch in XML
4866 * @category navigation
4867 * @copyright 2009 Sam Hemelryk
4868 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4870 class navigation_json
{
4871 /** @var array An array of different node types */
4872 protected $nodetype = array('node','branch');
4873 /** @var array An array of node keys and types */
4874 protected $expandable = array();
4876 * Turns a branch and all of its children into XML
4878 * @param navigation_node $branch
4879 * @return string XML string
4881 public function convert($branch) {
4882 $xml = $this->convert_child($branch);
4886 * Set the expandable items in the array so that we have enough information
4887 * to attach AJAX events
4888 * @param array $expandable
4890 public function set_expandable($expandable) {
4891 foreach ($expandable as $node) {
4892 $this->expandable
[$node['key'].':'.$node['type']] = $node;
4896 * Recusively converts a child node and its children to XML for output
4898 * @param navigation_node $child The child to convert
4899 * @param int $depth Pointlessly used to track the depth of the XML structure
4900 * @return string JSON
4902 protected function convert_child($child, $depth=1) {
4903 if (!$child->display
) {
4906 $attributes = array();
4907 $attributes['id'] = $child->id
;
4908 $attributes['name'] = (string)$child->text
; // This can be lang_string object so typecast it.
4909 $attributes['type'] = $child->type
;
4910 $attributes['key'] = $child->key
;
4911 $attributes['class'] = $child->get_css_type();
4913 if ($child->icon
instanceof pix_icon
) {
4914 $attributes['icon'] = array(
4915 'component' => $child->icon
->component
,
4916 'pix' => $child->icon
->pix
,
4918 foreach ($child->icon
->attributes
as $key=>$value) {
4919 if ($key == 'class') {
4920 $attributes['icon']['classes'] = explode(' ', $value);
4921 } else if (!array_key_exists($key, $attributes['icon'])) {
4922 $attributes['icon'][$key] = $value;
4926 } else if (!empty($child->icon
)) {
4927 $attributes['icon'] = (string)$child->icon
;
4930 if ($child->forcetitle ||
$child->title
!== $child->text
) {
4931 $attributes['title'] = htmlentities($child->title
, ENT_QUOTES
, 'UTF-8');
4933 if (array_key_exists($child->key
.':'.$child->type
, $this->expandable
)) {
4934 $attributes['expandable'] = $child->key
;
4935 $child->add_class($this->expandable
[$child->key
.':'.$child->type
]['id']);
4938 if (count($child->classes
)>0) {
4939 $attributes['class'] .= ' '.join(' ',$child->classes
);
4941 if (is_string($child->action
)) {
4942 $attributes['link'] = $child->action
;
4943 } else if ($child->action
instanceof moodle_url
) {
4944 $attributes['link'] = $child->action
->out();
4945 } else if ($child->action
instanceof action_link
) {
4946 $attributes['link'] = $child->action
->url
->out();
4948 $attributes['hidden'] = ($child->hidden
);
4949 $attributes['haschildren'] = ($child->children
->count()>0 ||
$child->type
== navigation_node
::TYPE_CATEGORY
);
4950 $attributes['haschildren'] = $attributes['haschildren'] ||
$child->type
== navigation_node
::TYPE_MY_CATEGORY
;
4952 if ($child->children
->count() > 0) {
4953 $attributes['children'] = array();
4954 foreach ($child->children
as $subchild) {
4955 $attributes['children'][] = $this->convert_child($subchild, $depth+
1);
4962 return json_encode($attributes);
4968 * The cache class used by global navigation and settings navigation.
4970 * It is basically an easy access point to session with a bit of smarts to make
4971 * sure that the information that is cached is valid still.
4975 * if (!$cache->viewdiscussion()) {
4976 * // Code to do stuff and produce cachable content
4977 * $cache->viewdiscussion = has_capability('mod/forum:viewdiscussion', $coursecontext);
4979 * $content = $cache->viewdiscussion;
4983 * @category navigation
4984 * @copyright 2009 Sam Hemelryk
4985 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4987 class navigation_cache
{
4988 /** @var int represents the time created */
4989 protected $creation;
4990 /** @var array An array of session keys */
4993 * The string to use to segregate this particular cache. It can either be
4994 * unique to start a fresh cache or if you want to share a cache then make
4995 * it the string used in the original cache.
4999 /** @var int a time that the information will time out */
5001 /** @var stdClass The current context */
5002 protected $currentcontext;
5003 /** @var int cache time information */
5004 const CACHETIME
= 0;
5005 /** @var int cache user id */
5006 const CACHEUSERID
= 1;
5007 /** @var int cache value */
5008 const CACHEVALUE
= 2;
5009 /** @var null|array An array of navigation cache areas to expire on shutdown */
5010 public static $volatilecaches;
5013 * Contructor for the cache. Requires two arguments
5015 * @param string $area The string to use to segregate this particular cache
5016 * it can either be unique to start a fresh cache or if you want
5017 * to share a cache then make it the string used in the original
5019 * @param int $timeout The number of seconds to time the information out after
5021 public function __construct($area, $timeout=1800) {
5022 $this->creation
= time();
5023 $this->area
= $area;
5024 $this->timeout
= time() - $timeout;
5025 if (rand(0,100) === 0) {
5026 $this->garbage_collection();
5031 * Used to set up the cache within the SESSION.
5033 * This is called for each access and ensure that we don't put anything into the session before
5036 protected function ensure_session_cache_initialised() {
5038 if (empty($this->session
)) {
5039 if (!isset($SESSION->navcache
)) {
5040 $SESSION->navcache
= new stdClass
;
5042 if (!isset($SESSION->navcache
->{$this->area
})) {
5043 $SESSION->navcache
->{$this->area
} = array();
5045 $this->session
= &$SESSION->navcache
->{$this->area
}; // pointer to array, =& is correct here
5050 * Magic Method to retrieve something by simply calling using = cache->key
5052 * @param mixed $key The identifier for the information you want out again
5053 * @return void|mixed Either void or what ever was put in
5055 public function __get($key) {
5056 if (!$this->cached($key)) {
5059 $information = $this->session
[$key][self
::CACHEVALUE
];
5060 return unserialize($information);
5064 * Magic method that simply uses {@link set();} to store something in the cache
5066 * @param string|int $key
5067 * @param mixed $information
5069 public function __set($key, $information) {
5070 $this->set($key, $information);
5074 * Sets some information against the cache (session) for later retrieval
5076 * @param string|int $key
5077 * @param mixed $information
5079 public function set($key, $information) {
5081 $this->ensure_session_cache_initialised();
5082 $information = serialize($information);
5083 $this->session
[$key]= array(self
::CACHETIME
=>time(), self
::CACHEUSERID
=>$USER->id
, self
::CACHEVALUE
=>$information);
5086 * Check the existence of the identifier in the cache
5088 * @param string|int $key
5091 public function cached($key) {
5093 $this->ensure_session_cache_initialised();
5094 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
) {
5100 * Compare something to it's equivilant in the cache
5102 * @param string $key
5103 * @param mixed $value
5104 * @param bool $serialise Whether to serialise the value before comparison
5105 * this should only be set to false if the value is already
5107 * @return bool If the value is the same false if it is not set or doesn't match
5109 public function compare($key, $value, $serialise = true) {
5110 if ($this->cached($key)) {
5112 $value = serialize($value);
5114 if ($this->session
[$key][self
::CACHEVALUE
] === $value) {
5121 * Wipes the entire cache, good to force regeneration
5123 public function clear() {
5125 unset($SESSION->navcache
);
5126 $this->session
= null;
5129 * Checks all cache entries and removes any that have expired, good ole cleanup
5131 protected function garbage_collection() {
5132 if (empty($this->session
)) {
5135 foreach ($this->session
as $key=>$cachedinfo) {
5136 if (is_array($cachedinfo) && $cachedinfo[self
::CACHETIME
]<$this->timeout
) {
5137 unset($this->session
[$key]);
5143 * Marks the cache as being volatile (likely to change)
5145 * Any caches marked as volatile will be destroyed at the on shutdown by
5146 * {@link navigation_node::destroy_volatile_caches()} which is registered
5147 * as a shutdown function if any caches are marked as volatile.
5149 * @param bool $setting True to destroy the cache false not too
5151 public function volatile($setting = true) {
5152 if (self
::$volatilecaches===null) {
5153 self
::$volatilecaches = array();
5154 core_shutdown_manager
::register_function(array('navigation_cache','destroy_volatile_caches'));
5158 self
::$volatilecaches[$this->area
] = $this->area
;
5159 } else if (array_key_exists($this->area
, self
::$volatilecaches)) {
5160 unset(self
::$volatilecaches[$this->area
]);
5165 * Destroys all caches marked as volatile
5167 * This function is static and works in conjunction with the static volatilecaches
5168 * property of navigation cache.
5169 * Because this function is static it manually resets the cached areas back to an
5172 public static function destroy_volatile_caches() {
5174 if (is_array(self
::$volatilecaches) && count(self
::$volatilecaches)>0) {
5175 foreach (self
::$volatilecaches as $area) {
5176 $SESSION->navcache
->{$area} = array();
5179 $SESSION->navcache
= new stdClass
;