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