Commit | Line | Data |
---|---|---|
7d2a0492 | 1 | <?php |
2 | ||
3 | // This file is part of Moodle - http://moodle.org/ | |
4 | // | |
5 | // Moodle is free software: you can redistribute it and/or modify | |
6 | // it under the terms of the GNU General Public License as published by | |
7 | // the Free Software Foundation, either version 3 of the License, or | |
8 | // (at your option) any later version. | |
9 | // | |
10 | // Moodle is distributed in the hope that it will be useful, | |
11 | // but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
13 | // GNU General Public License for more details. | |
14 | // | |
15 | // You should have received a copy of the GNU General Public License | |
16 | // along with Moodle. If not, see <http://www.gnu.org/licenses/>. | |
17 | ||
18 | /** | |
19 | * This file contains classes used to manage the navigation structures in Moodle | |
20 | * and was introduced as part of the changes occuring in Moodle 2.0 | |
21 | * | |
78bfb562 PS |
22 | * @since 2.0 |
23 | * @package core | |
7d2a0492 | 24 | * @subpackage navigation |
78bfb562 PS |
25 | * @copyright 2009 Sam Hemelryk |
26 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
7d2a0492 | 27 | */ |
28 | ||
78bfb562 PS |
29 | defined('MOODLE_INTERNAL') || die(); |
30 | ||
f5b5a822 | 31 | /** |
2561c4e9 | 32 | * The name that will be used to separate the navigation cache within SESSION |
f5b5a822 | 33 | */ |
34 | define('NAVIGATION_CACHE_NAME', 'navigation'); | |
35 | ||
7d2a0492 | 36 | /** |
37 | * This class is used to represent a node in a navigation tree | |
38 | * | |
39 | * This class is used to represent a node in a navigation tree within Moodle, | |
40 | * the tree could be one of global navigation, settings navigation, or the navbar. | |
41 | * Each node can be one of two types either a Leaf (default) or a branch. | |
42 | * When a node is first created it is created as a leaf, when/if children are added | |
43 | * the node then becomes a branch. | |
44 | * | |
45 | * @package moodlecore | |
babb3911 | 46 | * @subpackage navigation |
7d2a0492 | 47 | * @copyright 2009 Sam Hemelryk |
48 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
49 | */ | |
3406acde SH |
50 | class navigation_node implements renderable { |
51 | /** @var int Used to identify this node a leaf (default) 0 */ | |
507a7a9a | 52 | const NODETYPE_LEAF = 0; |
3406acde | 53 | /** @var int Used to identify this node a branch, happens with children 1 */ |
7d2a0492 | 54 | const NODETYPE_BRANCH = 1; |
3406acde | 55 | /** @var null Unknown node type null */ |
7d2a0492 | 56 | const TYPE_UNKNOWN = null; |
3406acde SH |
57 | /** @var int System node type 0 */ |
58 | const TYPE_ROOTNODE = 0; | |
59 | /** @var int System node type 1 */ | |
60 | const TYPE_SYSTEM = 1; | |
61 | /** @var int Category node type 10 */ | |
7d2a0492 | 62 | const TYPE_CATEGORY = 10; |
3406acde | 63 | /** @var int Course node type 20 */ |
7d2a0492 | 64 | const TYPE_COURSE = 20; |
3406acde | 65 | /** @var int Course Structure node type 30 */ |
507a7a9a | 66 | const TYPE_SECTION = 30; |
3406acde | 67 | /** @var int Activity node type, e.g. Forum, Quiz 40 */ |
7d2a0492 | 68 | const TYPE_ACTIVITY = 40; |
3406acde | 69 | /** @var int Resource node type, e.g. Link to a file, or label 50 */ |
7d2a0492 | 70 | const TYPE_RESOURCE = 50; |
3406acde | 71 | /** @var int A custom node type, default when adding without specifing type 60 */ |
7d2a0492 | 72 | const TYPE_CUSTOM = 60; |
3406acde | 73 | /** @var int Setting node type, used only within settings nav 70 */ |
7d2a0492 | 74 | const TYPE_SETTING = 70; |
3406acde | 75 | /** @var int Setting node type, used only within settings nav 80 */ |
507a7a9a | 76 | const TYPE_USER = 80; |
3406acde SH |
77 | /** @var int Setting node type, used for containers of no importance 90 */ |
78 | const TYPE_CONTAINER = 90; | |
7d2a0492 | 79 | |
80 | /** @var int Parameter to aid the coder in tracking [optional] */ | |
81 | public $id = null; | |
82 | /** @var string|int The identifier for the node, used to retrieve the node */ | |
83 | public $key = null; | |
84 | /** @var string The text to use for the node */ | |
85 | public $text = null; | |
86 | /** @var string Short text to use if requested [optional] */ | |
87 | public $shorttext = null; | |
88 | /** @var string The title attribute for an action if one is defined */ | |
89 | public $title = null; | |
90 | /** @var string A string that can be used to build a help button */ | |
91 | public $helpbutton = null; | |
3406acde | 92 | /** @var moodle_url|action_link|null An action for the node (link) */ |
7d2a0492 | 93 | public $action = null; |
f9fc1461 | 94 | /** @var pix_icon The path to an icon to use for this node */ |
7d2a0492 | 95 | public $icon = null; |
96 | /** @var int See TYPE_* constants defined for this class */ | |
97 | public $type = self::TYPE_UNKNOWN; | |
98 | /** @var int See NODETYPE_* constants defined for this class */ | |
99 | public $nodetype = self::NODETYPE_LEAF; | |
100 | /** @var bool If set to true the node will be collapsed by default */ | |
101 | public $collapse = false; | |
102 | /** @var bool If set to true the node will be expanded by default */ | |
103 | public $forceopen = false; | |
3406acde | 104 | /** @var array An array of CSS classes for the node */ |
7d2a0492 | 105 | public $classes = array(); |
3406acde | 106 | /** @var navigation_node_collection An array of child nodes */ |
7d2a0492 | 107 | public $children = array(); |
108 | /** @var bool If set to true the node will be recognised as active */ | |
109 | public $isactive = false; | |
3406acde | 110 | /** @var bool If set to true the node will be dimmed */ |
7d2a0492 | 111 | public $hidden = false; |
112 | /** @var bool If set to false the node will not be displayed */ | |
113 | public $display = true; | |
114 | /** @var bool If set to true then an HR will be printed before the node */ | |
115 | public $preceedwithhr = false; | |
116 | /** @var bool If set to true the the navigation bar should ignore this node */ | |
117 | public $mainnavonly = false; | |
118 | /** @var bool If set to true a title will be added to the action no matter what */ | |
119 | public $forcetitle = false; | |
3406acde SH |
120 | /** @var navigation_node A reference to the node parent */ |
121 | public $parent = null; | |
493a48f3 SH |
122 | /** @var bool Override to not display the icon even if one is provided **/ |
123 | public $hideicon = false; | |
7d2a0492 | 124 | /** @var array */ |
b14ae498 | 125 | protected $namedtypes = array(0=>'system',10=>'category',20=>'course',30=>'structure',40=>'activity',50=>'resource',60=>'custom',70=>'setting', 80=>'user'); |
7d2a0492 | 126 | /** @var moodle_url */ |
127 | protected static $fullmeurl = null; | |
d9d2817a SH |
128 | /** @var bool toogles auto matching of active node */ |
129 | public static $autofindactive = true; | |
7d2a0492 | 130 | |
131 | /** | |
3406acde | 132 | * Constructs a new navigation_node |
7d2a0492 | 133 | * |
3406acde SH |
134 | * @param array|string $properties Either an array of properties or a string to use |
135 | * as the text for the node | |
7d2a0492 | 136 | */ |
137 | public function __construct($properties) { | |
7d2a0492 | 138 | if (is_array($properties)) { |
3406acde SH |
139 | // Check the array for each property that we allow to set at construction. |
140 | // text - The main content for the node | |
141 | // shorttext - A short text if required for the node | |
142 | // icon - The icon to display for the node | |
143 | // type - The type of the node | |
144 | // key - The key to use to identify the node | |
145 | // parent - A reference to the nodes parent | |
146 | // action - The action to attribute to this node, usually a URL to link to | |
7d2a0492 | 147 | if (array_key_exists('text', $properties)) { |
148 | $this->text = $properties['text']; | |
149 | } | |
150 | if (array_key_exists('shorttext', $properties)) { | |
151 | $this->shorttext = $properties['shorttext']; | |
152 | } | |
7081714d SH |
153 | if (!array_key_exists('icon', $properties)) { |
154 | $properties['icon'] = new pix_icon('i/navigationitem', 'moodle'); | |
155 | } | |
156 | $this->icon = $properties['icon']; | |
157 | if ($this->icon instanceof pix_icon) { | |
158 | if (empty($this->icon->attributes['class'])) { | |
159 | $this->icon->attributes['class'] = 'navicon'; | |
160 | } else { | |
161 | $this->icon->attributes['class'] .= ' navicon'; | |
7da3a799 | 162 | } |
7d2a0492 | 163 | } |
164 | if (array_key_exists('type', $properties)) { | |
165 | $this->type = $properties['type']; | |
166 | } else { | |
167 | $this->type = self::TYPE_CUSTOM; | |
168 | } | |
169 | if (array_key_exists('key', $properties)) { | |
170 | $this->key = $properties['key']; | |
171 | } | |
3406acde SH |
172 | if (array_key_exists('parent', $properties)) { |
173 | $this->parent = $properties['parent']; | |
174 | } | |
175 | // This needs to happen last because of the check_if_active call that occurs | |
176 | if (array_key_exists('action', $properties)) { | |
177 | $this->action = $properties['action']; | |
178 | if (is_string($this->action)) { | |
179 | $this->action = new moodle_url($this->action); | |
180 | } | |
181 | if (self::$autofindactive) { | |
182 | $this->check_if_active(); | |
183 | } | |
184 | } | |
7d2a0492 | 185 | } else if (is_string($properties)) { |
186 | $this->text = $properties; | |
187 | } | |
188 | if ($this->text === null) { | |
189 | throw new coding_exception('You must set the text for the node when you create it.'); | |
190 | } | |
3406acde | 191 | // Default the title to the text |
7d2a0492 | 192 | $this->title = $this->text; |
3406acde SH |
193 | // Instantiate a new navigation node collection for this nodes children |
194 | $this->children = new navigation_node_collection(); | |
7d2a0492 | 195 | } |
196 | ||
95b97515 | 197 | /** |
3406acde | 198 | * Checks if this node is the active node. |
0baa5d46 | 199 | * |
3406acde SH |
200 | * This is determined by comparing the action for the node against the |
201 | * defined URL for the page. A match will see this node marked as active. | |
0baa5d46 | 202 | * |
3406acde SH |
203 | * @param int $strength One of URL_MATCH_EXACT, URL_MATCH_PARAMS, or URL_MATCH_BASE |
204 | * @return bool | |
7d2a0492 | 205 | */ |
bf6c37c7 | 206 | public function check_if_active($strength=URL_MATCH_EXACT) { |
207 | global $FULLME, $PAGE; | |
3406acde | 208 | // Set fullmeurl if it hasn't already been set |
7d2a0492 | 209 | if (self::$fullmeurl == null) { |
bf6c37c7 | 210 | if ($PAGE->has_set_url()) { |
3406acde | 211 | self::override_active_url(new moodle_url($PAGE->url)); |
bf6c37c7 | 212 | } else { |
3406acde | 213 | self::override_active_url(new moodle_url($FULLME)); |
7d2a0492 | 214 | } |
215 | } | |
bf6c37c7 | 216 | |
3406acde | 217 | // Compare the action of this node against the fullmeurl |
bf6c37c7 | 218 | if ($this->action instanceof moodle_url && $this->action->compare(self::$fullmeurl, $strength)) { |
7d2a0492 | 219 | $this->make_active(); |
220 | return true; | |
7d2a0492 | 221 | } |
222 | return false; | |
223 | } | |
3406acde | 224 | |
7d2a0492 | 225 | /** |
d0cfbab3 SH |
226 | * This sets the URL that the URL of new nodes get compared to when locating |
227 | * the active node. | |
228 | * | |
229 | * The active node is the node that matches the URL set here. By default this | |
230 | * is either $PAGE->url or if that hasn't been set $FULLME. | |
7d2a0492 | 231 | * |
3406acde SH |
232 | * @param moodle_url $url The url to use for the fullmeurl. |
233 | */ | |
234 | public static function override_active_url(moodle_url $url) { | |
633c0843 TH |
235 | // Clone the URL, in case the calling script changes their URL later. |
236 | self::$fullmeurl = new moodle_url($url); | |
3406acde SH |
237 | } |
238 | ||
239 | /** | |
240 | * Adds a navigation node as a child of this node. | |
435a512e | 241 | * |
3406acde SH |
242 | * @param string $text |
243 | * @param moodle_url|action_link $action | |
244 | * @param int $type | |
245 | * @param string $shorttext | |
246 | * @param string|int $key | |
247 | * @param pix_icon $icon | |
248 | * @return navigation_node | |
7d2a0492 | 249 | */ |
3406acde SH |
250 | public function add($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, pix_icon $icon=null) { |
251 | // First convert the nodetype for this node to a branch as it will now have children | |
7d2a0492 | 252 | if ($this->nodetype !== self::NODETYPE_BRANCH) { |
253 | $this->nodetype = self::NODETYPE_BRANCH; | |
254 | } | |
3406acde SH |
255 | // Properties array used when creating the new navigation node |
256 | $itemarray = array( | |
257 | 'text' => $text, | |
258 | 'type' => $type | |
259 | ); | |
260 | // Set the action if one was provided | |
7d2a0492 | 261 | if ($action!==null) { |
262 | $itemarray['action'] = $action; | |
263 | } | |
3406acde | 264 | // Set the shorttext if one was provided |
7d2a0492 | 265 | if ($shorttext!==null) { |
266 | $itemarray['shorttext'] = $shorttext; | |
267 | } | |
3406acde | 268 | // Set the icon if one was provided |
7d2a0492 | 269 | if ($icon!==null) { |
270 | $itemarray['icon'] = $icon; | |
271 | } | |
3406acde SH |
272 | // Default the key to the number of children if not provided |
273 | if ($key === null) { | |
274 | $key = $this->children->count(); | |
7d2a0492 | 275 | } |
3406acde | 276 | // Set the key |
7d2a0492 | 277 | $itemarray['key'] = $key; |
3406acde SH |
278 | // Set the parent to this node |
279 | $itemarray['parent'] = $this; | |
280 | // Add the child using the navigation_node_collections add method | |
281 | $node = $this->children->add(new navigation_node($itemarray)); | |
282 | // If the node is a category node or the user is logged in and its a course | |
283 | // then mark this node as a branch (makes it expandable by AJAX) | |
c73e37e0 | 284 | if (($type==self::TYPE_CATEGORY) || (isloggedin() && $type==self::TYPE_COURSE)) { |
3406acde | 285 | $node->nodetype = self::NODETYPE_BRANCH; |
7d2a0492 | 286 | } |
3406acde | 287 | // If this node is hidden mark it's children as hidden also |
7d2a0492 | 288 | if ($this->hidden) { |
3406acde | 289 | $node->hidden = true; |
7d2a0492 | 290 | } |
3406acde SH |
291 | // Return the node (reference returned by $this->children->add() |
292 | return $node; | |
7d2a0492 | 293 | } |
294 | ||
295 | /** | |
3406acde | 296 | * Searches for a node of the given type with the given key. |
7d2a0492 | 297 | * |
3406acde SH |
298 | * This searches this node plus all of its children, and their children.... |
299 | * If you know the node you are looking for is a child of this node then please | |
300 | * use the get method instead. | |
301 | * | |
302 | * @param int|string $key The key of the node we are looking for | |
303 | * @param int $type One of navigation_node::TYPE_* | |
304 | * @return navigation_node|false | |
7d2a0492 | 305 | */ |
3406acde SH |
306 | public function find($key, $type) { |
307 | return $this->children->find($key, $type); | |
308 | } | |
309 | ||
310 | /** | |
311 | * Get ths child of this node that has the given key + (optional) type. | |
312 | * | |
313 | * If you are looking for a node and want to search all children + thier children | |
314 | * then please use the find method instead. | |
315 | * | |
316 | * @param int|string $key The key of the node we are looking for | |
317 | * @param int $type One of navigation_node::TYPE_* | |
318 | * @return navigation_node|false | |
319 | */ | |
320 | public function get($key, $type=null) { | |
321 | return $this->children->get($key, $type); | |
322 | } | |
323 | ||
324 | /** | |
325 | * Removes this node. | |
326 | * | |
327 | * @return bool | |
328 | */ | |
329 | public function remove() { | |
330 | return $this->parent->children->remove($this->key, $this->type); | |
331 | } | |
332 | ||
333 | /** | |
334 | * Checks if this node has or could have any children | |
335 | * | |
336 | * @return bool Returns true if it has children or could have (by AJAX expansion) | |
337 | */ | |
338 | public function has_children() { | |
339 | return ($this->nodetype === navigation_node::NODETYPE_BRANCH || $this->children->count()>0); | |
340 | } | |
341 | ||
342 | /** | |
343 | * Marks this node as active and forces it open. | |
d0cfbab3 SH |
344 | * |
345 | * Important: If you are here because you need to mark a node active to get | |
346 | * the navigation to do what you want have you looked at {@see navigation_node::override_active_url()}? | |
347 | * You can use it to specify a different URL to match the active navigation node on | |
348 | * rather than having to locate and manually mark a node active. | |
3406acde SH |
349 | */ |
350 | public function make_active() { | |
351 | $this->isactive = true; | |
352 | $this->add_class('active_tree_node'); | |
353 | $this->force_open(); | |
354 | if ($this->parent !== null) { | |
355 | $this->parent->make_inactive(); | |
356 | } | |
357 | } | |
358 | ||
359 | /** | |
360 | * Marks a node as inactive and recusised back to the base of the tree | |
361 | * doing the same to all parents. | |
362 | */ | |
363 | public function make_inactive() { | |
364 | $this->isactive = false; | |
365 | $this->remove_class('active_tree_node'); | |
366 | if ($this->parent !== null) { | |
367 | $this->parent->make_inactive(); | |
7d2a0492 | 368 | } |
369 | } | |
370 | ||
371 | /** | |
3406acde SH |
372 | * Forces this node to be open and at the same time forces open all |
373 | * parents until the root node. | |
117bd748 | 374 | * |
3406acde SH |
375 | * Recursive. |
376 | */ | |
377 | public function force_open() { | |
378 | $this->forceopen = true; | |
379 | if ($this->parent !== null) { | |
380 | $this->parent->force_open(); | |
381 | } | |
382 | } | |
383 | ||
384 | /** | |
385 | * Adds a CSS class to this node. | |
386 | * | |
387 | * @param string $class | |
388 | * @return bool | |
7d2a0492 | 389 | */ |
390 | public function add_class($class) { | |
391 | if (!in_array($class, $this->classes)) { | |
392 | $this->classes[] = $class; | |
393 | } | |
394 | return true; | |
395 | } | |
396 | ||
397 | /** | |
3406acde | 398 | * Removes a CSS class from this node. |
7d2a0492 | 399 | * |
400 | * @param string $class | |
3406acde | 401 | * @return bool True if the class was successfully removed. |
7d2a0492 | 402 | */ |
403 | public function remove_class($class) { | |
404 | if (in_array($class, $this->classes)) { | |
405 | $key = array_search($class,$this->classes); | |
406 | if ($key!==false) { | |
407 | unset($this->classes[$key]); | |
408 | return true; | |
409 | } | |
410 | } | |
411 | return false; | |
412 | } | |
413 | ||
414 | /** | |
3406acde SH |
415 | * Sets the title for this node and forces Moodle to utilise it. |
416 | * @param string $title | |
417 | */ | |
418 | public function title($title) { | |
419 | $this->title = $title; | |
420 | $this->forcetitle = true; | |
421 | } | |
422 | ||
423 | /** | |
424 | * Resets the page specific information on this node if it is being unserialised. | |
425 | */ | |
426 | public function __wakeup(){ | |
427 | $this->forceopen = false; | |
428 | $this->isactive = false; | |
429 | $this->remove_class('active_tree_node'); | |
430 | } | |
431 | ||
432 | /** | |
433 | * Checks if this node or any of its children contain the active node. | |
435a512e | 434 | * |
3406acde | 435 | * Recursive. |
7d2a0492 | 436 | * |
3406acde | 437 | * @return bool |
7d2a0492 | 438 | */ |
3406acde SH |
439 | public function contains_active_node() { |
440 | if ($this->isactive) { | |
7d2a0492 | 441 | return true; |
442 | } else { | |
3406acde SH |
443 | foreach ($this->children as $child) { |
444 | if ($child->isactive || $child->contains_active_node()) { | |
445 | return true; | |
446 | } | |
447 | } | |
7d2a0492 | 448 | } |
3406acde | 449 | return false; |
7d2a0492 | 450 | } |
451 | ||
452 | /** | |
3406acde SH |
453 | * Finds the active node. |
454 | * | |
455 | * Searches this nodes children plus all of the children for the active node | |
456 | * and returns it if found. | |
7d2a0492 | 457 | * |
3406acde SH |
458 | * Recursive. |
459 | * | |
460 | * @return navigation_node|false | |
7d2a0492 | 461 | */ |
3406acde SH |
462 | public function find_active_node() { |
463 | if ($this->isactive) { | |
464 | return $this; | |
465 | } else { | |
7d2a0492 | 466 | foreach ($this->children as &$child) { |
3406acde SH |
467 | $outcome = $child->find_active_node(); |
468 | if ($outcome !== false) { | |
469 | return $outcome; | |
7d2a0492 | 470 | } |
471 | } | |
7d2a0492 | 472 | } |
3406acde | 473 | return false; |
7d2a0492 | 474 | } |
475 | ||
7c4efe3b SH |
476 | /** |
477 | * Searches all children for the best matching active node | |
478 | * @return navigation_node|false | |
479 | */ | |
480 | public function search_for_active_node() { | |
481 | if ($this->check_if_active(URL_MATCH_BASE)) { | |
482 | return $this; | |
483 | } else { | |
484 | foreach ($this->children as &$child) { | |
485 | $outcome = $child->search_for_active_node(); | |
486 | if ($outcome !== false) { | |
487 | return $outcome; | |
488 | } | |
489 | } | |
490 | } | |
491 | return false; | |
492 | } | |
493 | ||
7d2a0492 | 494 | /** |
3406acde | 495 | * Gets the content for this node. |
7d2a0492 | 496 | * |
3406acde SH |
497 | * @param bool $shorttext If true shorttext is used rather than the normal text |
498 | * @return string | |
7d2a0492 | 499 | */ |
3406acde | 500 | public function get_content($shorttext=false) { |
7d2a0492 | 501 | if ($shorttext && $this->shorttext!==null) { |
3406acde | 502 | return format_string($this->shorttext); |
7d2a0492 | 503 | } else { |
3406acde | 504 | return format_string($this->text); |
1c4eef57 | 505 | } |
3406acde | 506 | } |
1c4eef57 | 507 | |
3406acde SH |
508 | /** |
509 | * Gets the title to use for this node. | |
435a512e | 510 | * |
3406acde SH |
511 | * @return string |
512 | */ | |
513 | public function get_title() { | |
bbfa9be0 | 514 | if ($this->forcetitle || $this->action != null){ |
3406acde SH |
515 | return $this->title; |
516 | } else { | |
9bf16314 PS |
517 | return ''; |
518 | } | |
7d2a0492 | 519 | } |
117bd748 | 520 | |
7d2a0492 | 521 | /** |
3406acde | 522 | * Gets the CSS class to add to this node to describe its type |
435a512e | 523 | * |
7d2a0492 | 524 | * @return string |
525 | */ | |
526 | public function get_css_type() { | |
527 | if (array_key_exists($this->type, $this->namedtypes)) { | |
528 | return 'type_'.$this->namedtypes[$this->type]; | |
529 | } | |
530 | return 'type_unknown'; | |
531 | } | |
532 | ||
533 | /** | |
3406acde | 534 | * Finds all nodes that are expandable by AJAX |
7d2a0492 | 535 | * |
3406acde | 536 | * @param array $expandable An array by reference to populate with expandable nodes. |
7d2a0492 | 537 | */ |
3406acde | 538 | public function find_expandable(array &$expandable) { |
3406acde | 539 | foreach ($this->children as &$child) { |
8ad24c1a | 540 | if ($child->nodetype == self::NODETYPE_BRANCH && $child->children->count() == 0 && $child->display) { |
3406acde SH |
541 | $child->id = 'expandable_branch_'.(count($expandable)+1); |
542 | $this->add_class('canexpand'); | |
8ad24c1a | 543 | $expandable[] = array('id' => $child->id, 'key' => $child->key, 'type' => $child->type); |
7d2a0492 | 544 | } |
3406acde | 545 | $child->find_expandable($expandable); |
7d2a0492 | 546 | } |
7d2a0492 | 547 | } |
88f77c3c | 548 | |
4766a50c SH |
549 | /** |
550 | * Finds all nodes of a given type (recursive) | |
551 | * | |
552 | * @param int $type On of navigation_node::TYPE_* | |
553 | * @return array | |
554 | */ | |
88f77c3c SH |
555 | public function find_all_of_type($type) { |
556 | $nodes = $this->children->type($type); | |
557 | foreach ($this->children as &$node) { | |
558 | $childnodes = $node->find_all_of_type($type); | |
559 | $nodes = array_merge($nodes, $childnodes); | |
560 | } | |
561 | return $nodes; | |
562 | } | |
56ed242b SH |
563 | |
564 | /** | |
565 | * Removes this node if it is empty | |
566 | */ | |
567 | public function trim_if_empty() { | |
568 | if ($this->children->count() == 0) { | |
569 | $this->remove(); | |
570 | } | |
571 | } | |
572 | ||
573 | /** | |
574 | * Creates a tab representation of this nodes children that can be used | |
575 | * with print_tabs to produce the tabs on a page. | |
576 | * | |
577 | * call_user_func_array('print_tabs', $node->get_tabs_array()); | |
578 | * | |
579 | * @param array $inactive | |
580 | * @param bool $return | |
581 | * @return array Array (tabs, selected, inactive, activated, return) | |
582 | */ | |
583 | public function get_tabs_array(array $inactive=array(), $return=false) { | |
584 | $tabs = array(); | |
585 | $rows = array(); | |
586 | $selected = null; | |
587 | $activated = array(); | |
588 | foreach ($this->children as $node) { | |
589 | $tabs[] = new tabobject($node->key, $node->action, $node->get_content(), $node->get_title()); | |
590 | if ($node->contains_active_node()) { | |
591 | if ($node->children->count() > 0) { | |
592 | $activated[] = $node->key; | |
593 | foreach ($node->children as $child) { | |
594 | if ($child->contains_active_node()) { | |
595 | $selected = $child->key; | |
596 | } | |
597 | $rows[] = new tabobject($child->key, $child->action, $child->get_content(), $child->get_title()); | |
598 | } | |
599 | } else { | |
600 | $selected = $node->key; | |
601 | } | |
602 | } | |
603 | } | |
604 | return array(array($tabs, $rows), $selected, $inactive, $activated, $return); | |
605 | } | |
3406acde | 606 | } |
7d2a0492 | 607 | |
3406acde SH |
608 | /** |
609 | * Navigation node collection | |
610 | * | |
611 | * This class is responsible for managing a collection of navigation nodes. | |
612 | * It is required because a node's unique identifier is a combination of both its | |
613 | * key and its type. | |
614 | * | |
615 | * Originally an array was used with a string key that was a combination of the two | |
616 | * however it was decided that a better solution would be to use a class that | |
617 | * implements the standard IteratorAggregate interface. | |
618 | * | |
619 | * @package moodlecore | |
620 | * @subpackage navigation | |
621 | * @copyright 2010 Sam Hemelryk | |
622 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
623 | */ | |
624 | class navigation_node_collection implements IteratorAggregate { | |
7d2a0492 | 625 | /** |
3406acde SH |
626 | * A multidimensional array to where the first key is the type and the second |
627 | * key is the nodes key. | |
628 | * @var array | |
7d2a0492 | 629 | */ |
3406acde | 630 | protected $collection = array(); |
7d2a0492 | 631 | /** |
3406acde SH |
632 | * An array that contains references to nodes in the same order they were added. |
633 | * This is maintained as a progressive array. | |
634 | * @var array | |
7d2a0492 | 635 | */ |
3406acde | 636 | protected $orderedcollection = array(); |
da3ab9c4 | 637 | /** |
3406acde SH |
638 | * A reference to the last node that was added to the collection |
639 | * @var navigation_node | |
da3ab9c4 | 640 | */ |
3406acde | 641 | protected $last = null; |
6644741d | 642 | /** |
3406acde SH |
643 | * The total number of items added to this array. |
644 | * @var int | |
6644741d | 645 | */ |
3406acde | 646 | protected $count = 0; |
7d2a0492 | 647 | /** |
3406acde | 648 | * Adds a navigation node to the collection |
7d2a0492 | 649 | * |
3406acde SH |
650 | * @param navigation_node $node |
651 | * @return navigation_node | |
7d2a0492 | 652 | */ |
3406acde SH |
653 | public function add(navigation_node $node) { |
654 | global $CFG; | |
655 | $key = $node->key; | |
656 | $type = $node->type; | |
657 | // First check we have a 2nd dimension for this type | |
658 | if (!array_key_exists($type, $this->orderedcollection)) { | |
659 | $this->orderedcollection[$type] = array(); | |
7d2a0492 | 660 | } |
3406acde SH |
661 | // Check for a collision and report if debugging is turned on |
662 | if ($CFG->debug && array_key_exists($key, $this->orderedcollection[$type])) { | |
663 | debugging('Navigation node intersect: Adding a node that already exists '.$key, DEBUG_DEVELOPER); | |
7d2a0492 | 664 | } |
3406acde SH |
665 | // Add the node to the appropriate place in the ordered structure. |
666 | $this->orderedcollection[$type][$key] = $node; | |
667 | // Add a reference to the node to the progressive collection. | |
668 | $this->collection[$this->count] = &$this->orderedcollection[$type][$key]; | |
669 | // Update the last property to a reference to this new node. | |
670 | $this->last = &$this->orderedcollection[$type][$key]; | |
671 | $this->count++; | |
672 | // Return the reference to the now added node | |
673 | return $this->last; | |
7d2a0492 | 674 | } |
675 | ||
676 | /** | |
3406acde | 677 | * Fetches a node from this collection. |
7d2a0492 | 678 | * |
3406acde SH |
679 | * @param string|int $key The key of the node we want to find. |
680 | * @param int $type One of navigation_node::TYPE_*. | |
681 | * @return navigation_node|null | |
7d2a0492 | 682 | */ |
3406acde SH |
683 | public function get($key, $type=null) { |
684 | if ($type !== null) { | |
685 | // If the type is known then we can simply check and fetch | |
686 | if (!empty($this->orderedcollection[$type][$key])) { | |
687 | return $this->orderedcollection[$type][$key]; | |
688 | } | |
689 | } else { | |
690 | // Because we don't know the type we look in the progressive array | |
691 | foreach ($this->collection as $node) { | |
692 | if ($node->key === $key) { | |
693 | return $node; | |
7d2a0492 | 694 | } |
695 | } | |
696 | } | |
697 | return false; | |
698 | } | |
7d2a0492 | 699 | /** |
3406acde | 700 | * Searches for a node with matching key and type. |
7d2a0492 | 701 | * |
3406acde SH |
702 | * This function searches both the nodes in this collection and all of |
703 | * the nodes in each collection belonging to the nodes in this collection. | |
7d2a0492 | 704 | * |
3406acde | 705 | * Recursive. |
7d2a0492 | 706 | * |
3406acde SH |
707 | * @param string|int $key The key of the node we want to find. |
708 | * @param int $type One of navigation_node::TYPE_*. | |
709 | * @return navigation_node|null | |
7d2a0492 | 710 | */ |
3406acde SH |
711 | public function find($key, $type=null) { |
712 | if ($type !== null && array_key_exists($type, $this->orderedcollection) && array_key_exists($key, $this->orderedcollection[$type])) { | |
713 | return $this->orderedcollection[$type][$key]; | |
714 | } else { | |
715 | $nodes = $this->getIterator(); | |
716 | // Search immediate children first | |
717 | foreach ($nodes as &$node) { | |
d9219fc9 | 718 | if ($node->key === $key && ($type === null || $type === $node->type)) { |
3406acde | 719 | return $node; |
d926f4b1 | 720 | } |
3406acde SH |
721 | } |
722 | // Now search each childs children | |
723 | foreach ($nodes as &$node) { | |
724 | $result = $node->children->find($key, $type); | |
725 | if ($result !== false) { | |
726 | return $result; | |
d926f4b1 | 727 | } |
7d2a0492 | 728 | } |
729 | } | |
730 | return false; | |
731 | } | |
732 | ||
d926f4b1 | 733 | /** |
3406acde | 734 | * Fetches the last node that was added to this collection |
435a512e | 735 | * |
3406acde | 736 | * @return navigation_node |
d926f4b1 | 737 | */ |
3406acde SH |
738 | public function last() { |
739 | return $this->last; | |
740 | } | |
741 | /** | |
742 | * Fetches all nodes of a given type from this collection | |
743 | */ | |
744 | public function type($type) { | |
745 | if (!array_key_exists($type, $this->orderedcollection)) { | |
746 | $this->orderedcollection[$type] = array(); | |
d926f4b1 | 747 | } |
3406acde | 748 | return $this->orderedcollection[$type]; |
d926f4b1 | 749 | } |
7d2a0492 | 750 | /** |
3406acde | 751 | * Removes the node with the given key and type from the collection |
7d2a0492 | 752 | * |
3406acde SH |
753 | * @param string|int $key |
754 | * @param int $type | |
755 | * @return bool | |
7d2a0492 | 756 | */ |
3406acde SH |
757 | public function remove($key, $type=null) { |
758 | $child = $this->get($key, $type); | |
759 | if ($child !== false) { | |
760 | foreach ($this->collection as $colkey => $node) { | |
761 | if ($node->key == $key && $node->type == $type) { | |
762 | unset($this->collection[$colkey]); | |
763 | break; | |
764 | } | |
7d2a0492 | 765 | } |
3406acde SH |
766 | unset($this->orderedcollection[$child->type][$child->key]); |
767 | $this->count--; | |
768 | return true; | |
7d2a0492 | 769 | } |
3406acde | 770 | return false; |
7d2a0492 | 771 | } |
772 | ||
9da1ec27 | 773 | /** |
3406acde SH |
774 | * Gets the number of nodes in this collection |
775 | * @return int | |
7d2a0492 | 776 | */ |
3406acde SH |
777 | public function count() { |
778 | return count($this->collection); | |
7d2a0492 | 779 | } |
7d2a0492 | 780 | /** |
3406acde | 781 | * Gets an array iterator for the collection. |
7d2a0492 | 782 | * |
3406acde SH |
783 | * This is required by the IteratorAggregator interface and is used by routines |
784 | * such as the foreach loop. | |
7d2a0492 | 785 | * |
3406acde | 786 | * @return ArrayIterator |
7d2a0492 | 787 | */ |
3406acde SH |
788 | public function getIterator() { |
789 | return new ArrayIterator($this->collection); | |
7d2a0492 | 790 | } |
791 | } | |
792 | ||
793 | /** | |
794 | * The global navigation class used for... the global navigation | |
795 | * | |
796 | * This class is used by PAGE to store the global navigation for the site | |
797 | * and is then used by the settings nav and navbar to save on processing and DB calls | |
798 | * | |
799 | * See | |
800 | * <ul> | |
801 | * <li><b>{@link lib/pagelib.php}</b> {@link moodle_page::initialise_theme_and_output()}<li> | |
802 | * <li><b>{@link lib/ajax/getnavbranch.php}</b> Called by ajax<li> | |
803 | * </ul> | |
804 | * | |
805 | * @package moodlecore | |
babb3911 | 806 | * @subpackage navigation |
7d2a0492 | 807 | * @copyright 2009 Sam Hemelryk |
808 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
809 | */ | |
810 | class global_navigation extends navigation_node { | |
3406acde SH |
811 | /** |
812 | * The Moodle page this navigation object belongs to. | |
813 | * @var moodle_page | |
814 | */ | |
815 | protected $page; | |
7d2a0492 | 816 | /** @var bool */ |
817 | protected $initialised = false; | |
3406acde SH |
818 | /** @var array */ |
819 | protected $mycourses = array(); | |
820 | /** @var array */ | |
821 | protected $rootnodes = array(); | |
7d2a0492 | 822 | /** @var bool */ |
3406acde SH |
823 | protected $showemptysections = false; |
824 | /** @var array */ | |
7a7e209d | 825 | protected $extendforuser = array(); |
3406acde SH |
826 | /** @var navigation_cache */ |
827 | protected $cache; | |
828 | /** @var array */ | |
829 | protected $addedcourses = array(); | |
88f77c3c SH |
830 | /** @var int */ |
831 | protected $expansionlimit = 0; | |
832 | ||
7d2a0492 | 833 | /** |
3406acde SH |
834 | * Constructs a new global navigation |
835 | * | |
3406acde | 836 | * @param moodle_page $page The page this navigation object belongs to |
7d2a0492 | 837 | */ |
3406acde | 838 | public function __construct(moodle_page $page) { |
4766a50c | 839 | global $CFG, $SITE, $USER; |
3406acde | 840 | |
7d2a0492 | 841 | if (during_initial_install()) { |
3406acde | 842 | return; |
7d2a0492 | 843 | } |
3406acde | 844 | |
4766a50c SH |
845 | if (get_home_page() == HOMEPAGE_SITE) { |
846 | // We are using the site home for the root element | |
847 | $properties = array( | |
848 | 'key' => 'home', | |
849 | 'type' => navigation_node::TYPE_SYSTEM, | |
850 | 'text' => get_string('home'), | |
851 | 'action' => new moodle_url('/') | |
852 | ); | |
853 | } else { | |
854 | // We are using the users my moodle for the root element | |
855 | $properties = array( | |
856 | 'key' => 'myhome', | |
857 | 'type' => navigation_node::TYPE_SYSTEM, | |
858 | 'text' => get_string('myhome'), | |
859 | 'action' => new moodle_url('/my/') | |
860 | ); | |
dd8e5011 | 861 | } |
4766a50c SH |
862 | |
863 | // Use the parents consturctor.... good good reuse | |
3406acde SH |
864 | parent::__construct($properties); |
865 | ||
866 | // Initalise and set defaults | |
867 | $this->page = $page; | |
7d2a0492 | 868 | $this->forceopen = true; |
f5b5a822 | 869 | $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME); |
3406acde SH |
870 | |
871 | // Check if we need to clear the cache | |
7d2a0492 | 872 | $regenerate = optional_param('regenerate', null, PARAM_TEXT); |
3406acde | 873 | if ($regenerate === 'navigation') { |
7d2a0492 | 874 | $this->cache->clear(); |
875 | } | |
876 | } | |
877 | ||
878 | /** | |
3406acde | 879 | * Initialises the navigation object. |
7d2a0492 | 880 | * |
3406acde SH |
881 | * This causes the navigation object to look at the current state of the page |
882 | * that it is associated with and then load the appropriate content. | |
7d2a0492 | 883 | * |
3406acde SH |
884 | * This should only occur the first time that the navigation structure is utilised |
885 | * which will normally be either when the navbar is called to be displayed or | |
886 | * when a block makes use of it. | |
7d2a0492 | 887 | * |
3406acde | 888 | * @return bool |
7d2a0492 | 889 | */ |
3406acde | 890 | public function initialise() { |
4766a50c | 891 | global $CFG, $SITE, $USER, $DB; |
3406acde | 892 | // Check if it has alread been initialised |
7d2a0492 | 893 | if ($this->initialised || during_initial_install()) { |
894 | return true; | |
895 | } | |
e2b436d0 | 896 | $this->initialised = true; |
3406acde SH |
897 | |
898 | // Set up the five base root nodes. These are nodes where we will put our | |
899 | // content and are as follows: | |
900 | // site: Navigation for the front page. | |
901 | // myprofile: User profile information goes here. | |
902 | // mycourses: The users courses get added here. | |
903 | // courses: Additional courses are added here. | |
904 | // users: Other users information loaded here. | |
905 | $this->rootnodes = array(); | |
4766a50c | 906 | if (get_home_page() == HOMEPAGE_SITE) { |
3f9ccf85 | 907 | // The home element should be my moodle because the root element is the site |
b9d4c7d3 | 908 | if (isloggedin() && !isguestuser()) { // Makes no sense if you aren't logged in |
3f9ccf85 MD |
909 | $this->rootnodes['home'] = $this->add(get_string('myhome'), new moodle_url('/my/'), self::TYPE_SETTING, null, 'home'); |
910 | } | |
4766a50c SH |
911 | } else { |
912 | // The home element should be the site because the root node is my moodle | |
913 | $this->rootnodes['home'] = $this->add(get_string('sitehome'), new moodle_url('/'), self::TYPE_SETTING, null, 'home'); | |
914 | if ($CFG->defaulthomepage == HOMEPAGE_MY) { | |
915 | // We need to stop automatic redirection | |
916 | $this->rootnodes['home']->action->param('redirect', '0'); | |
917 | } | |
918 | } | |
3406acde SH |
919 | $this->rootnodes['site'] = $this->add_course($SITE); |
920 | $this->rootnodes['myprofile'] = $this->add(get_string('myprofile'), null, self::TYPE_USER, null, 'myprofile'); | |
921 | $this->rootnodes['mycourses'] = $this->add(get_string('mycourses'), null, self::TYPE_ROOTNODE, null, 'mycourses'); | |
922 | $this->rootnodes['courses'] = $this->add(get_string('courses'), null, self::TYPE_ROOTNODE, null, 'courses'); | |
923 | $this->rootnodes['users'] = $this->add(get_string('users'), null, self::TYPE_ROOTNODE, null, 'users'); | |
924 | ||
925 | // Fetch all of the users courses. | |
4766a50c SH |
926 | $limit = 20; |
927 | if (!empty($CFG->navcourselimit)) { | |
928 | $limit = $CFG->navcourselimit; | |
929 | } | |
930 | ||
9a18a77e SH |
931 | if (!empty($CFG->navshowcategories) && $DB->count_records('course_categories') == 1) { |
932 | // There is only one category so we don't want to show categories | |
933 | $CFG->navshowcategories = false; | |
934 | } | |
935 | ||
df997f84 | 936 | $this->mycourses = enrol_get_my_courses(NULL, 'visible DESC,sortorder ASC', $limit); |
ba2789c1 SH |
937 | $showallcourses = (count($this->mycourses) == 0 || !empty($CFG->navshowallcourses)); |
938 | $showcategories = ($showallcourses && !empty($CFG->navshowcategories)); | |
939 | ||
3406acde SH |
940 | // Check if any courses were returned. |
941 | if (count($this->mycourses) > 0) { | |
942 | // Add all of the users courses to the navigation | |
943 | foreach ($this->mycourses as &$course) { | |
4766a50c | 944 | $course->coursenode = $this->add_course($course); |
3406acde | 945 | } |
4766a50c SH |
946 | } |
947 | ||
4766a50c SH |
948 | if ($showcategories) { |
949 | // Load all categories (ensures we get the base categories) | |
950 | $this->load_all_categories(); | |
ba2789c1 SH |
951 | } else if ($showallcourses) { |
952 | // Load all courses | |
953 | $this->load_all_courses(); | |
3406acde SH |
954 | } |
955 | ||
14d35a26 SH |
956 | // We always load the frontpage course to ensure it is available without |
957 | // JavaScript enabled. | |
958 | $frontpagecourse = $this->load_course($SITE); | |
959 | $this->add_front_page_course_essentials($frontpagecourse, $SITE); | |
960 | ||
cede87e0 SH |
961 | $canviewcourseprofile = true; |
962 | ||
3406acde SH |
963 | // Next load context specific content into the navigation |
964 | switch ($this->page->context->contextlevel) { | |
965 | case CONTEXT_SYSTEM : | |
afc45eb1 SH |
966 | // This has already been loaded we just need to map the variable |
967 | $coursenode = $frontpagecourse; | |
968 | break; | |
3406acde | 969 | case CONTEXT_COURSECAT : |
14d35a26 SH |
970 | // This has already been loaded we just need to map the variable |
971 | $coursenode = $frontpagecourse; | |
afc45eb1 | 972 | $this->load_all_categories($this->page->context->instanceid); |
7d2a0492 | 973 | break; |
3406acde SH |
974 | case CONTEXT_BLOCK : |
975 | case CONTEXT_COURSE : | |
976 | // Load the course associated with the page into the navigation | |
977 | $course = $this->page->course; | |
978 | $coursenode = $this->load_course($course); | |
fab0a39f SH |
979 | |
980 | // If the course wasn't added then don't try going any further. | |
981 | if (!$coursenode) { | |
982 | $canviewcourseprofile = false; | |
983 | break; | |
984 | } | |
985 | ||
cede87e0 SH |
986 | // If the user is not enrolled then we only want to show the |
987 | // course node and not populate it. | |
988 | $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id); | |
f5c1e621 | 989 | // Not enrolled, can't view, and hasn't switched roles |
ed1d72ea SH |
990 | |
991 | if (!can_access_course($coursecontext)) { | |
cede87e0 SH |
992 | $coursenode->make_active(); |
993 | $canviewcourseprofile = false; | |
994 | break; | |
995 | } | |
3406acde SH |
996 | // Add the essentials such as reports etc... |
997 | $this->add_course_essentials($coursenode, $course); | |
998 | if ($this->format_display_course_content($course->format)) { | |
999 | // Load the course sections | |
1000 | $sections = $this->load_course_sections($course, $coursenode); | |
1001 | } | |
7c4efe3b SH |
1002 | if (!$coursenode->contains_active_node() && !$coursenode->search_for_active_node()) { |
1003 | $coursenode->make_active(); | |
1004 | } | |
7d2a0492 | 1005 | break; |
3406acde SH |
1006 | case CONTEXT_MODULE : |
1007 | $course = $this->page->course; | |
1008 | $cm = $this->page->cm; | |
1009 | // Load the course associated with the page into the navigation | |
1010 | $coursenode = $this->load_course($course); | |
cede87e0 SH |
1011 | |
1012 | // If the user is not enrolled then we only want to show the | |
1013 | // course node and not populate it. | |
1014 | $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id); | |
9a424c71 | 1015 | if (!can_access_course($coursecontext)) { |
e0be5f1f SH |
1016 | if ($coursenode) { |
1017 | $coursenode->make_active(); | |
1018 | } | |
cede87e0 SH |
1019 | $canviewcourseprofile = false; |
1020 | break; | |
1021 | } | |
1022 | ||
3406acde SH |
1023 | $this->add_course_essentials($coursenode, $course); |
1024 | // Load the course sections into the page | |
1025 | $sections = $this->load_course_sections($course, $coursenode); | |
44303ca6 | 1026 | if ($course->id != SITEID) { |
3406acde SH |
1027 | // Find the section for the $CM associated with the page and collect |
1028 | // its section number. | |
0d8b6a69 | 1029 | if (isset($cm->sectionnum)) { |
1030 | $cm->sectionnumber = $cm->sectionnum; | |
1031 | } else { | |
1032 | foreach ($sections as $section) { | |
1033 | if ($section->id == $cm->section) { | |
1034 | $cm->sectionnumber = $section->section; | |
1035 | break; | |
1036 | } | |
3406acde SH |
1037 | } |
1038 | } | |
1039 | ||
1040 | // Load all of the section activities for the section the cm belongs to. | |
2a62743c PS |
1041 | if (isset($cm->sectionnumber) and !empty($sections[$cm->sectionnumber])) { |
1042 | $activities = $this->load_section_activities($sections[$cm->sectionnumber]->sectionnode, $cm->sectionnumber, get_fast_modinfo($course)); | |
1043 | } else { | |
1044 | $activities = array(); | |
1045 | if ($activity = $this->load_stealth_activity($coursenode, get_fast_modinfo($course))) { | |
1046 | // "stealth" activity from unavailable section | |
1047 | $activities[$cm->id] = $activity; | |
1048 | } | |
1049 | } | |
3406acde SH |
1050 | } else { |
1051 | $activities = array(); | |
1052 | $activities[$cm->id] = $coursenode->get($cm->id, navigation_node::TYPE_ACTIVITY); | |
1053 | } | |
2a62743c PS |
1054 | if (!empty($activities[$cm->id])) { |
1055 | // Finally load the cm specific navigaton information | |
1056 | $this->load_activity($cm, $course, $activities[$cm->id]); | |
1057 | // Check if we have an active ndoe | |
1058 | if (!$activities[$cm->id]->contains_active_node() && !$activities[$cm->id]->search_for_active_node()) { | |
1059 | // And make the activity node active. | |
1060 | $activities[$cm->id]->make_active(); | |
1061 | } | |
1062 | } else { | |
1063 | //TODO: something is wrong, what to do? (Skodak) | |
7c4efe3b | 1064 | } |
7d2a0492 | 1065 | break; |
3406acde SH |
1066 | case CONTEXT_USER : |
1067 | $course = $this->page->course; | |
1068 | if ($course->id != SITEID) { | |
1069 | // Load the course associated with the user into the navigation | |
1070 | $coursenode = $this->load_course($course); | |
cede87e0 SH |
1071 | // If the user is not enrolled then we only want to show the |
1072 | // course node and not populate it. | |
1073 | $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id); | |
9a424c71 | 1074 | if (!can_access_course($coursecontext)) { |
cede87e0 SH |
1075 | $coursenode->make_active(); |
1076 | $canviewcourseprofile = false; | |
1077 | break; | |
1078 | } | |
3406acde SH |
1079 | $this->add_course_essentials($coursenode, $course); |
1080 | $sections = $this->load_course_sections($course, $coursenode); | |
7a7e209d | 1081 | } |
7d2a0492 | 1082 | break; |
1083 | } | |
7a7e209d | 1084 | |
ba2789c1 SH |
1085 | $limit = 20; |
1086 | if (!empty($CFG->navcourselimit)) { | |
1087 | $limit = $CFG->navcourselimit; | |
1088 | } | |
1089 | if ($showcategories) { | |
1090 | $categories = $this->find_all_of_type(self::TYPE_CATEGORY); | |
1091 | foreach ($categories as &$category) { | |
1092 | if ($category->children->count() >= $limit) { | |
1093 | $url = new moodle_url('/course/category.php', array('id'=>$category->key)); | |
1094 | $category->add(get_string('viewallcourses'), $url, self::TYPE_SETTING); | |
1095 | } | |
1096 | } | |
1097 | } else if ($this->rootnodes['courses']->children->count() >= $limit) { | |
1098 | $this->rootnodes['courses']->add(get_string('viewallcoursescategories'), new moodle_url('/course/index.php'), self::TYPE_SETTING); | |
1099 | } | |
1100 | ||
3406acde SH |
1101 | // Load for the current user |
1102 | $this->load_for_user(); | |
cede87e0 | 1103 | if ($this->page->context->contextlevel >= CONTEXT_COURSE && $this->page->context->instanceid != SITEID && $canviewcourseprofile) { |
87c215de SH |
1104 | $this->load_for_user(null, true); |
1105 | } | |
7a7e209d SH |
1106 | // Load each extending user into the navigation. |
1107 | foreach ($this->extendforuser as $user) { | |
44303ca6 | 1108 | if ($user->id != $USER->id) { |
7a7e209d SH |
1109 | $this->load_for_user($user); |
1110 | } | |
1111 | } | |
7a7e209d | 1112 | |
a683da3c SH |
1113 | // Give the local plugins a chance to include some navigation if they want. |
1114 | foreach (get_list_of_plugins('local') as $plugin) { | |
1115 | if (!file_exists($CFG->dirroot.'/local/'.$plugin.'/lib.php')) { | |
1116 | continue; | |
1117 | } | |
1118 | require_once($CFG->dirroot.'/local/'.$plugin.'/lib.php'); | |
1119 | $function = $plugin.'_extends_navigation'; | |
1120 | if (function_exists($function)) { | |
1121 | $function($this); | |
1122 | } | |
1123 | } | |
1124 | ||
3406acde SH |
1125 | // Remove any empty root nodes |
1126 | foreach ($this->rootnodes as $node) { | |
4766a50c SH |
1127 | // Dont remove the home node |
1128 | if ($node->key !== 'home' && !$node->has_children()) { | |
3406acde SH |
1129 | $node->remove(); |
1130 | } | |
1131 | } | |
1132 | ||
7c4efe3b SH |
1133 | if (!$this->contains_active_node()) { |
1134 | $this->search_for_active_node(); | |
1135 | } | |
1136 | ||
3406acde SH |
1137 | // If the user is not logged in modify the navigation structure as detailed |
1138 | // in {@link http://docs.moodle.org/en/Development:Navigation_2.0_structure} | |
1139 | if (!isloggedin()) { | |
1140 | $activities = clone($this->rootnodes['site']->children); | |
1141 | $this->rootnodes['site']->remove(); | |
1142 | $children = clone($this->children); | |
1143 | $this->children = new navigation_node_collection(); | |
1144 | foreach ($activities as $child) { | |
1145 | $this->children->add($child); | |
1146 | } | |
1147 | foreach ($children as $child) { | |
1148 | $this->children->add($child); | |
1149 | } | |
3406acde | 1150 | } |
7d2a0492 | 1151 | return true; |
1152 | } | |
1153 | /** | |
3406acde SH |
1154 | * Checks the course format to see whether it wants the navigation to load |
1155 | * additional information for the course. | |
1156 | * | |
1157 | * This function utilises a callback that can exist within the course format lib.php file | |
1158 | * The callback should be a function called: | |
1159 | * callback_{formatname}_display_content() | |
1160 | * It doesn't get any arguments and should return true if additional content is | |
1161 | * desired. If the callback doesn't exist we assume additional content is wanted. | |
1162 | * | |
3406acde SH |
1163 | * @param string $format The course format |
1164 | * @return bool | |
1165 | */ | |
1166 | protected function format_display_course_content($format) { | |
1167 | global $CFG; | |
1168 | $formatlib = $CFG->dirroot.'/course/format/'.$format.'/lib.php'; | |
1169 | if (file_exists($formatlib)) { | |
1170 | require_once($formatlib); | |
1171 | $displayfunc = 'callback_'.$format.'_display_content'; | |
1172 | if (function_exists($displayfunc) && !$displayfunc()) { | |
1173 | return $displayfunc(); | |
1174 | } | |
1175 | } | |
1176 | return true; | |
1177 | } | |
1178 | ||
1179 | /** | |
1180 | * Loads of the the courses in Moodle into the navigation. | |
1181 | * | |
4766a50c | 1182 | * @param string|array $categoryids Either a string or array of category ids to load courses for |
3406acde SH |
1183 | * @return array An array of navigation_node |
1184 | */ | |
4766a50c SH |
1185 | protected function load_all_courses($categoryids=null) { |
1186 | global $CFG, $DB, $USER; | |
1187 | ||
1188 | if ($categoryids !== null) { | |
1189 | if (is_array($categoryids)) { | |
1190 | list ($select, $params) = $DB->get_in_or_equal($categoryids); | |
1191 | } else { | |
1192 | $select = '= ?'; | |
1193 | $params = array($categoryids); | |
1194 | } | |
1195 | array_unshift($params, SITEID); | |
1196 | $select = ' AND c.category '.$select; | |
1197 | } else { | |
1198 | $params = array(SITEID); | |
1199 | $select = ''; | |
1200 | } | |
435a512e | 1201 | |
3406acde SH |
1202 | list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx'); |
1203 | $sql = "SELECT c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.category,cat.path AS categorypath $ccselect | |
1204 | FROM {course} c | |
1205 | $ccjoin | |
1206 | LEFT JOIN {course_categories} cat ON cat.id=c.category | |
4766a50c | 1207 | WHERE c.id <> ?$select |
3406acde | 1208 | ORDER BY c.sortorder ASC"; |
4766a50c SH |
1209 | $limit = 20; |
1210 | if (!empty($CFG->navcourselimit)) { | |
1211 | $limit = $CFG->navcourselimit; | |
1212 | } | |
1213 | $courses = $DB->get_records_sql($sql, $params, 0, $limit); | |
1214 | ||
3406acde SH |
1215 | $coursenodes = array(); |
1216 | foreach ($courses as $course) { | |
1217 | context_instance_preload($course); | |
1218 | $coursenodes[$course->id] = $this->add_course($course); | |
1219 | } | |
1220 | return $coursenodes; | |
1221 | } | |
1222 | ||
4766a50c SH |
1223 | /** |
1224 | * Loads all categories (top level or if an id is specified for that category) | |
1225 | * | |
1226 | * @param int $categoryid | |
1227 | * @return void | |
1228 | */ | |
1229 | protected function load_all_categories($categoryid=null) { | |
1230 | global $DB; | |
1231 | if ($categoryid == null) { | |
1232 | $categories = $DB->get_records('course_categories', array('parent'=>'0'), 'sortorder'); | |
1233 | } else { | |
1234 | $category = $DB->get_record('course_categories', array('id'=>$categoryid), '*', MUST_EXIST); | |
1235 | $wantedids = explode('/', trim($category->path, '/')); | |
1236 | list($select, $params) = $DB->get_in_or_equal($wantedids); | |
1237 | $select = 'id '.$select.' OR parent '.$select; | |
1238 | $params = array_merge($params, $params); | |
1239 | $categories = $DB->get_records_select('course_categories', $select, $params, 'sortorder'); | |
1240 | } | |
1241 | $structured = array(); | |
1242 | $categoriestoload = array(); | |
1243 | foreach ($categories as $category) { | |
1244 | if ($category->parent == '0') { | |
1245 | $structured[$category->id] = array('category'=>$category, 'children'=>array()); | |
1246 | } else { | |
1247 | if ($category->parent == $categoryid) { | |
1248 | $categoriestoload[] = $category->id; | |
1249 | } | |
1250 | $parents = array(); | |
1251 | $id = $category->parent; | |
1252 | while ($id != '0') { | |
1253 | $parents[] = $id; | |
1254 | if (!array_key_exists($id, $categories)) { | |
1255 | $categories[$id] = $DB->get_record('course_categories', array('id'=>$id), '*', MUST_EXIST); | |
1256 | } | |
1257 | $id = $categories[$id]->parent; | |
1258 | } | |
1259 | $parents = array_reverse($parents); | |
1260 | $parentref = &$structured[array_shift($parents)]; | |
1261 | foreach ($parents as $parent) { | |
1262 | if (!array_key_exists($parent, $parentref['children'])) { | |
1263 | $parentref['children'][$parent] = array('category'=>$categories[$parent], 'children'=>array()); | |
1264 | } | |
1265 | $parentref = &$parentref['children'][$parent]; | |
1266 | } | |
1267 | if (!array_key_exists($category->id, $parentref['children'])) { | |
1268 | $parentref['children'][$category->id] = array('category'=>$category, 'children'=>array()); | |
1269 | } | |
1270 | } | |
1271 | } | |
1272 | ||
1273 | foreach ($structured as $category) { | |
1274 | $this->add_category($category, $this->rootnodes['courses']); | |
1275 | } | |
1276 | ||
1277 | if ($categoryid !== null && count($wantedids)) { | |
1278 | foreach ($wantedids as $catid) { | |
1279 | $this->load_all_courses($catid); | |
1280 | } | |
1281 | } | |
1282 | } | |
1283 | ||
1284 | /** | |
1285 | * Adds a structured category to the navigation in the correct order/place | |
1286 | * | |
1287 | * @param object $cat | |
435a512e | 1288 | * @param navigation_node $parent |
4766a50c SH |
1289 | */ |
1290 | protected function add_category($cat, navigation_node $parent) { | |
14337688 SH |
1291 | $categorynode = $parent->get($cat['category']->id, navigation_node::TYPE_CATEGORY); |
1292 | if (!$categorynode) { | |
4766a50c SH |
1293 | $category = $cat['category']; |
1294 | $url = new moodle_url('/course/category.php', array('id'=>$category->id)); | |
480f906e | 1295 | $categorynode = $parent->add($category->name, $url, self::TYPE_CATEGORY, $category->name, $category->id); |
14337688 SH |
1296 | if (empty($category->visible)) { |
1297 | if (has_capability('moodle/category:viewhiddencategories', get_system_context())) { | |
1298 | $categorynode->hidden = true; | |
1299 | } else { | |
1300 | $categorynode->display = false; | |
1301 | } | |
1302 | } | |
4766a50c SH |
1303 | } |
1304 | foreach ($cat['children'] as $child) { | |
14337688 | 1305 | $this->add_category($child, $categorynode); |
4766a50c SH |
1306 | } |
1307 | } | |
1308 | ||
3406acde SH |
1309 | /** |
1310 | * Loads the given course into the navigation | |
7d2a0492 | 1311 | * |
3406acde SH |
1312 | * @param stdClass $course |
1313 | * @return navigation_node | |
1314 | */ | |
1315 | protected function load_course(stdClass $course) { | |
1316 | if ($course->id == SITEID) { | |
1317 | $coursenode = $this->rootnodes['site']; | |
1318 | } else if (array_key_exists($course->id, $this->mycourses)) { | |
1319 | if (!isset($this->mycourses[$course->id]->coursenode)) { | |
1320 | $this->mycourses[$course->id]->coursenode = $this->add_course($course); | |
1321 | } | |
1322 | $coursenode = $this->mycourses[$course->id]->coursenode; | |
1323 | } else { | |
1324 | $coursenode = $this->add_course($course); | |
1325 | } | |
1326 | return $coursenode; | |
1327 | } | |
1328 | ||
1329 | /** | |
1330 | * Loads all of the courses section into the navigation. | |
1331 | * | |
1332 | * This function utilisies a callback that can be implemented within the course | |
1333 | * formats lib.php file to customise the navigation that is generated at this | |
1334 | * point for the course. | |
1335 | * | |
1336 | * By default (if not defined) the method {@see load_generic_course_sections} is | |
1337 | * called instead. | |
1338 | * | |
3406acde SH |
1339 | * @param stdClass $course Database record for the course |
1340 | * @param navigation_node $coursenode The course node within the navigation | |
1341 | * @return array Array of navigation nodes for the section with key = section id | |
1342 | */ | |
1343 | protected function load_course_sections(stdClass $course, navigation_node $coursenode) { | |
1344 | global $CFG; | |
1345 | $structurefile = $CFG->dirroot.'/course/format/'.$course->format.'/lib.php'; | |
1346 | $structurefunc = 'callback_'.$course->format.'_load_content'; | |
1347 | if (function_exists($structurefunc)) { | |
1348 | return $structurefunc($this, $course, $coursenode); | |
1349 | } else if (file_exists($structurefile)) { | |
1350 | require_once $structurefile; | |
1351 | if (function_exists($structurefunc)) { | |
1352 | return $structurefunc($this, $course, $coursenode); | |
1353 | } else { | |
0f4ab67d | 1354 | return $this->load_generic_course_sections($course, $coursenode); |
3406acde SH |
1355 | } |
1356 | } else { | |
0f4ab67d | 1357 | return $this->load_generic_course_sections($course, $coursenode); |
3406acde SH |
1358 | } |
1359 | } | |
1360 | ||
1361 | /** | |
1362 | * Generically loads the course sections into the course's navigation. | |
1363 | * | |
1364 | * @param stdClass $course | |
1365 | * @param navigation_node $coursenode | |
1366 | * @param string $name The string that identifies each section. e.g Topic, or Week | |
1367 | * @param string $activeparam The url used to identify the active section | |
1368 | * @return array An array of course section nodes | |
1369 | */ | |
0f4ab67d | 1370 | public function load_generic_course_sections(stdClass $course, navigation_node $coursenode, $courseformat='unknown') { |
df997f84 PS |
1371 | global $CFG, $DB, $USER; |
1372 | ||
1373 | require_once($CFG->dirroot.'/course/lib.php'); | |
435a512e | 1374 | |
abaece1e SH |
1375 | if (!$this->cache->cached('modinfo'.$course->id)) { |
1376 | $this->cache->set('modinfo'.$course->id, get_fast_modinfo($course)); | |
1377 | } | |
1378 | $modinfo = $this->cache->{'modinfo'.$course->id}; | |
1379 | ||
1380 | if (!$this->cache->cached('coursesections'.$course->id)) { | |
1381 | $this->cache->set('coursesections'.$course->id, array_slice(get_all_sections($course->id), 0, $course->numsections+1, true)); | |
1382 | } | |
1383 | $sections = $this->cache->{'coursesections'.$course->id}; | |
1384 | ||
3406acde SH |
1385 | $viewhiddensections = has_capability('moodle/course:viewhiddensections', $this->page->context); |
1386 | ||
cc10c0b9 | 1387 | $activesection = course_get_display($course->id); |
0f4ab67d SH |
1388 | |
1389 | $namingfunction = 'callback_'.$courseformat.'_get_section_name'; | |
1390 | $namingfunctionexists = (function_exists($namingfunction)); | |
435a512e | 1391 | |
0f4ab67d SH |
1392 | $activeparamfunction = 'callback_'.$courseformat.'_request_key'; |
1393 | if (function_exists($activeparamfunction)) { | |
1394 | $activeparam = $activeparamfunction(); | |
1395 | } else { | |
1396 | $activeparam = 'section'; | |
dc076831 | 1397 | } |
7487c856 SH |
1398 | $navigationsections = array(); |
1399 | foreach ($sections as $sectionid=>$section) { | |
1400 | $section = clone($section); | |
3406acde SH |
1401 | if ($course->id == SITEID) { |
1402 | $this->load_section_activities($coursenode, $section->section, $modinfo); | |
1403 | } else { | |
1404 | if ((!$viewhiddensections && !$section->visible) || (!$this->showemptysections && !array_key_exists($section->section, $modinfo->sections))) { | |
1405 | continue; | |
1406 | } | |
0f4ab67d SH |
1407 | if ($namingfunctionexists) { |
1408 | $sectionname = $namingfunction($course, $section, $sections); | |
3406acde | 1409 | } else { |
0f4ab67d | 1410 | $sectionname = get_string('section').' '.$section->section; |
3406acde | 1411 | } |
dbe5050d SH |
1412 | //$url = new moodle_url('/course/view.php', array('id'=>$course->id)); |
1413 | $url = null; | |
3406acde SH |
1414 | $sectionnode = $coursenode->add($sectionname, $url, navigation_node::TYPE_SECTION, null, $section->id); |
1415 | $sectionnode->nodetype = navigation_node::NODETYPE_BRANCH; | |
1416 | $sectionnode->hidden = (!$section->visible); | |
cc10c0b9 | 1417 | if ($this->page->context->contextlevel != CONTEXT_MODULE && ($sectionnode->isactive || ($activesection && $section->section == $activesection))) { |
0f4ab67d | 1418 | $sectionnode->force_open(); |
3406acde SH |
1419 | $this->load_section_activities($sectionnode, $section->section, $modinfo); |
1420 | } | |
1421 | $section->sectionnode = $sectionnode; | |
7487c856 | 1422 | $navigationsections[$sectionid] = $section; |
3406acde SH |
1423 | } |
1424 | } | |
7487c856 | 1425 | return $navigationsections; |
3406acde SH |
1426 | } |
1427 | /** | |
1428 | * Loads all of the activities for a section into the navigation structure. | |
1429 | * | |
1430 | * @param navigation_node $sectionnode | |
1431 | * @param int $sectionnumber | |
0d8b6a69 | 1432 | * @param course_modinfo $modinfo Object returned from {@see get_fast_modinfo()} |
3406acde SH |
1433 | * @return array Array of activity nodes |
1434 | */ | |
0d8b6a69 | 1435 | protected function load_section_activities(navigation_node $sectionnode, $sectionnumber, course_modinfo $modinfo) { |
3406acde SH |
1436 | if (!array_key_exists($sectionnumber, $modinfo->sections)) { |
1437 | return true; | |
1438 | } | |
1439 | ||
3406acde SH |
1440 | $activities = array(); |
1441 | ||
1442 | foreach ($modinfo->sections[$sectionnumber] as $cmid) { | |
1443 | $cm = $modinfo->cms[$cmid]; | |
2a62743c | 1444 | if (!$cm->uservisible) { |
3406acde SH |
1445 | continue; |
1446 | } | |
1447 | if ($cm->icon) { | |
3aa11c75 | 1448 | $icon = new pix_icon($cm->icon, get_string('modulename', $cm->modname), $cm->iconcomponent); |
3406acde | 1449 | } else { |
3aa11c75 | 1450 | $icon = new pix_icon('icon', get_string('modulename', $cm->modname), $cm->modname); |
3406acde | 1451 | } |
0d8b6a69 | 1452 | $url = $cm->get_url(); |
d69e84b7 | 1453 | $activitynode = $sectionnode->add(format_string($cm->name), $url, navigation_node::TYPE_ACTIVITY, null, $cm->id, $icon); |
3406acde SH |
1454 | $activitynode->title(get_string('modulename', $cm->modname)); |
1455 | $activitynode->hidden = (!$cm->visible); | |
0d8b6a69 | 1456 | if (!$url) { |
1457 | // Do not show activities that don't have links! | |
93ea1294 SH |
1458 | $activitynode->display = false; |
1459 | } else if ($this->module_extends_navigation($cm->modname)) { | |
8f57314b | 1460 | $activitynode->nodetype = navigation_node::NODETYPE_BRANCH; |
3406acde SH |
1461 | } |
1462 | $activities[$cmid] = $activitynode; | |
1463 | } | |
1464 | ||
1465 | return $activities; | |
1466 | } | |
2a62743c PS |
1467 | /** |
1468 | * Loads a stealth module from unavailable section | |
1469 | * @param navigation_node $coursenode | |
1470 | * @param stdClass $modinfo | |
1471 | * @return navigation_node or null if not accessible | |
1472 | */ | |
1473 | protected function load_stealth_activity(navigation_node $coursenode, $modinfo) { | |
1474 | if (empty($modinfo->cms[$this->page->cm->id])) { | |
1475 | return null; | |
1476 | } | |
1477 | $cm = $modinfo->cms[$this->page->cm->id]; | |
1478 | if (!$cm->uservisible) { | |
1479 | return null; | |
1480 | } | |
1481 | if ($cm->icon) { | |
1482 | $icon = new pix_icon($cm->icon, get_string('modulename', $cm->modname), $cm->iconcomponent); | |
1483 | } else { | |
1484 | $icon = new pix_icon('icon', get_string('modulename', $cm->modname), $cm->modname); | |
1485 | } | |
0d8b6a69 | 1486 | $url = $cm->get_url(); |
2a62743c PS |
1487 | $activitynode = $coursenode->add(format_string($cm->name), $url, navigation_node::TYPE_ACTIVITY, null, $cm->id, $icon); |
1488 | $activitynode->title(get_string('modulename', $cm->modname)); | |
1489 | $activitynode->hidden = (!$cm->visible); | |
0d8b6a69 | 1490 | if (!$url) { |
1491 | // Don't show activities that don't have links! | |
2a62743c PS |
1492 | $activitynode->display = false; |
1493 | } else if ($this->module_extends_navigation($cm->modname)) { | |
1494 | $activitynode->nodetype = navigation_node::NODETYPE_BRANCH; | |
1495 | } | |
1496 | return $activitynode; | |
1497 | } | |
3406acde SH |
1498 | /** |
1499 | * Loads the navigation structure for the given activity into the activities node. | |
1500 | * | |
1501 | * This method utilises a callback within the modules lib.php file to load the | |
1502 | * content specific to activity given. | |
1503 | * | |
1504 | * The callback is a method: {modulename}_extend_navigation() | |
1505 | * Examples: | |
1506 | * * {@see forum_extend_navigation()} | |
1507 | * * {@see workshop_extend_navigation()} | |
1508 | * | |
f0dcc212 | 1509 | * @param cm_info|stdClass $cm |
3406acde SH |
1510 | * @param stdClass $course |
1511 | * @param navigation_node $activity | |
1512 | * @return bool | |
1513 | */ | |
0d8b6a69 | 1514 | protected function load_activity($cm, stdClass $course, navigation_node $activity) { |
3406acde | 1515 | global $CFG, $DB; |
44303ca6 | 1516 | |
f0dcc212 SH |
1517 | // make sure we have a $cm from get_fast_modinfo as this contains activity access details |
1518 | if (!($cm instanceof cm_info)) { | |
1519 | $modinfo = get_fast_modinfo($course); | |
1520 | $cm = $modinfo->get_cm($cm->id); | |
1521 | } | |
3406acde SH |
1522 | |
1523 | $activity->make_active(); | |
1524 | $file = $CFG->dirroot.'/mod/'.$cm->modname.'/lib.php'; | |
1525 | $function = $cm->modname.'_extend_navigation'; | |
1526 | ||
1527 | if (file_exists($file)) { | |
1528 | require_once($file); | |
1529 | if (function_exists($function)) { | |
1530 | $activtyrecord = $DB->get_record($cm->modname, array('id' => $cm->instance), '*', MUST_EXIST); | |
1531 | $function($activity, $course, $activtyrecord, $cm); | |
1532 | return true; | |
1533 | } | |
1534 | } | |
1535 | $activity->nodetype = navigation_node::NODETYPE_LEAF; | |
1536 | return false; | |
1537 | } | |
1538 | /** | |
1539 | * Loads user specific information into the navigation in the appopriate place. | |
1540 | * | |
1541 | * If no user is provided the current user is assumed. | |
1542 | * | |
3406acde SH |
1543 | * @param stdClass $user |
1544 | * @return bool | |
7a7e209d | 1545 | */ |
87c215de | 1546 | protected function load_for_user($user=null, $forceforcontext=false) { |
3406acde | 1547 | global $DB, $CFG, $USER; |
4f0c2d00 | 1548 | |
7a7e209d SH |
1549 | if ($user === null) { |
1550 | // We can't require login here but if the user isn't logged in we don't | |
1551 | // want to show anything | |
b9d4c7d3 | 1552 | if (!isloggedin() || isguestuser()) { |
7a7e209d SH |
1553 | return false; |
1554 | } | |
1555 | $user = $USER; | |
7a7e209d SH |
1556 | } else if (!is_object($user)) { |
1557 | // If the user is not an object then get them from the database | |
1558 | $user = $DB->get_record('user', array('id'=>(int)$user), '*', MUST_EXIST); | |
1559 | } | |
136ca7c8 SH |
1560 | |
1561 | $iscurrentuser = ($user->id == $USER->id); | |
1562 | ||
507a7a9a | 1563 | $usercontext = get_context_instance(CONTEXT_USER, $user->id); |
7a7e209d SH |
1564 | |
1565 | // Get the course set against the page, by default this will be the site | |
3406acde SH |
1566 | $course = $this->page->course; |
1567 | $baseargs = array('id'=>$user->id); | |
44303ca6 | 1568 | if ($course->id != SITEID && (!$iscurrentuser || $forceforcontext)) { |
3406acde SH |
1569 | if (array_key_exists($course->id, $this->mycourses)) { |
1570 | $coursenode = $this->mycourses[$course->id]->coursenode; | |
1571 | } else { | |
1572 | $coursenode = $this->rootnodes['courses']->find($course->id, navigation_node::TYPE_COURSE); | |
1573 | if (!$coursenode) { | |
1574 | $coursenode = $this->load_course($course); | |
1575 | } | |
1576 | } | |
7a7e209d | 1577 | $baseargs['course'] = $course->id; |
3406acde | 1578 | $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id); |
7a7e209d | 1579 | $issitecourse = false; |
7d2a0492 | 1580 | } else { |
7a7e209d | 1581 | // Load all categories and get the context for the system |
507a7a9a | 1582 | $coursecontext = get_context_instance(CONTEXT_SYSTEM); |
7a7e209d SH |
1583 | $issitecourse = true; |
1584 | } | |
1585 | ||
1586 | // Create a node to add user information under. | |
87c215de | 1587 | if ($iscurrentuser && !$forceforcontext) { |
3406acde SH |
1588 | // If it's the current user the information will go under the profile root node |
1589 | $usernode = $this->rootnodes['myprofile']; | |
7a7e209d SH |
1590 | } else { |
1591 | if (!$issitecourse) { | |
1592 | // Not the current user so add it to the participants node for the current course | |
3406acde | 1593 | $usersnode = $coursenode->get('participants', navigation_node::TYPE_CONTAINER); |
ad93ddd5 | 1594 | $userviewurl = new moodle_url('/user/view.php', $baseargs); |
7a7e209d SH |
1595 | } else { |
1596 | // This is the site so add a users node to the root branch | |
3406acde SH |
1597 | $usersnode = $this->rootnodes['users']; |
1598 | $usersnode->action = new moodle_url('/user/index.php', array('id'=>$course->id)); | |
ad93ddd5 | 1599 | $userviewurl = new moodle_url('/user/profile.php', $baseargs); |
7a7e209d | 1600 | } |
f5c1e621 SH |
1601 | if (!$usersnode) { |
1602 | // We should NEVER get here, if the course hasn't been populated | |
1603 | // with a participants node then the navigaiton either wasn't generated | |
1604 | // for it (you are missing a require_login or set_context call) or | |
1605 | // you don't have access.... in the interests of no leaking informatin | |
1606 | // we simply quit... | |
1607 | return false; | |
1608 | } | |
7a7e209d | 1609 | // Add a branch for the current user |
ad93ddd5 | 1610 | $usernode = $usersnode->add(fullname($user, true), $userviewurl, self::TYPE_USER, null, $user->id); |
3406acde | 1611 | |
5ac851fb SH |
1612 | if ($this->page->context->contextlevel == CONTEXT_USER && $user->id == $this->page->context->instanceid) { |
1613 | $usernode->make_active(); | |
1614 | } | |
7a7e209d SH |
1615 | } |
1616 | ||
1617 | // If the user is the current user or has permission to view the details of the requested | |
1618 | // user than add a view profile link. | |
507a7a9a | 1619 | if ($iscurrentuser || has_capability('moodle/user:viewdetails', $coursecontext) || has_capability('moodle/user:viewdetails', $usercontext)) { |
87c215de | 1620 | if ($issitecourse || ($iscurrentuser && !$forceforcontext)) { |
03d9401e MD |
1621 | $usernode->add(get_string('viewprofile'), new moodle_url('/user/profile.php',$baseargs)); |
1622 | } else { | |
1623 | $usernode->add(get_string('viewprofile'), new moodle_url('/user/view.php',$baseargs)); | |
1624 | } | |
7a7e209d SH |
1625 | } |
1626 | ||
1627 | // Add nodes for forum posts and discussions if the user can view either or both | |
00c11469 SH |
1628 | // There are no capability checks here as the content of the page is based |
1629 | // purely on the forums the current user has access too. | |
1630 | $forumtab = $usernode->add(get_string('forumposts', 'forum')); | |
1631 | $forumtab->add(get_string('posts', 'forum'), new moodle_url('/mod/forum/user.php', $baseargs)); | |
1632 | $forumtab->add(get_string('discussions', 'forum'), new moodle_url('/mod/forum/user.php', array_merge($baseargs, array('mode'=>'discussions')))); | |
7a7e209d | 1633 | |
27bad0a6 SH |
1634 | // Add blog nodes |
1635 | if (!empty($CFG->bloglevel)) { | |
1636 | require_once($CFG->dirroot.'/blog/lib.php'); | |
1637 | // Get all options for the user | |
1638 | $options = blog_get_options_for_user($user); | |
1639 | if (count($options) > 0) { | |
1640 | $blogs = $usernode->add(get_string('blogs', 'blog'), null, navigation_node::TYPE_CONTAINER); | |
1641 | foreach ($options as $option) { | |
1642 | $blogs->add($option['string'], $option['link']); | |
1643 | } | |
1644 | } | |
1645 | } | |
1646 | ||
5ac851fb SH |
1647 | if (!empty($CFG->messaging)) { |
1648 | $messageargs = null; | |
1649 | if ($USER->id!=$user->id) { | |
1650 | $messageargs = array('id'=>$user->id); | |
1651 | } | |
1652 | $url = new moodle_url('/message/index.php',$messageargs); | |
1653 | $usernode->add(get_string('messages', 'message'), $url, self::TYPE_SETTING, null, 'messages'); | |
c81b9f69 | 1654 | } |
c81b9f69 | 1655 | |
52d1a804 JG |
1656 | $context = get_context_instance(CONTEXT_USER, $USER->id); |
1657 | if ($iscurrentuser && has_capability('moodle/user:manageownfiles', $context)) { | |
82af55d7 MD |
1658 | $url = new moodle_url('/user/files.php'); |
1659 | $usernode->add(get_string('myfiles'), $url, self::TYPE_SETTING); | |
78765507 DC |
1660 | } |
1661 | ||
7a7e209d | 1662 | // Add a node to view the users notes if permitted |
507a7a9a | 1663 | if (!empty($CFG->enablenotes) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $coursecontext)) { |
3406acde SH |
1664 | $url = new moodle_url('/notes/index.php',array('user'=>$user->id)); |
1665 | if ($coursecontext->instanceid) { | |
1666 | $url->param('course', $coursecontext->instanceid); | |
1667 | } | |
1668 | $usernode->add(get_string('notes', 'notes'), $url); | |
7a7e209d SH |
1669 | } |
1670 | ||
1671 | // Add a reports tab and then add reports the the user has permission to see. | |
507a7a9a | 1672 | $anyreport = has_capability('moodle/user:viewuseractivitiesreport', $usercontext); |
9acb8241 SH |
1673 | |
1674 | $viewreports = ($anyreport || ($course->showreports && $iscurrentuser && $forceforcontext)); | |
03d9401e MD |
1675 | if ($viewreports) { |
1676 | $reporttab = $usernode->add(get_string('activityreports')); | |
1677 | $reportargs = array('user'=>$user->id); | |
1678 | if (!empty($course->id)) { | |
1679 | $reportargs['id'] = $course->id; | |
1680 | } else { | |
1681 | $reportargs['id'] = SITEID; | |
1682 | } | |
1683 | if ($viewreports || has_capability('coursereport/outline:view', $coursecontext)) { | |
1684 | $reporttab->add(get_string('outlinereport'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'outline')))); | |
1685 | $reporttab->add(get_string('completereport'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'complete')))); | |
1686 | } | |
4f0c2d00 | 1687 | |
03d9401e MD |
1688 | if ($viewreports || has_capability('coursereport/log:viewtoday', $coursecontext)) { |
1689 | $reporttab->add(get_string('todaylogs'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'todaylogs')))); | |
1690 | } | |
7a7e209d | 1691 | |
03d9401e MD |
1692 | if ($viewreports || has_capability('coursereport/log:view', $coursecontext)) { |
1693 | $reporttab->add(get_string('alllogs'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'alllogs')))); | |
1694 | } | |
7a7e209d | 1695 | |
03d9401e MD |
1696 | if (!empty($CFG->enablestats)) { |
1697 | if ($viewreports || has_capability('coursereport/stats:view', $coursecontext)) { | |
1698 | $reporttab->add(get_string('stats'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'stats')))); | |
1699 | } | |
7a7e209d | 1700 | } |
7a7e209d | 1701 | |
03d9401e MD |
1702 | $gradeaccess = false; |
1703 | if (has_capability('moodle/grade:viewall', $coursecontext)) { | |
1704 | //ok - can view all course grades | |
7a7e209d | 1705 | $gradeaccess = true; |
03d9401e MD |
1706 | } else if ($course->showgrades) { |
1707 | if ($iscurrentuser && has_capability('moodle/grade:view', $coursecontext)) { | |
1708 | //ok - can view own grades | |
1709 | $gradeaccess = true; | |
1710 | } else if (has_capability('moodle/grade:viewall', $usercontext)) { | |
1711 | // ok - can view grades of this user - parent most probably | |
1712 | $gradeaccess = true; | |
1713 | } else if ($anyreport) { | |
1714 | // ok - can view grades of this user - parent most probably | |
1715 | $gradeaccess = true; | |
1716 | } | |
1717 | } | |
1718 | if ($gradeaccess) { | |
1719 | $reporttab->add(get_string('grade'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'grade')))); | |
7a7e209d | 1720 | } |
7a7e209d | 1721 | |
03d9401e MD |
1722 | // Check the number of nodes in the report node... if there are none remove |
1723 | // the node | |
1724 | if (count($reporttab->children)===0) { | |
1725 | $usernode->remove_child($reporttab); | |
1726 | } | |
7a7e209d SH |
1727 | } |
1728 | ||
1729 | // If the user is the current user add the repositories for the current user | |
9acb8241 | 1730 | $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields)); |
7a7e209d SH |
1731 | if ($iscurrentuser) { |
1732 | require_once($CFG->dirroot . '/repository/lib.php'); | |
507a7a9a | 1733 | $editabletypes = repository::get_editable_types($usercontext); |
7a7e209d | 1734 | if (!empty($editabletypes)) { |
ad70376c | 1735 | $usernode->add(get_string('repositories', 'repository'), new moodle_url('/repository/manage_instances.php', array('contextid' => $usercontext->id))); |
7a7e209d | 1736 | } |
9acb8241 SH |
1737 | } else if ($course->id == SITEID && has_capability('moodle/user:viewdetails', $usercontext) && (!in_array('mycourses', $hiddenfields) || has_capability('moodle/user:viewhiddendetails', $coursecontext))) { |
1738 | ||
1739 | // Add view grade report is permitted | |
1740 | $reports = get_plugin_list('gradereport'); | |
1741 | arsort($reports); // user is last, we want to test it first | |
1742 | ||
1743 | $userscourses = enrol_get_users_courses($user->id); | |
1744 | $userscoursesnode = $usernode->add(get_string('courses')); | |
69816a5c | 1745 | |
9acb8241 SH |
1746 | foreach ($userscourses as $usercourse) { |
1747 | $usercoursecontext = get_context_instance(CONTEXT_COURSE, $usercourse->id); | |
1748 | $usercoursenode = $userscoursesnode->add($usercourse->shortname, new moodle_url('/user/view.php', array('id'=>$user->id, 'course'=>$usercourse->id)), self::TYPE_CONTAINER); | |
1749 | ||
1750 | $gradeavailable = has_capability('moodle/grade:viewall', $usercoursecontext); | |
1751 | if (!$gradeavailable && !empty($usercourse->showgrades) && is_array($reports) && !empty($reports)) { | |
1752 | foreach ($reports as $plugin => $plugindir) { | |
1753 | if (has_capability('gradereport/'.$plugin.':view', $usercoursecontext)) { | |
1754 | //stop when the first visible plugin is found | |
1755 | $gradeavailable = true; | |
1756 | break; | |
deaf04c7 | 1757 | } |
9acb8241 SH |
1758 | } |
1759 | } | |
1760 | ||
1761 | if ($gradeavailable) { | |
1762 | $url = new moodle_url('/grade/report/index.php', array('id'=>$usercourse->id)); | |
1763 | $usercoursenode->add(get_string('grades'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/grades', '')); | |
1764 | } | |
1765 | ||
1766 | // Add a node to view the users notes if permitted | |
1767 | if (!empty($CFG->enablenotes) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $usercoursecontext)) { | |
1768 | $url = new moodle_url('/notes/index.php',array('user'=>$user->id, 'course'=>$usercourse->id)); | |
1769 | $usercoursenode->add(get_string('notes', 'notes'), $url, self::TYPE_SETTING); | |
1770 | } | |
1771 | ||
ed1d72ea | 1772 | if (can_access_course(get_context_instance(CONTEXT_COURSE, $usercourse->id), $user->id)) { |
9acb8241 SH |
1773 | $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', '')); |
1774 | } | |
1775 | ||
1776 | $outlinetreport = ($anyreport || has_capability('coursereport/outline:view', $usercoursecontext)); | |
1777 | $logtodayreport = ($anyreport || has_capability('coursereport/log:viewtoday', $usercoursecontext)); | |
1778 | $logreport = ($anyreport || has_capability('coursereport/log:view', $usercoursecontext)); | |
1779 | $statsreport = ($anyreport || has_capability('coursereport/stats:view', $usercoursecontext)); | |
1780 | if ($outlinetreport || $logtodayreport || $logreport || $statsreport) { | |
1781 | $reporttab = $usercoursenode->add(get_string('activityreports')); | |
1782 | $reportargs = array('user'=>$user->id, 'id'=>$usercourse->id); | |
1783 | if ($outlinetreport) { | |
1784 | $reporttab->add(get_string('outlinereport'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'outline')))); | |
1785 | $reporttab->add(get_string('completereport'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'complete')))); | |
1786 | } | |
1787 | ||
1788 | if ($logtodayreport) { | |
1789 | $reporttab->add(get_string('todaylogs'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'todaylogs')))); | |
1790 | } | |
1791 | ||
1792 | if ($logreport) { | |
1793 | $reporttab->add(get_string('alllogs'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'alllogs')))); | |
1794 | } | |
1795 | ||
1796 | if (!empty($CFG->enablestats) && $statsreport) { | |
1797 | $reporttab->add(get_string('stats'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'stats')))); | |
1798 | } | |
1799 | } | |
1800 | } | |
7a7e209d SH |
1801 | } |
1802 | return true; | |
1803 | } | |
1804 | ||
1805 | /** | |
3406acde | 1806 | * This method simply checks to see if a given module can extend the navigation. |
7d2a0492 | 1807 | * |
1808 | * @param string $modname | |
1809 | * @return bool | |
1810 | */ | |
1811 | protected function module_extends_navigation($modname) { | |
1812 | global $CFG; | |
1813 | if ($this->cache->cached($modname.'_extends_navigation')) { | |
1814 | return $this->cache->{$modname.'_extends_navigation'}; | |
1815 | } | |
1816 | $file = $CFG->dirroot.'/mod/'.$modname.'/lib.php'; | |
1817 | $function = $modname.'_extend_navigation'; | |
1818 | if (function_exists($function)) { | |
1819 | $this->cache->{$modname.'_extends_navigation'} = true; | |
1820 | return true; | |
1821 | } else if (file_exists($file)) { | |
1822 | require_once($file); | |
1823 | if (function_exists($function)) { | |
1824 | $this->cache->{$modname.'_extends_navigation'} = true; | |
1825 | return true; | |
1826 | } | |
1827 | } | |
1828 | $this->cache->{$modname.'_extends_navigation'} = false; | |
1829 | return false; | |
1830 | } | |
1831 | /** | |
3406acde | 1832 | * Extends the navigation for the given user. |
435a512e | 1833 | * |
3406acde | 1834 | * @param stdClass $user A user from the database |
7d2a0492 | 1835 | */ |
3406acde SH |
1836 | public function extend_for_user($user) { |
1837 | $this->extendforuser[] = $user; | |
5d07e957 SH |
1838 | } |
1839 | ||
1840 | /** | |
1841 | * Returns all of the users the navigation is being extended for | |
1842 | * | |
1843 | * @return array | |
1844 | */ | |
1845 | public function get_extending_users() { | |
1846 | return $this->extendforuser; | |
7d2a0492 | 1847 | } |
7d2a0492 | 1848 | /** |
3406acde | 1849 | * Adds the given course to the navigation structure. |
7d2a0492 | 1850 | * |
3406acde SH |
1851 | * @param stdClass $course |
1852 | * @return navigation_node | |
7d2a0492 | 1853 | */ |
4766a50c SH |
1854 | public function add_course(stdClass $course, $forcegeneric = false) { |
1855 | global $CFG; | |
44303ca6 PS |
1856 | |
1857 | if ($course->id != SITEID) { | |
1858 | if (!$course->visible) { | |
1859 | if (is_role_switched($course->id)) { | |
1860 | // user has to be able to access course in order to switch, let's skip the visibility test here | |
1861 | } else if (!has_capability('moodle/course:viewhiddencourses', get_context_instance(CONTEXT_COURSE, $course->id))) { | |
1862 | return false; | |
1863 | } | |
1864 | } | |
7d2a0492 | 1865 | } |
7d2a0492 | 1866 | |
4766a50c SH |
1867 | $issite = ($course->id == SITEID); |
1868 | $ismycourse = (array_key_exists($course->id, $this->mycourses) && !$forcegeneric); | |
1869 | $displaycategories = (!$ismycourse && !$issite && !empty($CFG->navshowcategories)); | |
95892197 | 1870 | $shortname = $course->shortname; |
4766a50c SH |
1871 | |
1872 | if ($issite) { | |
3406acde | 1873 | $parent = $this; |
4766a50c | 1874 | $url = null; |
95892197 | 1875 | $shortname = get_string('sitepages'); |
4766a50c | 1876 | } else if ($ismycourse) { |
3406acde SH |
1877 | $parent = $this->rootnodes['mycourses']; |
1878 | $url = new moodle_url('/course/view.php', array('id'=>$course->id)); | |
7a7e209d | 1879 | } else { |
3406acde | 1880 | $parent = $this->rootnodes['courses']; |
a6855934 | 1881 | $url = new moodle_url('/course/view.php', array('id'=>$course->id)); |
7d2a0492 | 1882 | } |
4766a50c SH |
1883 | |
1884 | if ($displaycategories) { | |
1885 | // We need to load the category structure for this course | |
1886 | $categoryfound = false; | |
1887 | if (!empty($course->categorypath)) { | |
1888 | $categories = explode('/', trim($course->categorypath, '/')); | |
1889 | $category = $parent; | |
1890 | while ($category && $categoryid = array_shift($categories)) { | |
1891 | $category = $category->get($categoryid, self::TYPE_CATEGORY); | |
1892 | } | |
1893 | if ($category instanceof navigation_node) { | |
1894 | $parent = $category; | |
1895 | $categoryfound = true; | |
1896 | } | |
1897 | if (!$categoryfound && $forcegeneric) { | |
1898 | $this->load_all_categories($course->category); | |
1899 | if ($category = $parent->find($course->category, self::TYPE_CATEGORY)) { | |
1900 | $parent = $category; | |
1901 | $categoryfound = true; | |
1902 | } | |
1903 | } | |
1904 | } else if (!empty($course->category)) { | |
1905 | $this->load_all_categories($course->category); | |
1906 | if ($category = $parent->find($course->category, self::TYPE_CATEGORY)) { | |
1907 | $parent = $category; | |
1908 | $categoryfound = true; | |
1909 | } | |
1910 | if (!$categoryfound && !$forcegeneric) { | |
1911 | $this->load_all_categories($course->category); | |
1912 | if ($category = $parent->find($course->category, self::TYPE_CATEGORY)) { | |
1913 | $parent = $category; | |
1914 | $categoryfound = true; | |
1915 | } | |
1916 | } | |
1917 | } | |
1918 | } | |
1919 | ||
1920 | // We found the course... we can return it now :) | |
1921 | if ($coursenode = $parent->get($course->id, self::TYPE_COURSE)) { | |
1922 | return $coursenode; | |
1923 | } | |
1924 | ||
95892197 | 1925 | $coursenode = $parent->add($shortname, $url, self::TYPE_COURSE, $shortname, $course->id); |
3406acde SH |
1926 | $coursenode->nodetype = self::NODETYPE_BRANCH; |
1927 | $coursenode->hidden = (!$course->visible); | |
4766a50c | 1928 | $coursenode->title($course->fullname); |
3406acde | 1929 | $this->addedcourses[$course->id] = &$coursenode; |
4766a50c SH |
1930 | if ($ismycourse && !empty($CFG->navshowallcourses)) { |
1931 | // We need to add this course to the general courses node as well as the | |
1932 | // my courses node, rerun the function with the kill param | |
1933 | $genericcourse = $this->add_course($course, true); | |
1934 | if ($genericcourse->isactive) { | |
1935 | $genericcourse->make_inactive(); | |
1936 | $genericcourse->collapse = true; | |
1937 | if ($genericcourse->parent && $genericcourse->parent->type == self::TYPE_CATEGORY) { | |
1938 | $parent = $genericcourse->parent; | |
1939 | while ($parent && $parent->type == self::TYPE_CATEGORY) { | |
1940 | $parent->collapse = true; | |
1941 | $parent = $parent->parent; | |
1942 | } | |
1943 | } | |
1944 | } | |
1945 | } | |
3406acde | 1946 | return $coursenode; |
7d2a0492 | 1947 | } |
1948 | /** | |
3406acde | 1949 | * Adds essential course nodes to the navigation for the given course. |
7d2a0492 | 1950 | * |
3406acde | 1951 | * This method adds nodes such as reports, blogs and participants |
7d2a0492 | 1952 | * |
3406acde SH |
1953 | * @param navigation_node $coursenode |
1954 | * @param stdClass $course | |
7d2a0492 | 1955 | * @return bool |
1956 | */ | |
3406acde SH |
1957 | public function add_course_essentials(navigation_node $coursenode, stdClass $course) { |
1958 | global $CFG; | |
7d2a0492 | 1959 | |
4766a50c | 1960 | if ($course->id == SITEID) { |
3406acde | 1961 | return $this->add_front_page_course_essentials($coursenode, $course); |
7d2a0492 | 1962 | } |
7d2a0492 | 1963 | |
3406acde SH |
1964 | if ($coursenode == false || $coursenode->get('participants', navigation_node::TYPE_CONTAINER)) { |
1965 | return true; | |
7d2a0492 | 1966 | } |
7d2a0492 | 1967 | |
3406acde SH |
1968 | //Participants |
1969 | if (has_capability('moodle/course:viewparticipants', $this->page->context)) { | |
3406acde SH |
1970 | $participants = $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id), self::TYPE_CONTAINER, get_string('participants'), 'participants'); |
1971 | $currentgroup = groups_get_course_group($course, true); | |
1972 | if ($course->id == SITEID) { | |
1973 | $filterselect = ''; | |
1974 | } else if ($course->id && !$currentgroup) { | |
1975 | $filterselect = $course->id; | |
1976 | } else { | |
1977 | $filterselect = $currentgroup; | |
1978 | } | |
1979 | $filterselect = clean_param($filterselect, PARAM_INT); | |
8f6c1f34 PS |
1980 | if (($CFG->bloglevel == BLOG_GLOBAL_LEVEL or ($CFG->bloglevel == BLOG_SITE_LEVEL and (isloggedin() and !isguestuser()))) |
1981 | and has_capability('moodle/blog:view', get_context_instance(CONTEXT_SYSTEM))) { | |
3406acde SH |
1982 | $blogsurls = new moodle_url('/blog/index.php', array('courseid' => $filterselect)); |
1983 | $participants->add(get_string('blogs','blog'), $blogsurls->out()); | |
1984 | } | |
1985 | if (!empty($CFG->enablenotes) && (has_capability('moodle/notes:manage', $this->page->context) || has_capability('moodle/notes:view', $this->page->context))) { | |
1986 | $participants->add(get_string('notes','notes'), new moodle_url('/notes/index.php', array('filtertype'=>'course', 'filterselect'=>$filterselect))); | |
1987 | } | |
533299cb | 1988 | } else if (count($this->extendforuser) > 0 || $this->page->course->id == $course->id) { |
3406acde SH |
1989 | $participants = $coursenode->add(get_string('participants'), null, self::TYPE_CONTAINER, get_string('participants'), 'participants'); |
1990 | } | |
1991 | ||
1992 | // View course reports | |
1993 | if (has_capability('moodle/site:viewreports', $this->page->context)) { // basic capability for listing of reports | |
1994 | $reportnav = $coursenode->add(get_string('reports'), new moodle_url('/course/report.php', array('id'=>$course->id)), self::TYPE_CONTAINER, null, null, new pix_icon('i/stats', '')); | |
1995 | $coursereports = get_plugin_list('coursereport'); | |
1996 | foreach ($coursereports as $report=>$dir) { | |
1997 | $libfile = $CFG->dirroot.'/course/report/'.$report.'/lib.php'; | |
1998 | if (file_exists($libfile)) { | |
1999 | require_once($libfile); | |
2000 | $reportfunction = $report.'_report_extend_navigation'; | |
2001 | if (function_exists($report.'_report_extend_navigation')) { | |
2002 | $reportfunction($reportnav, $course, $this->page->context); | |
7d2a0492 | 2003 | } |
2004 | } | |
2005 | } | |
2006 | } | |
2007 | return true; | |
2008 | } | |
deaf04c7 SH |
2009 | /** |
2010 | * This generates the the structure of the course that won't be generated when | |
2011 | * the modules and sections are added. | |
2012 | * | |
2013 | * Things such as the reports branch, the participants branch, blogs... get | |
2014 | * added to the course node by this method. | |
2015 | * | |
2016 | * @param navigation_node $coursenode | |
2017 | * @param stdClass $course | |
2018 | * @return bool True for successfull generation | |
2019 | */ | |
3406acde SH |
2020 | public function add_front_page_course_essentials(navigation_node $coursenode, stdClass $course) { |
2021 | global $CFG; | |
7d2a0492 | 2022 | |
1fa692ed | 2023 | if ($coursenode == false || $coursenode->get('frontpageloaded', navigation_node::TYPE_CUSTOM)) { |
3406acde | 2024 | return true; |
7a7e209d SH |
2025 | } |
2026 | ||
1fa692ed SH |
2027 | // Hidden node that we use to determine if the front page navigation is loaded. |
2028 | // This required as there are not other guaranteed nodes that may be loaded. | |
2029 | $coursenode->add('frontpageloaded', null, self::TYPE_CUSTOM, null, 'frontpageloaded')->display = false; | |
2030 | ||
3406acde | 2031 | //Participants |
b475cf4c | 2032 | if (has_capability('moodle/course:viewparticipants', get_system_context())) { |
3406acde SH |
2033 | $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id), self::TYPE_CUSTOM, get_string('participants'), 'participants'); |
2034 | } | |
435a512e | 2035 | |
83a5e4fc | 2036 | $filterselect = 0; |
593270c6 MD |
2037 | |
2038 | // Blogs | |
8f6c1f34 PS |
2039 | if (!empty($CFG->bloglevel) |
2040 | and ($CFG->bloglevel == BLOG_GLOBAL_LEVEL or ($CFG->bloglevel == BLOG_SITE_LEVEL and (isloggedin() and !isguestuser()))) | |
2041 | and has_capability('moodle/blog:view', get_context_instance(CONTEXT_SYSTEM))) { | |
2042 | $blogsurls = new moodle_url('/blog/index.php', array('courseid' => $filterselect)); | |
2043 | $coursenode->add(get_string('blogs','blog'), $blogsurls->out()); | |
7d2a0492 | 2044 | } |
593270c6 MD |
2045 | |
2046 | // Notes | |
3406acde SH |
2047 | if (!empty($CFG->enablenotes) && (has_capability('moodle/notes:manage', $this->page->context) || has_capability('moodle/notes:view', $this->page->context))) { |
2048 | $coursenode->add(get_string('notes','notes'), new moodle_url('/notes/index.php', array('filtertype'=>'course', 'filterselect'=>$filterselect))); | |
2049 | } | |
593270c6 MD |
2050 | |
2051 | // Tags | |
2052 | if (!empty($CFG->usetags) && isloggedin()) { | |
3406acde | 2053 | $coursenode->add(get_string('tags', 'tag'), new moodle_url('/tag/search.php')); |
7d2a0492 | 2054 | } |
6644741d | 2055 | |
6644741d | 2056 | |
3406acde SH |
2057 | // View course reports |
2058 | if (has_capability('moodle/site:viewreports', $this->page->context)) { // basic capability for listing of reports | |
2059 | $reportnav = $coursenode->add(get_string('reports'), new moodle_url('/course/report.php', array('id'=>$course->id)), self::TYPE_CONTAINER, null, null, new pix_icon('i/stats', '')); | |
2060 | $coursereports = get_plugin_list('coursereport'); | |
2061 | foreach ($coursereports as $report=>$dir) { | |
2062 | $libfile = $CFG->dirroot.'/course/report/'.$report.'/lib.php'; | |
2063 | if (file_exists($libfile)) { | |
2064 | require_once($libfile); | |
2065 | $reportfunction = $report.'_report_extend_navigation'; | |
2066 | if (function_exists($report.'_report_extend_navigation')) { | |
2067 | $reportfunction($reportnav, $course, $this->page->context); | |
2068 | } | |
6644741d | 2069 | } |
6644741d | 2070 | } |
2071 | } | |
3406acde | 2072 | return true; |
6644741d | 2073 | } |
da3ab9c4 | 2074 | |
3406acde SH |
2075 | /** |
2076 | * Clears the navigation cache | |
2077 | */ | |
2078 | public function clear_cache() { | |
2079 | $this->cache->clear(); | |
da3ab9c4 | 2080 | } |
88f77c3c | 2081 | |
deaf04c7 SH |
2082 | /** |
2083 | * Sets an expansion limit for the navigation | |
2084 | * | |
2085 | * The expansion limit is used to prevent the display of content that has a type | |
2086 | * greater than the provided $type. | |
2087 | * | |
2088 | * Can be used to ensure things such as activities or activity content don't get | |
2089 | * shown on the navigation. | |
2090 | * They are still generated in order to ensure the navbar still makes sense. | |
2091 | * | |
2092 | * @param int $type One of navigation_node::TYPE_* | |
2093 | * @return <type> | |
2094 | */ | |
88f77c3c SH |
2095 | public function set_expansion_limit($type) { |
2096 | $nodes = $this->find_all_of_type($type); | |
2097 | foreach ($nodes as &$node) { | |
1af67ecb SH |
2098 | // We need to generate the full site node |
2099 | if ($type == self::TYPE_COURSE && $node->key == SITEID) { | |
2100 | continue; | |
2101 | } | |
88f77c3c | 2102 | foreach ($node->children as &$child) { |
1af67ecb SH |
2103 | // We still want to show course reports and participants containers |
2104 | // or there will be navigation missing. | |
2105 | if ($type == self::TYPE_COURSE && $child->type === self::TYPE_CONTAINER) { | |
2106 | continue; | |
2107 | } | |
88f77c3c SH |
2108 | $child->display = false; |
2109 | } | |
2110 | } | |
2111 | return true; | |
2112 | } | |
deaf04c7 SH |
2113 | /** |
2114 | * Attempts to get the navigation with the given key from this nodes children. | |
2115 | * | |
2116 | * This function only looks at this nodes children, it does NOT look recursivily. | |
2117 | * If the node can't be found then false is returned. | |
2118 | * | |
2119 | * If you need to search recursivily then use the {@see find()} method. | |
2120 | * | |
2121 | * Note: If you are trying to set the active node {@see navigation_node::override_active_url()} | |
2122 | * may be of more use to you. | |
2123 | * | |
2124 | * @param string|int $key The key of the node you wish to receive. | |
2125 | * @param int $type One of navigation_node::TYPE_* | |
2126 | * @return navigation_node|false | |
2127 | */ | |
e2b436d0 | 2128 | public function get($key, $type = null) { |
246a9b05 SH |
2129 | if (!$this->initialised) { |
2130 | $this->initialise(); | |
2131 | } | |
54dc15ab | 2132 | return parent::get($key, $type); |
e2b436d0 SH |
2133 | } |
2134 | ||
deaf04c7 SH |
2135 | /** |
2136 | * Searches this nodes children and thier children to find a navigation node | |
2137 | * with the matching key and type. | |
2138 | * | |
2139 | * This method is recursive and searches children so until either a node is | |
2140 | * found of there are no more nodes to search. | |
2141 | * | |
2142 | * If you know that the node being searched for is a child of this node | |
2143 | * then use the {@see get()} method instead. | |
2144 | * | |
2145 | * Note: If you are trying to set the active node {@see navigation_node::override_active_url()} | |
2146 | * may be of more use to you. | |
2147 | * | |
2148 | * @param string|int $key The key of the node you wish to receive. | |
2149 | * @param int $type One of navigation_node::TYPE_* | |
2150 | * @return navigation_node|false | |
2151 | */ | |
e2b436d0 | 2152 | public function find($key, $type) { |
246a9b05 SH |
2153 | if (!$this->initialised) { |
2154 | $this->initialise(); | |
2155 | } | |
54dc15ab | 2156 | return parent::find($key, $type); |
e2b436d0 | 2157 | } |
7d2a0492 | 2158 | } |
2159 | ||
2160 | /** | |
2161 | * The limited global navigation class used for the AJAX extension of the global | |
2162 | * navigation class. | |
2163 | * | |
2164 | * The primary methods that are used in the global navigation class have been overriden | |
2165 | * to ensure that only the relevant branch is generated at the root of the tree. | |
2166 | * This can be done because AJAX is only used when the backwards structure for the | |
2167 | * requested branch exists. | |
2168 | * This has been done only because it shortens the amounts of information that is generated | |
2169 | * which of course will speed up the response time.. because no one likes laggy AJAX. | |
2170 | * | |
2171 | * @package moodlecore | |
babb3911 | 2172 | * @subpackage navigation |
7d2a0492 | 2173 | * @copyright 2009 Sam Hemelryk |
2174 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
2175 | */ | |
507a7a9a | 2176 | class global_navigation_for_ajax extends global_navigation { |
3406acde | 2177 | |
39ae5e54 SH |
2178 | protected $branchtype; |
2179 | protected $instanceid; | |
2180 | ||
3406acde SH |
2181 | /** @var array */ |
2182 | protected $expandable = array(); | |
2183 | ||
7d2a0492 | 2184 | /** |
3406acde | 2185 | * Constructs the navigation for use in AJAX request |
3406acde | 2186 | */ |
246a9b05 | 2187 | public function __construct($page, $branchtype, $id) { |
4766a50c | 2188 | $this->page = $page; |
3406acde SH |
2189 | $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME); |
2190 | $this->children = new navigation_node_collection(); | |
39ae5e54 SH |
2191 | $this->branchtype = $branchtype; |
2192 | $this->instanceid = $id; | |
2193 | $this->initialise(); | |
3406acde SH |
2194 | } |
2195 | /** | |
2196 | * Initialise the navigation given the type and id for the branch to expand. | |
7d2a0492 | 2197 | * |
3406acde | 2198 | * @return array The expandable nodes |
7d2a0492 | 2199 | */ |
39ae5e54 SH |
2200 | public function initialise() { |
2201 | global $CFG, $DB, $SITE; | |
507a7a9a | 2202 | |
7d2a0492 | 2203 | if ($this->initialised || during_initial_install()) { |
95b97515 | 2204 | return $this->expandable; |
7d2a0492 | 2205 | } |
246a9b05 SH |
2206 | $this->initialised = true; |
2207 | ||
2208 | $this->rootnodes = array(); | |
2209 | $this->rootnodes['site'] = $this->add_course($SITE); | |
2210 | $this->rootnodes['courses'] = $this->add(get_string('courses'), null, self::TYPE_ROOTNODE, null, 'courses'); | |
507a7a9a SH |
2211 | |
2212 | // Branchtype will be one of navigation_node::TYPE_* | |
39ae5e54 | 2213 | switch ($this->branchtype) { |
4766a50c | 2214 | case self::TYPE_CATEGORY : |
39ae5e54 | 2215 | $this->load_all_categories($this->instanceid); |
4766a50c SH |
2216 | $limit = 20; |
2217 | if (!empty($CFG->navcourselimit)) { | |
2218 | $limit = (int)$CFG->navcourselimit; | |
2219 | } | |
39ae5e54 | 2220 | $courses = $DB->get_records('course', array('category' => $this->instanceid), 'sortorder','*', 0, $limit); |
4766a50c SH |
2221 | foreach ($courses as $course) { |
2222 | $this->add_course($course); | |
2223 | } | |
2224 | break; | |
507a7a9a | 2225 | case self::TYPE_COURSE : |
39ae5e54 | 2226 | $course = $DB->get_record('course', array('id' => $this->instanceid), '*', MUST_EXIST); |
507a7a9a | 2227 | require_course_login($course); |
87c215de | 2228 | $this->page->set_context(get_context_instance(CONTEXT_COURSE, $course->id)); |
3406acde SH |
2229 | $coursenode = $this->add_course($course); |
2230 | $this->add_course_essentials($coursenode, $course); | |
2231 | if ($this->format_display_course_content($course->format)) { | |
2232 | $this->load_course_sections($course, $coursenode); | |
2233 | } | |
7d2a0492 | 2234 | break; |
507a7a9a | 2235 | case self::TYPE_SECTION : |
3406acde | 2236 | $sql = 'SELECT c.*, cs.section AS sectionnumber |
507a7a9a SH |
2237 | FROM {course} c |
2238 | LEFT JOIN {course_sections} cs ON cs.course = c.id | |
2239 | WHERE cs.id = ?'; | |
39ae5e54 | 2240 | $course = $DB->get_record_sql($sql, array($this->instanceid), MUST_EXIST); |
507a7a9a | 2241 | require_course_login($course); |
87c215de | 2242 | $this->page->set_context(get_context_instance(CONTEXT_COURSE, $course->id)); |
3406acde SH |
2243 | $coursenode = $this->add_course($course); |
2244 | $this->add_course_essentials($coursenode, $course); | |
2245 | $sections = $this->load_course_sections($course, $coursenode); | |
2246 | $this->load_section_activities($sections[$course->sectionnumber]->sectionnode, $course->sectionnumber, get_fast_modinfo($course)); | |
7d2a0492 | 2247 | break; |
507a7a9a | 2248 | case self::TYPE_ACTIVITY : |
c78262b5 SH |
2249 | $sql = "SELECT c.* |
2250 | FROM {course} c | |
2251 | JOIN {course_modules} cm ON cm.course = c.id | |
2252 | WHERE cm.id = :cmid"; | |
2253 | $params = array('cmid' => $this->instanceid); | |
2254 | $course = $DB->get_record_sql($sql, $params, MUST_EXIST); | |
f0dcc212 SH |
2255 | $modinfo = get_fast_modinfo($course); |
2256 | $cm = $modinfo->get_cm($this->instanceid); | |
507a7a9a | 2257 | require_course_login($course, true, $cm); |
87c215de | 2258 | $this->page->set_context(get_context_instance(CONTEXT_MODULE, $cm->id)); |
3406acde | 2259 | $coursenode = $this->load_course($course); |
1aa1e9b5 SH |
2260 | if ($course->id == SITEID) { |
2261 | $modulenode = $this->load_activity($cm, $course, $coursenode->find($cm->id, self::TYPE_ACTIVITY)); | |
2262 | } else { | |
c78262b5 SH |
2263 | $sections = $this->load_course_sections($course, $coursenode); |
2264 | $activities = $this->load_section_activities($sections[$cm->sectionnum]->sectionnode, $cm->sectionnum, get_fast_modinfo($course)); | |
1aa1e9b5 SH |
2265 | $modulenode = $this->load_activity($cm, $course, $activities[$cm->id]); |
2266 | } | |
7d2a0492 | 2267 | break; |
507a7a9a | 2268 | default: |
3406acde | 2269 | throw new Exception('Unknown type'); |
507a7a9a | 2270 | return $this->expandable; |
7d2a0492 | 2271 | } |
588a3953 SH |
2272 | |
2273 | if ($this->page->context->contextlevel == CONTEXT_COURSE && $this->page->context->instanceid != SITEID) { | |
2274 | $this->load_for_user(null, true); | |
2275 | } | |
2276 | ||
507a7a9a | 2277 | $this->find_expandable($this->expandable); |
507a7a9a | 2278 | return $this->expandable; |
246a9b05 SH |
2279 | } |
2280 | ||
deaf04c7 SH |
2281 | /** |
2282 | * Returns an array of expandable nodes | |
2283 | * @return array | |
2284 | */ | |
246a9b05 SH |
2285 | public function get_expandable() { |
2286 | return $this->expandable; | |
7d2a0492 | 2287 | } |
7d2a0492 | 2288 | } |
2289 | ||
2290 | /** | |
2291 | * Navbar class | |
2292 | * | |
2293 | * This class is used to manage the navbar, which is initialised from the navigation | |
2294 | * object held by PAGE | |
2295 | * | |
2296 | * @package moodlecore | |
babb3911 | 2297 | * @subpackage navigation |
7d2a0492 | 2298 | * @copyright 2009 Sam Hemelryk |
2299 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
2300 | */ | |
2301 | class navbar extends navigation_node { | |
2302 | /** @var bool */ | |
2303 | protected $initialised = false; | |
2304 | /** @var mixed */ | |
2305 | protected $keys = array(); | |
2306 | /** @var null|string */ | |
2307 | protected $content = null; | |
3406acde | 2308 | /** @var moodle_page object */ |
7d2a0492 | 2309 | protected $page; |
2310 | /** @var bool */ | |
31759089 | 2311 | protected $ignoreactive = false; |
2312 | /** @var bool */ | |
7d2a0492 | 2313 | protected $duringinstall = false; |
7a7e209d SH |
2314 | /** @var bool */ |
2315 | protected $hasitems = false; | |
3406acde SH |
2316 | /** @var array */ |
2317 | protected $items; | |
2318 | /** @var array */ | |
2319 | public $children = array(); | |
4d5059d4 SH |
2320 | /** @var bool */ |
2321 | public $includesettingsbase = false; | |
7d2a0492 | 2322 | /** |
2323 | * The almighty constructor | |
3406acde SH |
2324 | * |
2325 | * @param moodle_page $page | |
7d2a0492 | 2326 | */ |
3406acde | 2327 | public function __construct(moodle_page $page) { |
507a7a9a | 2328 | global $CFG; |
7d2a0492 | 2329 | if (during_initial_install()) { |
2330 | $this->duringinstall = true; | |
2331 | return false; | |
2332 | } | |
2333 | $this->page = $page; | |
2334 | $this->text = get_string('home'); | |
2335 | $this->shorttext = get_string('home'); | |
2336 | $this->action = new moodle_url($CFG->wwwroot); | |
2337 | $this->nodetype = self::NODETYPE_BRANCH; | |
2338 | $this->type = self::TYPE_SYSTEM; | |
2339 | } | |
2340 | ||
2341 | /** | |
2342 | * Quick check to see if the navbar will have items in. | |
2343 | * | |
2344 | * @return bool Returns true if the navbar will have items, false otherwise | |
2345 | */ | |
2346 | public function has_items() { | |
2347 | if ($this->duringinstall) { | |
2348 | return false; | |
7a7e209d SH |
2349 | } else if ($this->hasitems !== false) { |
2350 | return true; | |
7d2a0492 | 2351 | } |
3406acde | 2352 | $this->page->navigation->initialise($this->page); |
bf6c37c7 | 2353 | |
7a7e209d | 2354 | $activenodefound = ($this->page->navigation->contains_active_node() || |
3406acde | 2355 | $this->page->settingsnav->contains_active_node()); |
bf6c37c7 | 2356 | |
3406acde | 2357 | $outcome = (count($this->children)>0 || (!$this->ignoreactive && $activenodefound)); |
7a7e209d | 2358 | $this->hasitems = $outcome; |
bf6c37c7 | 2359 | return $outcome; |
31759089 | 2360 | } |
2361 | ||
3406acde SH |
2362 | /** |
2363 | * Turn on/off ignore active | |
2364 | * | |
2365 | * @param bool $setting | |
2366 | */ | |
31759089 | 2367 | public function ignore_active($setting=true) { |
2368 | $this->ignoreactive = ($setting); | |
7d2a0492 | 2369 | } |
3406acde SH |
2370 | public function get($key, $type = null) { |
2371 | foreach ($this->children as &$child) { | |
2372 | if ($child->key === $key && ($type == null || $type == $child->type)) { | |
2373 | return $child; | |
2374 | } | |
2375 | } | |
2376 | return false; | |
2377 | } | |
7d2a0492 | 2378 | /** |
3406acde | 2379 | * Returns an array of navigation_node's that make up the navbar. |
435a512e | 2380 | * |
3406acde | 2381 | * @return array |
7d2a0492 | 2382 | */ |
3406acde SH |
2383 | public function get_items() { |
2384 | $items = array(); | |
7d2a0492 | 2385 | // Make sure that navigation is initialised |
7a7e209d | 2386 | if (!$this->has_items()) { |
3406acde | 2387 | return $items; |
7a7e209d | 2388 | } |
3406acde SH |
2389 | if ($this->items !== null) { |
2390 | return $this->items; | |
7d2a0492 | 2391 | } |
2392 | ||
3406acde SH |
2393 | if (count($this->children) > 0) { |
2394 | // Add the custom children | |
2395 | $items = array_reverse($this->children); | |
2396 | } | |
117bd748 | 2397 | |
3406acde SH |
2398 | $navigationactivenode = $this->page->navigation->find_active_node(); |
2399 | $settingsactivenode = $this->page->settingsnav->find_active_node(); | |
0b29477b | 2400 | |
7d2a0492 | 2401 | // Check if navigation contains the active node |
0b29477b | 2402 | if (!$this->ignoreactive) { |
435a512e | 2403 | |
3406acde | 2404 | if ($navigationactivenode && $settingsactivenode) { |
0b29477b | 2405 | // Parse a combined navigation tree |
3406acde SH |
2406 | while ($settingsactivenode && $settingsactivenode->parent !== null) { |
2407 | if (!$settingsactivenode->mainnavonly) { | |
2408 | $items[] = $settingsactivenode; | |
2409 | } | |
2410 | $settingsactivenode = $settingsactivenode->parent; | |
2411 | } | |
4d5059d4 SH |
2412 | if (!$this->includesettingsbase) { |
2413 | // Removes the first node from the settings (root node) from the list | |
2414 | array_pop($items); | |
2415 | } | |
3406acde SH |
2416 | while ($navigationactivenode && $navigationactivenode->parent !== null) { |
2417 | if (!$navigationactivenode->mainnavonly) { | |
2418 | $items[] = $navigationactivenode; | |
2419 | } | |
2420 | $navigationactivenode = $navigationactivenode->parent; | |
0b29477b | 2421 | } |
3406acde | 2422 | } else if ($navigationactivenode) { |
0b29477b | 2423 | // Parse the navigation tree to get the active node |
3406acde SH |
2424 | while ($navigationactivenode && $navigationactivenode->parent !== null) { |
2425 | if (!$navigationactivenode->mainnavonly) { | |
2426 | $items[] = $navigationactivenode; | |
2427 | } | |
2428 | $navigationactivenode = $navigationactivenode->parent; | |
2429 | } | |
2430 | } else if ($settingsactivenode) { | |
0b29477b | 2431 | // Parse the settings navigation to get the active node |
3406acde SH |
2432 | while ($settingsactivenode && $settingsactivenode->parent !== null) { |
2433 | if (!$settingsactivenode->mainnavonly) { | |
2434 | $items[] = $settingsactivenode; | |
2435 | } | |
2436 | $settingsactivenode = $settingsactivenode->parent; | |
2437 | } | |
0b29477b | 2438 | } |
7d2a0492 | 2439 | } |
a3bbac8b | 2440 | |
3406acde SH |
2441 | $items[] = new navigation_node(array( |
2442 | 'text'=>$this->page->navigation->text, | |
2443 | 'shorttext'=>$this->page->navigation->shorttext, | |
2444 | 'key'=>$this->page->navigation->key, | |
2445 | 'action'=>$this->page->navigation->action | |
2446 | )); | |
a3bbac8b | 2447 | |
3406acde SH |
2448 | $this->items = array_reverse($items); |
2449 | return $this->items; | |
7d2a0492 | 2450 | } |
507a7a9a | 2451 | |
7d2a0492 | 2452 | /** |
3406acde | 2453 | * Add a new navigation_node to the navbar, overrides parent::add |
7d2a0492 | 2454 | * |
2455 | * This function overrides {@link navigation_node::add()} so that we can change | |
2456 | * the way nodes get added to allow us to simply call add and have the node added to the | |
2457 | * end of the navbar | |
2458 | * | |
2459 | * @param string $text | |
7d2a0492 | 2460 | * @param string|moodle_url $action |
d972bad1 | 2461 | * @param int $type |
2462 | * @param string|int $key | |
2463 | * @param string $shorttext | |
7d2a0492 | 2464 | * @param string $icon |
3406acde | 2465 | * @return navigation_node |
7d2a0492 | 2466 | */ |
f9fc1461 | 2467 | public function add($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, pix_icon $icon=null) { |
3406acde SH |
2468 | if ($this->content !== null) { |
2469 | debugging('Nav bar items must be printed before $OUTPUT->header() has been called', DEBUG_DEVELOPER); | |
2470 | } | |
435a512e | 2471 | |
3406acde SH |
2472 | // Properties array used when creating the new navigation node |
2473 | $itemarray = array( | |
2474 | 'text' => $text, | |
2475 | 'type' => $type | |
2476 | ); | |
2477 | // Set the action if one was provided | |
2478 | if ($action!==null) { | |
2479 | $itemarray['action'] = $action; | |
2480 | } | |
2481 | // Set the shorttext if one was provided | |
2482 | if ($shorttext!==null) { | |
2483 | $itemarray['shorttext'] = $shorttext; | |
2484 | } | |
2485 | // Set the icon if one was provided | |
2486 | if ($icon!==null) { | |
2487 | $itemarray['icon'] = $icon; | |
7d2a0492 | 2488 | } |
3406acde SH |
2489 | // Default the key to the number of children if not provided |
2490 | if ($key === null) { | |
2491 | $key = count($this->children); | |
7d2a0492 | 2492 | } |
3406acde SH |
2493 | // Set the key |
2494 | $itemarray['key'] = $key; | |
2495 | // Set the parent to this node | |
2496 | $itemarray['parent'] = $this; | |
2497 | // Add the child using the navigation_node_collections add method | |
2498 | $this->children[] = new navigation_node($itemarray); | |
2499 | return $this; | |
7d2a0492 | 2500 | } |
2501 | } | |
2502 | ||
2503 | /** | |
2504 | * Class used to manage the settings option for the current page | |
2505 | * | |
2506 | * This class is used to manage the settings options in a tree format (recursively) | |
2507 | * and was created initially for use with the settings blocks. | |
2508 | * | |
2509 | * @package moodlecore | |
babb3911 | 2510 | * @subpackage navigation |
7d2a0492 | 2511 | * @copyright 2009 Sam Hemelryk |
2512 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
2513 | */ | |
2514 | class settings_navigation extends navigation_node { | |
2515 | /** @var stdClass */ | |
2516 | protected $context; | |
3406acde | 2517 | /** @var navigation_cache */ |
7d2a0492 | 2518 | protected $cache; |
3406acde | 2519 | /** @var moodle_page */ |
7d2a0492 | 2520 | protected $page; |
3406acde | 2521 | /** @var string */ |
d9d2817a | 2522 | protected $adminsection; |
4766a50c SH |
2523 | /** @var bool */ |
2524 | protected $initialised = false; | |
87c215de SH |
2525 | /** @var array */ |
2526 | protected $userstoextendfor = array(); | |
4766a50c | 2527 | |
7d2a0492 | 2528 | /** |
2529 | * Sets up the object with basic settings and preparse it for use | |
435a512e | 2530 | * |
3406acde | 2531 | * @param moodle_page $page |
7d2a0492 | 2532 | */ |
507a7a9a | 2533 | public function __construct(moodle_page &$page) { |
7d2a0492 | 2534 | if (during_initial_install()) { |
2535 | return false; | |
2536 | } | |
7d2a0492 | 2537 | $this->page = $page; |
2538 | // Initialise the main navigation. It is most important that this is done | |
2539 | // before we try anything | |
2540 | $this->page->navigation->initialise(); | |
2541 | // Initialise the navigation cache | |
f5b5a822 | 2542 | $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME); |
3406acde | 2543 | $this->children = new navigation_node_collection(); |
7d2a0492 | 2544 | } |
2545 | /** | |
2546 | * Initialise the settings navigation based on the current context | |
2547 | * | |
2548 | * This function initialises the settings navigation tree for a given context | |
2549 | * by calling supporting functions to generate major parts of the tree. | |
3406acde | 2550 | * |
7d2a0492 | 2551 | */ |
2552 | public function initialise() { | |
7e90d3a4 | 2553 | global $DB, $SESSION; |
4f0c2d00 | 2554 | |
7d2a0492 | 2555 | if (during_initial_install()) { |
2556 | return false; | |
4766a50c SH |
2557 | } else if ($this->initialised) { |
2558 | return true; | |
7d2a0492 | 2559 | } |
2560 | $this->id = 'settingsnav'; | |
2561 | $this->context = $this->page->context; | |
0b29477b SH |
2562 | |
2563 | $context = $this->context; | |
2564 | if ($context->contextlevel == CONTEXT_BLOCK) { | |
2565 | $this->load_block_settings(); | |
2566 | $context = $DB->get_record_sql('SELECT ctx.* FROM {block_instances} bi LEFT JOIN {context} ctx ON ctx.id=bi.parentcontextid WHERE bi.id=?', array($context->instanceid)); | |
2567 | } | |
2568 | ||
2569 | switch ($context->contextlevel) { | |
7d2a0492 | 2570 | case CONTEXT_SYSTEM: |
0b29477b SH |
2571 | if ($this->page->url->compare(new moodle_url('/admin/settings.php', array('section'=>'frontpagesettings')))) { |
2572 | $this->load_front_page_settings(($context->id == $this->context->id)); | |
2573 | } | |
7d2a0492 | 2574 | break; |
2575 | case CONTEXT_COURSECAT: | |
0b29477b | 2576 | $this->load_category_settings(); |
7d2a0492 | 2577 | break; |
2578 | case CONTEXT_COURSE: | |
0b29477b SH |
2579 | if ($this->page->course->id != SITEID) { |
2580 | $this->load_course_settings(($context->id == $this->context->id)); | |
7d2a0492 | 2581 | } else { |
0b29477b | 2582 | $this->load_front_page_settings(($context->id == $this->context->id)); |
7d2a0492 | 2583 | } |
2584 | break; | |
2585 | case CONTEXT_MODULE: | |
0b29477b SH |
2586 | $this->load_module_settings(); |
2587 | $this->load_course_settings(); | |
7d2a0492 | 2588 | break; |
2589 | case CONTEXT_USER: | |
0b29477b SH |
2590 | if ($this->page->course->id != SITEID) { |
2591 | $this->load_course_settings(); | |
7d2a0492 | 2592 | } |
7d2a0492 | 2593 | break; |
2594 | } | |
2595 | ||
3406acde | 2596 | $settings = $this->load_user_settings($this->page->course->id); |
7e90d3a4 SH |
2597 | |
2598 | if (isloggedin() && !isguestuser() && (!property_exists($SESSION, 'load_navigation_admin') || $SESSION->load_navigation_admin)) { | |
2599 | $admin = $this->load_administration_settings(); | |
2600 | $SESSION->load_navigation_admin = ($admin->has_children()); | |
2601 | } else { | |
2602 | $admin = false; | |
2603 | } | |
0b29477b | 2604 | |
3406acde SH |
2605 | if ($context->contextlevel == CONTEXT_SYSTEM && $admin) { |
2606 | $admin->force_open(); | |
2607 | } else if ($context->contextlevel == CONTEXT_USER && $settings) { | |
2608 | $settings->force_open(); | |
0b29477b SH |
2609 | } |
2610 | ||
7d2a0492 | 2611 | // Check if the user is currently logged in as another user |
2612 | if (session_is_loggedinas()) { | |
2613 | // Get the actual user, we need this so we can display an informative return link | |
2614 | $realuser = session_get_realuser(); | |
2615 | // Add the informative return to original user link | |
a6855934 | 2616 | $url = new moodle_url('/course/loginas.php',array('id'=>$this->page->course->id, 'return'=>1,'sesskey'=>sesskey())); |
f9fc1461 | 2617 | $this->add(get_string('returntooriginaluser', 'moodle', fullname($realuser, true)), $url, self::TYPE_SETTING, null, null, new pix_icon('t/left', '')); |
7d2a0492 | 2618 | } |
2619 | ||
3406acde SH |
2620 | foreach ($this->children as $key=>$node) { |
2621 | if ($node->nodetype != self::NODETYPE_BRANCH || $node->children->count()===0) { | |
2622 | $node->remove(); | |
2623 | } | |
2624 | } | |
4766a50c | 2625 | $this->initialised = true; |
7d2a0492 | 2626 | } |
2627 | /** | |
2628 | * Override the parent function so that we can add preceeding hr's and set a | |
2629 | * root node class against all first level element | |
2630 | * | |
2631 | * It does this by first calling the parent's add method {@link navigation_node::add()} | |
117bd748 | 2632 | * and then proceeds to use the key to set class and hr |
7d2a0492 | 2633 | * |
2634 | * @param string $text | |
91152a35 | 2635 | * @param sting|moodle_url $url |
7d2a0492 | 2636 | * @param string $shorttext |
2637 | * @param string|int $key | |
2638 | * @param int $type | |
7d2a0492 | 2639 | * @param string $icon |
3406acde | 2640 | * @return navigation_node |
7d2a0492 | 2641 | */ |
f9fc1461 | 2642 | public function add($text, $url=null, $type=null, $shorttext=null, $key=null, pix_icon $icon=null) { |
3406acde SH |
2643 | $node = parent::add($text, $url, $type, $shorttext, $key, $icon); |
2644 | $node->add_class('root_node'); | |
2645 | return $node; | |
7d2a0492 | 2646 | } |
a6e34701 | 2647 | |
2648 | /** | |
2649 | * This function allows the user to add something to the start of the settings | |
2650 | * navigation, which means it will be at the top of the settings navigation block | |
2651 | * | |
2652 | * @param string $text | |
2653 | * @param sting|moodle_url $url | |
2654 | * @param string $shorttext | |
2655 | * @param string|int $key | |
2656 | * @param int $type | |
2657 | * @param string $icon | |
3406acde | 2658 | * @return navigation_node |
a6e34701 | 2659 | */ |
f9fc1461 | 2660 | public function prepend($text, $url=null, $type=null, $shorttext=null, $key=null, pix_icon $icon=null) { |
a6e34701 | 2661 | $children = $this->children; |
b499db57 SH |
2662 | $childrenclass = get_class($children); |
2663 | $this->children = new $childrenclass; | |
3406acde SH |
2664 | $node = $this->add($text, $url, $type, $shorttext, $key, $icon); |
2665 | foreach ($children as $child) { | |
2666 | $this->children->add($child); | |
a6e34701 | 2667 | } |
3406acde | 2668 | return $node; |
a6e34701 | 2669 | } |
7d2a0492 | 2670 | /** |
2671 | * Load the site administration tree | |
2672 | * | |
2673 | * This function loads the site administration tree by using the lib/adminlib library functions | |
2674 | * | |
3406acde | 2675 | * @param navigation_node $referencebranch A reference to a branch in the settings |
7d2a0492 | 2676 | * navigation tree |
3406acde | 2677 | * @param part_of_admin_tree $adminbranch The branch to add, if null generate the admin |
7d2a0492 | 2678 | * tree and start at the beginning |
2679 | * @return mixed A key to access the admin tree by | |
2680 | */ | |
0e3eee62 | 2681 | protected function load_administration_settings(navigation_node $referencebranch=null, part_of_admin_tree $adminbranch=null) { |
507a7a9a | 2682 | global $CFG; |
0e3eee62 | 2683 | |
7d2a0492 | 2684 | // Check if we are just starting to generate this navigation. |
2685 | if ($referencebranch === null) { | |
0e3eee62 | 2686 | |
d9d2817a | 2687 | // Require the admin lib then get an admin structure |
0e3eee62 SH |
2688 | if (!function_exists('admin_get_root')) { |
2689 | require_once($CFG->dirroot.'/lib/adminlib.php'); | |
2690 | } | |
2691 | $adminroot = admin_get_root(false, false); | |
d9d2817a SH |
2692 | // This is the active section identifier |
2693 | $this->adminsection = $this->page->url->param('section'); | |
4f0c2d00 | 2694 | |
d9d2817a SH |
2695 | // Disable the navigation from automatically finding the active node |
2696 | navigation_node::$autofindactive = false; | |
3406acde | 2697 | $referencebranch = $this->add(get_string('administrationsite'), null, self::TYPE_SETTING, null, 'root'); |
0e3eee62 SH |
2698 | foreach ($adminroot->children as $adminbranch) { |
2699 | $this->load_administration_settings($referencebranch, $adminbranch); | |
2700 | } | |
d9d2817a | 2701 | navigation_node::$autofindactive = true; |
0e3eee62 | 2702 | |
d9d2817a | 2703 | // Use the admin structure to locate the active page |
3406acde SH |
2704 | if (!$this->contains_active_node() && $current = $adminroot->locate($this->adminsection, true)) { |
2705 | $currentnode = $this; | |
2706 | while (($pathkey = array_pop($current->path))!==null && $currentnode) { | |
2707 | $currentnode = $currentnode->get($pathkey); | |
2708 | } | |
2709 | if ($currentnode) { | |
2710 | $currentnode->make_active(); | |
7d2a0492 | 2711 | } |
25b550d2 SH |
2712 | } else { |
2713 | $this->scan_for_active_node($referencebranch); | |
0e3eee62 | 2714 | } |
3406acde | 2715 | return $referencebranch; |
8140c440 | 2716 | } else if ($adminbranch->check_access()) { |
7d2a0492 | 2717 | // We have a reference branch that we can access and is not hidden `hurrah` |
2718 | // Now we need to display it and any children it may have | |
2719 | $url = null; | |
2720 | $icon = null; | |
2721 | if ($adminbranch instanceof admin_settingpage) { | |
a6855934 | 2722 | $url = new moodle_url('/admin/settings.php', array('section'=>$adminbranch->name)); |
7d2a0492 | 2723 | } else if ($adminbranch instanceof admin_externalpage) { |
2724 | $url = $adminbranch->url; | |
2725 | } | |
2726 | ||
2727 | // Add the branch | |
3406acde | 2728 | $reference = $referencebranch->add($adminbranch->visiblename, $url, self::TYPE_SETTING, null, $adminbranch->name, $icon); |
8140c440 | 2729 | |
2730 | if ($adminbranch->is_hidden()) { | |
d9d2817a SH |
2731 | if (($adminbranch instanceof admin_externalpage || $adminbranch instanceof admin_settingpage) && $adminbranch->name == $this->adminsection) { |
2732 | $reference->add_class('hidden'); | |
2733 | } else { | |
2734 | $reference->display = false; | |
2735 | } | |
8140c440 | 2736 | } |
2737 | ||
7d2a0492 | 2738 | // Check if we are generating the admin notifications and whether notificiations exist |
2739 | if ($adminbranch->name === 'adminnotifications' && admin_critical_warnings_present()) { | |
2740 | $reference->add_class('criticalnotification'); | |
2741 | } | |
2742 | // Check if this branch has children | |
2743 | if ($reference && isset($adminbranch->children) && is_array($adminbranch->children) && count($adminbranch->children)>0) { | |
2744 | foreach ($adminbranch->children as $branch) { | |
2745 | // Generate the child branches as well now using this branch as the reference | |
459e384e | 2746 | $this->load_administration_settings($reference, $branch); |
7d2a0492 | 2747 | } |
2748 | } else { | |
f9fc1461 | 2749 | $reference->icon = new pix_icon('i/settings', ''); |
7d2a0492 | 2750 | } |
2751 | } | |
2752 | } | |
2753 | ||
25b550d2 SH |
2754 | /** |
2755 | * This function recursivily scans nodes until it finds the active node or there | |
2756 | * are no more nodes. | |
2757 | * @param navigation_node $node | |
2758 | */ | |
2759 | protected function scan_for_active_node(navigation_node $node) { | |
2760 | if (!$node->check_if_active() && $node->children->count()>0) { | |
2761 | foreach ($node->children as &$child) { | |
2762 | $this->scan_for_active_node($child); | |
2763 | } | |
2764 | } | |
2765 | } | |
2766 | ||
3406acde SH |
2767 | /** |
2768 | * Gets a navigation node given an array of keys that represent the path to | |
2769 | * the desired node. | |
2770 | * | |
2771 | * @param array $path | |
2772 | * @return navigation_node|false | |
2773 | */ | |
2774 | protected function get_by_path(array $path) { | |
2775 | $node = $this->get(array_shift($path)); | |
2776 | foreach ($path as $key) { | |
2777 | $node->get($key); | |
2778 | } | |
2779 | return $node; | |
2780 | } | |
2781 | ||
7d2a0492 | 2782 | /** |
2783 | * Generate the list of modules for the given course. | |
2784 | * | |
2785 | * The array of resources and activities that can be added to a course is then | |
2786 | * stored in the cache so that we can access it for anywhere. | |
2787 | * It saves us generating it all the time | |
2788 | * | |
2789 | * <code php> | |
2790 | * // To get resources: | |
2791 | * $this->cache->{'course'.$courseid.'resources'} | |
2792 | * // To get activities: | |
2793 | * $this->cache->{'course'.$courseid.'activities'} | |
2794 | * </code> | |
2795 | * | |
2796 | * @param stdClass $course The course to get modules for | |
2797 | */ | |
2798 | protected function get_course_modules($course) { | |
2799 | global $CFG; | |
2800 | $mods = $modnames = $modnamesplural = $modnamesused = array(); | |
2801 | // This function is included when we include course/lib.php at the top | |
2802 | // of this file | |
2803 | get_all_mods($course->id, $mods, $modnames, $modnamesplural, $modnamesused); | |
2804 | $resources = array(); | |
2805 | $activities = array(); | |
2806 | foreach($modnames as $modname=>$modnamestr) { | |
2807 | if (!course_allowed_module($course, $modname)) { | |
2808 | continue; | |
2809 | } | |
2810 | ||
2811 | $libfile = "$CFG->dirroot/mod/$modname/lib.php"; | |
2812 | if (!file_exists($libfile)) { | |
2813 | continue; | |
2814 | } | |
2815 | include_once($libfile); | |
2816 | $gettypesfunc = $modname.'_get_types'; | |
2817 | if (function_exists($gettypesfunc)) { | |
2818 | $types = $gettypesfunc(); | |
2819 | foreach($types as $type) { | |
2820 | if (!isset($type->modclass) || !isset($type->typestr)) { | |
2821 | debugging('Incorrect activity type in '.$modname); | |
2822 | continue; | |
2823 | } | |
2824 | if ($type->modclass == MOD_CLASS_RESOURCE) { | |
2825 | $resources[html_entity_decode($type->type)] = $type->typestr; | |
2826 | } else { | |
2827 | $activities[html_entity_decode($type->type)] = $type->typestr; | |
2828 | } | |
2829 | } | |
2830 | } else { | |
2831 | $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER); | |
2832 | if ($archetype == MOD_ARCHETYPE_RESOURCE) { | |
2833 | $resources[$modname] = $modnamestr; | |
2834 | } else { | |
2835 | // all other archetypes are considered activity | |
2836 | $activities[$modname] = $modnamestr; | |
2837 | } | |
2838 | } | |
2839 | } | |
2840 | $this->cache->{'course'.$course->id.'resources'} = $resources; | |
2841 | $this->cache->{'course'.$course->id.'activities'} = $activities; | |
2842 | } | |
2843 | ||
2844 | /** | |
2845 | * This function loads the course settings that are available for the user | |
2846 | * | |
0b29477b | 2847 | * @param bool $forceopen If set to true the course node will be forced open |
3406acde | 2848 | * @return navigation_node|false |
7d2a0492 | 2849 | */ |
0b29477b | 2850 | protected function load_course_settings($forceopen = false) { |
4f0c2d00 | 2851 | global $CFG, $USER, $SESSION, $OUTPUT; |
7d2a0492 | 2852 | |
2853 | $course = $this->page->course; | |
4f0c2d00 | 2854 | $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id); |
df997f84 PS |
2855 | |
2856 | // note: do not test if enrolled or viewing here because we need the enrol link in Course administration section | |
7d2a0492 | 2857 | |
3406acde SH |
2858 | $coursenode = $this->add(get_string('courseadministration'), null, self::TYPE_COURSE, null, 'courseadmin'); |
2859 | if ($forceopen) { | |
2860 | $coursenode->force_open(); | |
2861 | } | |
117bd748 | 2862 | |
4f0c2d00 | 2863 | if (has_capability('moodle/course:update', $coursecontext)) { |
7d2a0492 | 2864 | // Add the turn on/off settings |
a6855934 | 2865 | $url = new moodle_url('/course/view.php', array('id'=>$course->id, 'sesskey'=>sesskey())); |
7d2a0492 | 2866 | if ($this->page->user_is_editing()) { |
2867 | $url->param('edit', 'off'); | |
2868 | $editstring = get_string('turneditingoff'); | |
2869 | } else { | |
2870 | $url->param('edit', 'on'); | |
2871 | $editstring = get_string('turneditingon'); | |
2872 | } | |
f9fc1461 | 2873 | $coursenode->add($editstring, $url, self::TYPE_SETTING, null, null, new pix_icon('i/edit', '')); |
7d2a0492 | 2874 | |
7d2a0492 | 2875 | if ($this->page->user_is_editing()) { |
538891b5 SH |
2876 | // Removed as per MDL-22732 |
2877 | // $this->add_course_editing_links($course); | |
7d2a0492 | 2878 | } |
2879 | ||
2880 | // Add the course settings link | |
a6855934 | 2881 | $url = new moodle_url('/course/edit.php', array('id'=>$course->id)); |
20d6b374 | 2882 | $coursenode->add(get_string('editsettings'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/settings', '')); |
2be4d090 MD |
2883 | |
2884 | // Add the course completion settings link | |
2885 | if ($CFG->enablecompletion && $course->enablecompletion) { | |
2886 | $url = new moodle_url('/course/completion.php', array('id'=>$course->id)); | |
2887 | $coursenode->add(get_string('completion', 'completion'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/settings', '')); | |
2888 | } | |
7d2a0492 | 2889 | } |
117bd748 | 2890 | |
df997f84 PS |
2891 | // add enrol nodes |
2892 | enrol_add_course_navigation($coursenode, $course); | |
2893 | ||
2894 | // Manage filters | |
2895 | if (has_capability('moodle/filter:manage', $coursecontext) && count(filter_get_available_in_context($coursecontext))>0) { | |
2896 | $url = new moodle_url('/filter/manage.php', array('contextid'=>$coursecontext->id)); | |
2897 | $coursenode->add(get_string('filters', 'admin'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/filter', '')); | |
7d2a0492 | 2898 | } |
2899 | ||
2900 | // Add view grade report is permitted | |
2901 | $reportavailable = false; | |
4f0c2d00 | 2902 | if (has_capability('moodle/grade:viewall', $coursecontext)) { |
7d2a0492 | 2903 | $reportavailable = true; |
2904 | } else if (!empty($course->showgrades)) { | |
2905 | $reports = get_plugin_list('gradereport'); | |
2906 | if (is_array($reports) && count($reports)>0) { // Get all installed reports | |
2907 | arsort($reports); // user is last, we want to test it first | |
2908 | foreach ($reports as $plugin => $plugindir) { | |
4f0c2d00 | 2909 | if (has_capability('gradereport/'.$plugin.':view', $coursecontext)) { |
7d2a0492 | 2910 | //stop when the first visible plugin is found |
2911 | $reportavailable = true; | |
2912 | break; | |
2913 | } | |
2914 | } | |
2915 | } | |
2916 | } | |
2917 | if ($reportavailable) { | |
a6855934 | 2918 | $url = new moodle_url('/grade/report/index.php', array('id'=>$course->id)); |
b499db57 | 2919 | $gradenode = $coursenode->add(get_string('grades'), $url, self::TYPE_SETTING, null, 'grades', new pix_icon('i/grades', '')); |
7d2a0492 | 2920 | } |
2921 | ||
2922 | // Add outcome if permitted | |
4f0c2d00 | 2923 | if (!empty($CFG->enableoutcomes) && has_capability('moodle/course:update', $coursecontext)) { |
a6855934 | 2924 | $url = new moodle_url('/grade/edit/outcome/course.php', array('id'=>$course->id)); |
d6d07a68 | 2925 | $coursenode->add(get_string('outcomes', 'grades'), $url, self::TYPE_SETTING, null, 'outcomes', new pix_icon('i/outcomes', '')); |
7d2a0492 | 2926 | } |
2927 | ||
7d2a0492 | 2928 | // Backup this course |
4f0c2d00 | 2929 | if (has_capability('moodle/backup:backupcourse', $coursecontext)) { |
a6855934 | 2930 | $url = new moodle_url('/backup/backup.php', array('id'=>$course->id)); |
d6d07a68 | 2931 | $coursenode->add(get_string('backup'), $url, self::TYPE_SETTING, null, 'backup', new pix_icon('i/backup', '')); |
7d2a0492 | 2932 | } |
2933 | ||
2934 | // Restore to this course | |
4f0c2d00 | 2935 | if (has_capability('moodle/restore:restorecourse', $coursecontext)) { |
785d6603 | 2936 | $url = new moodle_url('/backup/restorefile.php', array('contextid'=>$coursecontext->id)); |
d6d07a68 | 2937 | $coursenode->add(get_string('restore'), $url, self::TYPE_SETTING, null, 'restore', new pix_icon('i/restore', '')); |
7d2a0492 | 2938 | } |
2939 | ||
2940 | // Import data from other courses | |
4f0c2d00 | 2941 | if (has_capability('moodle/restore:restoretargetimport', $coursecontext)) { |
ad93ddd5 | 2942 | $url = new moodle_url('/backup/import.php', array('id'=>$course->id)); |
d6d07a68 | 2943 | $coursenode->add(get_string('import'), $url, self::TYPE_SETTING, null, 'import', new pix_icon('i/restore', '')); |
7d2a0492 | 2944 | } |
2945 | ||
07ab0c80 | 2946 | // Publish course on a hub |
2947 | if (has_capability('moodle/course:publish', $coursecontext)) { | |
2948 | $url = new moodle_url('/course/publish/index.php', array('id'=>$course->id)); | |
d6d07a68 | 2949 | $coursenode->add(get_string('publish'), $url, self::TYPE_SETTING, null, 'publish', new pix_icon('i/publish', '')); |
07ab0c80 | 2950 | } |
2951 | ||
7d2a0492 | 2952 | // Reset this course |
4f0c2d00 | 2953 | if (has_capability('moodle/course:reset', $coursecontext)) { |
a6855934 | 2954 | $url = new moodle_url('/course/reset.php', array('id'=>$course->id)); |
f9fc1461 | 2955 | $coursenode->add(get_string('reset'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/return', '')); |
7d2a0492 | 2956 | } |
7d2a0492 | 2957 | |
56ed242b SH |
2958 | // Questions |
2959 | require_once($CFG->dirroot.'/question/editlib.php'); | |
2960 | question_extend_settings_navigation($coursenode, $coursecontext)->trim_if_empty(); | |
7d2a0492 | 2961 | |
2962 | // Repository Instances | |
2963 | require_once($CFG->dirroot.'/repository/lib.php'); | |
76046fa8 SH |
2964 | $editabletypes = repository::get_editable_types($coursecontext); |
2965 | if (has_capability('moodle/course:update', $coursecontext) && !empty($editabletypes)) { | |
2966 | $url = new moodle_url('/repository/manage_instances.php', array('contextid'=>$coursecontext->id)); | |
f9fc1461 | 2967 | $coursenode->add(get_string('repositories'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/repository', '')); |
7d2a0492 | 2968 | } |
2969 | ||
2970 | // Manage files | |
57ebd15e | 2971 | if ($course->legacyfiles == 2 and has_capability('moodle/course:managefiles', $coursecontext)) { |
69816a5c | 2972 | // hidden in new courses and courses where legacy files were turned off |
e921afa8 | 2973 | $url = new moodle_url('/files/index.php', array('contextid'=>$coursecontext->id)); |
69816a5c | 2974 | $coursenode->add(get_string('courselegacyfiles'), $url, self::TYPE_SETTING, null, 'coursefiles', new pix_icon('i/files', '')); |
7d2a0492 | 2975 | } |
2976 | ||
7d2a0492 | 2977 | // Switch roles |
2978 | $roles = array(); | |
2979 | $assumedrole = $this->in_alternative_role(); | |
2980 | if ($assumedrole!==false) { | |
2981 | $roles[0] = get_string('switchrolereturn'); | |
2982 | } | |
76046fa8 SH |
2983 | if (has_capability('moodle/role:switchroles', $coursecontext)) { |
2984 | $availableroles = get_switchable_roles($coursecontext); | |
7d2a0492 | 2985 | if (is_array($availableroles)) { |
2986 | foreach ($availableroles as $key=>$role) { | |
44303ca6 | 2987 | if ($assumedrole == (int)$key) { |
7d2a0492 | 2988 | continue; |
2989 | } | |
2990 | $roles[$key] = $role; | |
2991 | } | |
2992 | } | |
2993 | } | |
2994 | if (is_array($roles) && count($roles)>0) { | |
3406acde | 2995 | $switchroles = $this->add(get_string('switchroleto')); |
7d2a0492 | 2996 | if ((count($roles)==1 && array_key_exists(0, $roles))|| $assumedrole!==false) { |
3406acde | 2997 | $switchroles->force_open(); |
7d2a0492 | 2998 | } |
2999 | $returnurl = $this->page->url; | |
3000 | $returnurl->param('sesskey', sesskey()); | |
3001 | $SESSION->returnurl = serialize($returnurl); | |
3002 | foreach ($roles as $key=>$name) { | |
a6855934 | 3003 | $url = new moodle_url('/course/switchrole.php', array('id'=>$course->id,'sesskey'=>sesskey(), 'switchrole'=>$key, 'returnurl'=>'1')); |
3406acde | 3004 | $switchroles->add($name, $url, self::TYPE_SETTING, null, $key, new pix_icon('i/roles', '')); |
7d2a0492 | 3005 | } |
3006 | } | |
3007 | // Return we are done | |
3406acde | 3008 | return $coursenode; |
7d2a0492 | 3009 | } |
3010 | ||
538891b5 | 3011 | /** |
792881f0 | 3012 | * Adds branches and links to the settings navigation to add course activities |
538891b5 SH |
3013 | * and resources. |
3014 | * | |
3015 | * @param stdClass $course | |
3016 | */ | |
3017 | protected function add_course_editing_links($course) { | |
df997f84 PS |
3018 | global $CFG; |
3019 | ||
3020 | require_once($CFG->dirroot.'/course/lib.php'); | |
3021 | ||
538891b5 SH |
3022 | // Add `add` resources|activities branches |
3023 | $structurefile = $CFG->dirroot.'/course/format/'.$course->format.'/lib.php'; | |
3024 | if (file_exists($structurefile)) { | |
3025 | require_once($structurefile); | |
ee9ff059 SH |
3026 | $requestkey = call_user_func('callback_'.$course->format.'_request_key'); |
3027 | $formatidentifier = optional_param($requestkey, 0, PARAM_INT); | |
538891b5 | 3028 | } else { |
ee9ff059 SH |
3029 | $requestkey = get_string('section'); |
3030 | $formatidentifier = optional_param($requestkey, 0, PARAM_INT); | |
538891b5 SH |
3031 | } |
3032 | ||
3033 | $sections = get_all_sections($course->id); | |
3034 | ||
3035 | $addresource = $this->add(get_string('addresource')); | |
3036 | $addactivity = $this->add(get_string('addactivity')); | |
3037 | if ($formatidentifier!==0) { | |
3038 | $addresource->force_open(); | |
3039 | $addactivity->force_open(); | |
3040 | } | |
3041 | ||
3042 | if (!$this->cache->cached('course'.$course->id.'resources')) { | |
3043 | $this->get_course_modules($course); | |
3044 | } | |
3045 | $resources = $this->cache->{'course'.$course->id.'resources'}; | |
3046 | $activities = $this->cache->{'course'.$course->id.'activities'}; | |
3047 | ||
3048 | $textlib = textlib_get_instance(); | |
3049 | ||
3050 | foreach ($sections as $section) { | |
3051 | if ($formatidentifier !== 0 && $section->section != $formatidentifier) { | |
3052 | continue; | |
3053 | } | |
ee9ff059 | 3054 | $sectionurl = new moodle_url('/course/view.php', array('id'=>$course->id, $requestkey=>$section->section)); |
538891b5 SH |
3055 | if ($section->section == 0) { |
3056 | $sectionresources = $addresource->add(get_string('course'), $sectionurl, self::TYPE_SETTING); | |
3057 | $sectionactivities = $addactivity->add(get_string('course'), $sectionurl, self::TYPE_SETTING); | |
3058 | } else { | |
ee9ff059 SH |
3059 | $sectionname = get_section_name($course, $section); |
3060 | $sectionresources = $addresource->add($sectionname, $sectionurl, self::TYPE_SETTING); | |
3061 | $sectionactivities = $addactivity->add($sectionname, $sectionurl, self::TYPE_SETTING); | |
538891b5 SH |
3062 | } |
3063 | foreach ($resources as $value=>$resource) { | |
3064 | $url = new moodle_url('/course/mod.php', array('id'=>$course->id, 'sesskey'=>sesskey(), 'section'=>$section->section)); | |
3065 | $pos = strpos($value, '&type='); | |
3066 | if ($pos!==false) { | |
3067 | $url->param('add', $textlib->substr($value, 0,$pos)); | |
3068 | $url->param('type', $textlib->substr($value, $pos+6)); | |
3069 | } else { | |
3070 | $url->param('add', $value); | |
3071 | } | |
3072 | $sectionresources->add($resource, $url, self::TYPE_SETTING); | |
3073 | } | |
3074 | $subbranch = false; | |
3075 | foreach ($activities as $activityname=>$activity) { | |
3076 | if ($activity==='--') { | |
3077 | $subbranch = false; | |
3078 | continue; | |
3079 | } | |
3080 | if (strpos($activity, '--')===0) { | |
3081 | $subbranch = $sectionactivities->add(trim($activity, '-')); | |
3082 | continue; | |
3083 | } | |
3084 | $url = new moodle_url('/course/mod.php', array('id'=>$course->id, 'sesskey'=>sesskey(), 'section'=>$section->section)); | |
3085 | $pos = strpos($activityname, '&type='); | |
3086 | if ($pos!==false) { | |
3087 | $url->param('add', $textlib->substr($activityname, 0,$pos)); | |
3088 | $url->param('type', $textlib->substr($activityname, $pos+6)); | |
3089 | } else { | |
3090 | $url->param('add', $activityname); | |
3091 | } | |
3092 | if ($subbranch !== false) { | |
3093 | $subbranch->add($activity, $url, self::TYPE_SETTING); | |
3094 | } else { | |
3095 | $sectionactivities->add($activity, $url, self::TYPE_SETTING); | |
3096 | } | |
3097 | } | |
3098 | } | |
3099 | } | |
3100 | ||
7d2a0492 | 3101 | /** |
3102 | * This function calls the module function to inject module settings into the | |
3103 | * settings navigation tree. | |
3104 | * | |
3105 | * This only gets called if there is a corrosponding function in the modules | |
3106 | * lib file. | |
3107 | * | |
3108 | * For examples mod/forum/lib.php ::: forum_extend_settings_navigation() | |
3109 | * | |
3406acde | 3110 | * @return navigation_node|false |
7d2a0492 | 3111 | */ |
3112 | protected function load_module_settings() { | |
507a7a9a | 3113 | global $CFG; |
4dd5bce8 | 3114 | |
3115 | if (!$this->page->cm && $this->context->contextlevel == CONTEXT_MODULE && $this->context->instanceid) { | |
0b29477b | 3116 | $cm = get_coursemodule_from_id(false, $this->context->instanceid, 0, false, MUST_EXIST); |
507a7a9a | 3117 | $this->page->set_cm($cm, $this->page->course); |
4dd5bce8 | 3118 | } |
3119 | ||
f9bf32f8 SH |
3120 | $file = $CFG->dirroot.'/mod/'.$this->page->activityname.'/lib.php'; |
3121 | if (file_exists($file)) { | |
3122 | require_once($file); | |
3123 | } | |
3124 | ||
370d793c | 3125 | $modulenode = $this->add(get_string('pluginadministration', $this->page->activityname)); |
3406acde | 3126 | $modulenode->force_open(); |
4f0c2d00 | 3127 | |
0b29477b SH |
3128 | // Settings for the module |
3129 | if (has_capability('moodle/course:manageactivities', $this->page->cm->context)) { | |
3130 | $url = new moodle_url('/course/modedit.php', array('update' => $this->page->cm->id, 'return' => true, 'sesskey' => sesskey())); | |
20d6b374 | 3131 | $modulenode->add(get_string('editsettings'), $url, navigation_node::TYPE_SETTING); |
0b29477b SH |
3132 | } |
3133 | // Assign local roles | |
3134 | if (count(get_assignable_roles($this->page->cm->context))>0) { | |
3135 | $url = new moodle_url('/'.$CFG->admin.'/roles/assign.php', array('contextid'=>$this->page->cm->context->id)); | |
3136 | $modulenode->add(get_string('localroles', 'role'), $url, self::TYPE_SETTING); | |
3137 | } | |
3138 | // Override roles | |
3139 | if (has_capability('moodle/role:review', $this->page->cm->context) or count(get_overridable_roles($this->page->cm->context))>0) { | |
3140 | $url = new moodle_url('/'.$CFG->admin.'/roles/permissions.php', array('contextid'=>$this->page->cm->context->id)); | |
3141 | $modulenode->add(get_string('permissions', 'role'), $url, self::TYPE_SETTING); | |
3142 | } | |
3143 | // Check role permissions | |
3144 | if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:assign'), $this->page->cm->context)) { | |
3145 | $url = new moodle_url('/'.$CFG->admin.'/roles/check.php', array('contextid'=>$this->page->cm->context->id)); | |
3146 | $modulenode->add(get_string('checkpermissions', 'role'), $url, self::TYPE_SETTING); | |
3147 | } | |
3148 | // Manage filters | |
3149 | if (has_capability('moodle/filter:manage', $this->page->cm->context) && count(filter_get_available_in_context($this->page->cm->context))>0) { | |
3150 | $url = new moodle_url('/filter/manage.php', array('contextid'=>$this->page->cm->context->id)); | |
3151 | $modulenode->add(get_string('filters', 'admin'), $url, self::TYPE_SETTING); | |
3152 | } | |
4f0c2d00 | 3153 | |
18ddfc1e SH |
3154 | if (has_capability('coursereport/log:view', get_context_instance(CONTEXT_COURSE, $this->page->cm->course))) { |
3155 | $url = new moodle_url('/course/report/log/index.php', array('chooselog'=>'1','id'=>$this->page->cm->course,'modid'=>$this->page->cm->id)); | |
3156 | $modulenode->add(get_string('logs'), $url, self::TYPE_SETTING); | |
3157 | } | |
3158 | ||
59c7680f SH |
3159 | // Add a backup link |
3160 | $featuresfunc = $this->page->activityname.'_supports'; | |
02848cbf | 3161 | if (function_exists($featuresfunc) && $featuresfunc(FEATURE_BACKUP_MOODLE2) && has_capability('moodle/backup:backupactivity', $this->page->cm->context)) { |
59c7680f SH |
3162 | $url = new moodle_url('/backup/backup.php', array('id'=>$this->page->cm->course, 'cm'=>$this->page->cm->id)); |
3163 | $modulenode->add(get_string('backup'), $url, self::TYPE_SETTING); | |
3164 | } | |
3165 | ||
d0da42d1 DC |
3166 | // Restore this activity |
3167 | $featuresfunc = $this->page->activityname.'_supports'; | |
3168 | if (function_exists($featuresfunc) && $featuresfunc(FEATURE_BACKUP_MOODLE2) && has_capability('moodle/restore:restoreactivity', $this->page->cm->context)) { | |
3169 | $url = new moodle_url('/backup/restorefile.php', array('contextid'=>$this->page->cm->context->id)); | |
3170 | $modulenode->add(get_string('restore'), $url, self::TYPE_SETTING); | |
3171 | } | |
3172 | ||
507a7a9a | 3173 | $function = $this->page->activityname.'_extend_settings_navigation'; |
7d2a0492 | 3174 | if (!function_exists($function)) { |
3406acde | 3175 | return $modulenode; |
7d2a0492 | 3176 | } |
0b29477b SH |
3177 | |
3178 | $function($this, $modulenode); | |
3179 | ||
3180 | // Remove the module node if there are no children | |
3181 | if (empty($modulenode->children)) { | |
3406acde | 3182 | $modulenode->remove(); |
0b29477b SH |
3183 | } |
3184 | ||
3406acde | 3185 | return $modulenode; |
7d2a0492 | 3186 | } |
3187 | ||
3188 | /** | |
3189 | * Loads the user settings block of the settings nav | |
117bd748 | 3190 | * |
7d2a0492 | 3191 | * This function is simply works out the userid and whether we need to load |
117bd748 | 3192 | * just the current users profile settings, or the current user and the user the |
7d2a0492 | 3193 | * current user is viewing. |
117bd748 | 3194 | * |
7d2a0492 | 3195 | * This function has some very ugly code to work out the user, if anyone has |
3196 | * any bright ideas please feel free to intervene. | |
3197 | * | |
3198 | * @param int $courseid The course id of the current course | |
3406acde | 3199 | * @return navigation_node|false |
7d2a0492 | 3200 | */ |
3201 | protected function load_user_settings($courseid=SITEID) { | |
0b29477b | 3202 | global $USER, $FULLME, $CFG; |
7d2a0492 |