2 // This file is part of Moodle - http://moodle.org/
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 // GNU General Public License for more details.
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
18 * This file contains classes used to manage the navigation structures within Moodle.
22 * @copyright 2009 Sam Hemelryk
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26 defined('MOODLE_INTERNAL') ||
die();
29 * The name that will be used to separate the navigation cache within SESSION
31 define('NAVIGATION_CACHE_NAME', 'navigation');
32 define('NAVIGATION_SITE_ADMIN_CACHE_NAME', 'navigationsiteadmin');
35 * This class is used to represent a node in a navigation tree
37 * This class is used to represent a node in a navigation tree within Moodle,
38 * the tree could be one of global navigation, settings navigation, or the navbar.
39 * Each node can be one of two types either a Leaf (default) or a branch.
40 * When a node is first created it is created as a leaf, when/if children are added
41 * the node then becomes a branch.
44 * @category navigation
45 * @copyright 2009 Sam Hemelryk
46 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
48 class navigation_node
implements renderable
{
49 /** @var int Used to identify this node a leaf (default) 0 */
50 const NODETYPE_LEAF
= 0;
51 /** @var int Used to identify this node a branch, happens with children 1 */
52 const NODETYPE_BRANCH
= 1;
53 /** @var null Unknown node type null */
54 const TYPE_UNKNOWN
= null;
55 /** @var int System node type 0 */
56 const TYPE_ROOTNODE
= 0;
57 /** @var int System node type 1 */
58 const TYPE_SYSTEM
= 1;
59 /** @var int Category node type 10 */
60 const TYPE_CATEGORY
= 10;
61 /** var int Category displayed in MyHome navigation node */
62 const TYPE_MY_CATEGORY
= 11;
63 /** @var int Course node type 20 */
64 const TYPE_COURSE
= 20;
65 /** @var int Course Structure node type 30 */
66 const TYPE_SECTION
= 30;
67 /** @var int Activity node type, e.g. Forum, Quiz 40 */
68 const TYPE_ACTIVITY
= 40;
69 /** @var int Resource node type, e.g. Link to a file, or label 50 */
70 const TYPE_RESOURCE
= 50;
71 /** @var int A custom node type, default when adding without specifing type 60 */
72 const TYPE_CUSTOM
= 60;
73 /** @var int Setting node type, used only within settings nav 70 */
74 const TYPE_SETTING
= 70;
75 /** @var int site admin branch node type, used only within settings nav 71 */
76 const TYPE_SITE_ADMIN
= 71;
77 /** @var int Setting node type, used only within settings nav 80 */
79 /** @var int Setting node type, used for containers of no importance 90 */
80 const TYPE_CONTAINER
= 90;
81 /** var int Course the current user is not enrolled in */
82 const COURSE_OTHER
= 0;
83 /** var int Course the current user is enrolled in but not viewing */
85 /** var int Course the current user is currently viewing */
86 const COURSE_CURRENT
= 2;
88 /** @var int Parameter to aid the coder in tracking [optional] */
90 /** @var string|int The identifier for the node, used to retrieve the node */
92 /** @var string The text to use for the node */
94 /** @var string Short text to use if requested [optional] */
95 public $shorttext = null;
96 /** @var string The title attribute for an action if one is defined */
98 /** @var string A string that can be used to build a help button */
99 public $helpbutton = null;
100 /** @var moodle_url|action_link|null An action for the node (link) */
101 public $action = null;
102 /** @var pix_icon The path to an icon to use for this node */
104 /** @var int See TYPE_* constants defined for this class */
105 public $type = self
::TYPE_UNKNOWN
;
106 /** @var int See NODETYPE_* constants defined for this class */
107 public $nodetype = self
::NODETYPE_LEAF
;
108 /** @var bool If set to true the node will be collapsed by default */
109 public $collapse = false;
110 /** @var bool If set to true the node will be expanded by default */
111 public $forceopen = false;
112 /** @var array An array of CSS classes for the node */
113 public $classes = array();
114 /** @var navigation_node_collection An array of child nodes */
115 public $children = array();
116 /** @var bool If set to true the node will be recognised as active */
117 public $isactive = false;
118 /** @var bool If set to true the node will be dimmed */
119 public $hidden = false;
120 /** @var bool If set to false the node will not be displayed */
121 public $display = true;
122 /** @var bool If set to true then an HR will be printed before the node */
123 public $preceedwithhr = false;
124 /** @var bool If set to true the the navigation bar should ignore this node */
125 public $mainnavonly = false;
126 /** @var bool If set to true a title will be added to the action no matter what */
127 public $forcetitle = false;
128 /** @var navigation_node A reference to the node parent, you should never set this directly you should always call set_parent */
129 public $parent = null;
130 /** @var bool Override to not display the icon even if one is provided **/
131 public $hideicon = false;
132 /** @var bool Set to true if we KNOW that this node can be expanded. */
133 public $isexpandable = false;
135 protected $namedtypes = array(0=>'system',10=>'category',20=>'course',30=>'structure',40=>'activity',50=>'resource',60=>'custom',70=>'setting',71=>'siteadmin', 80=>'user');
136 /** @var moodle_url */
137 protected static $fullmeurl = null;
138 /** @var bool toogles auto matching of active node */
139 public static $autofindactive = true;
140 /** @var bool should we load full admin tree or rely on AJAX for performance reasons */
141 protected static $loadadmintree = false;
142 /** @var mixed If set to an int, that section will be included even if it has no activities */
143 public $includesectionnum = false;
146 * Constructs a new navigation_node
148 * @param array|string $properties Either an array of properties or a string to use
149 * as the text for the node
151 public function __construct($properties) {
152 if (is_array($properties)) {
153 // Check the array for each property that we allow to set at construction.
154 // text - The main content for the node
155 // shorttext - A short text if required for the node
156 // icon - The icon to display for the node
157 // type - The type of the node
158 // key - The key to use to identify the node
159 // parent - A reference to the nodes parent
160 // action - The action to attribute to this node, usually a URL to link to
161 if (array_key_exists('text', $properties)) {
162 $this->text
= $properties['text'];
164 if (array_key_exists('shorttext', $properties)) {
165 $this->shorttext
= $properties['shorttext'];
167 if (!array_key_exists('icon', $properties)) {
168 $properties['icon'] = new pix_icon('i/navigationitem', '');
170 $this->icon
= $properties['icon'];
171 if ($this->icon
instanceof pix_icon
) {
172 if (empty($this->icon
->attributes
['class'])) {
173 $this->icon
->attributes
['class'] = 'navicon';
175 $this->icon
->attributes
['class'] .= ' navicon';
178 if (array_key_exists('type', $properties)) {
179 $this->type
= $properties['type'];
181 $this->type
= self
::TYPE_CUSTOM
;
183 if (array_key_exists('key', $properties)) {
184 $this->key
= $properties['key'];
186 // This needs to happen last because of the check_if_active call that occurs
187 if (array_key_exists('action', $properties)) {
188 $this->action
= $properties['action'];
189 if (is_string($this->action
)) {
190 $this->action
= new moodle_url($this->action
);
192 if (self
::$autofindactive) {
193 $this->check_if_active();
196 if (array_key_exists('parent', $properties)) {
197 $this->set_parent($properties['parent']);
199 } else if (is_string($properties)) {
200 $this->text
= $properties;
202 if ($this->text
=== null) {
203 throw new coding_exception('You must set the text for the node when you create it.');
205 // Instantiate a new navigation node collection for this nodes children
206 $this->children
= new navigation_node_collection();
210 * Checks if this node is the active node.
212 * This is determined by comparing the action for the node against the
213 * defined URL for the page. A match will see this node marked as active.
215 * @param int $strength One of URL_MATCH_EXACT, URL_MATCH_PARAMS, or URL_MATCH_BASE
218 public function check_if_active($strength=URL_MATCH_EXACT
) {
219 global $FULLME, $PAGE;
220 // Set fullmeurl if it hasn't already been set
221 if (self
::$fullmeurl == null) {
222 if ($PAGE->has_set_url()) {
223 self
::override_active_url(new moodle_url($PAGE->url
));
225 self
::override_active_url(new moodle_url($FULLME));
229 // Compare the action of this node against the fullmeurl
230 if ($this->action
instanceof moodle_url
&& $this->action
->compare(self
::$fullmeurl, $strength)) {
231 $this->make_active();
238 * This sets the URL that the URL of new nodes get compared to when locating
241 * The active node is the node that matches the URL set here. By default this
242 * is either $PAGE->url or if that hasn't been set $FULLME.
244 * @param moodle_url $url The url to use for the fullmeurl.
245 * @param bool $loadadmintree use true if the URL point to administration tree
247 public static function override_active_url(moodle_url
$url, $loadadmintree = false) {
248 // Clone the URL, in case the calling script changes their URL later.
249 self
::$fullmeurl = new moodle_url($url);
250 // True means we do not want AJAX loaded admin tree, required for all admin pages.
251 if ($loadadmintree) {
252 // Do not change back to false if already set.
253 self
::$loadadmintree = true;
258 * Use when page is linked from the admin tree,
259 * if not used navigation could not find the page using current URL
260 * because the tree is not fully loaded.
262 public static function require_admin_tree() {
263 self
::$loadadmintree = true;
267 * Creates a navigation node, ready to add it as a child using add_node
268 * function. (The created node needs to be added before you can use it.)
269 * @param string $text
270 * @param moodle_url|action_link $action
272 * @param string $shorttext
273 * @param string|int $key
274 * @param pix_icon $icon
275 * @return navigation_node
277 public static function create($text, $action=null, $type=self
::TYPE_CUSTOM
,
278 $shorttext=null, $key=null, pix_icon
$icon=null) {
279 // Properties array used when creating the new navigation node
284 // Set the action if one was provided
285 if ($action!==null) {
286 $itemarray['action'] = $action;
288 // Set the shorttext if one was provided
289 if ($shorttext!==null) {
290 $itemarray['shorttext'] = $shorttext;
292 // Set the icon if one was provided
294 $itemarray['icon'] = $icon;
297 $itemarray['key'] = $key;
298 // Construct and return
299 return new navigation_node($itemarray);
303 * Adds a navigation node as a child of this node.
305 * @param string $text
306 * @param moodle_url|action_link $action
308 * @param string $shorttext
309 * @param string|int $key
310 * @param pix_icon $icon
311 * @return navigation_node
313 public function add($text, $action=null, $type=self
::TYPE_CUSTOM
, $shorttext=null, $key=null, pix_icon
$icon=null) {
315 $childnode = self
::create($text, $action, $type, $shorttext, $key, $icon);
317 // Add the child to end and return
318 return $this->add_node($childnode);
322 * Adds a navigation node as a child of this one, given a $node object
323 * created using the create function.
324 * @param navigation_node $childnode Node to add
325 * @param string $beforekey
326 * @return navigation_node The added node
328 public function add_node(navigation_node
$childnode, $beforekey=null) {
329 // First convert the nodetype for this node to a branch as it will now have children
330 if ($this->nodetype
!== self
::NODETYPE_BRANCH
) {
331 $this->nodetype
= self
::NODETYPE_BRANCH
;
333 // Set the parent to this node
334 $childnode->set_parent($this);
336 // Default the key to the number of children if not provided
337 if ($childnode->key
=== null) {
338 $childnode->key
= $this->children
->count();
341 // Add the child using the navigation_node_collections add method
342 $node = $this->children
->add($childnode, $beforekey);
344 // If added node is a category node or the user is logged in and it's a course
345 // then mark added node as a branch (makes it expandable by AJAX)
346 $type = $childnode->type
;
347 if (($type == self
::TYPE_CATEGORY
) ||
(isloggedin() && ($type == self
::TYPE_COURSE
)) ||
($type == self
::TYPE_MY_CATEGORY
) ||
348 ($type === self
::TYPE_SITE_ADMIN
)) {
349 $node->nodetype
= self
::NODETYPE_BRANCH
;
351 // If this node is hidden mark it's children as hidden also
353 $node->hidden
= true;
355 // Return added node (reference returned by $this->children->add()
360 * Return a list of all the keys of all the child nodes.
361 * @return array the keys.
363 public function get_children_key_list() {
364 return $this->children
->get_key_list();
368 * Searches for a node of the given type with the given key.
370 * This searches this node plus all of its children, and their children....
371 * If you know the node you are looking for is a child of this node then please
372 * use the get method instead.
374 * @param int|string $key The key of the node we are looking for
375 * @param int $type One of navigation_node::TYPE_*
376 * @return navigation_node|false
378 public function find($key, $type) {
379 return $this->children
->find($key, $type);
383 * Get the child of this node that has the given key + (optional) type.
385 * If you are looking for a node and want to search all children + thier children
386 * then please use the find method instead.
388 * @param int|string $key The key of the node we are looking for
389 * @param int $type One of navigation_node::TYPE_*
390 * @return navigation_node|false
392 public function get($key, $type=null) {
393 return $this->children
->get($key, $type);
401 public function remove() {
402 return $this->parent
->children
->remove($this->key
, $this->type
);
406 * Checks if this node has or could have any children
408 * @return bool Returns true if it has children or could have (by AJAX expansion)
410 public function has_children() {
411 return ($this->nodetype
=== navigation_node
::NODETYPE_BRANCH ||
$this->children
->count()>0 ||
$this->isexpandable
);
415 * Marks this node as active and forces it open.
417 * Important: If you are here because you need to mark a node active to get
418 * the navigation to do what you want have you looked at {@link navigation_node::override_active_url()}?
419 * You can use it to specify a different URL to match the active navigation node on
420 * rather than having to locate and manually mark a node active.
422 public function make_active() {
423 $this->isactive
= true;
424 $this->add_class('active_tree_node');
426 if ($this->parent
!== null) {
427 $this->parent
->make_inactive();
432 * Marks a node as inactive and recusised back to the base of the tree
433 * doing the same to all parents.
435 public function make_inactive() {
436 $this->isactive
= false;
437 $this->remove_class('active_tree_node');
438 if ($this->parent
!== null) {
439 $this->parent
->make_inactive();
444 * Forces this node to be open and at the same time forces open all
445 * parents until the root node.
449 public function force_open() {
450 $this->forceopen
= true;
451 if ($this->parent
!== null) {
452 $this->parent
->force_open();
457 * Adds a CSS class to this node.
459 * @param string $class
462 public function add_class($class) {
463 if (!in_array($class, $this->classes
)) {
464 $this->classes
[] = $class;
470 * Removes a CSS class from this node.
472 * @param string $class
473 * @return bool True if the class was successfully removed.
475 public function remove_class($class) {
476 if (in_array($class, $this->classes
)) {
477 $key = array_search($class,$this->classes
);
479 unset($this->classes
[$key]);
487 * Sets the title for this node and forces Moodle to utilise it.
488 * @param string $title
490 public function title($title) {
491 $this->title
= $title;
492 $this->forcetitle
= true;
496 * Resets the page specific information on this node if it is being unserialised.
498 public function __wakeup(){
499 $this->forceopen
= false;
500 $this->isactive
= false;
501 $this->remove_class('active_tree_node');
505 * Checks if this node or any of its children contain the active node.
511 public function contains_active_node() {
512 if ($this->isactive
) {
515 foreach ($this->children
as $child) {
516 if ($child->isactive ||
$child->contains_active_node()) {
525 * Finds the active node.
527 * Searches this nodes children plus all of the children for the active node
528 * and returns it if found.
532 * @return navigation_node|false
534 public function find_active_node() {
535 if ($this->isactive
) {
538 foreach ($this->children
as &$child) {
539 $outcome = $child->find_active_node();
540 if ($outcome !== false) {
549 * Searches all children for the best matching active node
550 * @return navigation_node|false
552 public function search_for_active_node() {
553 if ($this->check_if_active(URL_MATCH_BASE
)) {
556 foreach ($this->children
as &$child) {
557 $outcome = $child->search_for_active_node();
558 if ($outcome !== false) {
567 * Gets the content for this node.
569 * @param bool $shorttext If true shorttext is used rather than the normal text
572 public function get_content($shorttext=false) {
573 if ($shorttext && $this->shorttext
!==null) {
574 return format_string($this->shorttext
);
576 return format_string($this->text
);
581 * Gets the title to use for this node.
585 public function get_title() {
586 if ($this->forcetitle ||
$this->action
!= null){
594 * Gets the CSS class to add to this node to describe its type
598 public function get_css_type() {
599 if (array_key_exists($this->type
, $this->namedtypes
)) {
600 return 'type_'.$this->namedtypes
[$this->type
];
602 return 'type_unknown';
606 * Finds all nodes that are expandable by AJAX
608 * @param array $expandable An array by reference to populate with expandable nodes.
610 public function find_expandable(array &$expandable) {
611 foreach ($this->children
as &$child) {
612 if ($child->display
&& $child->has_children() && $child->children
->count() == 0) {
613 $child->id
= 'expandable_branch_'.$child->type
.'_'.clean_param($child->key
, PARAM_ALPHANUMEXT
);
614 $this->add_class('canexpand');
615 $expandable[] = array('id' => $child->id
, 'key' => $child->key
, 'type' => $child->type
);
617 $child->find_expandable($expandable);
622 * Finds all nodes of a given type (recursive)
624 * @param int $type One of navigation_node::TYPE_*
627 public function find_all_of_type($type) {
628 $nodes = $this->children
->type($type);
629 foreach ($this->children
as &$node) {
630 $childnodes = $node->find_all_of_type($type);
631 $nodes = array_merge($nodes, $childnodes);
637 * Removes this node if it is empty
639 public function trim_if_empty() {
640 if ($this->children
->count() == 0) {
646 * Creates a tab representation of this nodes children that can be used
647 * with print_tabs to produce the tabs on a page.
649 * call_user_func_array('print_tabs', $node->get_tabs_array());
651 * @param array $inactive
652 * @param bool $return
653 * @return array Array (tabs, selected, inactive, activated, return)
655 public function get_tabs_array(array $inactive=array(), $return=false) {
659 $activated = array();
660 foreach ($this->children
as $node) {
661 $tabs[] = new tabobject($node->key
, $node->action
, $node->get_content(), $node->get_title());
662 if ($node->contains_active_node()) {
663 if ($node->children
->count() > 0) {
664 $activated[] = $node->key
;
665 foreach ($node->children
as $child) {
666 if ($child->contains_active_node()) {
667 $selected = $child->key
;
669 $rows[] = new tabobject($child->key
, $child->action
, $child->get_content(), $child->get_title());
672 $selected = $node->key
;
676 return array(array($tabs, $rows), $selected, $inactive, $activated, $return);
680 * Sets the parent for this node and if this node is active ensures that the tree is properly
683 * @param navigation_node $parent
685 public function set_parent(navigation_node
$parent) {
686 // Set the parent (thats the easy part)
687 $this->parent
= $parent;
688 // Check if this node is active (this is checked during construction)
689 if ($this->isactive
) {
690 // Force all of the parent nodes open so you can see this node
691 $this->parent
->force_open();
692 // Make all parents inactive so that its clear where we are.
693 $this->parent
->make_inactive();
698 * Hides the node and any children it has.
701 * @param array $typestohide Optional. An array of node types that should be hidden.
702 * If null all nodes will be hidden.
703 * If an array is given then nodes will only be hidden if their type mtatches an element in the array.
704 * e.g. array(navigation_node::TYPE_COURSE) would hide only course nodes.
706 public function hide(array $typestohide = null) {
707 if ($typestohide === null ||
in_array($this->type
, $typestohide)) {
708 $this->display
= false;
709 if ($this->has_children()) {
710 foreach ($this->children
as $child) {
711 $child->hide($typestohide);
719 * Navigation node collection
721 * This class is responsible for managing a collection of navigation nodes.
722 * It is required because a node's unique identifier is a combination of both its
725 * Originally an array was used with a string key that was a combination of the two
726 * however it was decided that a better solution would be to use a class that
727 * implements the standard IteratorAggregate interface.
730 * @category navigation
731 * @copyright 2010 Sam Hemelryk
732 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
734 class navigation_node_collection
implements IteratorAggregate
{
736 * A multidimensional array to where the first key is the type and the second
737 * key is the nodes key.
740 protected $collection = array();
742 * An array that contains references to nodes in the same order they were added.
743 * This is maintained as a progressive array.
746 protected $orderedcollection = array();
748 * A reference to the last node that was added to the collection
749 * @var navigation_node
751 protected $last = null;
753 * The total number of items added to this array.
756 protected $count = 0;
759 * Adds a navigation node to the collection
761 * @param navigation_node $node Node to add
762 * @param string $beforekey If specified, adds before a node with this key,
763 * otherwise adds at end
764 * @return navigation_node Added node
766 public function add(navigation_node
$node, $beforekey=null) {
771 // First check we have a 2nd dimension for this type
772 if (!array_key_exists($type, $this->orderedcollection
)) {
773 $this->orderedcollection
[$type] = array();
775 // Check for a collision and report if debugging is turned on
776 if ($CFG->debug
&& array_key_exists($key, $this->orderedcollection
[$type])) {
777 debugging('Navigation node intersect: Adding a node that already exists '.$key, DEBUG_DEVELOPER
);
780 // Find the key to add before
781 $newindex = $this->count
;
783 if ($beforekey !== null) {
784 foreach ($this->collection
as $index => $othernode) {
785 if ($othernode->key
=== $beforekey) {
791 if ($newindex === $this->count
) {
792 debugging('Navigation node add_before: Reference node not found ' . $beforekey .
793 ', options: ' . implode(' ', $this->get_key_list()), DEBUG_DEVELOPER
);
797 // Add the node to the appropriate place in the by-type structure (which
798 // is not ordered, despite the variable name)
799 $this->orderedcollection
[$type][$key] = $node;
801 // Update existing references in the ordered collection (which is the
802 // one that isn't called 'ordered') to shuffle them along if required
803 for ($oldindex = $this->count
; $oldindex > $newindex; $oldindex--) {
804 $this->collection
[$oldindex] = $this->collection
[$oldindex - 1];
807 // Add a reference to the node to the progressive collection.
808 $this->collection
[$newindex] = $this->orderedcollection
[$type][$key];
809 // Update the last property to a reference to this new node.
810 $this->last
= $this->orderedcollection
[$type][$key];
812 // Reorder the array by index if needed
814 ksort($this->collection
);
817 // Return the reference to the now added node
822 * Return a list of all the keys of all the nodes.
823 * @return array the keys.
825 public function get_key_list() {
827 foreach ($this->collection
as $node) {
828 $keys[] = $node->key
;
834 * Fetches a node from this collection.
836 * @param string|int $key The key of the node we want to find.
837 * @param int $type One of navigation_node::TYPE_*.
838 * @return navigation_node|null
840 public function get($key, $type=null) {
841 if ($type !== null) {
842 // If the type is known then we can simply check and fetch
843 if (!empty($this->orderedcollection
[$type][$key])) {
844 return $this->orderedcollection
[$type][$key];
847 // Because we don't know the type we look in the progressive array
848 foreach ($this->collection
as $node) {
849 if ($node->key
=== $key) {
858 * Searches for a node with matching key and type.
860 * This function searches both the nodes in this collection and all of
861 * the nodes in each collection belonging to the nodes in this collection.
865 * @param string|int $key The key of the node we want to find.
866 * @param int $type One of navigation_node::TYPE_*.
867 * @return navigation_node|null
869 public function find($key, $type=null) {
870 if ($type !== null && array_key_exists($type, $this->orderedcollection
) && array_key_exists($key, $this->orderedcollection
[$type])) {
871 return $this->orderedcollection
[$type][$key];
873 $nodes = $this->getIterator();
874 // Search immediate children first
875 foreach ($nodes as &$node) {
876 if ($node->key
=== $key && ($type === null ||
$type === $node->type
)) {
880 // Now search each childs children
881 foreach ($nodes as &$node) {
882 $result = $node->children
->find($key, $type);
883 if ($result !== false) {
892 * Fetches the last node that was added to this collection
894 * @return navigation_node
896 public function last() {
901 * Fetches all nodes of a given type from this collection
903 * @param string|int $type node type being searched for.
904 * @return array ordered collection
906 public function type($type) {
907 if (!array_key_exists($type, $this->orderedcollection
)) {
908 $this->orderedcollection
[$type] = array();
910 return $this->orderedcollection
[$type];
913 * Removes the node with the given key and type from the collection
915 * @param string|int $key The key of the node we want to find.
919 public function remove($key, $type=null) {
920 $child = $this->get($key, $type);
921 if ($child !== false) {
922 foreach ($this->collection
as $colkey => $node) {
923 if ($node->key
=== $key && $node->type
== $type) {
924 unset($this->collection
[$colkey]);
925 $this->collection
= array_values($this->collection
);
929 unset($this->orderedcollection
[$child->type
][$child->key
]);
937 * Gets the number of nodes in this collection
939 * This option uses an internal count rather than counting the actual options to avoid
940 * a performance hit through the count function.
944 public function count() {
948 * Gets an array iterator for the collection.
950 * This is required by the IteratorAggregator interface and is used by routines
951 * such as the foreach loop.
953 * @return ArrayIterator
955 public function getIterator() {
956 return new ArrayIterator($this->collection
);
961 * The global navigation class used for... the global navigation
963 * This class is used by PAGE to store the global navigation for the site
964 * and is then used by the settings nav and navbar to save on processing and DB calls
967 * {@link lib/pagelib.php} {@link moodle_page::initialise_theme_and_output()}
968 * {@link lib/ajax/getnavbranch.php} Called by ajax
971 * @category navigation
972 * @copyright 2009 Sam Hemelryk
973 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
975 class global_navigation
extends navigation_node
{
976 /** @var moodle_page The Moodle page this navigation object belongs to. */
978 /** @var bool switch to let us know if the navigation object is initialised*/
979 protected $initialised = false;
980 /** @var array An array of course information */
981 protected $mycourses = array();
982 /** @var array An array for containing root navigation nodes */
983 protected $rootnodes = array();
984 /** @var bool A switch for whether to show empty sections in the navigation */
985 protected $showemptysections = true;
986 /** @var bool A switch for whether courses should be shown within categories on the navigation. */
987 protected $showcategories = null;
988 /** @var null@var bool A switch for whether or not to show categories in the my courses branch. */
989 protected $showmycategories = null;
990 /** @var array An array of stdClasses for users that the navigation is extended for */
991 protected $extendforuser = array();
992 /** @var navigation_cache */
994 /** @var array An array of course ids that are present in the navigation */
995 protected $addedcourses = array();
997 protected $allcategoriesloaded = false;
998 /** @var array An array of category ids that are included in the navigation */
999 protected $addedcategories = array();
1000 /** @var int expansion limit */
1001 protected $expansionlimit = 0;
1002 /** @var int userid to allow parent to see child's profile page navigation */
1003 protected $useridtouseforparentchecks = 0;
1004 /** @var cache_session A cache that stores information on expanded courses */
1005 protected $cacheexpandcourse = null;
1007 /** Used when loading categories to load all top level categories [parent = 0] **/
1008 const LOAD_ROOT_CATEGORIES
= 0;
1009 /** Used when loading categories to load all categories **/
1010 const LOAD_ALL_CATEGORIES
= -1;
1013 * Constructs a new global navigation
1015 * @param moodle_page $page The page this navigation object belongs to
1017 public function __construct(moodle_page
$page) {
1018 global $CFG, $SITE, $USER;
1020 if (during_initial_install()) {
1024 if (get_home_page() == HOMEPAGE_SITE
) {
1025 // We are using the site home for the root element
1026 $properties = array(
1028 'type' => navigation_node
::TYPE_SYSTEM
,
1029 'text' => get_string('home'),
1030 'action' => new moodle_url('/')
1033 // We are using the users my moodle for the root element
1034 $properties = array(
1036 'type' => navigation_node
::TYPE_SYSTEM
,
1037 'text' => get_string('myhome'),
1038 'action' => new moodle_url('/my/')
1042 // Use the parents constructor.... good good reuse
1043 parent
::__construct($properties);
1045 // Initalise and set defaults
1046 $this->page
= $page;
1047 $this->forceopen
= true;
1048 $this->cache
= new navigation_cache(NAVIGATION_CACHE_NAME
);
1052 * Mutator to set userid to allow parent to see child's profile
1053 * page navigation. See MDL-25805 for initial issue. Linked to it
1054 * is an issue explaining why this is a REALLY UGLY HACK thats not
1057 * @param int $userid userid of profile page that parent wants to navigate around.
1059 public function set_userid_for_parent_checks($userid) {
1060 $this->useridtouseforparentchecks
= $userid;
1065 * Initialises the navigation object.
1067 * This causes the navigation object to look at the current state of the page
1068 * that it is associated with and then load the appropriate content.
1070 * This should only occur the first time that the navigation structure is utilised
1071 * which will normally be either when the navbar is called to be displayed or
1072 * when a block makes use of it.
1076 public function initialise() {
1077 global $CFG, $SITE, $USER;
1078 // Check if it has already been initialised
1079 if ($this->initialised ||
during_initial_install()) {
1082 $this->initialised
= true;
1084 // Set up the five base root nodes. These are nodes where we will put our
1085 // content and are as follows:
1086 // site: Navigation for the front page.
1087 // myprofile: User profile information goes here.
1088 // currentcourse: The course being currently viewed.
1089 // mycourses: The users courses get added here.
1090 // courses: Additional courses are added here.
1091 // users: Other users information loaded here.
1092 $this->rootnodes
= array();
1093 if (get_home_page() == HOMEPAGE_SITE
) {
1094 // The home element should be my moodle because the root element is the site
1095 if (isloggedin() && !isguestuser()) { // Makes no sense if you aren't logged in
1096 $this->rootnodes
['home'] = $this->add(get_string('myhome'), new moodle_url('/my/'), self
::TYPE_SETTING
, null, 'home');
1099 // The home element should be the site because the root node is my moodle
1100 $this->rootnodes
['home'] = $this->add(get_string('sitehome'), new moodle_url('/'), self
::TYPE_SETTING
, null, 'home');
1101 if (!empty($CFG->defaulthomepage
) && ($CFG->defaulthomepage
== HOMEPAGE_MY
)) {
1102 // We need to stop automatic redirection
1103 $this->rootnodes
['home']->action
->param('redirect', '0');
1106 $this->rootnodes
['site'] = $this->add_course($SITE);
1107 $this->rootnodes
['myprofile'] = $this->add(get_string('myprofile'), null, self
::TYPE_USER
, null, 'myprofile');
1108 $this->rootnodes
['currentcourse'] = $this->add(get_string('currentcourse'), null, self
::TYPE_ROOTNODE
, null, 'currentcourse');
1109 $this->rootnodes
['mycourses'] = $this->add(get_string('mycourses'), new moodle_url('/my/'), self
::TYPE_ROOTNODE
, null, 'mycourses');
1110 $this->rootnodes
['courses'] = $this->add(get_string('courses'), new moodle_url('/course/index.php'), self
::TYPE_ROOTNODE
, null, 'courses');
1111 $this->rootnodes
['users'] = $this->add(get_string('users'), null, self
::TYPE_ROOTNODE
, null, 'users');
1113 // We always load the frontpage course to ensure it is available without
1114 // JavaScript enabled.
1115 $this->add_front_page_course_essentials($this->rootnodes
['site'], $SITE);
1116 $this->load_course_sections($SITE, $this->rootnodes
['site']);
1118 $course = $this->page
->course
;
1120 // $issite gets set to true if the current pages course is the sites frontpage course
1121 $issite = ($this->page
->course
->id
== $SITE->id
);
1122 // Determine if the user is enrolled in any course.
1123 $enrolledinanycourse = enrol_user_sees_own_courses();
1125 $this->rootnodes
['currentcourse']->mainnavonly
= true;
1126 if ($enrolledinanycourse) {
1127 $this->rootnodes
['mycourses']->isexpandable
= true;
1128 if ($CFG->navshowallcourses
) {
1129 // When we show all courses we need to show both the my courses and the regular courses branch.
1130 $this->rootnodes
['courses']->isexpandable
= true;
1133 $this->rootnodes
['courses']->isexpandable
= true;
1136 if ($this->rootnodes
['mycourses']->isactive
) {
1137 $this->load_courses_enrolled();
1140 $canviewcourseprofile = true;
1142 // Next load context specific content into the navigation
1143 switch ($this->page
->context
->contextlevel
) {
1144 case CONTEXT_SYSTEM
:
1145 // Nothing left to do here I feel.
1147 case CONTEXT_COURSECAT
:
1148 // This is essential, we must load categories.
1149 $this->load_all_categories($this->page
->context
->instanceid
, true);
1151 case CONTEXT_BLOCK
:
1152 case CONTEXT_COURSE
:
1154 // Nothing left to do here.
1158 // Load the course associated with the current page into the navigation.
1159 $coursenode = $this->add_course($course, false, self
::COURSE_CURRENT
);
1160 // If the course wasn't added then don't try going any further.
1162 $canviewcourseprofile = false;
1166 // If the user is not enrolled then we only want to show the
1167 // course node and not populate it.
1169 // Not enrolled, can't view, and hasn't switched roles
1170 if (!can_access_course($course)) {
1171 if ($coursenode->isexpandable
=== true) {
1172 // Obviously the situation has changed, update the cache and adjust the node.
1173 // This occurs if the user access to a course has been revoked (one way or another) after
1174 // initially logging in for this session.
1175 $this->get_expand_course_cache()->set($course->id
, 1);
1176 $coursenode->isexpandable
= true;
1177 $coursenode->nodetype
= self
::NODETYPE_BRANCH
;
1179 // Very ugly hack - do not force "parents" to enrol into course their child is enrolled in,
1180 // this hack has been propagated from user/view.php to display the navigation node. (MDL-25805)
1181 if (!$this->current_user_is_parent_role()) {
1182 $coursenode->make_active();
1183 $canviewcourseprofile = false;
1188 if ($coursenode->isexpandable
=== false) {
1189 // Obviously the situation has changed, update the cache and adjust the node.
1190 // This occurs if the user has been granted access to a course (one way or another) after initially
1191 // logging in for this session.
1192 $this->get_expand_course_cache()->set($course->id
, 1);
1193 $coursenode->isexpandable
= true;
1194 $coursenode->nodetype
= self
::NODETYPE_BRANCH
;
1197 // Add the essentials such as reports etc...
1198 $this->add_course_essentials($coursenode, $course);
1199 // Extend course navigation with it's sections/activities
1200 $this->load_course_sections($course, $coursenode);
1201 if (!$coursenode->contains_active_node() && !$coursenode->search_for_active_node()) {
1202 $coursenode->make_active();
1206 case CONTEXT_MODULE
:
1208 // If this is the site course then most information will have
1209 // already been loaded.
1210 // However we need to check if there is more content that can
1211 // yet be loaded for the specific module instance.
1212 $activitynode = $this->rootnodes
['site']->find($this->page
->cm
->id
, navigation_node
::TYPE_ACTIVITY
);
1213 if ($activitynode) {
1214 $this->load_activity($this->page
->cm
, $this->page
->course
, $activitynode);
1219 $course = $this->page
->course
;
1220 $cm = $this->page
->cm
;
1222 // Load the course associated with the page into the navigation
1223 $coursenode = $this->add_course($course, false, self
::COURSE_CURRENT
);
1225 // If the course wasn't added then don't try going any further.
1227 $canviewcourseprofile = false;
1231 // If the user is not enrolled then we only want to show the
1232 // course node and not populate it.
1233 if (!can_access_course($course)) {
1234 $coursenode->make_active();
1235 $canviewcourseprofile = false;
1239 $this->add_course_essentials($coursenode, $course);
1241 // Load the course sections into the page
1242 $this->load_course_sections($course, $coursenode, null, $cm);
1243 $activity = $coursenode->find($cm->id
, navigation_node
::TYPE_ACTIVITY
);
1244 if (!empty($activity)) {
1245 // Finally load the cm specific navigaton information
1246 $this->load_activity($cm, $course, $activity);
1247 // Check if we have an active ndoe
1248 if (!$activity->contains_active_node() && !$activity->search_for_active_node()) {
1249 // And make the activity node active.
1250 $activity->make_active();
1256 // The users profile information etc is already loaded
1257 // for the front page.
1260 $course = $this->page
->course
;
1261 // Load the course associated with the user into the navigation
1262 $coursenode = $this->add_course($course, false, self
::COURSE_CURRENT
);
1264 // If the course wasn't added then don't try going any further.
1266 $canviewcourseprofile = false;
1270 // If the user is not enrolled then we only want to show the
1271 // course node and not populate it.
1272 if (!can_access_course($course)) {
1273 $coursenode->make_active();
1274 $canviewcourseprofile = false;
1277 $this->add_course_essentials($coursenode, $course);
1278 $this->load_course_sections($course, $coursenode);
1282 // Load for the current user
1283 $this->load_for_user();
1284 if ($this->page
->context
->contextlevel
>= CONTEXT_COURSE
&& $this->page
->context
->instanceid
!= $SITE->id
&& $canviewcourseprofile) {
1285 $this->load_for_user(null, true);
1287 // Load each extending user into the navigation.
1288 foreach ($this->extendforuser
as $user) {
1289 if ($user->id
!= $USER->id
) {
1290 $this->load_for_user($user);
1294 // Give the local plugins a chance to include some navigation if they want.
1295 foreach (core_component
::get_plugin_list_with_file('local', 'lib.php', true) as $plugin => $file) {
1296 $function = "local_{$plugin}_extends_navigation";
1297 $oldfunction = "{$plugin}_extends_navigation";
1298 if (function_exists($function)) {
1299 // This is the preferred function name as there is less chance of conflicts
1301 } else if (function_exists($oldfunction)) {
1302 // We continue to support the old function name to ensure backwards compatibility
1303 debugging("Deprecated local plugin navigation callback: Please rename '{$oldfunction}' to '{$function}'. Support for the old callback will be dropped after the release of 2.4", DEBUG_DEVELOPER
);
1304 $oldfunction($this);
1308 // Remove any empty root nodes
1309 foreach ($this->rootnodes
as $node) {
1310 // Dont remove the home node
1311 /** @var navigation_node $node */
1312 if ($node->key
!== 'home' && !$node->has_children() && !$node->isactive
) {
1317 if (!$this->contains_active_node()) {
1318 $this->search_for_active_node();
1321 // If the user is not logged in modify the navigation structure as detailed
1322 // in {@link http://docs.moodle.org/dev/Navigation_2.0_structure}
1323 if (!isloggedin()) {
1324 $activities = clone($this->rootnodes
['site']->children
);
1325 $this->rootnodes
['site']->remove();
1326 $children = clone($this->children
);
1327 $this->children
= new navigation_node_collection();
1328 foreach ($activities as $child) {
1329 $this->children
->add($child);
1331 foreach ($children as $child) {
1332 $this->children
->add($child);
1339 * Returns true if the current user is a parent of the user being currently viewed.
1341 * If the current user is not viewing another user, or if the current user does not hold any parent roles over the
1342 * other user being viewed this function returns false.
1343 * In order to set the user for whom we are checking against you must call {@link set_userid_for_parent_checks()}
1348 protected function current_user_is_parent_role() {
1350 if ($this->useridtouseforparentchecks
&& $this->useridtouseforparentchecks
!= $USER->id
) {
1351 $usercontext = context_user
::instance($this->useridtouseforparentchecks
, MUST_EXIST
);
1352 if (!has_capability('moodle/user:viewdetails', $usercontext)) {
1355 if ($DB->record_exists('role_assignments', array('userid' => $USER->id
, 'contextid' => $usercontext->id
))) {
1363 * Returns true if courses should be shown within categories on the navigation.
1365 * @param bool $ismycourse Set to true if you are calculating this for a course.
1368 protected function show_categories($ismycourse = false) {
1371 return $this->show_my_categories();
1373 if ($this->showcategories
=== null) {
1375 if ($this->page
->context
->contextlevel
== CONTEXT_COURSECAT
) {
1377 } else if (!empty($CFG->navshowcategories
) && $DB->count_records('course_categories') > 1) {
1380 $this->showcategories
= $show;
1382 return $this->showcategories
;
1386 * Returns true if we should show categories in the My Courses branch.
1389 protected function show_my_categories() {
1391 if ($this->showmycategories
=== null) {
1392 $this->showmycategories
= !empty($CFG->navshowmycoursecategories
) && $DB->count_records('course_categories') > 1;
1394 return $this->showmycategories
;
1398 * Loads the courses in Moodle into the navigation.
1400 * @global moodle_database $DB
1401 * @param string|array $categoryids An array containing categories to load courses
1402 * for, OR null to load courses for all categories.
1403 * @return array An array of navigation_nodes one for each course
1405 protected function load_all_courses($categoryids = null) {
1406 global $CFG, $DB, $SITE;
1408 // Work out the limit of courses.
1410 if (!empty($CFG->navcourselimit
)) {
1411 $limit = $CFG->navcourselimit
;
1414 $toload = (empty($CFG->navshowallcourses
))?self
::LOAD_ROOT_CATEGORIES
:self
::LOAD_ALL_CATEGORIES
;
1416 // If we are going to show all courses AND we are showing categories then
1417 // to save us repeated DB calls load all of the categories now
1418 if ($this->show_categories()) {
1419 $this->load_all_categories($toload);
1422 // Will be the return of our efforts
1423 $coursenodes = array();
1425 // Check if we need to show categories.
1426 if ($this->show_categories()) {
1427 // Hmmm we need to show categories... this is going to be painful.
1428 // We now need to fetch up to $limit courses for each category to
1430 if ($categoryids !== null) {
1431 if (!is_array($categoryids)) {
1432 $categoryids = array($categoryids);
1434 list($categorywhere, $categoryparams) = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED
, 'cc');
1435 $categorywhere = 'WHERE cc.id '.$categorywhere;
1436 } else if ($toload == self
::LOAD_ROOT_CATEGORIES
) {
1437 $categorywhere = 'WHERE cc.depth = 1 OR cc.depth = 2';
1438 $categoryparams = array();
1440 $categorywhere = '';
1441 $categoryparams = array();
1444 // First up we are going to get the categories that we are going to
1445 // need so that we can determine how best to load the courses from them.
1446 $sql = "SELECT cc.id, COUNT(c.id) AS coursecount
1447 FROM {course_categories} cc
1448 LEFT JOIN {course} c ON c.category = cc.id
1451 $categories = $DB->get_recordset_sql($sql, $categoryparams);
1452 $fullfetch = array();
1453 $partfetch = array();
1454 foreach ($categories as $category) {
1455 if (!$this->can_add_more_courses_to_category($category->id
)) {
1458 if ($category->coursecount
> $limit * 5) {
1459 $partfetch[] = $category->id
;
1460 } else if ($category->coursecount
> 0) {
1461 $fullfetch[] = $category->id
;
1464 $categories->close();
1466 if (count($fullfetch)) {
1467 // First up fetch all of the courses in categories where we know that we are going to
1468 // need the majority of courses.
1469 list($categoryids, $categoryparams) = $DB->get_in_or_equal($fullfetch, SQL_PARAMS_NAMED
, 'lcategory');
1470 $ccselect = ', ' . context_helper
::get_preload_record_columns_sql('ctx');
1471 $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
1472 $categoryparams['contextlevel'] = CONTEXT_COURSE
;
1473 $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
1476 WHERE c.category {$categoryids}
1477 ORDER BY c.sortorder ASC";
1478 $coursesrs = $DB->get_recordset_sql($sql, $categoryparams);
1479 foreach ($coursesrs as $course) {
1480 if ($course->id
== $SITE->id
) {
1481 // This should not be necessary, frontpage is not in any category.
1484 if (array_key_exists($course->id
, $this->addedcourses
)) {
1485 // It is probably better to not include the already loaded courses
1486 // directly in SQL because inequalities may confuse query optimisers
1487 // and may interfere with query caching.
1490 if (!$this->can_add_more_courses_to_category($course->category
)) {
1493 context_helper
::preload_from_record($course);
1494 if (!$course->visible
&& !is_role_switched($course->id
) && !has_capability('moodle/course:viewhiddencourses', context_course
::instance($course->id
))) {
1497 $coursenodes[$course->id
] = $this->add_course($course);
1499 $coursesrs->close();
1502 if (count($partfetch)) {
1503 // Next we will work our way through the categories where we will likely only need a small
1504 // proportion of the courses.
1505 foreach ($partfetch as $categoryid) {
1506 $ccselect = ', ' . context_helper
::get_preload_record_columns_sql('ctx');
1507 $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
1508 $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
1511 WHERE c.category = :categoryid
1512 ORDER BY c.sortorder ASC";
1513 $courseparams = array('categoryid' => $categoryid, 'contextlevel' => CONTEXT_COURSE
);
1514 $coursesrs = $DB->get_recordset_sql($sql, $courseparams, 0, $limit * 5);
1515 foreach ($coursesrs as $course) {
1516 if ($course->id
== $SITE->id
) {
1517 // This should not be necessary, frontpage is not in any category.
1520 if (array_key_exists($course->id
, $this->addedcourses
)) {
1521 // It is probably better to not include the already loaded courses
1522 // directly in SQL because inequalities may confuse query optimisers
1523 // and may interfere with query caching.
1524 // This also helps to respect expected $limit on repeated executions.
1527 if (!$this->can_add_more_courses_to_category($course->category
)) {
1530 context_helper
::preload_from_record($course);
1531 if (!$course->visible
&& !is_role_switched($course->id
) && !has_capability('moodle/course:viewhiddencourses', context_course
::instance($course->id
))) {
1534 $coursenodes[$course->id
] = $this->add_course($course);
1536 $coursesrs->close();
1540 // Prepare the SQL to load the courses and their contexts
1541 list($courseids, $courseparams) = $DB->get_in_or_equal(array_keys($this->addedcourses
), SQL_PARAMS_NAMED
, 'lc', false);
1542 $ccselect = ', ' . context_helper
::get_preload_record_columns_sql('ctx');
1543 $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
1544 $courseparams['contextlevel'] = CONTEXT_COURSE
;
1545 $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
1548 WHERE c.id {$courseids}
1549 ORDER BY c.sortorder ASC";
1550 $coursesrs = $DB->get_recordset_sql($sql, $courseparams);
1551 foreach ($coursesrs as $course) {
1552 if ($course->id
== $SITE->id
) {
1553 // frotpage is not wanted here
1556 if ($this->page
->course
&& ($this->page
->course
->id
== $course->id
)) {
1557 // Don't include the currentcourse in this nodelist - it's displayed in the Current course node
1560 context_helper
::preload_from_record($course);
1561 if (!$course->visible
&& !is_role_switched($course->id
) && !has_capability('moodle/course:viewhiddencourses', context_course
::instance($course->id
))) {
1564 $coursenodes[$course->id
] = $this->add_course($course);
1565 if (count($coursenodes) >= $limit) {
1569 $coursesrs->close();
1572 return $coursenodes;
1576 * Returns true if more courses can be added to the provided category.
1578 * @param int|navigation_node|stdClass $category
1581 protected function can_add_more_courses_to_category($category) {
1584 if (!empty($CFG->navcourselimit
)) {
1585 $limit = (int)$CFG->navcourselimit
;
1587 if (is_numeric($category)) {
1588 if (!array_key_exists($category, $this->addedcategories
)) {
1591 $coursecount = count($this->addedcategories
[$category]->children
->type(self
::TYPE_COURSE
));
1592 } else if ($category instanceof navigation_node
) {
1593 if (($category->type
!= self
::TYPE_CATEGORY
) ||
($category->type
!= self
::TYPE_MY_CATEGORY
)) {
1596 $coursecount = count($category->children
->type(self
::TYPE_COURSE
));
1597 } else if (is_object($category) && property_exists($category,'id')) {
1598 $coursecount = count($this->addedcategories
[$category->id
]->children
->type(self
::TYPE_COURSE
));
1600 return ($coursecount <= $limit);
1604 * Loads all categories (top level or if an id is specified for that category)
1606 * @param int $categoryid The category id to load or null/0 to load all base level categories
1607 * @param bool $showbasecategories If set to true all base level categories will be loaded as well
1608 * as the requested category and any parent categories.
1609 * @return navigation_node|void returns a navigation node if a category has been loaded.
1611 protected function load_all_categories($categoryid = self
::LOAD_ROOT_CATEGORIES
, $showbasecategories = false) {
1614 // Check if this category has already been loaded
1615 if ($this->allcategoriesloaded ||
($categoryid < 1 && $this->is_category_fully_loaded($categoryid))) {
1619 $catcontextsql = context_helper
::get_preload_record_columns_sql('ctx');
1620 $sqlselect = "SELECT cc.*, $catcontextsql
1621 FROM {course_categories} cc
1622 JOIN {context} ctx ON cc.id = ctx.instanceid";
1623 $sqlwhere = "WHERE ctx.contextlevel = ".CONTEXT_COURSECAT
;
1624 $sqlorder = "ORDER BY cc.depth ASC, cc.sortorder ASC, cc.id ASC";
1627 $categoriestoload = array();
1628 if ($categoryid == self
::LOAD_ALL_CATEGORIES
) {
1629 // We are going to load all categories regardless... prepare to fire
1630 // on the database server!
1631 } else if ($categoryid == self
::LOAD_ROOT_CATEGORIES
) { // can be 0
1632 // We are going to load all of the first level categories (categories without parents)
1633 $sqlwhere .= " AND cc.parent = 0";
1634 } else if (array_key_exists($categoryid, $this->addedcategories
)) {
1635 // The category itself has been loaded already so we just need to ensure its subcategories
1637 $addedcategories = $this->addedcategories
;
1638 unset($addedcategories[$categoryid]);
1639 if (count($addedcategories) > 0) {
1640 list($sql, $params) = $DB->get_in_or_equal(array_keys($addedcategories), SQL_PARAMS_NAMED
, 'parent', false);
1641 if ($showbasecategories) {
1642 // We need to include categories with parent = 0 as well
1643 $sqlwhere .= " AND (cc.parent = :categoryid OR cc.parent = 0) AND cc.parent {$sql}";
1645 // All we need is categories that match the parent
1646 $sqlwhere .= " AND cc.parent = :categoryid AND cc.parent {$sql}";
1649 $params['categoryid'] = $categoryid;
1651 // This category hasn't been loaded yet so we need to fetch it, work out its category path
1652 // and load this category plus all its parents and subcategories
1653 $category = $DB->get_record('course_categories', array('id' => $categoryid), 'path', MUST_EXIST
);
1654 $categoriestoload = explode('/', trim($category->path
, '/'));
1655 list($select, $params) = $DB->get_in_or_equal($categoriestoload);
1656 // We are going to use select twice so double the params
1657 $params = array_merge($params, $params);
1658 $basecategorysql = ($showbasecategories)?
' OR cc.depth = 1':'';
1659 $sqlwhere .= " AND (cc.id {$select} OR cc.parent {$select}{$basecategorysql})";
1662 $categoriesrs = $DB->get_recordset_sql("$sqlselect $sqlwhere $sqlorder", $params);
1663 $categories = array();
1664 foreach ($categoriesrs as $category) {
1665 // Preload the context.. we'll need it when adding the category in order
1666 // to format the category name.
1667 context_helper
::preload_from_record($category);
1668 if (array_key_exists($category->id
, $this->addedcategories
)) {
1669 // Do nothing, its already been added.
1670 } else if ($category->parent
== '0') {
1671 // This is a root category lets add it immediately
1672 $this->add_category($category, $this->rootnodes
['courses']);
1673 } else if (array_key_exists($category->parent
, $this->addedcategories
)) {
1674 // This categories parent has already been added we can add this immediately
1675 $this->add_category($category, $this->addedcategories
[$category->parent
]);
1677 $categories[] = $category;
1680 $categoriesrs->close();
1682 // Now we have an array of categories we need to add them to the navigation.
1683 while (!empty($categories)) {
1684 $category = reset($categories);
1685 if (array_key_exists($category->id
, $this->addedcategories
)) {
1687 } else if ($category->parent
== '0') {
1688 $this->add_category($category, $this->rootnodes
['courses']);
1689 } else if (array_key_exists($category->parent
, $this->addedcategories
)) {
1690 $this->add_category($category, $this->addedcategories
[$category->parent
]);
1692 // This category isn't in the navigation and niether is it's parent (yet).
1693 // We need to go through the category path and add all of its components in order.
1694 $path = explode('/', trim($category->path
, '/'));
1695 foreach ($path as $catid) {
1696 if (!array_key_exists($catid, $this->addedcategories
)) {
1697 // This category isn't in the navigation yet so add it.
1698 $subcategory = $categories[$catid];
1699 if ($subcategory->parent
== '0') {
1700 // Yay we have a root category - this likely means we will now be able
1701 // to add categories without problems.
1702 $this->add_category($subcategory, $this->rootnodes
['courses']);
1703 } else if (array_key_exists($subcategory->parent
, $this->addedcategories
)) {
1704 // The parent is in the category (as we'd expect) so add it now.
1705 $this->add_category($subcategory, $this->addedcategories
[$subcategory->parent
]);
1706 // Remove the category from the categories array.
1707 unset($categories[$catid]);
1709 // We should never ever arrive here - if we have then there is a bigger
1711 throw new coding_exception('Category path order is incorrect and/or there are missing categories');
1716 // Remove the category from the categories array now that we know it has been added.
1717 unset($categories[$category->id
]);
1719 if ($categoryid === self
::LOAD_ALL_CATEGORIES
) {
1720 $this->allcategoriesloaded
= true;
1722 // Check if there are any categories to load.
1723 if (count($categoriestoload) > 0) {
1724 $readytoloadcourses = array();
1725 foreach ($categoriestoload as $category) {
1726 if ($this->can_add_more_courses_to_category($category)) {
1727 $readytoloadcourses[] = $category;
1730 if (count($readytoloadcourses)) {
1731 $this->load_all_courses($readytoloadcourses);
1735 // Look for all categories which have been loaded
1736 if (!empty($this->addedcategories
)) {
1737 $categoryids = array();
1738 foreach ($this->addedcategories
as $category) {
1739 if ($this->can_add_more_courses_to_category($category)) {
1740 $categoryids[] = $category->key
;
1744 list($categoriessql, $params) = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED
);
1745 $params['limit'] = (!empty($CFG->navcourselimit
))?
$CFG->navcourselimit
:20;
1746 $sql = "SELECT cc.id, COUNT(c.id) AS coursecount
1747 FROM {course_categories} cc
1748 JOIN {course} c ON c.category = cc.id
1749 WHERE cc.id {$categoriessql}
1751 HAVING COUNT(c.id) > :limit";
1752 $excessivecategories = $DB->get_records_sql($sql, $params);
1753 foreach ($categories as &$category) {
1754 if (array_key_exists($category->key
, $excessivecategories) && !$this->can_add_more_courses_to_category($category)) {
1755 $url = new moodle_url('/course/index.php', array('categoryid' => $category->key
));
1756 $category->add(get_string('viewallcourses'), $url, self
::TYPE_SETTING
);
1764 * Adds a structured category to the navigation in the correct order/place
1766 * @param stdClass $category category to be added in navigation.
1767 * @param navigation_node $parent parent navigation node
1768 * @param int $nodetype type of node, if category is under MyHome then it's TYPE_MY_CATEGORY
1771 protected function add_category(stdClass
$category, navigation_node
$parent, $nodetype = self
::TYPE_CATEGORY
) {
1772 if (array_key_exists($category->id
, $this->addedcategories
)) {
1775 $url = new moodle_url('/course/index.php', array('categoryid' => $category->id
));
1776 $context = context_coursecat
::instance($category->id
);
1777 $categoryname = format_string($category->name
, true, array('context' => $context));
1778 $categorynode = $parent->add($categoryname, $url, $nodetype, $categoryname, $category->id
);
1779 if (empty($category->visible
)) {
1780 if (has_capability('moodle/category:viewhiddencategories', context_system
::instance())) {
1781 $categorynode->hidden
= true;
1783 $categorynode->display
= false;
1786 $this->addedcategories
[$category->id
] = $categorynode;
1790 * Loads the given course into the navigation
1792 * @param stdClass $course
1793 * @return navigation_node
1795 protected function load_course(stdClass
$course) {
1797 if ($course->id
== $SITE->id
) {
1798 // This is always loaded during initialisation
1799 return $this->rootnodes
['site'];
1800 } else if (array_key_exists($course->id
, $this->addedcourses
)) {
1801 // The course has already been loaded so return a reference
1802 return $this->addedcourses
[$course->id
];
1805 return $this->add_course($course);
1810 * Loads all of the courses section into the navigation.
1812 * This function calls method from current course format, see
1813 * {@link format_base::extend_course_navigation()}
1814 * If course module ($cm) is specified but course format failed to create the node,
1815 * the activity node is created anyway.
1817 * By default course formats call the method {@link global_navigation::load_generic_course_sections()}
1819 * @param stdClass $course Database record for the course
1820 * @param navigation_node $coursenode The course node within the navigation
1821 * @param null|int $sectionnum If specified load the contents of section with this relative number
1822 * @param null|cm_info $cm If specified make sure that activity node is created (either
1823 * in containg section or by calling load_stealth_activity() )
1825 protected function load_course_sections(stdClass
$course, navigation_node
$coursenode, $sectionnum = null, $cm = null) {
1827 require_once($CFG->dirroot
.'/course/lib.php');
1828 if (isset($cm->sectionnum
)) {
1829 $sectionnum = $cm->sectionnum
;
1831 if ($sectionnum !== null) {
1832 $this->includesectionnum
= $sectionnum;
1834 course_get_format($course)->extend_course_navigation($this, $coursenode, $sectionnum, $cm);
1835 if (isset($cm->id
)) {
1836 $activity = $coursenode->find($cm->id
, self
::TYPE_ACTIVITY
);
1837 if (empty($activity)) {
1838 $activity = $this->load_stealth_activity($coursenode, get_fast_modinfo($course));
1844 * Generates an array of sections and an array of activities for the given course.
1846 * This method uses the cache to improve performance and avoid the get_fast_modinfo call
1848 * @param stdClass $course
1849 * @return array Array($sections, $activities)
1851 protected function generate_sections_and_activities(stdClass
$course) {
1853 require_once($CFG->dirroot
.'/course/lib.php');
1855 $modinfo = get_fast_modinfo($course);
1856 $sections = $modinfo->get_section_info_all();
1858 // For course formats using 'numsections' trim the sections list
1859 $courseformatoptions = course_get_format($course)->get_format_options();
1860 if (isset($courseformatoptions['numsections'])) {
1861 $sections = array_slice($sections, 0, $courseformatoptions['numsections']+
1, true);
1864 $activities = array();
1866 foreach ($sections as $key => $section) {
1867 // Clone and unset summary to prevent $SESSION bloat (MDL-31802).
1868 $sections[$key] = clone($section);
1869 unset($sections[$key]->summary
);
1870 $sections[$key]->hasactivites
= false;
1871 if (!array_key_exists($section->section
, $modinfo->sections
)) {
1874 foreach ($modinfo->sections
[$section->section
] as $cmid) {
1875 $cm = $modinfo->cms
[$cmid];
1876 $activity = new stdClass
;
1877 $activity->id
= $cm->id
;
1878 $activity->course
= $course->id
;
1879 $activity->section
= $section->section
;
1880 $activity->name
= $cm->name
;
1881 $activity->icon
= $cm->icon
;
1882 $activity->iconcomponent
= $cm->iconcomponent
;
1883 $activity->hidden
= (!$cm->visible
);
1884 $activity->modname
= $cm->modname
;
1885 $activity->nodetype
= navigation_node
::NODETYPE_LEAF
;
1886 $activity->onclick
= $cm->onclick
;
1889 $activity->url
= null;
1890 $activity->display
= false;
1892 $activity->url
= $url->out();
1893 $activity->display
= $cm->uservisible ?
true : false;
1894 if (self
::module_extends_navigation($cm->modname
)) {
1895 $activity->nodetype
= navigation_node
::NODETYPE_BRANCH
;
1898 $activities[$cmid] = $activity;
1899 if ($activity->display
) {
1900 $sections[$key]->hasactivites
= true;
1905 return array($sections, $activities);
1909 * Generically loads the course sections into the course's navigation.
1911 * @param stdClass $course
1912 * @param navigation_node $coursenode
1913 * @return array An array of course section nodes
1915 public function load_generic_course_sections(stdClass
$course, navigation_node
$coursenode) {
1916 global $CFG, $DB, $USER, $SITE;
1917 require_once($CFG->dirroot
.'/course/lib.php');
1919 list($sections, $activities) = $this->generate_sections_and_activities($course);
1921 $navigationsections = array();
1922 foreach ($sections as $sectionid => $section) {
1923 $section = clone($section);
1924 if ($course->id
== $SITE->id
) {
1925 $this->load_section_activities($coursenode, $section->section
, $activities);
1927 if (!$section->uservisible ||
(!$this->showemptysections
&&
1928 !$section->hasactivites
&& $this->includesectionnum
!== $section->section
)) {
1932 $sectionname = get_section_name($course, $section);
1933 $url = course_get_url($course, $section->section
, array('navigation' => true));
1935 $sectionnode = $coursenode->add($sectionname, $url, navigation_node
::TYPE_SECTION
, null, $section->id
);
1936 $sectionnode->nodetype
= navigation_node
::NODETYPE_BRANCH
;
1937 $sectionnode->hidden
= (!$section->visible ||
!$section->available
);
1938 if ($this->includesectionnum
!== false && $this->includesectionnum
== $section->section
) {
1939 $this->load_section_activities($sectionnode, $section->section
, $activities);
1941 $section->sectionnode
= $sectionnode;
1942 $navigationsections[$sectionid] = $section;
1945 return $navigationsections;
1949 * Loads all of the activities for a section into the navigation structure.
1951 * @param navigation_node $sectionnode
1952 * @param int $sectionnumber
1953 * @param array $activities An array of activites as returned by {@link global_navigation::generate_sections_and_activities()}
1954 * @param stdClass $course The course object the section and activities relate to.
1955 * @return array Array of activity nodes
1957 protected function load_section_activities(navigation_node
$sectionnode, $sectionnumber, array $activities, $course = null) {
1959 // A static counter for JS function naming
1960 static $legacyonclickcounter = 0;
1962 $activitynodes = array();
1963 if (empty($activities)) {
1964 return $activitynodes;
1967 if (!is_object($course)) {
1968 $activity = reset($activities);
1969 $courseid = $activity->course
;
1971 $courseid = $course->id
;
1973 $showactivities = ($courseid != $SITE->id ||
!empty($CFG->navshowfrontpagemods
));
1975 foreach ($activities as $activity) {
1976 if ($activity->section
!= $sectionnumber) {
1979 if ($activity->icon
) {
1980 $icon = new pix_icon($activity->icon
, get_string('modulename', $activity->modname
), $activity->iconcomponent
);
1982 $icon = new pix_icon('icon', get_string('modulename', $activity->modname
), $activity->modname
);
1985 // Prepare the default name and url for the node
1986 $activityname = format_string($activity->name
, true, array('context' => context_module
::instance($activity->id
)));
1987 $action = new moodle_url($activity->url
);
1989 // Check if the onclick property is set (puke!)
1990 if (!empty($activity->onclick
)) {
1991 // Increment the counter so that we have a unique number.
1992 $legacyonclickcounter++
;
1993 // Generate the function name we will use
1994 $functionname = 'legacy_activity_onclick_handler_'.$legacyonclickcounter;
1995 $propogrationhandler = '';
1996 // Check if we need to cancel propogation. Remember inline onclick
1997 // events would return false if they wanted to prevent propogation and the
1999 if (strpos($activity->onclick
, 'return false')) {
2000 $propogrationhandler = 'e.halt();';
2002 // Decode the onclick - it has already been encoded for display (puke)
2003 $onclick = htmlspecialchars_decode($activity->onclick
, ENT_QUOTES
);
2004 // Build the JS function the click event will call
2005 $jscode = "function {$functionname}(e) { $propogrationhandler $onclick }";
2006 $this->page
->requires
->js_init_code($jscode);
2007 // Override the default url with the new action link
2008 $action = new action_link($action, $activityname, new component_action('click', $functionname));
2011 $activitynode = $sectionnode->add($activityname, $action, navigation_node
::TYPE_ACTIVITY
, null, $activity->id
, $icon);
2012 $activitynode->title(get_string('modulename', $activity->modname
));
2013 $activitynode->hidden
= $activity->hidden
;
2014 $activitynode->display
= $showactivities && $activity->display
;
2015 $activitynode->nodetype
= $activity->nodetype
;
2016 $activitynodes[$activity->id
] = $activitynode;
2019 return $activitynodes;
2022 * Loads a stealth module from unavailable section
2023 * @param navigation_node $coursenode
2024 * @param stdClass $modinfo
2025 * @return navigation_node or null if not accessible
2027 protected function load_stealth_activity(navigation_node
$coursenode, $modinfo) {
2028 if (empty($modinfo->cms
[$this->page
->cm
->id
])) {
2031 $cm = $modinfo->cms
[$this->page
->cm
->id
];
2033 $icon = new pix_icon($cm->icon
, get_string('modulename', $cm->modname
), $cm->iconcomponent
);
2035 $icon = new pix_icon('icon', get_string('modulename', $cm->modname
), $cm->modname
);
2038 $activitynode = $coursenode->add(format_string($cm->name
), $url, navigation_node
::TYPE_ACTIVITY
, null, $cm->id
, $icon);
2039 $activitynode->title(get_string('modulename', $cm->modname
));
2040 $activitynode->hidden
= (!$cm->visible
);
2041 if (!$cm->uservisible
) {
2042 // Do not show any error here, let the page handle exception that activity is not visible for the current user.
2043 // Also there may be no exception at all in case when teacher is logged in as student.
2044 $activitynode->display
= false;
2046 // Don't show activities that don't have links!
2047 $activitynode->display
= false;
2048 } else if (self
::module_extends_navigation($cm->modname
)) {
2049 $activitynode->nodetype
= navigation_node
::NODETYPE_BRANCH
;
2051 return $activitynode;
2054 * Loads the navigation structure for the given activity into the activities node.
2056 * This method utilises a callback within the modules lib.php file to load the
2057 * content specific to activity given.
2059 * The callback is a method: {modulename}_extend_navigation()
2061 * * {@link forum_extend_navigation()}
2062 * * {@link workshop_extend_navigation()}
2064 * @param cm_info|stdClass $cm
2065 * @param stdClass $course
2066 * @param navigation_node $activity
2069 protected function load_activity($cm, stdClass
$course, navigation_node
$activity) {
2072 // make sure we have a $cm from get_fast_modinfo as this contains activity access details
2073 if (!($cm instanceof cm_info
)) {
2074 $modinfo = get_fast_modinfo($course);
2075 $cm = $modinfo->get_cm($cm->id
);
2077 $activity->nodetype
= navigation_node
::NODETYPE_LEAF
;
2078 $activity->make_active();
2079 $file = $CFG->dirroot
.'/mod/'.$cm->modname
.'/lib.php';
2080 $function = $cm->modname
.'_extend_navigation';
2082 if (file_exists($file)) {
2083 require_once($file);
2084 if (function_exists($function)) {
2085 $activtyrecord = $DB->get_record($cm->modname
, array('id' => $cm->instance
), '*', MUST_EXIST
);
2086 $function($activity, $course, $activtyrecord, $cm);
2090 // Allow the active advanced grading method plugin to append module navigation
2091 $featuresfunc = $cm->modname
.'_supports';
2092 if (function_exists($featuresfunc) && $featuresfunc(FEATURE_ADVANCED_GRADING
)) {
2093 require_once($CFG->dirroot
.'/grade/grading/lib.php');
2094 $gradingman = get_grading_manager($cm->context
, 'mod_'.$cm->modname
);
2095 $gradingman->extend_navigation($this, $activity);
2098 return $activity->has_children();
2101 * Loads user specific information into the navigation in the appropriate place.
2103 * If no user is provided the current user is assumed.
2105 * @param stdClass $user
2106 * @param bool $forceforcontext probably force something to be loaded somewhere (ask SamH if not sure what this means)
2109 protected function load_for_user($user=null, $forceforcontext=false) {
2110 global $DB, $CFG, $USER, $SITE;
2112 if ($user === null) {
2113 // We can't require login here but if the user isn't logged in we don't
2114 // want to show anything
2115 if (!isloggedin() ||
isguestuser()) {
2119 } else if (!is_object($user)) {
2120 // If the user is not an object then get them from the database
2121 $select = context_helper
::get_preload_record_columns_sql('ctx');
2122 $sql = "SELECT u.*, $select
2124 JOIN {context} ctx ON u.id = ctx.instanceid
2125 WHERE u.id = :userid AND
2126 ctx.contextlevel = :contextlevel";
2127 $user = $DB->get_record_sql($sql, array('userid' => (int)$user, 'contextlevel' => CONTEXT_USER
), MUST_EXIST
);
2128 context_helper
::preload_from_record($user);
2131 $iscurrentuser = ($user->id
== $USER->id
);
2133 $usercontext = context_user
::instance($user->id
);
2135 // Get the course set against the page, by default this will be the site
2136 $course = $this->page
->course
;
2137 $baseargs = array('id'=>$user->id
);
2138 if ($course->id
!= $SITE->id
&& (!$iscurrentuser ||
$forceforcontext)) {
2139 $coursenode = $this->add_course($course, false, self
::COURSE_CURRENT
);
2140 $baseargs['course'] = $course->id
;
2141 $coursecontext = context_course
::instance($course->id
);
2142 $issitecourse = false;
2144 // Load all categories and get the context for the system
2145 $coursecontext = context_system
::instance();
2146 $issitecourse = true;
2149 // Create a node to add user information under.
2150 if ($iscurrentuser && !$forceforcontext) {
2151 // If it's the current user the information will go under the profile root node
2152 $usernode = $this->rootnodes
['myprofile'];
2153 $course = get_site();
2154 $coursecontext = context_course
::instance($course->id
);
2155 $issitecourse = true;
2157 if (!$issitecourse) {
2158 // Not the current user so add it to the participants node for the current course
2159 $usersnode = $coursenode->get('participants', navigation_node
::TYPE_CONTAINER
);
2160 $userviewurl = new moodle_url('/user/view.php', $baseargs);
2162 // This is the site so add a users node to the root branch
2163 $usersnode = $this->rootnodes
['users'];
2164 if (has_capability('moodle/course:viewparticipants', $coursecontext)) {
2165 $usersnode->action
= new moodle_url('/user/index.php', array('id'=>$course->id
));
2167 $userviewurl = new moodle_url('/user/profile.php', $baseargs);
2170 // We should NEVER get here, if the course hasn't been populated
2171 // with a participants node then the navigaiton either wasn't generated
2172 // for it (you are missing a require_login or set_context call) or
2173 // you don't have access.... in the interests of no leaking informatin
2174 // we simply quit...
2177 // Add a branch for the current user
2178 $canseefullname = has_capability('moodle/site:viewfullnames', $coursecontext);
2179 $usernode = $usersnode->add(fullname($user, $canseefullname), $userviewurl, self
::TYPE_USER
, null, $user->id
);
2181 if ($this->page
->context
->contextlevel
== CONTEXT_USER
&& $user->id
== $this->page
->context
->instanceid
) {
2182 $usernode->make_active();
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) ||
has_capability('moodle/user:viewdetails', $usercontext)) {
2189 if ($issitecourse ||
($iscurrentuser && !$forceforcontext)) {
2190 $usernode->add(get_string('viewprofile'), new moodle_url('/user/profile.php',$baseargs));
2192 $usernode->add(get_string('viewprofile'), new moodle_url('/user/view.php',$baseargs));
2196 if (!empty($CFG->navadduserpostslinks
)) {
2197 // Add nodes for forum posts and discussions if the user can view either or both
2198 // There are no capability checks here as the content of the page is based
2199 // purely on the forums the current user has access too.
2200 $forumtab = $usernode->add(get_string('forumposts', 'forum'));
2201 $forumtab->add(get_string('posts', 'forum'), new moodle_url('/mod/forum/user.php', $baseargs));
2202 $forumtab->add(get_string('discussions', 'forum'), new moodle_url('/mod/forum/user.php', array_merge($baseargs, array('mode'=>'discussions'))));
2206 if (!empty($CFG->enableblogs
)) {
2207 if (!$this->cache
->cached('userblogoptions'.$user->id
)) {
2208 require_once($CFG->dirroot
.'/blog/lib.php');
2209 // Get all options for the user
2210 $options = blog_get_options_for_user($user);
2211 $this->cache
->set('userblogoptions'.$user->id
, $options);
2213 $options = $this->cache
->{'userblogoptions'.$user->id
};
2216 if (count($options) > 0) {
2217 $blogs = $usernode->add(get_string('blogs', 'blog'), null, navigation_node
::TYPE_CONTAINER
);
2218 foreach ($options as $type => $option) {
2219 if ($type == "rss") {
2220 $blogs->add($option['string'], $option['link'], settings_navigation
::TYPE_SETTING
, null, null, new pix_icon('i/rss', ''));
2222 $blogs->add($option['string'], $option['link']);
2228 // Add the messages link.
2229 // It is context based so can appear in "My profile" and in course participants information.
2230 if (!empty($CFG->messaging
)) {
2231 $messageargs = array('user1' => $USER->id
);
2232 if ($USER->id
!= $user->id
) {
2233 $messageargs['user2'] = $user->id
;
2235 if ($course->id
!= $SITE->id
) {
2236 $messageargs['viewing'] = MESSAGE_VIEW_COURSE
. $course->id
;
2238 $url = new moodle_url('/message/index.php',$messageargs);
2239 $usernode->add(get_string('messages', 'message'), $url, self
::TYPE_SETTING
, null, 'messages');
2242 // Add the "My private files" link.
2243 // This link doesn't have a unique display for course context so only display it under "My profile".
2244 if ($issitecourse && $iscurrentuser && has_capability('moodle/user:manageownfiles', $usercontext)) {
2245 $url = new moodle_url('/user/files.php');
2246 $usernode->add(get_string('myfiles'), $url, self
::TYPE_SETTING
);
2249 if (!empty($CFG->enablebadges
) && $iscurrentuser &&
2250 has_capability('moodle/badges:manageownbadges', $usercontext)) {
2251 $url = new moodle_url('/badges/mybadges.php');
2252 $usernode->add(get_string('mybadges', 'badges'), $url, self
::TYPE_SETTING
);
2255 // Add a node to view the users notes if permitted
2256 if (!empty($CFG->enablenotes
) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $coursecontext)) {
2257 $url = new moodle_url('/notes/index.php',array('user'=>$user->id
));
2258 if ($coursecontext->instanceid
!= SITEID
) {
2259 $url->param('course', $coursecontext->instanceid
);
2261 $usernode->add(get_string('notes', 'notes'), $url);
2264 // If the user is the current user add the repositories for the current user
2265 $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields
));
2266 if ($iscurrentuser) {
2267 if (!$this->cache
->cached('contexthasrepos'.$usercontext->id
)) {
2268 require_once($CFG->dirroot
. '/repository/lib.php');
2269 $editabletypes = repository
::get_editable_types($usercontext);
2270 $haseditabletypes = !empty($editabletypes);
2271 unset($editabletypes);
2272 $this->cache
->set('contexthasrepos'.$usercontext->id
, $haseditabletypes);
2274 $haseditabletypes = $this->cache
->{'contexthasrepos'.$usercontext->id
};
2276 if ($haseditabletypes) {
2277 $usernode->add(get_string('repositories', 'repository'), new moodle_url('/repository/manage_instances.php', array('contextid' => $usercontext->id
)));
2279 } else if ($course->id
== $SITE->id
&& has_capability('moodle/user:viewdetails', $usercontext) && (!in_array('mycourses', $hiddenfields) ||
has_capability('moodle/user:viewhiddendetails', $coursecontext))) {
2281 // Add view grade report is permitted
2282 $reports = core_component
::get_plugin_list('gradereport');
2283 arsort($reports); // user is last, we want to test it first
2285 $userscourses = enrol_get_users_courses($user->id
);
2286 $userscoursesnode = $usernode->add(get_string('courses'));
2289 foreach ($userscourses as $usercourse) {
2290 if ($count === (int)$CFG->navcourselimit
) {
2291 $url = new moodle_url('/user/profile.php', array('id' => $user->id
, 'showallcourses' => 1));
2292 $userscoursesnode->add(get_string('showallcourses'), $url);
2296 $usercoursecontext = context_course
::instance($usercourse->id
);
2297 $usercourseshortname = format_string($usercourse->shortname
, true, array('context' => $usercoursecontext));
2298 $usercoursenode = $userscoursesnode->add($usercourseshortname, new moodle_url('/user/view.php', array('id'=>$user->id
, 'course'=>$usercourse->id
)), self
::TYPE_CONTAINER
);
2300 $gradeavailable = has_capability('moodle/grade:viewall', $usercoursecontext);
2301 if (!$gradeavailable && !empty($usercourse->showgrades
) && is_array($reports) && !empty($reports)) {
2302 foreach ($reports as $plugin => $plugindir) {
2303 if (has_capability('gradereport/'.$plugin.':view', $usercoursecontext)) {
2304 //stop when the first visible plugin is found
2305 $gradeavailable = true;
2311 if ($gradeavailable) {
2312 $url = new moodle_url('/grade/report/index.php', array('id'=>$usercourse->id
));
2313 $usercoursenode->add(get_string('grades'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/grades', ''));
2316 // Add a node to view the users notes if permitted
2317 if (!empty($CFG->enablenotes
) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $usercoursecontext)) {
2318 $url = new moodle_url('/notes/index.php',array('user'=>$user->id
, 'course'=>$usercourse->id
));
2319 $usercoursenode->add(get_string('notes', 'notes'), $url, self
::TYPE_SETTING
);
2322 if (can_access_course($usercourse, $user->id
)) {
2323 $usercoursenode->add(get_string('entercourse'), new moodle_url('/course/view.php', array('id'=>$usercourse->id
)), self
::TYPE_SETTING
, null, null, new pix_icon('i/course', ''));
2326 $reporttab = $usercoursenode->add(get_string('activityreports'));
2328 $reports = get_plugin_list_with_function('report', 'extend_navigation_user', 'lib.php');
2329 foreach ($reports as $reportfunction) {
2330 $reportfunction($reporttab, $user, $usercourse);
2333 $reporttab->trim_if_empty();
2340 * This method simply checks to see if a given module can extend the navigation.
2342 * @todo (MDL-25290) A shared caching solution should be used to save details on what extends navigation.
2344 * @param string $modname
2347 public static function module_extends_navigation($modname) {
2349 static $extendingmodules = array();
2350 if (!array_key_exists($modname, $extendingmodules)) {
2351 $extendingmodules[$modname] = false;
2352 $file = $CFG->dirroot
.'/mod/'.$modname.'/lib.php';
2353 if (file_exists($file)) {
2354 $function = $modname.'_extend_navigation';
2355 require_once($file);
2356 $extendingmodules[$modname] = (function_exists($function));
2359 return $extendingmodules[$modname];
2362 * Extends the navigation for the given user.
2364 * @param stdClass $user A user from the database
2366 public function extend_for_user($user) {
2367 $this->extendforuser
[] = $user;
2371 * Returns all of the users the navigation is being extended for
2373 * @return array An array of extending users.
2375 public function get_extending_users() {
2376 return $this->extendforuser
;
2379 * Adds the given course to the navigation structure.
2381 * @param stdClass $course
2382 * @param bool $forcegeneric
2383 * @param bool $ismycourse
2384 * @return navigation_node
2386 public function add_course(stdClass
$course, $forcegeneric = false, $coursetype = self
::COURSE_OTHER
) {
2389 // We found the course... we can return it now :)
2390 if (!$forcegeneric && array_key_exists($course->id
, $this->addedcourses
)) {
2391 return $this->addedcourses
[$course->id
];
2394 $coursecontext = context_course
::instance($course->id
);
2396 if ($course->id
!= $SITE->id
&& !$course->visible
) {
2397 if (is_role_switched($course->id
)) {
2398 // user has to be able to access course in order to switch, let's skip the visibility test here
2399 } else if (!has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2404 $issite = ($course->id
== $SITE->id
);
2405 $shortname = format_string($course->shortname
, true, array('context' => $coursecontext));
2406 $fullname = format_string($course->fullname
, true, array('context' => $coursecontext));
2407 // This is the name that will be shown for the course.
2408 $coursename = empty($CFG->navshowfullcoursenames
) ?
$shortname : $fullname;
2410 // Can the user expand the course to see its content.
2411 $canexpandcourse = true;
2415 if (empty($CFG->usesitenameforsitepages
)) {
2416 $coursename = get_string('sitepages');
2418 } else if ($coursetype == self
::COURSE_CURRENT
) {
2419 $parent = $this->rootnodes
['currentcourse'];
2420 $url = new moodle_url('/course/view.php', array('id'=>$course->id
));
2421 } else if ($coursetype == self
::COURSE_MY
&& !$forcegeneric) {
2422 if (!empty($CFG->navshowmycoursecategories
) && ($parent = $this->rootnodes
['mycourses']->find($course->category
, self
::TYPE_MY_CATEGORY
))) {
2423 // Nothing to do here the above statement set $parent to the category within mycourses.
2425 $parent = $this->rootnodes
['mycourses'];
2427 $url = new moodle_url('/course/view.php', array('id'=>$course->id
));
2429 $parent = $this->rootnodes
['courses'];
2430 $url = new moodle_url('/course/view.php', array('id'=>$course->id
));
2431 // They can only expand the course if they can access it.
2432 $canexpandcourse = $this->can_expand_course($course);
2433 if (!empty($course->category
) && $this->show_categories($coursetype == self
::COURSE_MY
)) {
2434 if (!$this->is_category_fully_loaded($course->category
)) {
2435 // We need to load the category structure for this course
2436 $this->load_all_categories($course->category
, false);
2438 if (array_key_exists($course->category
, $this->addedcategories
)) {
2439 $parent = $this->addedcategories
[$course->category
];
2440 // This could lead to the course being created so we should check whether it is the case again
2441 if (!$forcegeneric && array_key_exists($course->id
, $this->addedcourses
)) {
2442 return $this->addedcourses
[$course->id
];
2448 $coursenode = $parent->add($coursename, $url, self
::TYPE_COURSE
, $shortname, $course->id
);
2449 $coursenode->hidden
= (!$course->visible
);
2450 // We need to decode &'s here as they will have been added by format_string above and attributes will be encoded again
2452 $coursenode->title(str_replace('&', '&', $fullname));
2453 if ($canexpandcourse) {
2454 // This course can be expanded by the user, make it a branch to make the system aware that its expandable by ajax.
2455 $coursenode->nodetype
= self
::NODETYPE_BRANCH
;
2456 $coursenode->isexpandable
= true;
2458 $coursenode->nodetype
= self
::NODETYPE_LEAF
;
2459 $coursenode->isexpandable
= false;
2461 if (!$forcegeneric) {
2462 $this->addedcourses
[$course->id
] = $coursenode;
2469 * Returns a cache instance to use for the expand course cache.
2470 * @return cache_session
2472 protected function get_expand_course_cache() {
2473 if ($this->cacheexpandcourse
=== null) {
2474 $this->cacheexpandcourse
= cache
::make('core', 'navigation_expandcourse');
2476 return $this->cacheexpandcourse
;
2480 * Checks if a user can expand a course in the navigation.
2482 * We use a cache here because in order to be accurate we need to call can_access_course which is a costly function.
2483 * Because this functionality is basic + non-essential and because we lack good event triggering this cache
2484 * permits stale data.
2485 * In the situation the user is granted access to a course after we've initialised this session cache the cache
2487 * It is brought up to date in only one of two ways.
2488 * 1. The user logs out and in again.
2489 * 2. The user browses to the course they've just being given access to.
2491 * Really all this controls is whether the node is shown as expandable or not. It is uber un-important.
2493 * @param stdClass $course
2496 protected function can_expand_course($course) {
2497 $cache = $this->get_expand_course_cache();
2498 $canexpand = $cache->get($course->id
);
2499 if ($canexpand === false) {
2500 $canexpand = isloggedin() && can_access_course($course);
2501 $canexpand = (int)$canexpand;
2502 $cache->set($course->id
, $canexpand);
2504 return ($canexpand === 1);
2508 * Returns true if the category has already been loaded as have any child categories
2510 * @param int $categoryid
2513 protected function is_category_fully_loaded($categoryid) {
2514 return (array_key_exists($categoryid, $this->addedcategories
) && ($this->allcategoriesloaded ||
$this->addedcategories
[$categoryid]->children
->count() > 0));
2518 * Adds essential course nodes to the navigation for the given course.
2520 * This method adds nodes such as reports, blogs and participants
2522 * @param navigation_node $coursenode
2523 * @param stdClass $course
2524 * @return bool returns true on successful addition of a node.
2526 public function add_course_essentials($coursenode, stdClass
$course) {
2529 if ($course->id
== $SITE->id
) {
2530 return $this->add_front_page_course_essentials($coursenode, $course);
2533 if ($coursenode == false ||
!($coursenode instanceof navigation_node
) ||
$coursenode->get('participants', navigation_node
::TYPE_CONTAINER
)) {
2538 if (has_capability('moodle/course:viewparticipants', $this->page
->context
)) {
2539 $participants = $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id
), self
::TYPE_CONTAINER
, get_string('participants'), 'participants');
2540 if (!empty($CFG->enableblogs
)) {
2541 if (($CFG->bloglevel
== BLOG_GLOBAL_LEVEL
or ($CFG->bloglevel
== BLOG_SITE_LEVEL
and (isloggedin() and !isguestuser())))
2542 and has_capability('moodle/blog:view', context_system
::instance())) {
2543 $blogsurls = new moodle_url('/blog/index.php');
2544 if ($course->id
== $SITE->id
) {
2545 $blogsurls->param('courseid', 0);
2546 } else if ($currentgroup = groups_get_course_group($course, true)) {
2547 $blogsurls->param('groupid', $currentgroup);
2549 $blogsurls->param('courseid', $course->id
);
2551 $participants->add(get_string('blogscourse','blog'), $blogsurls->out());
2554 if (!empty($CFG->enablenotes
) && (has_capability('moodle/notes:manage', $this->page
->context
) ||
has_capability('moodle/notes:view', $this->page
->context
))) {
2555 $participants->add(get_string('notes','notes'), new moodle_url('/notes/index.php', array('filtertype'=>'course', 'filterselect'=>$course->id
)));
2557 } else if (count($this->extendforuser
) > 0 ||
$this->page
->course
->id
== $course->id
) {
2558 $participants = $coursenode->add(get_string('participants'), null, self
::TYPE_CONTAINER
, get_string('participants'), 'participants');
2562 if (!empty($CFG->enablebadges
) && !empty($CFG->badges_allowcoursebadges
) &&
2563 has_capability('moodle/badges:viewbadges', $this->page
->context
)) {
2564 $url = new moodle_url('/badges/view.php', array('type' => 2, 'id' => $course->id
));
2566 $coursenode->add(get_string('coursebadges', 'badges'), null,
2567 navigation_node
::TYPE_CONTAINER
, null, 'coursebadges');
2568 $coursenode->get('coursebadges')->add(get_string('badgesview', 'badges'), $url,
2569 navigation_node
::TYPE_SETTING
, null, 'badgesview',
2570 new pix_icon('i/badge', get_string('badgesview', 'badges')));
2576 * This generates the structure of the course that won't be generated when
2577 * the modules and sections are added.
2579 * Things such as the reports branch, the participants branch, blogs... get
2580 * added to the course node by this method.
2582 * @param navigation_node $coursenode
2583 * @param stdClass $course
2584 * @return bool True for successfull generation
2586 public function add_front_page_course_essentials(navigation_node
$coursenode, stdClass
$course) {
2589 if ($coursenode == false ||
$coursenode->get('frontpageloaded', navigation_node
::TYPE_CUSTOM
)) {
2593 // Hidden node that we use to determine if the front page navigation is loaded.
2594 // This required as there are not other guaranteed nodes that may be loaded.
2595 $coursenode->add('frontpageloaded', null, self
::TYPE_CUSTOM
, null, 'frontpageloaded')->display
= false;
2598 if (has_capability('moodle/course:viewparticipants', context_system
::instance())) {
2599 $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id
), self
::TYPE_CUSTOM
, get_string('participants'), 'participants');
2605 if (!empty($CFG->enableblogs
)
2606 and ($CFG->bloglevel
== BLOG_GLOBAL_LEVEL
or ($CFG->bloglevel
== BLOG_SITE_LEVEL
and (isloggedin() and !isguestuser())))
2607 and has_capability('moodle/blog:view', context_system
::instance())) {
2608 $blogsurls = new moodle_url('/blog/index.php', array('courseid' => $filterselect));
2609 $coursenode->add(get_string('blogssite','blog'), $blogsurls->out());
2613 if (!empty($CFG->enablebadges
) && has_capability('moodle/badges:viewbadges', $this->page
->context
)) {
2614 $url = new moodle_url($CFG->wwwroot
. '/badges/view.php', array('type' => 1));
2615 $coursenode->add(get_string('sitebadges', 'badges'), $url, navigation_node
::TYPE_CUSTOM
);
2619 if (!empty($CFG->enablenotes
) && (has_capability('moodle/notes:manage', $this->page
->context
) ||
has_capability('moodle/notes:view', $this->page
->context
))) {
2620 $coursenode->add(get_string('notes','notes'), new moodle_url('/notes/index.php', array('filtertype'=>'course', 'filterselect'=>$filterselect)));
2624 if (!empty($CFG->usetags
) && isloggedin()) {
2625 $coursenode->add(get_string('tags', 'tag'), new moodle_url('/tag/search.php'));
2630 $calendarurl = new moodle_url('/calendar/view.php', array('view' => 'month'));
2631 $coursenode->add(get_string('calendar', 'calendar'), $calendarurl, self
::TYPE_CUSTOM
, null, 'calendar');
2638 * Clears the navigation cache
2640 public function clear_cache() {
2641 $this->cache
->clear();
2645 * Sets an expansion limit for the navigation
2647 * The expansion limit is used to prevent the display of content that has a type
2648 * greater than the provided $type.
2650 * Can be used to ensure things such as activities or activity content don't get
2651 * shown on the navigation.
2652 * They are still generated in order to ensure the navbar still makes sense.
2654 * @param int $type One of navigation_node::TYPE_*
2655 * @return bool true when complete.
2657 public function set_expansion_limit($type) {
2659 $nodes = $this->find_all_of_type($type);
2661 // We only want to hide specific types of nodes.
2662 // Only nodes that represent "structure" in the navigation tree should be hidden.
2663 // If we hide all nodes then we risk hiding vital information.
2664 $typestohide = array(
2665 self
::TYPE_CATEGORY
,
2671 foreach ($nodes as $node) {
2672 // We need to generate the full site node
2673 if ($type == self
::TYPE_COURSE
&& $node->key
== $SITE->id
) {
2676 foreach ($node->children
as $child) {
2677 $child->hide($typestohide);
2683 * Attempts to get the navigation with the given key from this nodes children.
2685 * This function only looks at this nodes children, it does NOT look recursivily.
2686 * If the node can't be found then false is returned.
2688 * If you need to search recursivily then use the {@link global_navigation::find()} method.
2690 * Note: If you are trying to set the active node {@link navigation_node::override_active_url()}
2691 * may be of more use to you.
2693 * @param string|int $key The key of the node you wish to receive.
2694 * @param int $type One of navigation_node::TYPE_*
2695 * @return navigation_node|false
2697 public function get($key, $type = null) {
2698 if (!$this->initialised
) {
2699 $this->initialise();
2701 return parent
::get($key, $type);
2705 * Searches this nodes children and their children to find a navigation node
2706 * with the matching key and type.
2708 * This method is recursive and searches children so until either a node is
2709 * found or there are no more nodes to search.
2711 * If you know that the node being searched for is a child of this node
2712 * then use the {@link global_navigation::get()} method instead.
2714 * Note: If you are trying to set the active node {@link navigation_node::override_active_url()}
2715 * may be of more use to you.
2717 * @param string|int $key The key of the node you wish to receive.
2718 * @param int $type One of navigation_node::TYPE_*
2719 * @return navigation_node|false
2721 public function find($key, $type) {
2722 if (!$this->initialised
) {
2723 $this->initialise();
2725 if ($type == self
::TYPE_ROOTNODE
&& array_key_exists($key, $this->rootnodes
)) {
2726 return $this->rootnodes
[$key];
2728 return parent
::find($key, $type);
2732 * They've expanded the 'my courses' branch.
2734 protected function load_courses_enrolled() {
2736 $sortorder = 'visible DESC';
2737 // Prevent undefined $CFG->navsortmycoursessort errors.
2738 if (empty($CFG->navsortmycoursessort
)) {
2739 $CFG->navsortmycoursessort
= 'sortorder';
2741 // Append the chosen sortorder.
2742 $sortorder = $sortorder . ',' . $CFG->navsortmycoursessort
. ' ASC';
2743 $courses = enrol_get_my_courses(null, $sortorder);
2744 if (count($courses) && $this->show_my_categories()) {
2745 // OK Actually we are loading categories. We only want to load categories that have a parent of 0.
2746 // In order to make sure we load everything required we must first find the categories that are not
2747 // base categories and work out the bottom category in thier path.
2748 $categoryids = array();
2749 foreach ($courses as $course) {
2750 $categoryids[] = $course->category
;
2752 $categoryids = array_unique($categoryids);
2753 list($sql, $params) = $DB->get_in_or_equal($categoryids);
2754 $categories = $DB->get_recordset_select('course_categories', 'id '.$sql.' AND parent <> 0', $params, 'sortorder, id', 'id, path');
2755 foreach ($categories as $category) {
2756 $bits = explode('/', trim($category->path
,'/'));
2757 $categoryids[] = array_shift($bits);
2759 $categoryids = array_unique($categoryids);
2760 $categories->close();
2762 // Now we load the base categories.
2763 list($sql, $params) = $DB->get_in_or_equal($categoryids);
2764 $categories = $DB->get_recordset_select('course_categories', 'id '.$sql.' AND parent = 0', $params, 'sortorder, id');
2765 foreach ($categories as $category) {
2766 $this->add_category($category, $this->rootnodes
['mycourses'], self
::TYPE_MY_CATEGORY
);
2768 $categories->close();
2770 foreach ($courses as $course) {
2771 $this->add_course($course, false, self
::COURSE_MY
);
2778 * The global navigation class used especially for AJAX requests.
2780 * The primary methods that are used in the global navigation class have been overriden
2781 * to ensure that only the relevant branch is generated at the root of the tree.
2782 * This can be done because AJAX is only used when the backwards structure for the
2783 * requested branch exists.
2784 * This has been done only because it shortens the amounts of information that is generated
2785 * which of course will speed up the response time.. because no one likes laggy AJAX.
2788 * @category navigation
2789 * @copyright 2009 Sam Hemelryk
2790 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2792 class global_navigation_for_ajax
extends global_navigation
{
2794 /** @var int used for determining what type of navigation_node::TYPE_* is being used */
2795 protected $branchtype;
2797 /** @var int the instance id */
2798 protected $instanceid;
2800 /** @var array Holds an array of expandable nodes */
2801 protected $expandable = array();
2804 * Constructs the navigation for use in an AJAX request
2806 * @param moodle_page $page moodle_page object
2807 * @param int $branchtype
2810 public function __construct($page, $branchtype, $id) {
2811 $this->page
= $page;
2812 $this->cache
= new navigation_cache(NAVIGATION_CACHE_NAME
);
2813 $this->children
= new navigation_node_collection();
2814 $this->branchtype
= $branchtype;
2815 $this->instanceid
= $id;
2816 $this->initialise();
2819 * Initialise the navigation given the type and id for the branch to expand.
2821 * @return array An array of the expandable nodes
2823 public function initialise() {
2826 if ($this->initialised ||
during_initial_install()) {
2827 return $this->expandable
;
2829 $this->initialised
= true;
2831 $this->rootnodes
= array();
2832 $this->rootnodes
['site'] = $this->add_course($SITE);
2833 $this->rootnodes
['mycourses'] = $this->add(get_string('mycourses'), new moodle_url('/my'), self
::TYPE_ROOTNODE
, null, 'mycourses');
2834 $this->rootnodes
['courses'] = $this->add(get_string('courses'), null, self
::TYPE_ROOTNODE
, null, 'courses');
2835 // The courses branch is always displayed, and is always expandable (although may be empty).
2836 // This mimicks what is done during {@link global_navigation::initialise()}.
2837 $this->rootnodes
['courses']->isexpandable
= true;
2839 // Branchtype will be one of navigation_node::TYPE_*
2840 switch ($this->branchtype
) {
2842 if ($this->instanceid
=== 'mycourses') {
2843 $this->load_courses_enrolled();
2844 } else if ($this->instanceid
=== 'courses') {
2845 $this->load_courses_other();
2848 case self
::TYPE_CATEGORY
:
2849 $this->load_category($this->instanceid
);
2851 case self
::TYPE_MY_CATEGORY
:
2852 $this->load_category($this->instanceid
, self
::TYPE_MY_CATEGORY
);
2854 case self
::TYPE_COURSE
:
2855 $course = $DB->get_record('course', array('id' => $this->instanceid
), '*', MUST_EXIST
);
2856 if (!can_access_course($course)) {
2857 // Thats OK all courses are expandable by default. We don't need to actually expand it we can just
2858 // add the course node and break. This leads to an empty node.
2859 $this->add_course($course);
2862 require_course_login($course, true, null, false, true);
2863 $this->page
->set_context(context_course
::instance($course->id
));
2864 $coursenode = $this->add_course($course);
2865 $this->add_course_essentials($coursenode, $course);
2866 $this->load_course_sections($course, $coursenode);
2868 case self
::TYPE_SECTION
:
2869 $sql = 'SELECT c.*, cs.section AS sectionnumber
2871 LEFT JOIN {course_sections} cs ON cs.course = c.id
2873 $course = $DB->get_record_sql($sql, array($this->instanceid
), MUST_EXIST
);
2874 require_course_login($course, true, null, false, true);
2875 $this->page
->set_context(context_course
::instance($course->id
));
2876 $coursenode = $this->add_course($course);
2877 $this->add_course_essentials($coursenode, $course);
2878 $this->load_course_sections($course, $coursenode, $course->sectionnumber
);
2880 case self
::TYPE_ACTIVITY
:
2883 JOIN {course_modules} cm ON cm.course = c.id
2884 WHERE cm.id = :cmid";
2885 $params = array('cmid' => $this->instanceid
);
2886 $course = $DB->get_record_sql($sql, $params, MUST_EXIST
);
2887 $modinfo = get_fast_modinfo($course);
2888 $cm = $modinfo->get_cm($this->instanceid
);
2889 require_course_login($course, true, $cm, false, true);
2890 $this->page
->set_context(context_module
::instance($cm->id
));
2891 $coursenode = $this->load_course($course);
2892 $this->load_course_sections($course, $coursenode, null, $cm);
2893 $activitynode = $coursenode->find($cm->id
, self
::TYPE_ACTIVITY
);
2894 if ($activitynode) {
2895 $modulenode = $this->load_activity($cm, $course, $activitynode);
2899 throw new Exception('Unknown type');
2900 return $this->expandable
;
2903 if ($this->page
->context
->contextlevel
== CONTEXT_COURSE
&& $this->page
->context
->instanceid
!= $SITE->id
) {
2904 $this->load_for_user(null, true);
2907 $this->find_expandable($this->expandable
);
2908 return $this->expandable
;
2912 * They've expanded the general 'courses' branch.
2914 protected function load_courses_other() {
2915 $this->load_all_courses();
2919 * Loads a single category into the AJAX navigation.
2921 * This function is special in that it doesn't concern itself with the parent of
2922 * the requested category or its siblings.
2923 * This is because with the AJAX navigation we know exactly what is wanted and only need to
2926 * @global moodle_database $DB
2927 * @param int $categoryid id of category to load in navigation.
2928 * @param int $nodetype type of node, if category is under MyHome then it's TYPE_MY_CATEGORY
2931 protected function load_category($categoryid, $nodetype = self
::TYPE_CATEGORY
) {
2935 if (!empty($CFG->navcourselimit
)) {
2936 $limit = (int)$CFG->navcourselimit
;
2939 $catcontextsql = context_helper
::get_preload_record_columns_sql('ctx');
2940 $sql = "SELECT cc.*, $catcontextsql
2941 FROM {course_categories} cc
2942 JOIN {context} ctx ON cc.id = ctx.instanceid
2943 WHERE ctx.contextlevel = ".CONTEXT_COURSECAT
." AND
2944 (cc.id = :categoryid1 OR cc.parent = :categoryid2)
2945 ORDER BY cc.depth ASC, cc.sortorder ASC, cc.id ASC";
2946 $params = array('categoryid1' => $categoryid, 'categoryid2' => $categoryid);
2947 $categories = $DB->get_recordset_sql($sql, $params, 0, $limit);
2948 $categorylist = array();
2949 $subcategories = array();
2950 $basecategory = null;
2951 foreach ($categories as $category) {
2952 $categorylist[] = $category->id
;
2953 context_helper
::preload_from_record($category);
2954 if ($category->id
== $categoryid) {
2955 $this->add_category($category, $this, $nodetype);
2956 $basecategory = $this->addedcategories
[$category->id
];
2958 $subcategories[$category->id
] = $category;
2961 $categories->close();
2964 // If category is shown in MyHome then only show enrolled courses and hide empty subcategories,
2965 // else show all courses.
2966 if ($nodetype === self
::TYPE_MY_CATEGORY
) {
2967 $courses = enrol_get_my_courses();
2968 $categoryids = array();
2970 // Only search for categories if basecategory was found.
2971 if (!is_null($basecategory)) {
2972 // Get course parent category ids.
2973 foreach ($courses as $course) {
2974 $categoryids[] = $course->category
;
2977 // Get a unique list of category ids which a part of the path
2978 // to user's courses.
2979 $coursesubcategories = array();
2980 $addedsubcategories = array();
2982 list($sql, $params) = $DB->get_in_or_equal($categoryids);
2983 $categories = $DB->get_recordset_select('course_categories', 'id '.$sql, $params, 'sortorder, id', 'id, path');
2985 foreach ($categories as $category){
2986 $coursesubcategories = array_merge($coursesubcategories, explode('/', trim($category->path
, "/")));
2988 $coursesubcategories = array_unique($coursesubcategories);
2990 // Only add a subcategory if it is part of the path to user's course and
2991 // wasn't already added.
2992 foreach ($subcategories as $subid => $subcategory) {
2993 if (in_array($subid, $coursesubcategories) &&
2994 !in_array($subid, $addedsubcategories)) {
2995 $this->add_category($subcategory, $basecategory, $nodetype);
2996 $addedsubcategories[] = $subid;
3001 foreach ($courses as $course) {
3002 // Add course if it's in category.
3003 if (in_array($course->category
, $categorylist)) {
3004 $this->add_course($course, true, self
::COURSE_MY
);
3008 if (!is_null($basecategory)) {
3009 foreach ($subcategories as $key=>$category) {
3010 $this->add_category($category, $basecategory, $nodetype);
3013 $courses = $DB->get_recordset('course', array('category' => $categoryid), 'sortorder', '*' , 0, $limit);
3014 foreach ($courses as $course) {
3015 $this->add_course($course);
3022 * Returns an array of expandable nodes
3025 public function get_expandable() {
3026 return $this->expandable
;
3033 * This class is used to manage the navbar, which is initialised from the navigation
3034 * object held by PAGE
3037 * @category navigation
3038 * @copyright 2009 Sam Hemelryk
3039 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3041 class navbar
extends navigation_node
{
3042 /** @var bool A switch for whether the navbar is initialised or not */
3043 protected $initialised = false;
3044 /** @var mixed keys used to reference the nodes on the navbar */
3045 protected $keys = array();
3046 /** @var null|string content of the navbar */
3047 protected $content = null;
3048 /** @var moodle_page object the moodle page that this navbar belongs to */
3050 /** @var bool A switch for whether to ignore the active navigation information */
3051 protected $ignoreactive = false;
3052 /** @var bool A switch to let us know if we are in the middle of an install */
3053 protected $duringinstall = false;
3054 /** @var bool A switch for whether the navbar has items */
3055 protected $hasitems = false;
3056 /** @var array An array of navigation nodes for the navbar */
3058 /** @var array An array of child node objects */
3059 public $children = array();
3060 /** @var bool A switch for whether we want to include the root node in the navbar */
3061 public $includesettingsbase = false;
3062 /** @var navigation_node[] $prependchildren */
3063 protected $prependchildren = array();
3065 * The almighty constructor
3067 * @param moodle_page $page
3069 public function __construct(moodle_page
$page) {
3071 if (during_initial_install()) {
3072 $this->duringinstall
= true;
3075 $this->page
= $page;
3076 $this->text
= get_string('home');
3077 $this->shorttext
= get_string('home');
3078 $this->action
= new moodle_url($CFG->wwwroot
);
3079 $this->nodetype
= self
::NODETYPE_BRANCH
;
3080 $this->type
= self
::TYPE_SYSTEM
;
3084 * Quick check to see if the navbar will have items in.
3086 * @return bool Returns true if the navbar will have items, false otherwise
3088 public function has_items() {
3089 if ($this->duringinstall
) {
3091 } else if ($this->hasitems
!== false) {
3094 $this->page
->navigation
->initialise($this->page
);
3096 $activenodefound = ($this->page
->navigation
->contains_active_node() ||
3097 $this->page
->settingsnav
->contains_active_node());
3099 $outcome = (count($this->children
) > 0 ||
count($this->prependchildren
) ||
(!$this->ignoreactive
&& $activenodefound));
3100 $this->hasitems
= $outcome;
3105 * Turn on/off ignore active
3107 * @param bool $setting
3109 public function ignore_active($setting=true) {
3110 $this->ignoreactive
= ($setting);
3114 * Gets a navigation node
3116 * @param string|int $key for referencing the navbar nodes
3117 * @param int $type navigation_node::TYPE_*
3118 * @return navigation_node|bool
3120 public function get($key, $type = null) {
3121 foreach ($this->children
as &$child) {
3122 if ($child->key
=== $key && ($type == null ||
$type == $child->type
)) {
3126 foreach ($this->prependchildren
as &$child) {
3127 if ($child->key
=== $key && ($type == null ||
$type == $child->type
)) {
3134 * Returns an array of navigation_node's that make up the navbar.
3138 public function get_items() {
3141 // Make sure that navigation is initialised
3142 if (!$this->has_items()) {
3145 if ($this->items
!== null) {
3146 return $this->items
;
3149 if (count($this->children
) > 0) {
3150 // Add the custom children.
3151 $items = array_reverse($this->children
);
3154 $navigationactivenode = $this->page
->navigation
->find_active_node();
3155 $settingsactivenode = $this->page
->settingsnav
->find_active_node();
3157 // Check if navigation contains the active node
3158 if (!$this->ignoreactive
) {
3160 if ($navigationactivenode && $settingsactivenode) {
3161 // Parse a combined navigation tree
3162 while ($settingsactivenode && $settingsactivenode->parent
!== null) {
3163 if (!$settingsactivenode->mainnavonly
) {
3164 $items[] = $settingsactivenode;
3166 $settingsactivenode = $settingsactivenode->parent
;
3168 if (!$this->includesettingsbase
) {
3169 // Removes the first node from the settings (root node) from the list
3172 while ($navigationactivenode && $navigationactivenode->parent
!== null) {
3173 if (!$navigationactivenode->mainnavonly
) {
3174 $items[] = $navigationactivenode;
3176 if (!empty($CFG->navshowcategories
) &&
3177 $navigationactivenode->type
=== self
::TYPE_COURSE
&&
3178 $navigationactivenode->parent
->key
=== 'currentcourse') {
3179 $items = array_merge($items, $this->get_course_categories());
3181 $navigationactivenode = $navigationactivenode->parent
;
3183 } else if ($navigationactivenode) {
3184 // Parse the navigation tree to get the active node
3185 while ($navigationactivenode && $navigationactivenode->parent
!== null) {
3186 if (!$navigationactivenode->mainnavonly
) {
3187 $items[] = $navigationactivenode;
3189 if (!empty($CFG->navshowcategories
) &&
3190 $navigationactivenode->type
=== self
::TYPE_COURSE
&&
3191 $navigationactivenode->parent
->key
=== 'currentcourse') {
3192 $items = array_merge($items, $this->get_course_categories());
3194 $navigationactivenode = $navigationactivenode->parent
;
3196 } else if ($settingsactivenode) {
3197 // Parse the settings navigation to get the active node
3198 while ($settingsactivenode && $settingsactivenode->parent
!== null) {
3199 if (!$settingsactivenode->mainnavonly
) {
3200 $items[] = $settingsactivenode;
3202 $settingsactivenode = $settingsactivenode->parent
;
3207 $items[] = new navigation_node(array(
3208 'text'=>$this->page
->navigation
->text
,
3209 'shorttext'=>$this->page
->navigation
->shorttext
,
3210 'key'=>$this->page
->navigation
->key
,
3211 'action'=>$this->page
->navigation
->action
3214 if (count($this->prependchildren
) > 0) {
3215 // Add the custom children
3216 $items = array_merge($items, array_reverse($this->prependchildren
));
3219 $this->items
= array_reverse($items);
3220 return $this->items
;
3224 * Get the list of categories leading to this course.
3226 * This function is used by {@link navbar::get_items()} to add back the "courses"
3227 * node and category chain leading to the current course. Note that this is only ever
3228 * called for the current course, so we don't need to bother taking in any parameters.
3232 private function get_course_categories() {
3235 require_once($CFG->dirroot
.'/course/lib.php');
3236 $categories = array();
3237 $cap = 'moodle/category:viewhiddencategories';
3238 foreach ($this->page
->categories
as $category) {
3239 if (!$category->visible
&& !has_capability($cap, get_category_or_system_context($category->parent
))) {
3242 $url = new moodle_url('/course/index.php', array('categoryid' => $category->id
));
3243 $name = format_string($category->name
, true, array('context' => context_coursecat
::instance($category->id
)));
3244 $categorynode = navigation_node
::create($name, $url, self
::TYPE_CATEGORY
, null, $category->id
);
3245 if (!$category->visible
) {
3246 $categorynode->hidden
= true;
3248 $categories[] = $categorynode;
3250 if (is_enrolled(context_course
::instance($this->page
->course
->id
))) {
3251 $courses = $this->page
->navigation
->get('mycourses');
3253 $courses = $this->page
->navigation
->get('courses');
3256 // Courses node may not be present.
3257 $courses = navigation_node
::create(
3258 get_string('courses'),
3259 new moodle_url('/course/index.php'),
3260 self
::TYPE_CONTAINER
3263 $categories[] = $courses;
3268 * Add a new navigation_node to the navbar, overrides parent::add
3270 * This function overrides {@link navigation_node::add()} so that we can change
3271 * the way nodes get added to allow us to simply call add and have the node added to the
3274 * @param string $text
3275 * @param string|moodle_url|action_link $action An action to associate with this node.
3276 * @param int $type One of navigation_node::TYPE_*
3277 * @param string $shorttext
3278 * @param string|int $key A key to identify this node with. Key + type is unique to a parent.
3279 * @param pix_icon $icon An optional icon to use for this node.
3280 * @return navigation_node
3282 public function add($text, $action=null, $type=self
::TYPE_CUSTOM
, $shorttext=null, $key=null, pix_icon
$icon=null) {
3283 if ($this->content
!== null) {
3284 debugging('Nav bar items must be printed before $OUTPUT->header() has been called', DEBUG_DEVELOPER
);
3287 // Properties array used when creating the new navigation node
3292 // Set the action if one was provided
3293 if ($action!==null) {
3294 $itemarray['action'] = $action;
3296 // Set the shorttext if one was provided
3297 if ($shorttext!==null) {
3298 $itemarray['shorttext'] = $shorttext;
3300 // Set the icon if one was provided
3302 $itemarray['icon'] = $icon;
3304 // Default the key to the number of children if not provided
3305 if ($key === null) {
3306 $key = count($this->children
);
3309 $itemarray['key'] = $key;
3310 // Set the parent to this node
3311 $itemarray['parent'] = $this;
3312 // Add the child using the navigation_node_collections add method
3313 $this->children
[] = new navigation_node($itemarray);
3318 * Prepends a new navigation_node to the start of the navbar
3320 * @param string $text
3321 * @param string|moodle_url|action_link $action An action to associate with this node.
3322 * @param int $type One of navigation_node::TYPE_*
3323 * @param string $shorttext
3324 * @param string|int $key A key to identify this node with. Key + type is unique to a parent.
3325 * @param pix_icon $icon An optional icon to use for this node.
3326 * @return navigation_node
3328 public function prepend($text, $action=null, $type=self
::TYPE_CUSTOM
, $shorttext=null, $key=null, pix_icon
$icon=null) {
3329 if ($this->content
!== null) {
3330 debugging('Nav bar items must be printed before $OUTPUT->header() has been called', DEBUG_DEVELOPER
);
3332 // Properties array used when creating the new navigation node.
3337 // Set the action if one was provided.
3338 if ($action!==null) {
3339 $itemarray['action'] = $action;
3341 // Set the shorttext if one was provided.
3342 if ($shorttext!==null) {
3343 $itemarray['shorttext'] = $shorttext;
3345 // Set the icon if one was provided.
3347 $itemarray['icon'] = $icon;
3349 // Default the key to the number of children if not provided.
3350 if ($key === null) {
3351 $key = count($this->children
);
3354 $itemarray['key'] = $key;
3355 // Set the parent to this node.
3356 $itemarray['parent'] = $this;
3357 // Add the child node to the prepend list.
3358 $this->prependchildren
[] = new navigation_node($itemarray);
3364 * Class used to manage the settings option for the current page
3366 * This class is used to manage the settings options in a tree format (recursively)
3367 * and was created initially for use with the settings blocks.
3370 * @category navigation
3371 * @copyright 2009 Sam Hemelryk
3372 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3374 class settings_navigation
extends navigation_node
{
3375 /** @var stdClass the current context */
3377 /** @var moodle_page the moodle page that the navigation belongs to */
3379 /** @var string contains administration section navigation_nodes */
3380 protected $adminsection;
3381 /** @var bool A switch to see if the navigation node is initialised */
3382 protected $initialised = false;
3383 /** @var array An array of users that the nodes can extend for. */
3384 protected $userstoextendfor = array();
3385 /** @var navigation_cache **/
3389 * Sets up the object with basic settings and preparse it for use
3391 * @param moodle_page $page
3393 public function __construct(moodle_page
&$page) {
3394 if (during_initial_install()) {
3397 $this->page
= $page;
3398 // Initialise the main navigation. It is most important that this is done
3399 // before we try anything
3400 $this->page
->navigation
->initialise();
3401 // Initialise the navigation cache
3402 $this->cache
= new navigation_cache(NAVIGATION_CACHE_NAME
);
3403 $this->children
= new navigation_node_collection();
3406 * Initialise the settings navigation based on the current context
3408 * This function initialises the settings navigation tree for a given context
3409 * by calling supporting functions to generate major parts of the tree.
3412 public function initialise() {
3413 global $DB, $SESSION, $SITE;
3415 if (during_initial_install()) {
3417 } else if ($this->initialised
) {
3420 $this->id
= 'settingsnav';
3421 $this->context
= $this->page
->context
;
3423 $context = $this->context
;
3424 if ($context->contextlevel
== CONTEXT_BLOCK
) {
3425 $this->load_block_settings();
3426 $context = $context->get_parent_context();
3428 switch ($context->contextlevel
) {
3429 case CONTEXT_SYSTEM
:
3430 if ($this->page
->url
->compare(new moodle_url('/admin/settings.php', array('section'=>'frontpagesettings')))) {
3431 $this->load_front_page_settings(($context->id
== $this->context
->id
));
3434 case CONTEXT_COURSECAT
:
3435 $this->load_category_settings();
3437 case CONTEXT_COURSE
:
3438 if ($this->page
->course
->id
!= $SITE->id
) {
3439 $this->load_course_settings(($context->id
== $this->context
->id
));
3441 $this->load_front_page_settings(($context->id
== $this->context
->id
));
3444 case CONTEXT_MODULE
:
3445 $this->load_module_settings();
3446 $this->load_course_settings();
3449 if ($this->page
->course
->id
!= $SITE->id
) {
3450 $this->load_course_settings();
3455 $usersettings = $this->load_user_settings($this->page
->course
->id
);
3457 $adminsettings = false;
3458 if (isloggedin() && !isguestuser() && (!isset($SESSION->load_navigation_admin
) ||
$SESSION->load_navigation_admin
)) {
3459 $isadminpage = $this->is_admin_tree_needed();
3461 if (has_capability('moodle/site:config', context_system
::instance())) {
3462 // Make sure this works even if config capability changes on the fly
3463 // and also make it fast for admin right after login.
3464 $SESSION->load_navigation_admin
= 1;
3466 $adminsettings = $this->load_administration_settings();
3469 } else if (!isset($SESSION->load_navigation_admin
)) {
3470 $adminsettings = $this->load_administration_settings();
3471 $SESSION->load_navigation_admin
= (int)($adminsettings->children
->count() > 0);
3473 } else if ($SESSION->load_navigation_admin
) {
3475 $adminsettings = $this->load_administration_settings();
3479 // Print empty navigation node, if needed.
3480 if ($SESSION->load_navigation_admin
&& !$isadminpage) {
3481 if ($adminsettings) {
3482 // Do not print settings tree on pages that do not need it, this helps with performance.
3483 $adminsettings->remove();
3484 $adminsettings = false;
3486 $siteadminnode = $this->add(get_string('administrationsite'), new moodle_url('/admin'), self
::TYPE_SITE_ADMIN
, null, 'siteadministration');
3487 $siteadminnode->id
= 'expandable_branch_'.$siteadminnode->type
.'_'.clean_param($siteadminnode->key
, PARAM_ALPHANUMEXT
);
3488 $this->page
->requires
->data_for_js('siteadminexpansion', $siteadminnode);
3492 if ($context->contextlevel
== CONTEXT_SYSTEM
&& $adminsettings) {
3493 $adminsettings->force_open();
3494 } else if ($context->contextlevel
== CONTEXT_USER
&& $usersettings) {
3495 $usersettings->force_open();
3498 // Check if the user is currently logged in as another user
3499 if (\core\session\manager
::is_loggedinas()) {
3500 // Get the actual user, we need this so we can display an informative return link
3501 $realuser = \core\session\manager
::get_realuser();
3502 // Add the informative return to original user link
3503 $url = new moodle_url('/course/loginas.php',array('id'=>$this->page
->course
->id
, 'return'=>1,'sesskey'=>sesskey()));
3504 $this->add(get_string('returntooriginaluser', 'moodle', fullname($realuser, true)), $url, self
::TYPE_SETTING
, null, null, new pix_icon('t/left', ''));
3507 // At this point we give any local plugins the ability to extend/tinker with the navigation settings.
3508 $this->load_local_plugin_settings();
3510 foreach ($this->children
as $key=>$node) {
3511 if ($node->nodetype
!= self
::NODETYPE_BRANCH ||
$node->children
->count()===0) {
3512 // Site administration is shown as link.
3513 if (!empty($SESSION->load_navigation_admin
) && ($node->type
=== self
::TYPE_SITE_ADMIN
)) {
3519 $this->initialised
= true;
3522 * Override the parent function so that we can add preceeding hr's and set a
3523 * root node class against all first level element
3525 * It does this by first calling the parent's add method {@link navigation_node::add()}
3526 * and then proceeds to use the key to set class and hr
3528 * @param string $text text to be used for the link.
3529 * @param string|moodle_url $url url for the new node
3530 * @param int $type the type of node navigation_node::TYPE_*
3531 * @param string $shorttext
3532 * @param string|int $key a key to access the node by.
3533 * @param pix_icon $icon An icon that appears next to the node.
3534 * @return navigation_node with the new node added to it.
3536 public function add($text, $url=null, $type=null, $shorttext=null, $key=null, pix_icon
$icon=null) {
3537 $node = parent
::add($text, $url, $type, $shorttext, $key, $icon);
3538 $node->add_class('root_node');
3543 * This function allows the user to add something to the start of the settings
3544 * navigation, which means it will be at the top of the settings navigation block
3546 * @param string $text text to be used for the link.
3547 * @param string|moodle_url $url url for the new node
3548 * @param int $type the type of node navigation_node::TYPE_*
3549 * @param string $shorttext
3550 * @param string|int $key a key to access the node by.
3551 * @param pix_icon $icon An icon that appears next to the node.
3552 * @return navigation_node $node with the new node added to it.
3554 public function prepend($text, $url=null, $type=null, $shorttext=null, $key=null, pix_icon
$icon=null) {
3555 $children = $this->children
;
3556 $childrenclass = get_class($children);
3557 $this->children
= new $childrenclass;
3558 $node = $this->add($text, $url, $type, $shorttext, $key, $icon);
3559 foreach ($children as $child) {
3560 $this->children
->add($child);
3566 * Does this page require loading of full admin tree or is
3567 * it enough rely on AJAX?
3571 protected function is_admin_tree_needed() {
3572 if (self
::$loadadmintree) {
3573 // Usually external admin page or settings page.
3577 if ($this->page
->pagelayout
=== 'admin' or strpos($this->page
->pagetype
, 'admin-') === 0) {
3578 // Admin settings tree is intended for system level settings and management only, use navigation for the rest!
3579 if ($this->page
->context
->contextlevel
!= CONTEXT_SYSTEM
) {
3589 * Load the site administration tree
3591 * This function loads the site administration tree by using the lib/adminlib library functions
3593 * @param navigation_node $referencebranch A reference to a branch in the settings
3595 * @param part_of_admin_tree $adminbranch The branch to add, if null generate the admin
3596 * tree and start at the beginning
3597 * @return mixed A key to access the admin tree by
3599 protected function load_administration_settings(navigation_node
$referencebranch=null, part_of_admin_tree
$adminbranch=null) {
3602 // Check if we are just starting to generate this navigation.
3603 if ($referencebranch === null) {
3605 // Require the admin lib then get an admin structure
3606 if (!function_exists('admin_get_root')) {
3607 require_once($CFG->dirroot
.'/lib/adminlib.php');
3609 $adminroot = admin_get_root(false, false);
3610 // This is the active section identifier
3611 $this->adminsection
= $this->page
->url
->param('section');
3613 // Disable the navigation from automatically finding the active node
3614 navigation_node
::$autofindactive = false;
3615 $referencebranch = $this->add(get_string('administrationsite'), null, self
::TYPE_SITE_ADMIN
, null, 'root');
3616 foreach ($adminroot->children
as $adminbranch) {
3617 $this->load_administration_settings($referencebranch, $adminbranch);
3619 navigation_node
::$autofindactive = true;
3621 // Use the admin structure to locate the active page
3622 if (!$this->contains_active_node() && $current = $adminroot->locate($this->adminsection
, true)) {
3623 $currentnode = $this;
3624 while (($pathkey = array_pop($current->path
))!==null && $currentnode) {
3625 $currentnode = $currentnode->get($pathkey);
3628 $currentnode->make_active();
3631 $this->scan_for_active_node($referencebranch);
3633 return $referencebranch;
3634 } else if ($adminbranch->check_access()) {
3635 // We have a reference branch that we can access and is not hidden `hurrah`
3636 // Now we need to display it and any children it may have
3639 if ($adminbranch instanceof admin_settingpage
) {
3640 $url = new moodle_url('/'.$CFG->admin
.'/settings.php', array('section'=>$adminbranch->name
));
3641 } else if ($adminbranch instanceof admin_externalpage
) {
3642 $url = $adminbranch->url
;
3643 } else if (!empty($CFG->linkadmincategories
) && $adminbranch instanceof admin_category
) {
3644 $url = new moodle_url('/'.$CFG->admin
.'/category.php', array('category' => $adminbranch->name
));
3648 $reference = $referencebranch->add($adminbranch->visiblename
, $url, self
::TYPE_SETTING
, null, $adminbranch->name
, $icon);
3650 if ($adminbranch->is_hidden()) {
3651 if (($adminbranch instanceof admin_externalpage ||
$adminbranch instanceof admin_settingpage
) && $adminbranch->name
== $this->adminsection
) {
3652 $reference->add_class('hidden');
3654 $reference->display
= false;
3658 // Check if we are generating the admin notifications and whether notificiations exist
3659 if ($adminbranch->name
=== 'adminnotifications' && admin_critical_warnings_present()) {
3660 $reference->add_class('criticalnotification');
3662 // Check if this branch has children
3663 if ($reference && isset($adminbranch->children
) && is_array($adminbranch->children
) && count($adminbranch->children
)>0) {
3664 foreach ($adminbranch->children
as $branch) {
3665 // Generate the child branches as well now using this branch as the reference
3666 $this->load_administration_settings($reference, $branch);
3669 $reference->icon
= new pix_icon('i/settings', '');
3675 * This function recursivily scans nodes until it finds the active node or there
3676 * are no more nodes.
3677 * @param navigation_node $node
3679 protected function scan_for_active_node(navigation_node
$node) {
3680 if (!$node->check_if_active() && $node->children
->count()>0) {
3681 foreach ($node->children
as &$child) {
3682 $this->scan_for_active_node($child);
3688 * Gets a navigation node given an array of keys that represent the path to
3691 * @param array $path
3692 * @return navigation_node|false
3694 protected function get_by_path(array $path) {
3695 $node = $this->get(array_shift($path));
3696 foreach ($path as $key) {
3703 * This function loads the course settings that are available for the user
3705 * @param bool $forceopen If set to true the course node will be forced open
3706 * @return navigation_node|false
3708 protected function load_course_settings($forceopen = false) {
3711 $course = $this->page
->course
;
3712 $coursecontext = context_course
::instance($course->id
);
3714 // note: do not test if enrolled or viewing here because we need the enrol link in Course administration section
3716 $coursenode = $this->add(get_string('courseadministration'), null, self
::TYPE_COURSE
, null, 'courseadmin');
3718 $coursenode->force_open();
3721 if ($this->page
->user_allowed_editing()) {
3722 // Add the turn on/off settings
3724 if ($this->page
->url
->compare(new moodle_url('/course/view.php'), URL_MATCH_BASE
)) {
3725 // We are on the course page, retain the current page params e.g. section.
3726 $baseurl = clone($this->page
->url
);
3727 $baseurl->param('sesskey', sesskey());
3729 // Edit on the main course page.
3730 $baseurl = new moodle_url('/course/view.php', array('id'=>$course->id
, 'return'=>$this->page
->url
->out_as_local_url(false), 'sesskey'=>sesskey()));
3733 $editurl = clone($baseurl);
3734 if ($this->page
->user_is_editing()) {
3735 $editurl->param('edit', 'off');
3736 $editstring = get_string('turneditingoff');
3738 $editurl->param('edit', 'on');
3739 $editstring = get_string('turneditingon');
3741 $coursenode->add($editstring, $editurl, self
::TYPE_SETTING
, null, 'turneditingonoff', new pix_icon('i/edit', ''));
3744 if (has_capability('moodle/course:update', $coursecontext)) {
3745 // Add the course settings link
3746 $url = new moodle_url('/course/edit.php', array('id'=>$course->id
));
3747 $coursenode->add(get_string('editsettings'), $url, self
::TYPE_SETTING
, null, 'editsettings', new pix_icon('i/settings', ''));
3749 // Add the course completion settings link
3750 if ($CFG->enablecompletion
&& $course->enablecompletion
) {
3751 $url = new moodle_url('/course/completion.php', array('id'=>$course->id
));
3752 $coursenode->add(get_string('coursecompletion', 'completion'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/settings', ''));
3757 enrol_add_course_navigation($coursenode, $course);
3760 if (has_capability('moodle/filter:manage', $coursecontext) && count(filter_get_available_in_context($coursecontext))>0) {
3761 $url = new moodle_url('/filter/manage.php', array('contextid'=>$coursecontext->id
));
3762 $coursenode->add(get_string('filters', 'admin'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/filter', ''));
3765 // View course reports.
3766 if (has_capability('moodle/site:viewreports', $coursecontext)) { // Basic capability for listing of reports.
3767 $reportnav = $coursenode->add(get_string('reports'), null, self
::TYPE_CONTAINER
, null, null,
3768 new pix_icon('i/stats', ''));
3769 $coursereports = core_component
::get_plugin_list('coursereport');
3770 foreach ($coursereports as $report => $dir) {
3771 $libfile = $CFG->dirroot
.'/course/report/'.$report.'/lib.php';
3772 if (file_exists($libfile)) {
3773 require_once($libfile);
3774 $reportfunction = $report.'_report_extend_navigation';
3775 if (function_exists($report.'_report_extend_navigation')) {
3776 $reportfunction($reportnav, $course, $coursecontext);
3781 $reports = get_plugin_list_with_function('report', 'extend_navigation_course', 'lib.php');
3782 foreach ($reports as $reportfunction) {
3783 $reportfunction($reportnav, $course, $coursecontext);
3787 // Add view grade report is permitted
3788 $reportavailable = false;
3789 if (has_capability('moodle/grade:viewall', $coursecontext)) {
3790 $reportavailable = true;
3791 } else if (!empty($course->showgrades
)) {
3792 $reports = core_component
::get_plugin_list('gradereport');
3793 if (is_array($reports) && count($reports)>0) { // Get all installed reports
3794 arsort($reports); // user is last, we want to test it first
3795 foreach ($reports as $plugin => $plugindir) {
3796 if (has_capability('gradereport/'.$plugin.':view', $coursecontext)) {
3797 //stop when the first visible plugin is found
3798 $reportavailable = true;
3804 if ($reportavailable) {
3805 $url = new moodle_url('/grade/report/index.php', array('id'=>$course->id
));
3806 $gradenode = $coursenode->add(get_string('grades'), $url, self
::TYPE_SETTING
, null, 'grades', new pix_icon('i/grades', ''));
3809 // Add outcome if permitted
3810 if (!empty($CFG->enableoutcomes
) && has_capability('moodle/course:update', $coursecontext)) {
3811 $url = new moodle_url('/grade/edit/outcome/course.php', array('id'=>$course->id
));
3812 $coursenode->add(get_string('outcomes', 'grades'), $url, self
::TYPE_SETTING
, null, 'outcomes', new pix_icon('i/outcomes', ''));
3815 //Add badges navigation
3816 require_once($CFG->libdir
.'/badgeslib.php');
3817 badges_add_course_navigation($coursenode, $course);
3819 // Backup this course
3820 if (has_capability('moodle/backup:backupcourse', $coursecontext)) {
3821 $url = new moodle_url('/backup/backup.php', array('id'=>$course->id
));
3822 $coursenode->add(get_string('backup'), $url, self
::TYPE_SETTING
, null, 'backup', new pix_icon('i/backup', ''));
3825 // Restore to this course
3826 if (has_capability('moodle/restore:restorecourse', $coursecontext)) {
3827 $url = new moodle_url('/backup/restorefile.php', array('contextid'=>$coursecontext->id
));
3828 $coursenode->add(get_string('restore'), $url, self
::TYPE_SETTING
, null, 'restore', new pix_icon('i/restore', ''));
3831 // Import data from other courses
3832 if (has_capability('moodle/restore:restoretargetimport', $coursecontext)) {
3833 $url = new moodle_url('/backup/import.php', array('id'=>$course->id
));
3834 $coursenode->add(get_string('import'), $url, self
::TYPE_SETTING
, null, 'import', new pix_icon('i/import', ''));
3837 // Publish course on a hub
3838 if (has_capability('moodle/course:publish', $coursecontext)) {
3839 $url = new moodle_url('/course/publish/index.php', array('id'=>$course->id
));
3840 $coursenode->add(get_string('publish'), $url, self
::TYPE_SETTING
, null, 'publish', new pix_icon('i/publish', ''));
3843 // Reset this course
3844 if (has_capability('moodle/course:reset', $coursecontext)) {
3845 $url = new moodle_url('/course/reset.php', array('id'=>$course->id
));
3846 $coursenode->add(get_string('reset'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/return', ''));
3850 require_once($CFG->libdir
. '/questionlib.php');
3851 question_extend_settings_navigation($coursenode, $coursecontext)->trim_if_empty();
3853 if (has_capability('moodle/course:update', $coursecontext)) {
3854 // Repository Instances
3855 if (!$this->cache
->cached('contexthasrepos'.$coursecontext->id
)) {
3856 require_once($CFG->dirroot
. '/repository/lib.php');
3857 $editabletypes = repository
::get_editable_types($coursecontext);
3858 $haseditabletypes = !empty($editabletypes);
3859 unset($editabletypes);
3860 $this->cache
->set('contexthasrepos'.$coursecontext->id
, $haseditabletypes);
3862 $haseditabletypes = $this->cache
->{'contexthasrepos'.$coursecontext->id
};
3864 if ($haseditabletypes) {
3865 $url = new moodle_url('/repository/manage_instances.php', array('contextid' => $coursecontext->id
));
3866 $coursenode->add(get_string('repositories'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/repository', ''));
3871 if ($course->legacyfiles
== 2 and has_capability('moodle/course:managefiles', $coursecontext)) {
3872 // hidden in new courses and courses where legacy files were turned off
3873 $url = new moodle_url('/files/index.php', array('contextid'=>$coursecontext->id
));
3874 $coursenode->add(get_string('courselegacyfiles'), $url, self
::TYPE_SETTING
, null, 'coursefiles', new pix_icon('i/folder', ''));
3880 $assumedrole = $this->in_alternative_role();
3881 if ($assumedrole !== false) {
3882 $roles[0] = get_string('switchrolereturn');
3884 if (has_capability('moodle/role:switchroles', $coursecontext)) {
3885 $availableroles = get_switchable_roles($coursecontext);
3886 if (is_array($availableroles)) {
3887 foreach ($availableroles as $key=>$role) {
3888 if ($assumedrole == (int)$key) {
3891 $roles[$key] = $role;
3895 if (is_array($roles) && count($roles)>0) {
3896 $switchroles = $this->add(get_string('switchroleto'));
3897 if ((count($roles)==1 && array_key_exists(0, $roles))||
$assumedrole!==false) {
3898 $switchroles->force_open();
3900 foreach ($roles as $key => $name) {
3901 $url = new moodle_url('/course/switchrole.php', array('id'=>$course->id
, 'sesskey'=>sesskey(), 'switchrole'=>$key, 'returnurl'=>$this->page
->url
->out_as_local_url(false)));
3902 $switchroles->add($name, $url, self
::TYPE_SETTING
, null, $key, new pix_icon('i/switchrole', ''));
3905 // Return we are done
3910 * This function calls the module function to inject module settings into the
3911 * settings navigation tree.
3913 * This only gets called if there is a corrosponding function in the modules
3916 * For examples mod/forum/lib.php {@link forum_extend_settings_navigation()}
3918 * @return navigation_node|false
3920 protected function load_module_settings() {
3923 if (!$this->page
->cm
&& $this->context
->contextlevel
== CONTEXT_MODULE
&& $this->context
->instanceid
) {
3924 $cm = get_coursemodule_from_id(false, $this->context
->instanceid
, 0, false, MUST_EXIST
);
3925 $this->page
->set_cm($cm, $this->page
->course
);
3928 $file = $CFG->dirroot
.'/mod/'.$this->page
->activityname
.'/lib.php';
3929 if (file_exists($file)) {
3930 require_once($file);
3933 $modulenode = $this->add(get_string('pluginadministration', $this->page
->activityname
), null, self
::TYPE_SETTING
, null, 'modulesettings');
3934 $modulenode->force_open();
3936 // Settings for the module
3937 if (has_capability('moodle/course:manageactivities', $this->page
->cm
->context
)) {
3938 $url = new moodle_url('/course/modedit.php', array('update' => $this->page
->cm
->id
, 'return' => 1));
3939 $modulenode->add(get_string('editsettings'), $url, navigation_node
::TYPE_SETTING
, null, 'modedit');
3941 // Assign local roles
3942 if (count(get_assignable_roles($this->page
->cm
->context
))>0) {
3943 $url = new moodle_url('/'.$CFG->admin
.'/roles/assign.php', array('contextid'=>$this->page
->cm
->context
->id
));
3944 $modulenode->add(get_string('localroles', 'role'), $url, self
::TYPE_SETTING
, null, 'roleassign');
3947 if (has_capability('moodle/role:review', $this->page
->cm
->context
) or count(get_overridable_roles($this->page
->cm
->context
))>0) {
3948 $url = new moodle_url('/'.$CFG->admin
.'/roles/permissions.php', array('contextid'=>$this->page
->cm
->context
->id
));
3949 $modulenode->add(get_string('permissions', 'role'), $url, self
::TYPE_SETTING
, null, 'roleoverride');
3951 // Check role permissions
3952 if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:assign'), $this->page
->cm
->context
)) {
3953 $url = new moodle_url('/'.$CFG->admin
.'/roles/check.php', array('contextid'=>$this->page
->cm
->context
->id
));
3954 $modulenode->add(get_string('checkpermissions', 'role'), $url, self
::TYPE_SETTING
, null, 'rolecheck');
3957 if (has_capability('moodle/filter:manage', $this->page
->cm
->context
) && count(filter_get_available_in_context($this->page
->cm
->context
))>0) {
3958 $url = new moodle_url('/filter/manage.php', array('contextid'=>$this->page
->cm
->context
->id
));
3959 $modulenode->add(get_string('filters', 'admin'), $url, self
::TYPE_SETTING
, null, 'filtermanage');
3962 $reports = get_plugin_list_with_function('report', 'extend_navigation_module', 'lib.php');
3963 foreach ($reports as $reportfunction) {
3964 $reportfunction($modulenode, $this->page
->cm
);
3966 // Add a backup link
3967 $featuresfunc = $this->page
->activityname
.'_supports';
3968 if (function_exists($featuresfunc) && $featuresfunc(FEATURE_BACKUP_MOODLE2
) && has_capability('moodle/backup:backupactivity', $this->page
->cm
->context
)) {
3969 $url = new moodle_url('/backup/backup.php', array('id'=>$this->page
->cm
->course
, 'cm'=>$this->page
->cm
->id
));
3970 $modulenode->add(get_string('backup'), $url, self
::TYPE_SETTING
, null, 'backup');
3973 // Restore this activity
3974 $featuresfunc = $this->page
->activityname
.'_supports';
3975 if (function_exists($featuresfunc) && $featuresfunc(FEATURE_BACKUP_MOODLE2
) && has_capability('moodle/restore:restoreactivity', $this->page
->cm
->context
)) {
3976 $url = new moodle_url('/backup/restorefile.php', array('contextid'=>$this->page
->cm
->context
->id
));
3977 $modulenode->add(get_string('restore'), $url, self
::TYPE_SETTING
, null, 'restore');
3980 // Allow the active advanced grading method plugin to append its settings
3981 $featuresfunc = $this->page
->activityname
.'_supports';
3982 if (function_exists($featuresfunc) && $featuresfunc(FEATURE_ADVANCED_GRADING
) && has_capability('moodle/grade:managegradingforms', $this->page
->cm
->context
)) {
3983 require_once($CFG->dirroot
.'/grade/grading/lib.php');
3984 $gradingman = get_grading_manager($this->page
->cm
->context
, 'mod_'.$this->page
->activityname
);
3985 $gradingman->extend_settings_navigation($this, $modulenode);
3988 $function = $this->page
->activityname
.'_extend_settings_navigation';
3989 if (!function_exists($function)) {
3993 $function($this, $modulenode);
3995 // Remove the module node if there are no children
3996 if (empty($modulenode->children
)) {
3997 $modulenode->remove();
4004 * Loads the user settings block of the settings nav
4006 * This function is simply works out the userid and whether we need to load
4007 * just the current users profile settings, or the current user and the user the
4008 * current user is viewing.
4010 * This function has some very ugly code to work out the user, if anyone has
4011 * any bright ideas please feel free to intervene.
4013 * @param int $courseid The course id of the current course
4014 * @return navigation_node|false
4016 protected function load_user_settings($courseid = SITEID
) {
4019 if (isguestuser() ||
!isloggedin()) {
4023 $navusers = $this->page
->navigation
->get_extending_users();
4025 if (count($this->userstoextendfor
) > 0 ||
count($navusers) > 0) {
4027 foreach ($this->userstoextendfor
as $userid) {
4028 if ($userid == $USER->id
) {
4031 $node = $this->generate_user_settings($courseid, $userid, 'userviewingsettings');
4032 if (is_null($usernode)) {
4036 foreach ($navusers as $user) {
4037 if ($user->id
== $USER->id
) {
4040 $node = $this->generate_user_settings($courseid, $user->id
, 'userviewingsettings');
4041 if (is_null($usernode)) {
4045 $this->generate_user_settings($courseid, $USER->id
);
4047 $usernode = $this->generate_user_settings($courseid, $USER->id
);
4053 * Extends the settings navigation for the given user.
4055 * Note: This method gets called automatically if you call
4056 * $PAGE->navigation->extend_for_user($userid)
4058 * @param int $userid
4060 public function extend_for_user($userid) {
4063 if (!in_array($userid, $this->userstoextendfor
)) {
4064 $this->userstoextendfor
[] = $userid;
4065 if ($this->initialised
) {
4066 $this->generate_user_settings($this->page
->course
->id
, $userid, 'userviewingsettings');
4067 $children = array();
4068 foreach ($this->children
as $child) {
4069 $children[] = $child;
4071 array_unshift($children, array_pop($children));
4072 $this->children
= new navigation_node_collection();
4073 foreach ($children as $child) {
4074 $this->children
->add($child);
4081 * This function gets called by {@link settings_navigation::load_user_settings()} and actually works out
4082 * what can be shown/done
4084 * @param int $courseid The current course' id
4085 * @param int $userid The user id to load for
4086 * @param string $gstitle The string to pass to get_string for the branch title
4087 * @return navigation_node|false
4089 protected function generate_user_settings($courseid, $userid, $gstitle='usercurrentsettings') {
4090 global $DB, $CFG, $USER, $SITE;
4092 if ($courseid != $SITE->id
) {
4093 if (!empty($this->page
->course
->id
) && $this->page
->course
->id
== $courseid) {
4094 $course = $this->page
->course
;
4096 $select = context_helper
::get_preload_record_columns_sql('ctx');
4097 $sql = "SELECT c.*, $select
4099 JOIN {context} ctx ON c.id = ctx.instanceid
4100 WHERE c.id = :courseid AND ctx.contextlevel = :contextlevel";
4101 $params = array('courseid' => $courseid, 'contextlevel' => CONTEXT_COURSE
);
4102 $course = $DB->get_record_sql($sql, $params, MUST_EXIST
);
4103 context_helper
::preload_from_record($course);
4109 $coursecontext = context_course
::instance($course->id
); // Course context
4110 $systemcontext = context_system
::instance();
4111 $currentuser = ($USER->id
== $userid);
4115 $usercontext = context_user
::instance($user->id
); // User context
4117 $select = context_helper
::get_preload_record_columns_sql('ctx');
4118 $sql = "SELECT u.*, $select
4120 JOIN {context} ctx ON u.id = ctx.instanceid
4121 WHERE u.id = :userid AND ctx.contextlevel = :contextlevel";
4122 $params = array('userid' => $userid, 'contextlevel' => CONTEXT_USER
);
4123 $user = $DB->get_record_sql($sql, $params, IGNORE_MISSING
);
4127 context_helper
::preload_from_record($user);
4129 // Check that the user can view the profile
4130 $usercontext = context_user
::instance($user->id
); // User context
4131 $canviewuser = has_capability('moodle/user:viewdetails', $usercontext);
4133 if ($course->id
== $SITE->id
) {
4134 if ($CFG->forceloginforprofiles
&& !has_coursecontact_role($user->id
) && !$canviewuser) { // Reduce possibility of "browsing" userbase at site level
4135 // Teachers can browse and be browsed at site level. If not forceloginforprofiles, allow access (bug #4366)
4139 $canviewusercourse = has_capability('moodle/user:viewdetails', $coursecontext);
4140 $userisenrolled = is_enrolled($coursecontext, $user->id
);
4141 if ((!$canviewusercourse && !$canviewuser) ||
!$userisenrolled) {
4144 $canaccessallgroups = has_capability('moodle/site:accessallgroups', $coursecontext);
4145 if (!$canaccessallgroups && groups_get_course_groupmode($course) == SEPARATEGROUPS
&& !$canviewuser) {
4146 // If groups are in use, make sure we can see that group (MDL-45874). That does not apply to parents.
4147 if ($courseid == $this->page
->course
->id
) {
4148 $mygroups = get_fast_modinfo($this->page
->course
)->groups
;
4150 $mygroups = groups_get_user_groups($courseid);
4152 $usergroups = groups_get_user_groups($courseid, $userid);
4153 if (!array_intersect_key($mygroups[0], $usergroups[0])) {
4160 $fullname = fullname($user, has_capability('moodle/site:viewfullnames', $this->page
->context
));
4163 if ($gstitle != 'usercurrentsettings') {
4167 // Add a user setting branch
4168 $usersetting = $this->add(get_string($gstitle, 'moodle', $fullname), null, self
::TYPE_CONTAINER
, null, $key);
4169 $usersetting->id
= 'usersettings';
4170 if ($this->page
->context
->contextlevel
== CONTEXT_USER
&& $this->page
->context
->instanceid
== $user->id
) {
4171 // Automatically start by making it active
4172 $usersetting->make_active();
4175 // Check if the user has been deleted
4176 if ($user->deleted
) {
4177 if (!has_capability('moodle/user:update', $coursecontext)) {
4178 // We can't edit the user so just show the user deleted message
4179 $usersetting->add(get_string('userdeleted'), null, self
::TYPE_SETTING
);
4181 // We can edit the user so show the user deleted message and link it to the profile
4182 if ($course->id
== $SITE->id
) {
4183 $profileurl = new moodle_url('/user/profile.php', array('id'=>$user->id
));
4185 $profileurl = new moodle_url('/user/view.php', array('id'=>$user->id
, 'course'=>$course->id
));
4187 $usersetting->add(get_string('userdeleted'), $profileurl, self
::TYPE_SETTING
);
4192 $userauthplugin = false;
4193 if (!empty($user->auth
)) {
4194 $userauthplugin = get_auth_plugin($user->auth
);
4197 // Add the profile edit link
4198 if (isloggedin() && !isguestuser($user) && !is_mnet_remote_user($user)) {
4199 if (($currentuser ||
is_siteadmin($USER) ||
!is_siteadmin($user)) && has_capability('moodle/user:update', $systemcontext)) {
4200 $url = new moodle_url('/user/editadvanced.php', array('id'=>$user->id
, 'course'=>$course->id
));
4201 $usersetting->add(get_string('editmyprofile'), $url, self
::TYPE_SETTING
);
4202 } else if ((has_capability('moodle/user:editprofile', $usercontext) && !is_siteadmin($user)) ||
($currentuser && has_capability('moodle/user:editownprofile', $systemcontext))) {
4203 if ($userauthplugin && $userauthplugin->can_edit_profile()) {
4204 $url = $userauthplugin->edit_profile_url();
4206 $url = new moodle_url('/user/edit.php', array('id'=>$user->id
, 'course'=>$course->id
));
4208 $usersetting->add(get_string('editmyprofile'), $url, self
::TYPE_SETTING
);
4213 // Change password link
4214 if ($userauthplugin && $currentuser && !\core\session\manager
::is_loggedinas() && !isguestuser() && has_capability('moodle/user:changeownpassword', $systemcontext) && $userauthplugin->can_change_password()) {
4215 $passwordchangeurl = $userauthplugin->change_password_url();
4216 if (empty($passwordchangeurl)) {
4217 $passwordchangeurl = new moodle_url('/login/change_password.php', array('id'=>$course->id
));
4219 $usersetting->add(get_string("changepassword"), $passwordchangeurl, self
::TYPE_SETTING
);
4222 // View the roles settings
4223 if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:manage'), $usercontext)) {
4224 $roles = $usersetting->add(get_string('roles'), null, self
::TYPE_SETTING
);
4226 $url = new moodle_url('/admin/roles/usersroles.php', array('userid'=>$user->id
, 'courseid'=>$course->id
));
4227 $roles->add(get_string('thisusersroles', 'role'), $url, self
::TYPE_SETTING
);
4229 $assignableroles = get_assignable_roles($usercontext, ROLENAME_BOTH
);
4231 if (!empty($assignableroles)) {
4232 $url = new moodle_url('/admin/roles/assign.php', array('contextid'=>$usercontext->id
,'userid'=>$user->id
, 'courseid'=>$course->id
));
4233 $roles->add(get_string('assignrolesrelativetothisuser', 'role'), $url, self
::TYPE_SETTING
);
4236 if (has_capability('moodle/role:review', $usercontext) ||
count(get_overridable_roles($usercontext, ROLENAME_BOTH
))>0) {
4237 $url = new moodle_url('/admin/roles/permissions.php', array('contextid'=>$usercontext->id
,'userid'=>$user->id
, 'courseid'=>$course->id
));
4238 $roles->add(get_string('permissions', 'role'), $url, self
::TYPE_SETTING
);
4241 $url = new moodle_url('/admin/roles/check.php', array('contextid'=>$usercontext->id
,'userid'=>$user->id
, 'courseid'=>$course->id
));
4242 $roles->add(get_string('checkpermissions', 'role'), $url, self
::TYPE_SETTING
);
4246 if ($currentuser && !empty($CFG->enableportfolios
) && has_capability('moodle/portfolio:export', $systemcontext)) {
4247 require_once($CFG->libdir
. '/portfoliolib.php');
4248 if (portfolio_has_visible_instances()) {
4249 $portfolio = $usersetting->add(get_string('portfolios', 'portfolio'), null, self
::TYPE_SETTING
);
4251 $url = new moodle_url('/user/portfolio.php', array('courseid'=>$course->id
));
4252 $portfolio->add(get_string('configure', 'portfolio'), $url, self
::TYPE_SETTING
);
4254 $url = new moodle_url('/user/portfoliologs.php', array('courseid'=>$course->id
));
4255 $portfolio->add(get_string('logs', 'portfolio'), $url, self
::TYPE_SETTING
);
4259 $enablemanagetokens = false;
4260 if (!empty($CFG->enablerssfeeds
)) {
4261 $enablemanagetokens = true;
4262 } else if (!is_siteadmin($USER->id
)
4263 && !empty($CFG->enablewebservices
)
4264 && has_capability('moodle/webservice:createtoken', context_system
::instance()) ) {
4265 $enablemanagetokens = true;
4268 if ($currentuser && $enablemanagetokens) {
4269 $url = new moodle_url('/user/managetoken.php', array('sesskey'=>sesskey()));
4270 $usersetting->add(get_string('securitykeys', 'webservice'), $url, self
::TYPE_SETTING
);
4274 if (($currentuser && has_capability('moodle/user:editownmessageprofile', $systemcontext)) ||
(!isguestuser($user) && has_capability('moodle/user:editmessageprofile', $usercontext) && !is_primary_admin($user->id
))) {
4275 $url = new moodle_url('/message/edit.php', array('id'=>$user->id
));
4276 $usersetting->add(get_string('messaging', 'message'), $url, self
::TYPE_SETTING
);
4280 if ($currentuser && !empty($CFG->enableblogs
)) {
4281 $blog = $usersetting->add(get_string('blogs', 'blog'), null, navigation_node
::TYPE_CONTAINER
, null, 'blogs');
4282 $blog->add(get_string('preferences', 'blog'), new moodle_url('/blog/preferences.php'), navigation_node
::TYPE_SETTING
);
4283 if (!empty($CFG->useexternalblogs
) && $CFG->maxexternalblogsperuser
> 0 && has_capability('moodle/blog:manageexternal', context_system
::instance())) {
4284 $blog->add(get_string('externalblogs', 'blog'), new moodle_url('/blog/external_blogs.php'), navigation_node
::TYPE_SETTING
);
4285 $blog->add(get_string('addnewexternalblog', 'blog'), new moodle_url('/blog/external_blog_edit.php'), navigation_node
::TYPE_SETTING
);
4290 if ($currentuser && !empty($CFG->enablebadges
)) {
4291 $badges = $usersetting->add(get_string('badges'), null, navigation_node
::TYPE_CONTAINER
, null, 'badges');
4292 $badges->add(get_string('preferences'), new moodle_url('/badges/preferences.php'), navigation_node
::TYPE_SETTING
);
4293 if (!empty($CFG->badges_allowexternalbackpack
)) {
4294 $badges->add(get_string('backpackdetails', 'badges'), new moodle_url('/badges/mybackpack.php'), navigation_node
::TYPE_SETTING
);
4298 // Add reports node.
4299 $reporttab = $usersetting->add(get_string('activityreports'));
4300 $reports = get_plugin_list_with_function('report', 'extend_navigation_user', 'lib.php');
4301 foreach ($reports as $reportfunction) {
4302 $reportfunction($reporttab, $user, $course);
4304 $anyreport = has_capability('moodle/user:viewuseractivitiesreport', $usercontext);
4305 if ($anyreport ||
($course->showreports
&& $currentuser)) {
4306 // Add grade hardcoded grade report if necessary.
4307 $gradeaccess = false;
4308 if (has_capability('moodle/grade:viewall', $coursecontext)) {
4309 // Can view all course grades.
4310 $gradeaccess = true;
4311 } else if ($course->showgrades
) {
4312 if ($currentuser && has_capability('moodle/grade:view', $coursecontext)) {
4313 // Can view own grades.
4314 $gradeaccess = true;
4315 } else if (has_capability('moodle/grade:viewall', $usercontext)) {
4316 // Can view grades of this user - parent most probably.
4317 $gradeaccess = true;
4318 } else if ($anyreport) {
4319 // Can view grades of this user - parent most probably.
4320 $gradeaccess = true;
4324 $reporttab->add(get_string('grade'), new moodle_url('/course/user.php', array('mode'=>'grade', 'id'=>$course->id
,
4325 'user'=>$usercontext->instanceid
)));
4328 // Check the number of nodes in the report node... if there are none remove the node
4329 $reporttab->trim_if_empty();
4332 if (!$user->deleted
and !$currentuser && !\core\session\manager
::is_loggedinas() && has_capability('moodle/user:loginas', $coursecontext) && !is_siteadmin($user->id
)) {
4333 $url = new moodle_url('/course/loginas.php', array('id'=>$course->id
, 'user'=>$user->id
, 'sesskey'=>sesskey()));
4334 $usersetting->add(get_string('loginas'), $url, self
::TYPE_SETTING
);
4337 return $usersetting;
4341 * Loads block specific settings in the navigation
4343 * @return navigation_node
4345 protected function load_block_settings() {
4348 $blocknode = $this->add($this->context
->get_context_name(), null, self
::TYPE_SETTING
, null, 'blocksettings');
4349 $blocknode->force_open();
4351 // Assign local roles
4352 $assignurl = new moodle_url('/'.$CFG->admin
.'/roles/assign.php', array('contextid'=>$this->context
->id
));
4353 $blocknode->add(get_string('assignroles', 'role'), $assignurl, self
::TYPE_SETTING
);
4356 if (has_capability('moodle/role:review', $this->context
) or count(get_overridable_roles($this->context
))>0) {
4357 $url = new moodle_url('/'.$CFG->admin
.'/roles/permissions.php', array('contextid'=>$this->context
->id
));
4358 $blocknode->add(get_string('permissions', 'role'), $url, self
::TYPE_SETTING
);
4360 // Check role permissions
4361 if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:assign'), $this->context
)) {
4362 $url = new moodle_url('/'.$CFG->admin
.'/roles/check.php', array('contextid'=>$this->context
->id
));
4363 $blocknode->add(get_string('checkpermissions', 'role'), $url, self
::TYPE_SETTING
);
4370 * Loads category specific settings in the navigation
4372 * @return navigation_node
4374 protected function load_category_settings() {
4377 // We can land here while being in the context of a block, in which case we
4378 // should get the parent context which should be the category one. See self::initialise().
4379 if ($this->context
->contextlevel
== CONTEXT_BLOCK
) {
4380 $catcontext = $this->context
->get_parent_context();
4382 $catcontext = $this->context
;
4385 // Let's make sure that we always have the right context when getting here.
4386 if ($catcontext->contextlevel
!= CONTEXT_COURSECAT
) {
4387 throw new coding_exception('Unexpected context while loading category settings.');
4390 $categorynode = $this->add($catcontext->get_context_name(), null, null, null, 'categorysettings');
4391 $categorynode->force_open();
4393 if (can_edit_in_category($catcontext->instanceid
)) {
4394 $url = new moodle_url('/course/management.php', array('categoryid' => $catcontext->instanceid
));
4395 $editstring = get_string('managecategorythis');
4396 $categorynode->add($editstring, $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/edit', ''));
4399 if (has_capability('moodle/category:manage', $catcontext)) {
4400 $editurl = new moodle_url('/course/editcategory.php', array('id' => $catcontext->instanceid
));
4401 $categorynode->add(get_string('editcategorythis'), $editurl, self
::TYPE_SETTING
, null, 'edit', new pix_icon('i/edit', ''));
4403 $addsubcaturl = new moodle_url('/course/editcategory.php', array('parent' => $catcontext->instanceid
));
4404 $categorynode->add(get_string('addsubcategory'), $addsubcaturl, self
::TYPE_SETTING
, null, 'addsubcat', new pix_icon('i/withsubcat', ''));
4407 // Assign local roles
4408 $assignableroles = get_assignable_roles($catcontext);
4409 if (!empty($assignableroles)) {
4410 $assignurl = new moodle_url('/'.$CFG->admin
.'/roles/assign.php', array('contextid' => $catcontext->id
));
4411 $categorynode->add(get_string('assignroles', 'role'), $assignurl, self
::TYPE_SETTING
, null, 'roles', new pix_icon('i/assignroles', ''));
4415 if (has_capability('moodle/role:review', $catcontext) or count(get_overridable_roles($catcontext)) > 0) {
4416 $url = new moodle_url('/'.$CFG->admin
.'/roles/permissions.php', array('contextid' => $catcontext->id
));
4417 $categorynode->add(get_string('permissions', 'role'), $url, self
::TYPE_SETTING
, null, 'permissions', new pix_icon('i/permissions', ''));
4419 // Check role permissions
4420 if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride',
4421 'moodle/role:override', 'moodle/role:assign'), $catcontext)) {
4422 $url = new moodle_url('/'.$CFG->admin
.'/roles/check.php', array('contextid' => $catcontext->id
));
4423 $categorynode->add(get_string('checkpermissions', 'role'), $url, self
::TYPE_SETTING
, null, 'checkpermissions', new pix_icon('i/checkpermissions', ''));
4427 if (has_any_capability(array('moodle/cohort:view', 'moodle/cohort:manage'), $catcontext)) {
4428 $categorynode->add(get_string('cohorts', 'cohort'), new moodle_url('/cohort/index.php',
4429 array('contextid' => $catcontext->id
)), self
::TYPE_SETTING
, null, 'cohort', new pix_icon('i/cohort', ''));
4433 if (has_capability('moodle/filter:manage', $catcontext) && count(filter_get_available_in_context($catcontext)) > 0) {
4434 $url = new moodle_url('/filter/manage.php', array('contextid' => $catcontext->id
));
4435 $categorynode->add(get_string('filters', 'admin'), $url, self
::TYPE_SETTING
, null, 'filters', new pix_icon('i/filter', ''));
4439 if (has_capability('moodle/course:create', $catcontext)) {
4440 $url = new moodle_url('/backup/restorefile.php', array('contextid' => $catcontext->id
));
4441 $categorynode->add(get_string('restorecourse', 'admin'), $url, self
::TYPE_SETTING
, null, 'restorecourse', new pix_icon('i/restore', ''));
4444 return $categorynode;
4448 * Determine whether the user is assuming another role
4450 * This function checks to see if the user is assuming another role by means of
4451 * role switching. In doing this we compare each RSW key (context path) against
4452 * the current context path. This ensures that we can provide the switching
4453 * options against both the course and any page shown under the course.
4455 * @return bool|int The role(int) if the user is in another role, false otherwise
4457 protected function in_alternative_role() {
4459 if (!empty($USER->access
['rsw']) && is_array($USER->access
['rsw'])) {
4460 if (!empty($this->page
->context
) && !empty($USER->access
['rsw'][$this->page
->context
->path
])) {
4461 return $USER->access
['rsw'][$this->page
->context
->path
];
4463 foreach ($USER->access
['rsw'] as $key=>$role) {
4464 if (strpos($this->context
->path
,$key)===0) {
4473 * This function loads all of the front page settings into the settings navigation.
4474 * This function is called when the user is on the front page, or $COURSE==$SITE
4475 * @param bool $forceopen (optional)
4476 * @return navigation_node
4478 protected function load_front_page_settings($forceopen = false) {
4481 $course = clone($SITE);
4482 $coursecontext = context_course
::instance($course->id
); // Course context
4484 $frontpage = $this->add(get_string('frontpagesettings'), null, self
::TYPE_SETTING
, null, 'frontpage');
4486 $frontpage->force_open();
4488 $frontpage->id
= 'frontpagesettings';
4490 if ($this->page
->user_allowed_editing()) {
4492 // Add the turn on/off settings
4493 $url = new moodle_url('/course/view.php', array('id'=>$course->id
, 'sesskey'=>sesskey()));
4494 if ($this->page
->user_is_editing()) {
4495 $url->param('edit', 'off');
4496 $editstring = get_string('turneditingoff');
4498 $url->param('edit', 'on');
4499 $editstring = get_string('turneditingon');
4501 $frontpage->add($editstring, $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/edit', ''));
4504 if (has_capability('moodle/course:update', $coursecontext)) {
4505 // Add the course settings link
4506 $url = new moodle_url('/admin/settings.php', array('section'=>'frontpagesettings'));
4507 $frontpage->add(get_string('editsettings'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/settings', ''));
4511 enrol_add_course_navigation($frontpage, $course);
4514 if (has_capability('moodle/filter:manage', $coursecontext) && count(filter_get_available_in_context($coursecontext))>0) {
4515 $url = new moodle_url('/filter/manage.php', array('contextid'=>$coursecontext->id
));
4516 $frontpage->add(get_string('filters', 'admin'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/filter', ''));
4519 // View course reports.
4520 if (has_capability('moodle/site:viewreports', $coursecontext)) { // Basic capability for listing of reports.
4521 $frontpagenav = $frontpage->add(get_string('reports'), null, self
::TYPE_CONTAINER
, null, null,
4522 new pix_icon('i/stats', ''));
4523 $coursereports = core_component
::get_plugin_list('coursereport');
4524 foreach ($coursereports as $report=>$dir) {
4525 $libfile = $CFG->dirroot
.'/course/report/'.$report.'/lib.php';
4526 if (file_exists($libfile)) {
4527 require_once($libfile);
4528 $reportfunction = $report.'_report_extend_navigation';
4529 if (function_exists($report.'_report_extend_navigation')) {
4530 $reportfunction($frontpagenav, $course, $coursecontext);
4535 $reports = get_plugin_list_with_function('report', 'extend_navigation_course', 'lib.php');
4536 foreach ($reports as $reportfunction) {
4537 $reportfunction($frontpagenav, $course, $coursecontext);
4541 // Backup this course
4542 if (has_capability('moodle/backup:backupcourse', $coursecontext)) {
4543 $url = new moodle_url('/backup/backup.php', array('id'=>$course->id
));
4544 $frontpage->add(get_string('backup'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/backup', ''));
4547 // Restore to this course
4548 if (has_capability('moodle/restore:restorecourse', $coursecontext)) {
4549 $url = new moodle_url('/backup/restorefile.php', array('contextid'=>$coursecontext->id
));
4550 $frontpage->add(get_string('restore'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/restore', ''));
4554 require_once($CFG->libdir
. '/questionlib.php');
4555 question_extend_settings_navigation($frontpage, $coursecontext)->trim_if_empty();
4558 if ($course->legacyfiles
== 2 and has_capability('moodle/course:managefiles', $this->context
)) {
4559 //hiden in new installs
4560 $url = new moodle_url('/files/index.php', array('contextid'=>$coursecontext->id
));
4561 $frontpage->add(get_string('sitelegacyfiles'), $url, self
::TYPE_SETTING
, null, null, new pix_icon('i/folder', ''));
4567 * This function gives local plugins an opportunity to modify the settings navigation.
4569 protected function load_local_plugin_settings() {
4570 // Get all local plugins with an extend_settings_navigation function in their lib.php file
4571 foreach (get_plugin_list_with_function('local', 'extends_settings_navigation') as $function) {
4572 // Call each function providing this (the settings navigation) and the current context.
4573 $function($this, $this->context
);
4578 * This function marks the cache as volatile so it is cleared during shutdown
4580 public function clear_cache() {
4581 $this->cache
->volatile();
4586 * Class used to populate site admin navigation for ajax.
4589 * @category navigation
4590 * @copyright 2013 Rajesh Taneja <rajesh@moodle.com>
4591 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4593 class settings_navigation_ajax
extends settings_navigation
{
4595 * Constructs the navigation for use in an AJAX request
4597 * @param moodle_page $page
4599 public function __construct(moodle_page
&$page) {
4600 $this->page
= $page;
4601 $this->cache
= new navigation_cache(NAVIGATION_CACHE_NAME
);
4602 $this->children
= new navigation_node_collection();
4603 $this->initialise();
4607 * Initialise the site admin navigation.
4609 * @return array An array of the expandable nodes
4611 public function initialise() {
4612 if ($this->initialised ||
during_initial_install()) {
4615 $this->context
= $this->page
->context
;
4616 $this->load_administration_settings();
4618 // Check if local plugins is adding node to site admin.
4619 $this->load_local_plugin_settings();
4621 $this->initialised
= true;
4626 * Simple class used to output a navigation branch in XML
4629 * @category navigation
4630 * @copyright 2009 Sam Hemelryk
4631 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4633 class navigation_json
{
4634 /** @var array An array of different node types */
4635 protected $nodetype = array('node','branch');
4636 /** @var array An array of node keys and types */
4637 protected $expandable = array();
4639 * Turns a branch and all of its children into XML
4641 * @param navigation_node $branch
4642 * @return string XML string
4644 public function convert($branch) {
4645 $xml = $this->convert_child($branch);
4649 * Set the expandable items in the array so that we have enough information
4650 * to attach AJAX events
4651 * @param array $expandable
4653 public function set_expandable($expandable) {
4654 foreach ($expandable as $node) {
4655 $this->expandable
[$node['key'].':'.$node['type']] = $node;
4659 * Recusively converts a child node and its children to XML for output
4661 * @param navigation_node $child The child to convert
4662 * @param int $depth Pointlessly used to track the depth of the XML structure
4663 * @return string JSON
4665 protected function convert_child($child, $depth=1) {
4666 if (!$child->display
) {
4669 $attributes = array();
4670 $attributes['id'] = $child->id
;
4671 $attributes['name'] = (string)$child->text
; // This can be lang_string object so typecast it.
4672 $attributes['type'] = $child->type
;
4673 $attributes['key'] = $child->key
;
4674 $attributes['class'] = $child->get_css_type();
4676 if ($child->icon
instanceof pix_icon
) {
4677 $attributes['icon'] = array(
4678 'component' => $child->icon
->component
,
4679 'pix' => $child->icon
->pix
,
4681 foreach ($child->icon
->attributes
as $key=>$value) {
4682 if ($key == 'class') {
4683 $attributes['icon']['classes'] = explode(' ', $value);
4684 } else if (!array_key_exists($key, $attributes['icon'])) {
4685 $attributes['icon'][$key] = $value;
4689 } else if (!empty($child->icon
)) {
4690 $attributes['icon'] = (string)$child->icon
;
4693 if ($child->forcetitle ||
$child->title
!== $child->text
) {
4694 $attributes['title'] = htmlentities($child->title
, ENT_QUOTES
, 'UTF-8');
4696 if (array_key_exists($child->key
.':'.$child->type
, $this->expandable
)) {
4697 $attributes['expandable'] = $child->key
;
4698 $child->add_class($this->expandable
[$child->key
.':'.$child->type
]['id']);
4701 if (count($child->classes
)>0) {
4702 $attributes['class'] .= ' '.join(' ',$child->classes
);
4704 if (is_string($child->action
)) {
4705 $attributes['link'] = $child->action
;
4706 } else if ($child->action
instanceof moodle_url
) {
4707 $attributes['link'] = $child->action
->out();
4708 } else if ($child->action
instanceof action_link
) {
4709 $attributes['link'] = $child->action
->url
->out();
4711 $attributes['hidden'] = ($child->hidden
);
4712 $attributes['haschildren'] = ($child->children
->count()>0 ||
$child->type
== navigation_node
::TYPE_CATEGORY
);
4713 $attributes['haschildren'] = $attributes['haschildren'] ||
$child->type
== navigation_node
::TYPE_MY_CATEGORY
;
4715 if ($child->children
->count() > 0) {
4716 $attributes['children'] = array();
4717 foreach ($child->children
as $subchild) {
4718 $attributes['children'][] = $this->convert_child($subchild, $depth+
1);
4725 return json_encode($attributes);
4731 * The cache class used by global navigation and settings navigation.
4733 * It is basically an easy access point to session with a bit of smarts to make
4734 * sure that the information that is cached is valid still.
4738 * if (!$cache->viewdiscussion()) {
4739 * // Code to do stuff and produce cachable content
4740 * $cache->viewdiscussion = has_capability('mod/forum:viewdiscussion', $coursecontext);
4742 * $content = $cache->viewdiscussion;
4746 * @category navigation
4747 * @copyright 2009 Sam Hemelryk
4748 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4750 class navigation_cache
{
4751 /** @var int represents the time created */
4752 protected $creation;
4753 /** @var array An array of session keys */
4756 * The string to use to segregate this particular cache. It can either be
4757 * unique to start a fresh cache or if you want to share a cache then make
4758 * it the string used in the original cache.
4762 /** @var int a time that the information will time out */
4764 /** @var stdClass The current context */
4765 protected $currentcontext;
4766 /** @var int cache time information */
4767 const CACHETIME
= 0;
4768 /** @var int cache user id */
4769 const CACHEUSERID
= 1;
4770 /** @var int cache value */
4771 const CACHEVALUE
= 2;
4772 /** @var null|array An array of navigation cache areas to expire on shutdown */
4773 public static $volatilecaches;
4776 * Contructor for the cache. Requires two arguments
4778 * @param string $area The string to use to segregate this particular cache
4779 * it can either be unique to start a fresh cache or if you want
4780 * to share a cache then make it the string used in the original
4782 * @param int $timeout The number of seconds to time the information out after
4784 public function __construct($area, $timeout=1800) {
4785 $this->creation
= time();
4786 $this->area
= $area;
4787 $this->timeout
= time() - $timeout;
4788 if (rand(0,100) === 0) {
4789 $this->garbage_collection();
4794 * Used to set up the cache within the SESSION.
4796 * This is called for each access and ensure that we don't put anything into the session before
4799 protected function ensure_session_cache_initialised() {
4801 if (empty($this->session
)) {
4802 if (!isset($SESSION->navcache
)) {
4803 $SESSION->navcache
= new stdClass
;
4805 if (!isset($SESSION->navcache
->{$this->area
})) {
4806 $SESSION->navcache
->{$this->area
} = array();
4808 $this->session
= &$SESSION->navcache
->{$this->area
}; // pointer to array, =& is correct here
4813 * Magic Method to retrieve something by simply calling using = cache->key
4815 * @param mixed $key The identifier for the information you want out again
4816 * @return void|mixed Either void or what ever was put in
4818 public function __get($key) {
4819 if (!$this->cached($key)) {
4822 $information = $this->session
[$key][self
::CACHEVALUE
];
4823 return unserialize($information);
4827 * Magic method that simply uses {@link set();} to store something in the cache
4829 * @param string|int $key
4830 * @param mixed $information
4832 public function __set($key, $information) {
4833 $this->set($key, $information);
4837 * Sets some information against the cache (session) for later retrieval
4839 * @param string|int $key
4840 * @param mixed $information
4842 public function set($key, $information) {
4844 $this->ensure_session_cache_initialised();
4845 $information = serialize($information);
4846 $this->session
[$key]= array(self
::CACHETIME
=>time(), self
::CACHEUSERID
=>$USER->id
, self
::CACHEVALUE
=>$information);
4849 * Check the existence of the identifier in the cache
4851 * @param string|int $key
4854 public function cached($key) {
4856 $this->ensure_session_cache_initialised();
4857 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
) {
4863 * Compare something to it's equivilant in the cache
4865 * @param string $key
4866 * @param mixed $value
4867 * @param bool $serialise Whether to serialise the value before comparison
4868 * this should only be set to false if the value is already
4870 * @return bool If the value is the same false if it is not set or doesn't match
4872 public function compare($key, $value, $serialise = true) {
4873 if ($this->cached($key)) {
4875 $value = serialize($value);
4877 if ($this->session
[$key][self
::CACHEVALUE
] === $value) {
4884 * Wipes the entire cache, good to force regeneration
4886 public function clear() {
4888 unset($SESSION->navcache
);
4889 $this->session
= null;
4892 * Checks all cache entries and removes any that have expired, good ole cleanup
4894 protected function garbage_collection() {
4895 if (empty($this->session
)) {
4898 foreach ($this->session
as $key=>$cachedinfo) {
4899 if (is_array($cachedinfo) && $cachedinfo[self
::CACHETIME
]<$this->timeout
) {
4900 unset($this->session
[$key]);
4906 * Marks the cache as being volatile (likely to change)
4908 * Any caches marked as volatile will be destroyed at the on shutdown by
4909 * {@link navigation_node::destroy_volatile_caches()} which is registered
4910 * as a shutdown function if any caches are marked as volatile.
4912 * @param bool $setting True to destroy the cache false not too
4914 public function volatile($setting = true) {
4915 if (self
::$volatilecaches===null) {
4916 self
::$volatilecaches = array();
4917 core_shutdown_manager
::register_function(array('navigation_cache','destroy_volatile_caches'));
4921 self
::$volatilecaches[$this->area
] = $this->area
;
4922 } else if (array_key_exists($this->area
, self
::$volatilecaches)) {
4923 unset(self
::$volatilecaches[$this->area
]);
4928 * Destroys all caches marked as volatile
4930 * This function is static and works in conjunction with the static volatilecaches
4931 * property of navigation cache.
4932 * Because this function is static it manually resets the cached areas back to an
4935 public static function destroy_volatile_caches() {
4937 if (is_array(self
::$volatilecaches) && count(self
::$volatilecaches)>0) {
4938 foreach (self
::$volatilecaches as $area) {
4939 $SESSION->navcache
->{$area} = array();
4942 $SESSION->navcache
= new stdClass
;