Commit | Line | Data |
---|---|---|
7d2a0492 | 1 | <?php |
7d2a0492 | 2 | // This file is part of Moodle - http://moodle.org/ |
3 | // | |
4 | // Moodle is free software: you can redistribute it and/or modify | |
5 | // it under the terms of the GNU General Public License as published by | |
6 | // the Free Software Foundation, either version 3 of the License, or | |
7 | // (at your option) any later version. | |
8 | // | |
9 | // Moodle is distributed in the hope that it will be useful, | |
10 | // but WITHOUT ANY WARRANTY; without even the implied warranty of | |
11 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
12 | // GNU General Public License for more details. | |
13 | // | |
14 | // You should have received a copy of the GNU General Public License | |
15 | // along with Moodle. If not, see <http://www.gnu.org/licenses/>. | |
16 | ||
17 | /** | |
98556b23 | 18 | * This file contains classes used to manage the navigation structures within Moodle. |
7d2a0492 | 19 | * |
5bcfd504 | 20 | * @since Moodle 2.0 |
78bfb562 | 21 | * @package core |
78bfb562 PS |
22 | * @copyright 2009 Sam Hemelryk |
23 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
7d2a0492 | 24 | */ |
25 | ||
78bfb562 PS |
26 | defined('MOODLE_INTERNAL') || die(); |
27 | ||
f5b5a822 | 28 | /** |
2561c4e9 | 29 | * The name that will be used to separate the navigation cache within SESSION |
f5b5a822 | 30 | */ |
31 | define('NAVIGATION_CACHE_NAME', 'navigation'); | |
5ab32c11 | 32 | define('NAVIGATION_SITE_ADMIN_CACHE_NAME', 'navigationsiteadmin'); |
f5b5a822 | 33 | |
7d2a0492 | 34 | /** |
35 | * This class is used to represent a node in a navigation tree | |
36 | * | |
37 | * This class is used to represent a node in a navigation tree within Moodle, | |
38 | * the tree could be one of global navigation, settings navigation, or the navbar. | |
39 | * Each node can be one of two types either a Leaf (default) or a branch. | |
40 | * When a node is first created it is created as a leaf, when/if children are added | |
41 | * the node then becomes a branch. | |
42 | * | |
31fde54f AG |
43 | * @package core |
44 | * @category navigation | |
7d2a0492 | 45 | * @copyright 2009 Sam Hemelryk |
46 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
47 | */ | |
3406acde SH |
48 | class navigation_node implements renderable { |
49 | /** @var int Used to identify this node a leaf (default) 0 */ | |
507a7a9a | 50 | const NODETYPE_LEAF = 0; |
3406acde | 51 | /** @var int Used to identify this node a branch, happens with children 1 */ |
7d2a0492 | 52 | const NODETYPE_BRANCH = 1; |
3406acde | 53 | /** @var null Unknown node type null */ |
7d2a0492 | 54 | const TYPE_UNKNOWN = null; |
3406acde SH |
55 | /** @var int System node type 0 */ |
56 | const TYPE_ROOTNODE = 0; | |
57 | /** @var int System node type 1 */ | |
58 | const TYPE_SYSTEM = 1; | |
59 | /** @var int Category node type 10 */ | |
7d2a0492 | 60 | const TYPE_CATEGORY = 10; |
db47f68f RT |
61 | /** var int Category displayed in MyHome navigation node */ |
62 | const TYPE_MY_CATEGORY = 11; | |
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; |
5ab32c11 RT |
75 | /** @var int site admin branch node type, used only within settings nav 71 */ |
76 | const TYPE_SITE_ADMIN = 71; | |
3406acde | 77 | /** @var int Setting node type, used only within settings nav 80 */ |
507a7a9a | 78 | const TYPE_USER = 80; |
3406acde SH |
79 | /** @var int Setting node type, used for containers of no importance 90 */ |
80 | const TYPE_CONTAINER = 90; | |
6caf3f5c ARN |
81 | /** var int Course the current user is not enrolled in */ |
82 | const COURSE_OTHER = 0; | |
83 | /** var int Course the current user is enrolled in but not viewing */ | |
84 | const COURSE_MY = 1; | |
85 | /** var int Course the current user is currently viewing */ | |
86 | const COURSE_CURRENT = 2; | |
7d2a0492 | 87 | |
88 | /** @var int Parameter to aid the coder in tracking [optional] */ | |
89 | public $id = null; | |
90 | /** @var string|int The identifier for the node, used to retrieve the node */ | |
91 | public $key = null; | |
92 | /** @var string The text to use for the node */ | |
93 | public $text = null; | |
94 | /** @var string Short text to use if requested [optional] */ | |
95 | public $shorttext = null; | |
96 | /** @var string The title attribute for an action if one is defined */ | |
97 | public $title = null; | |
98 | /** @var string A string that can be used to build a help button */ | |
99 | public $helpbutton = null; | |
3406acde | 100 | /** @var moodle_url|action_link|null An action for the node (link) */ |
7d2a0492 | 101 | public $action = null; |
f9fc1461 | 102 | /** @var pix_icon The path to an icon to use for this node */ |
7d2a0492 | 103 | public $icon = null; |
104 | /** @var int See TYPE_* constants defined for this class */ | |
105 | public $type = self::TYPE_UNKNOWN; | |
106 | /** @var int See NODETYPE_* constants defined for this class */ | |
107 | public $nodetype = self::NODETYPE_LEAF; | |
108 | /** @var bool If set to true the node will be collapsed by default */ | |
109 | public $collapse = false; | |
110 | /** @var bool If set to true the node will be expanded by default */ | |
111 | public $forceopen = false; | |
3406acde | 112 | /** @var array An array of CSS classes for the node */ |
7d2a0492 | 113 | public $classes = array(); |
3406acde | 114 | /** @var navigation_node_collection An array of child nodes */ |
7d2a0492 | 115 | public $children = array(); |
116 | /** @var bool If set to true the node will be recognised as active */ | |
117 | public $isactive = false; | |
3406acde | 118 | /** @var bool If set to true the node will be dimmed */ |
7d2a0492 | 119 | public $hidden = false; |
120 | /** @var bool If set to false the node will not be displayed */ | |
121 | public $display = true; | |
122 | /** @var bool If set to true then an HR will be printed before the node */ | |
123 | public $preceedwithhr = false; | |
124 | /** @var bool If set to true the the navigation bar should ignore this node */ | |
125 | public $mainnavonly = false; | |
126 | /** @var bool If set to true a title will be added to the action no matter what */ | |
127 | public $forcetitle = false; | |
d38a4849 | 128 | /** @var navigation_node A reference to the node parent, you should never set this directly you should always call set_parent */ |
3406acde | 129 | public $parent = null; |
493a48f3 SH |
130 | /** @var bool Override to not display the icon even if one is provided **/ |
131 | public $hideicon = false; | |
58b602da SH |
132 | /** @var bool Set to true if we KNOW that this node can be expanded. */ |
133 | public $isexpandable = false; | |
7d2a0492 | 134 | /** @var array */ |
5ab32c11 | 135 | protected $namedtypes = array(0=>'system',10=>'category',20=>'course',30=>'structure',40=>'activity',50=>'resource',60=>'custom',70=>'setting',71=>'siteadmin', 80=>'user'); |
7d2a0492 | 136 | /** @var moodle_url */ |
137 | protected static $fullmeurl = null; | |
d9d2817a SH |
138 | /** @var bool toogles auto matching of active node */ |
139 | public static $autofindactive = true; | |
61bb8c93 PS |
140 | /** @var bool should we load full admin tree or rely on AJAX for performance reasons */ |
141 | protected static $loadadmintree = false; | |
d67e4821 | 142 | /** @var mixed If set to an int, that section will be included even if it has no activities */ |
143 | public $includesectionnum = false; | |
7d2a0492 | 144 | |
145 | /** | |
3406acde | 146 | * Constructs a new navigation_node |
7d2a0492 | 147 | * |
3406acde SH |
148 | * @param array|string $properties Either an array of properties or a string to use |
149 | * as the text for the node | |
7d2a0492 | 150 | */ |
151 | public function __construct($properties) { | |
7d2a0492 | 152 | if (is_array($properties)) { |
3406acde SH |
153 | // Check the array for each property that we allow to set at construction. |
154 | // text - The main content for the node | |
155 | // shorttext - A short text if required for the node | |
156 | // icon - The icon to display for the node | |
157 | // type - The type of the node | |
158 | // key - The key to use to identify the node | |
159 | // parent - A reference to the nodes parent | |
160 | // action - The action to attribute to this node, usually a URL to link to | |
7d2a0492 | 161 | if (array_key_exists('text', $properties)) { |
162 | $this->text = $properties['text']; | |
163 | } | |
164 | if (array_key_exists('shorttext', $properties)) { | |
165 | $this->shorttext = $properties['shorttext']; | |
166 | } | |
7081714d | 167 | if (!array_key_exists('icon', $properties)) { |
775fe700 | 168 | $properties['icon'] = new pix_icon('i/navigationitem', ''); |
7081714d SH |
169 | } |
170 | $this->icon = $properties['icon']; | |
171 | if ($this->icon instanceof pix_icon) { | |
172 | if (empty($this->icon->attributes['class'])) { | |
173 | $this->icon->attributes['class'] = 'navicon'; | |
174 | } else { | |
175 | $this->icon->attributes['class'] .= ' navicon'; | |
7da3a799 | 176 | } |
7d2a0492 | 177 | } |
178 | if (array_key_exists('type', $properties)) { | |
179 | $this->type = $properties['type']; | |
180 | } else { | |
181 | $this->type = self::TYPE_CUSTOM; | |
182 | } | |
183 | if (array_key_exists('key', $properties)) { | |
184 | $this->key = $properties['key']; | |
185 | } | |
3406acde SH |
186 | // This needs to happen last because of the check_if_active call that occurs |
187 | if (array_key_exists('action', $properties)) { | |
188 | $this->action = $properties['action']; | |
189 | if (is_string($this->action)) { | |
190 | $this->action = new moodle_url($this->action); | |
191 | } | |
192 | if (self::$autofindactive) { | |
193 | $this->check_if_active(); | |
194 | } | |
195 | } | |
d38a4849 SH |
196 | if (array_key_exists('parent', $properties)) { |
197 | $this->set_parent($properties['parent']); | |
198 | } | |
7d2a0492 | 199 | } else if (is_string($properties)) { |
200 | $this->text = $properties; | |
201 | } | |
202 | if ($this->text === null) { | |
203 | throw new coding_exception('You must set the text for the node when you create it.'); | |
204 | } | |
3406acde SH |
205 | // Instantiate a new navigation node collection for this nodes children |
206 | $this->children = new navigation_node_collection(); | |
7d2a0492 | 207 | } |
208 | ||
95b97515 | 209 | /** |
3406acde | 210 | * Checks if this node is the active node. |
0baa5d46 | 211 | * |
3406acde SH |
212 | * This is determined by comparing the action for the node against the |
213 | * defined URL for the page. A match will see this node marked as active. | |
0baa5d46 | 214 | * |
3406acde SH |
215 | * @param int $strength One of URL_MATCH_EXACT, URL_MATCH_PARAMS, or URL_MATCH_BASE |
216 | * @return bool | |
7d2a0492 | 217 | */ |
bf6c37c7 | 218 | public function check_if_active($strength=URL_MATCH_EXACT) { |
219 | global $FULLME, $PAGE; | |
3406acde | 220 | // Set fullmeurl if it hasn't already been set |
7d2a0492 | 221 | if (self::$fullmeurl == null) { |
bf6c37c7 | 222 | if ($PAGE->has_set_url()) { |
3406acde | 223 | self::override_active_url(new moodle_url($PAGE->url)); |
bf6c37c7 | 224 | } else { |
3406acde | 225 | self::override_active_url(new moodle_url($FULLME)); |
7d2a0492 | 226 | } |
227 | } | |
bf6c37c7 | 228 | |
3406acde | 229 | // Compare the action of this node against the fullmeurl |
bf6c37c7 | 230 | if ($this->action instanceof moodle_url && $this->action->compare(self::$fullmeurl, $strength)) { |
7d2a0492 | 231 | $this->make_active(); |
232 | return true; | |
7d2a0492 | 233 | } |
234 | return false; | |
235 | } | |
3406acde | 236 | |
7d2a0492 | 237 | /** |
d0cfbab3 SH |
238 | * This sets the URL that the URL of new nodes get compared to when locating |
239 | * the active node. | |
240 | * | |
241 | * The active node is the node that matches the URL set here. By default this | |
242 | * is either $PAGE->url or if that hasn't been set $FULLME. | |
7d2a0492 | 243 | * |
3406acde | 244 | * @param moodle_url $url The url to use for the fullmeurl. |
61bb8c93 | 245 | * @param bool $loadadmintree use true if the URL point to administration tree |
3406acde | 246 | */ |
61bb8c93 | 247 | public static function override_active_url(moodle_url $url, $loadadmintree = false) { |
633c0843 TH |
248 | // Clone the URL, in case the calling script changes their URL later. |
249 | self::$fullmeurl = new moodle_url($url); | |
61bb8c93 PS |
250 | // True means we do not want AJAX loaded admin tree, required for all admin pages. |
251 | if ($loadadmintree) { | |
252 | // Do not change back to false if already set. | |
253 | self::$loadadmintree = true; | |
254 | } | |
255 | } | |
256 | ||
257 | /** | |
258 | * Use when page is linked from the admin tree, | |
259 | * if not used navigation could not find the page using current URL | |
260 | * because the tree is not fully loaded. | |
261 | */ | |
262 | public static function require_admin_tree() { | |
263 | self::$loadadmintree = true; | |
3406acde SH |
264 | } |
265 | ||
266 | /** | |
188a8127 | 267 | * Creates a navigation node, ready to add it as a child using add_node |
268 | * function. (The created node needs to be added before you can use it.) | |
3406acde SH |
269 | * @param string $text |
270 | * @param moodle_url|action_link $action | |
271 | * @param int $type | |
272 | * @param string $shorttext | |
273 | * @param string|int $key | |
274 | * @param pix_icon $icon | |
275 | * @return navigation_node | |
7d2a0492 | 276 | */ |
188a8127 | 277 | public static function create($text, $action=null, $type=self::TYPE_CUSTOM, |
278 | $shorttext=null, $key=null, pix_icon $icon=null) { | |
3406acde SH |
279 | // Properties array used when creating the new navigation node |
280 | $itemarray = array( | |
281 | 'text' => $text, | |
282 | 'type' => $type | |
283 | ); | |
284 | // Set the action if one was provided | |
7d2a0492 | 285 | if ($action!==null) { |
286 | $itemarray['action'] = $action; | |
287 | } | |
3406acde | 288 | // Set the shorttext if one was provided |
7d2a0492 | 289 | if ($shorttext!==null) { |
290 | $itemarray['shorttext'] = $shorttext; | |
291 | } | |
3406acde | 292 | // Set the icon if one was provided |
7d2a0492 | 293 | if ($icon!==null) { |
294 | $itemarray['icon'] = $icon; | |
295 | } | |
3406acde | 296 | // Set the key |
7d2a0492 | 297 | $itemarray['key'] = $key; |
188a8127 | 298 | // Construct and return |
299 | return new navigation_node($itemarray); | |
300 | } | |
301 | ||
302 | /** | |
303 | * Adds a navigation node as a child of this node. | |
304 | * | |
305 | * @param string $text | |
306 | * @param moodle_url|action_link $action | |
307 | * @param int $type | |
308 | * @param string $shorttext | |
309 | * @param string|int $key | |
310 | * @param pix_icon $icon | |
311 | * @return navigation_node | |
312 | */ | |
313 | public function add($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, pix_icon $icon=null) { | |
314 | // Create child node | |
315 | $childnode = self::create($text, $action, $type, $shorttext, $key, $icon); | |
316 | ||
317 | // Add the child to end and return | |
318 | return $this->add_node($childnode); | |
319 | } | |
320 | ||
321 | /** | |
322 | * Adds a navigation node as a child of this one, given a $node object | |
323 | * created using the create function. | |
324 | * @param navigation_node $childnode Node to add | |
31fde54f | 325 | * @param string $beforekey |
188a8127 | 326 | * @return navigation_node The added node |
327 | */ | |
328 | public function add_node(navigation_node $childnode, $beforekey=null) { | |
329 | // First convert the nodetype for this node to a branch as it will now have children | |
330 | if ($this->nodetype !== self::NODETYPE_BRANCH) { | |
331 | $this->nodetype = self::NODETYPE_BRANCH; | |
332 | } | |
3406acde | 333 | // Set the parent to this node |
d38a4849 | 334 | $childnode->set_parent($this); |
188a8127 | 335 | |
336 | // Default the key to the number of children if not provided | |
337 | if ($childnode->key === null) { | |
338 | $childnode->key = $this->children->count(); | |
339 | } | |
340 | ||
3406acde | 341 | // Add the child using the navigation_node_collections add method |
188a8127 | 342 | $node = $this->children->add($childnode, $beforekey); |
343 | ||
344 | // If added node is a category node or the user is logged in and it's a course | |
345 | // then mark added node as a branch (makes it expandable by AJAX) | |
346 | $type = $childnode->type; | |
5ab32c11 RT |
347 | if (($type == self::TYPE_CATEGORY) || (isloggedin() && ($type == self::TYPE_COURSE)) || ($type == self::TYPE_MY_CATEGORY) || |
348 | ($type === self::TYPE_SITE_ADMIN)) { | |
3406acde | 349 | $node->nodetype = self::NODETYPE_BRANCH; |
7d2a0492 | 350 | } |
3406acde | 351 | // If this node is hidden mark it's children as hidden also |
7d2a0492 | 352 | if ($this->hidden) { |
3406acde | 353 | $node->hidden = true; |
7d2a0492 | 354 | } |
188a8127 | 355 | // Return added node (reference returned by $this->children->add() |
3406acde | 356 | return $node; |
7d2a0492 | 357 | } |
358 | ||
0c2f94e0 TH |
359 | /** |
360 | * Return a list of all the keys of all the child nodes. | |
361 | * @return array the keys. | |
362 | */ | |
363 | public function get_children_key_list() { | |
364 | return $this->children->get_key_list(); | |
365 | } | |
366 | ||
7d2a0492 | 367 | /** |
3406acde | 368 | * Searches for a node of the given type with the given key. |
7d2a0492 | 369 | * |
3406acde SH |
370 | * This searches this node plus all of its children, and their children.... |
371 | * If you know the node you are looking for is a child of this node then please | |
372 | * use the get method instead. | |
373 | * | |
374 | * @param int|string $key The key of the node we are looking for | |
375 | * @param int $type One of navigation_node::TYPE_* | |
376 | * @return navigation_node|false | |
7d2a0492 | 377 | */ |
3406acde SH |
378 | public function find($key, $type) { |
379 | return $this->children->find($key, $type); | |
380 | } | |
381 | ||
382 | /** | |
31fde54f | 383 | * Get the child of this node that has the given key + (optional) type. |
3406acde SH |
384 | * |
385 | * If you are looking for a node and want to search all children + thier children | |
386 | * then please use the find method instead. | |
387 | * | |
388 | * @param int|string $key The key of the node we are looking for | |
389 | * @param int $type One of navigation_node::TYPE_* | |
390 | * @return navigation_node|false | |
391 | */ | |
392 | public function get($key, $type=null) { | |
393 | return $this->children->get($key, $type); | |
394 | } | |
395 | ||
396 | /** | |
397 | * Removes this node. | |
398 | * | |
399 | * @return bool | |
400 | */ | |
401 | public function remove() { | |
402 | return $this->parent->children->remove($this->key, $this->type); | |
403 | } | |
404 | ||
405 | /** | |
406 | * Checks if this node has or could have any children | |
407 | * | |
408 | * @return bool Returns true if it has children or could have (by AJAX expansion) | |
409 | */ | |
410 | public function has_children() { | |
58b602da | 411 | return ($this->nodetype === navigation_node::NODETYPE_BRANCH || $this->children->count()>0 || $this->isexpandable); |
3406acde SH |
412 | } |
413 | ||
414 | /** | |
415 | * Marks this node as active and forces it open. | |
d0cfbab3 SH |
416 | * |
417 | * Important: If you are here because you need to mark a node active to get | |
93123b17 | 418 | * the navigation to do what you want have you looked at {@link navigation_node::override_active_url()}? |
d0cfbab3 SH |
419 | * You can use it to specify a different URL to match the active navigation node on |
420 | * rather than having to locate and manually mark a node active. | |
3406acde SH |
421 | */ |
422 | public function make_active() { | |
423 | $this->isactive = true; | |
424 | $this->add_class('active_tree_node'); | |
425 | $this->force_open(); | |
426 | if ($this->parent !== null) { | |
427 | $this->parent->make_inactive(); | |
428 | } | |
429 | } | |
430 | ||
431 | /** | |
432 | * Marks a node as inactive and recusised back to the base of the tree | |
433 | * doing the same to all parents. | |
434 | */ | |
435 | public function make_inactive() { | |
436 | $this->isactive = false; | |
437 | $this->remove_class('active_tree_node'); | |
438 | if ($this->parent !== null) { | |
439 | $this->parent->make_inactive(); | |
7d2a0492 | 440 | } |
441 | } | |
442 | ||
443 | /** | |
3406acde SH |
444 | * Forces this node to be open and at the same time forces open all |
445 | * parents until the root node. | |
117bd748 | 446 | * |
3406acde SH |
447 | * Recursive. |
448 | */ | |
449 | public function force_open() { | |
450 | $this->forceopen = true; | |
451 | if ($this->parent !== null) { | |
452 | $this->parent->force_open(); | |
453 | } | |
454 | } | |
455 | ||
456 | /** | |
457 | * Adds a CSS class to this node. | |
458 | * | |
459 | * @param string $class | |
460 | * @return bool | |
7d2a0492 | 461 | */ |
462 | public function add_class($class) { | |
463 | if (!in_array($class, $this->classes)) { | |
464 | $this->classes[] = $class; | |
465 | } | |
466 | return true; | |
467 | } | |
468 | ||
469 | /** | |
3406acde | 470 | * Removes a CSS class from this node. |
7d2a0492 | 471 | * |
472 | * @param string $class | |
3406acde | 473 | * @return bool True if the class was successfully removed. |
7d2a0492 | 474 | */ |
475 | public function remove_class($class) { | |
476 | if (in_array($class, $this->classes)) { | |
477 | $key = array_search($class,$this->classes); | |
478 | if ($key!==false) { | |
479 | unset($this->classes[$key]); | |
480 | return true; | |
481 | } | |
482 | } | |
483 | return false; | |
484 | } | |
485 | ||
486 | /** | |
3406acde SH |
487 | * Sets the title for this node and forces Moodle to utilise it. |
488 | * @param string $title | |
489 | */ | |
490 | public function title($title) { | |
491 | $this->title = $title; | |
492 | $this->forcetitle = true; | |
493 | } | |
494 | ||
495 | /** | |
496 | * Resets the page specific information on this node if it is being unserialised. | |
497 | */ | |
498 | public function __wakeup(){ | |
499 | $this->forceopen = false; | |
500 | $this->isactive = false; | |
501 | $this->remove_class('active_tree_node'); | |
502 | } | |
503 | ||
504 | /** | |
505 | * Checks if this node or any of its children contain the active node. | |
435a512e | 506 | * |
3406acde | 507 | * Recursive. |
7d2a0492 | 508 | * |
3406acde | 509 | * @return bool |
7d2a0492 | 510 | */ |
3406acde SH |
511 | public function contains_active_node() { |
512 | if ($this->isactive) { | |
7d2a0492 | 513 | return true; |
514 | } else { | |
3406acde SH |
515 | foreach ($this->children as $child) { |
516 | if ($child->isactive || $child->contains_active_node()) { | |
517 | return true; | |
518 | } | |
519 | } | |
7d2a0492 | 520 | } |
3406acde | 521 | return false; |
7d2a0492 | 522 | } |
523 | ||
524 | /** | |
3406acde SH |
525 | * Finds the active node. |
526 | * | |
527 | * Searches this nodes children plus all of the children for the active node | |
528 | * and returns it if found. | |
7d2a0492 | 529 | * |
3406acde SH |
530 | * Recursive. |
531 | * | |
532 | * @return navigation_node|false | |
7d2a0492 | 533 | */ |
3406acde SH |
534 | public function find_active_node() { |
535 | if ($this->isactive) { | |
536 | return $this; | |
537 | } else { | |
7d2a0492 | 538 | foreach ($this->children as &$child) { |
3406acde SH |
539 | $outcome = $child->find_active_node(); |
540 | if ($outcome !== false) { | |
541 | return $outcome; | |
7d2a0492 | 542 | } |
543 | } | |
7d2a0492 | 544 | } |
3406acde | 545 | return false; |
7d2a0492 | 546 | } |
547 | ||
7c4efe3b SH |
548 | /** |
549 | * Searches all children for the best matching active node | |
550 | * @return navigation_node|false | |
551 | */ | |
552 | public function search_for_active_node() { | |
553 | if ($this->check_if_active(URL_MATCH_BASE)) { | |
554 | return $this; | |
555 | } else { | |
556 | foreach ($this->children as &$child) { | |
557 | $outcome = $child->search_for_active_node(); | |
558 | if ($outcome !== false) { | |
559 | return $outcome; | |
560 | } | |
561 | } | |
562 | } | |
563 | return false; | |
564 | } | |
565 | ||
7d2a0492 | 566 | /** |
3406acde | 567 | * Gets the content for this node. |
7d2a0492 | 568 | * |
3406acde SH |
569 | * @param bool $shorttext If true shorttext is used rather than the normal text |
570 | * @return string | |
7d2a0492 | 571 | */ |
3406acde | 572 | public function get_content($shorttext=false) { |
7d2a0492 | 573 | if ($shorttext && $this->shorttext!==null) { |
3406acde | 574 | return format_string($this->shorttext); |
7d2a0492 | 575 | } else { |
3406acde | 576 | return format_string($this->text); |
1c4eef57 | 577 | } |
3406acde | 578 | } |
1c4eef57 | 579 | |
3406acde SH |
580 | /** |
581 | * Gets the title to use for this node. | |
435a512e | 582 | * |
3406acde SH |
583 | * @return string |
584 | */ | |
585 | public function get_title() { | |
bbfa9be0 | 586 | if ($this->forcetitle || $this->action != null){ |
3406acde SH |
587 | return $this->title; |
588 | } else { | |
9bf16314 PS |
589 | return ''; |
590 | } | |
7d2a0492 | 591 | } |
117bd748 | 592 | |
7d2a0492 | 593 | /** |
3406acde | 594 | * Gets the CSS class to add to this node to describe its type |
435a512e | 595 | * |
7d2a0492 | 596 | * @return string |
597 | */ | |
598 | public function get_css_type() { | |
599 | if (array_key_exists($this->type, $this->namedtypes)) { | |
600 | return 'type_'.$this->namedtypes[$this->type]; | |
601 | } | |
602 | return 'type_unknown'; | |
603 | } | |
604 | ||
605 | /** | |
3406acde | 606 | * Finds all nodes that are expandable by AJAX |
7d2a0492 | 607 | * |
3406acde | 608 | * @param array $expandable An array by reference to populate with expandable nodes. |
7d2a0492 | 609 | */ |
3406acde | 610 | public function find_expandable(array &$expandable) { |
3406acde | 611 | foreach ($this->children as &$child) { |
58b602da | 612 | if ($child->display && $child->has_children() && $child->children->count() == 0) { |
09da042b | 613 | $child->id = 'expandable_branch_'.$child->type.'_'.clean_param($child->key, PARAM_ALPHANUMEXT); |
3406acde | 614 | $this->add_class('canexpand'); |
8ad24c1a | 615 | $expandable[] = array('id' => $child->id, 'key' => $child->key, 'type' => $child->type); |
7d2a0492 | 616 | } |
3406acde | 617 | $child->find_expandable($expandable); |
7d2a0492 | 618 | } |
7d2a0492 | 619 | } |
88f77c3c | 620 | |
4766a50c SH |
621 | /** |
622 | * Finds all nodes of a given type (recursive) | |
623 | * | |
31fde54f | 624 | * @param int $type One of navigation_node::TYPE_* |
4766a50c SH |
625 | * @return array |
626 | */ | |
88f77c3c SH |
627 | public function find_all_of_type($type) { |
628 | $nodes = $this->children->type($type); | |
629 | foreach ($this->children as &$node) { | |
630 | $childnodes = $node->find_all_of_type($type); | |
631 | $nodes = array_merge($nodes, $childnodes); | |
632 | } | |
633 | return $nodes; | |
634 | } | |
56ed242b SH |
635 | |
636 | /** | |
637 | * Removes this node if it is empty | |
638 | */ | |
639 | public function trim_if_empty() { | |
640 | if ($this->children->count() == 0) { | |
641 | $this->remove(); | |
642 | } | |
643 | } | |
644 | ||
645 | /** | |
646 | * Creates a tab representation of this nodes children that can be used | |
647 | * with print_tabs to produce the tabs on a page. | |
648 | * | |
649 | * call_user_func_array('print_tabs', $node->get_tabs_array()); | |
650 | * | |
651 | * @param array $inactive | |
652 | * @param bool $return | |
653 | * @return array Array (tabs, selected, inactive, activated, return) | |
654 | */ | |
655 | public function get_tabs_array(array $inactive=array(), $return=false) { | |
656 | $tabs = array(); | |
657 | $rows = array(); | |
658 | $selected = null; | |
659 | $activated = array(); | |
660 | foreach ($this->children as $node) { | |
661 | $tabs[] = new tabobject($node->key, $node->action, $node->get_content(), $node->get_title()); | |
662 | if ($node->contains_active_node()) { | |
663 | if ($node->children->count() > 0) { | |
664 | $activated[] = $node->key; | |
665 | foreach ($node->children as $child) { | |
666 | if ($child->contains_active_node()) { | |
667 | $selected = $child->key; | |
668 | } | |
669 | $rows[] = new tabobject($child->key, $child->action, $child->get_content(), $child->get_title()); | |
670 | } | |
671 | } else { | |
672 | $selected = $node->key; | |
673 | } | |
674 | } | |
675 | } | |
676 | return array(array($tabs, $rows), $selected, $inactive, $activated, $return); | |
677 | } | |
d38a4849 SH |
678 | |
679 | /** | |
680 | * Sets the parent for this node and if this node is active ensures that the tree is properly | |
681 | * adjusted as well. | |
682 | * | |
683 | * @param navigation_node $parent | |
684 | */ | |
685 | public function set_parent(navigation_node $parent) { | |
686 | // Set the parent (thats the easy part) | |
687 | $this->parent = $parent; | |
688 | // Check if this node is active (this is checked during construction) | |
689 | if ($this->isactive) { | |
690 | // Force all of the parent nodes open so you can see this node | |
691 | $this->parent->force_open(); | |
692 | // Make all parents inactive so that its clear where we are. | |
693 | $this->parent->make_inactive(); | |
694 | } | |
695 | } | |
ba7b1ca5 SH |
696 | |
697 | /** | |
698 | * Hides the node and any children it has. | |
699 | * | |
5bcfd504 | 700 | * @since Moodle 2.5 |
8718ffba SH |
701 | * @param array $typestohide Optional. An array of node types that should be hidden. |
702 | * If null all nodes will be hidden. | |
703 | * If an array is given then nodes will only be hidden if their type mtatches an element in the array. | |
704 | * e.g. array(navigation_node::TYPE_COURSE) would hide only course nodes. | |
705 | */ | |
706 | public function hide(array $typestohide = null) { | |
707 | if ($typestohide === null || in_array($this->type, $typestohide)) { | |
708 | $this->display = false; | |
709 | if ($this->has_children()) { | |
710 | foreach ($this->children as $child) { | |
711 | $child->hide($typestohide); | |
712 | } | |
ba7b1ca5 SH |
713 | } |
714 | } | |
715 | } | |
3406acde | 716 | } |
7d2a0492 | 717 | |
3406acde SH |
718 | /** |
719 | * Navigation node collection | |
720 | * | |
721 | * This class is responsible for managing a collection of navigation nodes. | |
722 | * It is required because a node's unique identifier is a combination of both its | |
723 | * key and its type. | |
724 | * | |
725 | * Originally an array was used with a string key that was a combination of the two | |
726 | * however it was decided that a better solution would be to use a class that | |
727 | * implements the standard IteratorAggregate interface. | |
728 | * | |
31fde54f AG |
729 | * @package core |
730 | * @category navigation | |
3406acde SH |
731 | * @copyright 2010 Sam Hemelryk |
732 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
733 | */ | |
734 | class navigation_node_collection implements IteratorAggregate { | |
7d2a0492 | 735 | /** |
3406acde SH |
736 | * A multidimensional array to where the first key is the type and the second |
737 | * key is the nodes key. | |
738 | * @var array | |
7d2a0492 | 739 | */ |
3406acde | 740 | protected $collection = array(); |
7d2a0492 | 741 | /** |
3406acde SH |
742 | * An array that contains references to nodes in the same order they were added. |
743 | * This is maintained as a progressive array. | |
744 | * @var array | |
7d2a0492 | 745 | */ |
3406acde | 746 | protected $orderedcollection = array(); |
da3ab9c4 | 747 | /** |
3406acde SH |
748 | * A reference to the last node that was added to the collection |
749 | * @var navigation_node | |
da3ab9c4 | 750 | */ |
3406acde | 751 | protected $last = null; |
6644741d | 752 | /** |
3406acde SH |
753 | * The total number of items added to this array. |
754 | * @var int | |
6644741d | 755 | */ |
3406acde | 756 | protected $count = 0; |
0c2f94e0 | 757 | |
7d2a0492 | 758 | /** |
3406acde | 759 | * Adds a navigation node to the collection |
7d2a0492 | 760 | * |
188a8127 | 761 | * @param navigation_node $node Node to add |
762 | * @param string $beforekey If specified, adds before a node with this key, | |
763 | * otherwise adds at end | |
764 | * @return navigation_node Added node | |
7d2a0492 | 765 | */ |
188a8127 | 766 | public function add(navigation_node $node, $beforekey=null) { |
3406acde SH |
767 | global $CFG; |
768 | $key = $node->key; | |
769 | $type = $node->type; | |
188a8127 | 770 | |
3406acde SH |
771 | // First check we have a 2nd dimension for this type |
772 | if (!array_key_exists($type, $this->orderedcollection)) { | |
773 | $this->orderedcollection[$type] = array(); | |
7d2a0492 | 774 | } |
3406acde SH |
775 | // Check for a collision and report if debugging is turned on |
776 | if ($CFG->debug && array_key_exists($key, $this->orderedcollection[$type])) { | |
777 | debugging('Navigation node intersect: Adding a node that already exists '.$key, DEBUG_DEVELOPER); | |
7d2a0492 | 778 | } |
188a8127 | 779 | |
780 | // Find the key to add before | |
781 | $newindex = $this->count; | |
782 | $last = true; | |
783 | if ($beforekey !== null) { | |
784 | foreach ($this->collection as $index => $othernode) { | |
785 | if ($othernode->key === $beforekey) { | |
786 | $newindex = $index; | |
787 | $last = false; | |
788 | break; | |
789 | } | |
790 | } | |
791 | if ($newindex === $this->count) { | |
188a8127 | 792 | debugging('Navigation node add_before: Reference node not found ' . $beforekey . |
0c2f94e0 | 793 | ', options: ' . implode(' ', $this->get_key_list()), DEBUG_DEVELOPER); |
188a8127 | 794 | } |
795 | } | |
796 | ||
797 | // Add the node to the appropriate place in the by-type structure (which | |
798 | // is not ordered, despite the variable name) | |
3406acde | 799 | $this->orderedcollection[$type][$key] = $node; |
188a8127 | 800 | if (!$last) { |
801 | // Update existing references in the ordered collection (which is the | |
802 | // one that isn't called 'ordered') to shuffle them along if required | |
803 | for ($oldindex = $this->count; $oldindex > $newindex; $oldindex--) { | |
804 | $this->collection[$oldindex] = $this->collection[$oldindex - 1]; | |
805 | } | |
806 | } | |
3406acde | 807 | // Add a reference to the node to the progressive collection. |
082513ba | 808 | $this->collection[$newindex] = $this->orderedcollection[$type][$key]; |
3406acde | 809 | // Update the last property to a reference to this new node. |
082513ba | 810 | $this->last = $this->orderedcollection[$type][$key]; |
5436561c | 811 | |
188a8127 | 812 | // Reorder the array by index if needed |
813 | if (!$last) { | |
814 | ksort($this->collection); | |
188a8127 | 815 | } |
3406acde SH |
816 | $this->count++; |
817 | // Return the reference to the now added node | |
188a8127 | 818 | return $node; |
7d2a0492 | 819 | } |
820 | ||
0c2f94e0 TH |
821 | /** |
822 | * Return a list of all the keys of all the nodes. | |
823 | * @return array the keys. | |
824 | */ | |
825 | public function get_key_list() { | |
826 | $keys = array(); | |
827 | foreach ($this->collection as $node) { | |
828 | $keys[] = $node->key; | |
829 | } | |
830 | return $keys; | |
831 | } | |
832 | ||
7d2a0492 | 833 | /** |
3406acde | 834 | * Fetches a node from this collection. |
7d2a0492 | 835 | * |
3406acde SH |
836 | * @param string|int $key The key of the node we want to find. |
837 | * @param int $type One of navigation_node::TYPE_*. | |
838 | * @return navigation_node|null | |
7d2a0492 | 839 | */ |
3406acde SH |
840 | public function get($key, $type=null) { |
841 | if ($type !== null) { | |
842 | // If the type is known then we can simply check and fetch | |
843 | if (!empty($this->orderedcollection[$type][$key])) { | |
844 | return $this->orderedcollection[$type][$key]; | |
845 | } | |
846 | } else { | |
847 | // Because we don't know the type we look in the progressive array | |
848 | foreach ($this->collection as $node) { | |
849 | if ($node->key === $key) { | |
850 | return $node; | |
7d2a0492 | 851 | } |
852 | } | |
853 | } | |
854 | return false; | |
855 | } | |
0c2f94e0 | 856 | |
7d2a0492 | 857 | /** |
3406acde | 858 | * Searches for a node with matching key and type. |
7d2a0492 | 859 | * |
3406acde SH |
860 | * This function searches both the nodes in this collection and all of |
861 | * the nodes in each collection belonging to the nodes in this collection. | |
7d2a0492 | 862 | * |
3406acde | 863 | * Recursive. |
7d2a0492 | 864 | * |
3406acde SH |
865 | * @param string|int $key The key of the node we want to find. |
866 | * @param int $type One of navigation_node::TYPE_*. | |
867 | * @return navigation_node|null | |
7d2a0492 | 868 | */ |
3406acde SH |
869 | public function find($key, $type=null) { |
870 | if ($type !== null && array_key_exists($type, $this->orderedcollection) && array_key_exists($key, $this->orderedcollection[$type])) { | |
871 | return $this->orderedcollection[$type][$key]; | |
872 | } else { | |
873 | $nodes = $this->getIterator(); | |
874 | // Search immediate children first | |
875 | foreach ($nodes as &$node) { | |
d9219fc9 | 876 | if ($node->key === $key && ($type === null || $type === $node->type)) { |
3406acde | 877 | return $node; |
d926f4b1 | 878 | } |
3406acde SH |
879 | } |
880 | // Now search each childs children | |
881 | foreach ($nodes as &$node) { | |
882 | $result = $node->children->find($key, $type); | |
883 | if ($result !== false) { | |
884 | return $result; | |
d926f4b1 | 885 | } |
7d2a0492 | 886 | } |
887 | } | |
888 | return false; | |
889 | } | |
890 | ||
d926f4b1 | 891 | /** |
3406acde | 892 | * Fetches the last node that was added to this collection |
435a512e | 893 | * |
3406acde | 894 | * @return navigation_node |
d926f4b1 | 895 | */ |
3406acde SH |
896 | public function last() { |
897 | return $this->last; | |
898 | } | |
0c2f94e0 | 899 | |
3406acde SH |
900 | /** |
901 | * Fetches all nodes of a given type from this collection | |
31fde54f AG |
902 | * |
903 | * @param string|int $type node type being searched for. | |
904 | * @return array ordered collection | |
3406acde SH |
905 | */ |
906 | public function type($type) { | |
907 | if (!array_key_exists($type, $this->orderedcollection)) { | |
908 | $this->orderedcollection[$type] = array(); | |
d926f4b1 | 909 | } |
3406acde | 910 | return $this->orderedcollection[$type]; |
d926f4b1 | 911 | } |
7d2a0492 | 912 | /** |
3406acde | 913 | * Removes the node with the given key and type from the collection |
7d2a0492 | 914 | * |
31fde54f | 915 | * @param string|int $key The key of the node we want to find. |
3406acde SH |
916 | * @param int $type |
917 | * @return bool | |
7d2a0492 | 918 | */ |
3406acde SH |
919 | public function remove($key, $type=null) { |
920 | $child = $this->get($key, $type); | |
921 | if ($child !== false) { | |
922 | foreach ($this->collection as $colkey => $node) { | |
e3b11a6e | 923 | if ($node->key === $key && $node->type == $type) { |
3406acde | 924 | unset($this->collection[$colkey]); |
5150c302 | 925 | $this->collection = array_values($this->collection); |
3406acde SH |
926 | break; |
927 | } | |
7d2a0492 | 928 | } |
3406acde SH |
929 | unset($this->orderedcollection[$child->type][$child->key]); |
930 | $this->count--; | |
931 | return true; | |
7d2a0492 | 932 | } |
3406acde | 933 | return false; |
7d2a0492 | 934 | } |
935 | ||
9da1ec27 | 936 | /** |
3406acde | 937 | * Gets the number of nodes in this collection |
e26507b3 SH |
938 | * |
939 | * This option uses an internal count rather than counting the actual options to avoid | |
940 | * a performance hit through the count function. | |
941 | * | |
3406acde | 942 | * @return int |
7d2a0492 | 943 | */ |
3406acde | 944 | public function count() { |
e26507b3 | 945 | return $this->count; |
7d2a0492 | 946 | } |
7d2a0492 | 947 | /** |
3406acde | 948 | * Gets an array iterator for the collection. |
7d2a0492 | 949 | * |
3406acde SH |
950 | * This is required by the IteratorAggregator interface and is used by routines |
951 | * such as the foreach loop. | |
7d2a0492 | 952 | * |
3406acde | 953 | * @return ArrayIterator |
7d2a0492 | 954 | */ |
3406acde SH |
955 | public function getIterator() { |
956 | return new ArrayIterator($this->collection); | |
7d2a0492 | 957 | } |
958 | } | |
959 | ||
960 | /** | |
961 | * The global navigation class used for... the global navigation | |
962 | * | |
963 | * This class is used by PAGE to store the global navigation for the site | |
964 | * and is then used by the settings nav and navbar to save on processing and DB calls | |
965 | * | |
966 | * See | |
93123b17 | 967 | * {@link lib/pagelib.php} {@link moodle_page::initialise_theme_and_output()} |
31fde54f | 968 | * {@link lib/ajax/getnavbranch.php} Called by ajax |
7d2a0492 | 969 | * |
31fde54f AG |
970 | * @package core |
971 | * @category navigation | |
7d2a0492 | 972 | * @copyright 2009 Sam Hemelryk |
973 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
974 | */ | |
975 | class global_navigation extends navigation_node { | |
31fde54f | 976 | /** @var moodle_page The Moodle page this navigation object belongs to. */ |
3406acde | 977 | protected $page; |
31fde54f | 978 | /** @var bool switch to let us know if the navigation object is initialised*/ |
7d2a0492 | 979 | protected $initialised = false; |
31fde54f | 980 | /** @var array An array of course information */ |
3406acde | 981 | protected $mycourses = array(); |
aab6438c | 982 | /** @var navigation_node[] An array for containing root navigation nodes */ |
3406acde | 983 | protected $rootnodes = array(); |
31fde54f | 984 | /** @var bool A switch for whether to show empty sections in the navigation */ |
fe221dd5 | 985 | protected $showemptysections = true; |
31fde54f | 986 | /** @var bool A switch for whether courses should be shown within categories on the navigation. */ |
9bf5af21 | 987 | protected $showcategories = null; |
58b602da SH |
988 | /** @var null@var bool A switch for whether or not to show categories in the my courses branch. */ |
989 | protected $showmycategories = null; | |
31fde54f | 990 | /** @var array An array of stdClasses for users that the navigation is extended for */ |
7a7e209d | 991 | protected $extendforuser = array(); |
3406acde SH |
992 | /** @var navigation_cache */ |
993 | protected $cache; | |
31fde54f | 994 | /** @var array An array of course ids that are present in the navigation */ |
3406acde | 995 | protected $addedcourses = array(); |
8e8de15f SH |
996 | /** @var bool */ |
997 | protected $allcategoriesloaded = false; | |
31fde54f | 998 | /** @var array An array of category ids that are included in the navigation */ |
e26507b3 | 999 | protected $addedcategories = array(); |
31fde54f | 1000 | /** @var int expansion limit */ |
88f77c3c | 1001 | protected $expansionlimit = 0; |
31fde54f | 1002 | /** @var int userid to allow parent to see child's profile page navigation */ |
870815fa | 1003 | protected $useridtouseforparentchecks = 0; |
cbd063f4 SH |
1004 | /** @var cache_session A cache that stores information on expanded courses */ |
1005 | protected $cacheexpandcourse = null; | |
88f77c3c | 1006 | |
8e8de15f SH |
1007 | /** Used when loading categories to load all top level categories [parent = 0] **/ |
1008 | const LOAD_ROOT_CATEGORIES = 0; | |
1009 | /** Used when loading categories to load all categories **/ | |
1010 | const LOAD_ALL_CATEGORIES = -1; | |
1011 | ||
7d2a0492 | 1012 | /** |
3406acde SH |
1013 | * Constructs a new global navigation |
1014 | * | |
3406acde | 1015 | * @param moodle_page $page The page this navigation object belongs to |
7d2a0492 | 1016 | */ |
3406acde | 1017 | public function __construct(moodle_page $page) { |
4766a50c | 1018 | global $CFG, $SITE, $USER; |
3406acde | 1019 | |
7d2a0492 | 1020 | if (during_initial_install()) { |
3406acde | 1021 | return; |
7d2a0492 | 1022 | } |
3406acde | 1023 | |
4766a50c SH |
1024 | if (get_home_page() == HOMEPAGE_SITE) { |
1025 | // We are using the site home for the root element | |
1026 | $properties = array( | |
1027 | 'key' => 'home', | |
1028 | 'type' => navigation_node::TYPE_SYSTEM, | |
1029 | 'text' => get_string('home'), | |
1030 | 'action' => new moodle_url('/') | |
1031 | ); | |
1032 | } else { | |
1033 | // We are using the users my moodle for the root element | |
1034 | $properties = array( | |
1035 | 'key' => 'myhome', | |
1036 | 'type' => navigation_node::TYPE_SYSTEM, | |
1037 | 'text' => get_string('myhome'), | |
1038 | 'action' => new moodle_url('/my/') | |
1039 | ); | |
dd8e5011 | 1040 | } |
4766a50c | 1041 | |
31fde54f | 1042 | // Use the parents constructor.... good good reuse |
3406acde SH |
1043 | parent::__construct($properties); |
1044 | ||
1045 | // Initalise and set defaults | |
1046 | $this->page = $page; | |
7d2a0492 | 1047 | $this->forceopen = true; |
f5b5a822 | 1048 | $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME); |
7d2a0492 | 1049 | } |
1050 | ||
b9bcad24 AB |
1051 | /** |
1052 | * Mutator to set userid to allow parent to see child's profile | |
1053 | * page navigation. See MDL-25805 for initial issue. Linked to it | |
1054 | * is an issue explaining why this is a REALLY UGLY HACK thats not | |
1055 | * for you to use! | |
1056 | * | |
5607036a | 1057 | * @param int $userid userid of profile page that parent wants to navigate around. |
b9bcad24 | 1058 | */ |
870815fa SH |
1059 | public function set_userid_for_parent_checks($userid) { |
1060 | $this->useridtouseforparentchecks = $userid; | |
b9bcad24 AB |
1061 | } |
1062 | ||
1063 | ||
7d2a0492 | 1064 | /** |
3406acde | 1065 | * Initialises the navigation object. |
7d2a0492 | 1066 | * |
3406acde SH |
1067 | * This causes the navigation object to look at the current state of the page |
1068 | * that it is associated with and then load the appropriate content. | |
7d2a0492 | 1069 | * |
3406acde SH |
1070 | * This should only occur the first time that the navigation structure is utilised |
1071 | * which will normally be either when the navbar is called to be displayed or | |
1072 | * when a block makes use of it. | |
7d2a0492 | 1073 | * |
3406acde | 1074 | * @return bool |
7d2a0492 | 1075 | */ |
3406acde | 1076 | public function initialise() { |
58b602da SH |
1077 | global $CFG, $SITE, $USER; |
1078 | // Check if it has already been initialised | |
7d2a0492 | 1079 | if ($this->initialised || during_initial_install()) { |
1080 | return true; | |
1081 | } | |
e2b436d0 | 1082 | $this->initialised = true; |
3406acde SH |
1083 | |
1084 | // Set up the five base root nodes. These are nodes where we will put our | |
1085 | // content and are as follows: | |
58b602da SH |
1086 | // site: Navigation for the front page. |
1087 | // myprofile: User profile information goes here. | |
1088 | // currentcourse: The course being currently viewed. | |
1089 | // mycourses: The users courses get added here. | |
1090 | // courses: Additional courses are added here. | |
1091 | // users: Other users information loaded here. | |
3406acde | 1092 | $this->rootnodes = array(); |
4766a50c | 1093 | if (get_home_page() == HOMEPAGE_SITE) { |
3f9ccf85 | 1094 | // The home element should be my moodle because the root element is the site |
b9d4c7d3 | 1095 | if (isloggedin() && !isguestuser()) { // Makes no sense if you aren't logged in |
e26507b3 | 1096 | $this->rootnodes['home'] = $this->add(get_string('myhome'), new moodle_url('/my/'), self::TYPE_SETTING, null, 'home'); |
3f9ccf85 | 1097 | } |
4766a50c SH |
1098 | } else { |
1099 | // The home element should be the site because the root node is my moodle | |
e26507b3 | 1100 | $this->rootnodes['home'] = $this->add(get_string('sitehome'), new moodle_url('/'), self::TYPE_SETTING, null, 'home'); |
ab6ec58a | 1101 | if (!empty($CFG->defaulthomepage) && ($CFG->defaulthomepage == HOMEPAGE_MY)) { |
4766a50c SH |
1102 | // We need to stop automatic redirection |
1103 | $this->rootnodes['home']->action->param('redirect', '0'); | |
1104 | } | |
1105 | } | |
58b602da | 1106 | $this->rootnodes['site'] = $this->add_course($SITE); |
e26507b3 | 1107 | $this->rootnodes['myprofile'] = $this->add(get_string('myprofile'), null, self::TYPE_USER, null, 'myprofile'); |
6caf3f5c | 1108 | $this->rootnodes['currentcourse'] = $this->add(get_string('currentcourse'), null, self::TYPE_ROOTNODE, null, 'currentcourse'); |
4c9464ca | 1109 | $this->rootnodes['mycourses'] = $this->add(get_string('mycourses'), new moodle_url('/my/'), self::TYPE_ROOTNODE, null, 'mycourses'); |
58b602da SH |
1110 | $this->rootnodes['courses'] = $this->add(get_string('courses'), new moodle_url('/course/index.php'), self::TYPE_ROOTNODE, null, 'courses'); |
1111 | $this->rootnodes['users'] = $this->add(get_string('users'), null, self::TYPE_ROOTNODE, null, 'users'); | |
3406acde | 1112 | |
80c69522 SH |
1113 | // We always load the frontpage course to ensure it is available without |
1114 | // JavaScript enabled. | |
1115 | $this->add_front_page_course_essentials($this->rootnodes['site'], $SITE); | |
1116 | $this->load_course_sections($SITE, $this->rootnodes['site']); | |
1117 | ||
58b602da SH |
1118 | $course = $this->page->course; |
1119 | ||
8e8de15f | 1120 | // $issite gets set to true if the current pages course is the sites frontpage course |
98556b23 | 1121 | $issite = ($this->page->course->id == $SITE->id); |
58b602da SH |
1122 | // Determine if the user is enrolled in any course. |
1123 | $enrolledinanycourse = enrol_user_sees_own_courses(); | |
4766a50c | 1124 | |
58b602da SH |
1125 | $this->rootnodes['currentcourse']->mainnavonly = true; |
1126 | if ($enrolledinanycourse) { | |
1127 | $this->rootnodes['mycourses']->isexpandable = true; | |
1128 | if ($CFG->navshowallcourses) { | |
1129 | // When we show all courses we need to show both the my courses and the regular courses branch. | |
1130 | $this->rootnodes['courses']->isexpandable = true; | |
8e8de15f | 1131 | } |
58b602da SH |
1132 | } else { |
1133 | $this->rootnodes['courses']->isexpandable = true; | |
3406acde SH |
1134 | } |
1135 | ||
aab6438c SH |
1136 | // Load the users enrolled courses if they are viewing the My Moodle page AND the admin has not |
1137 | // set that they wish to keep the My Courses branch collapsed by default. | |
99f041eb | 1138 | if (!empty($CFG->navexpandmycourses) && $this->rootnodes['mycourses']->isactive){ |
aab6438c SH |
1139 | $this->load_courses_enrolled(); |
1140 | } else { | |
1141 | $this->rootnodes['mycourses']->collapse = true; | |
1142 | $this->rootnodes['mycourses']->make_inactive(); | |
f87ce4e9 SH |
1143 | } |
1144 | ||
cede87e0 SH |
1145 | $canviewcourseprofile = true; |
1146 | ||
6a16e136 SH |
1147 | // Next load context specific content into the navigation |
1148 | switch ($this->page->context->contextlevel) { | |
1149 | case CONTEXT_SYSTEM : | |
58b602da | 1150 | // Nothing left to do here I feel. |
6a16e136 SH |
1151 | break; |
1152 | case CONTEXT_COURSECAT : | |
58b602da SH |
1153 | // This is essential, we must load categories. |
1154 | $this->load_all_categories($this->page->context->instanceid, true); | |
6a16e136 SH |
1155 | break; |
1156 | case CONTEXT_BLOCK : | |
1157 | case CONTEXT_COURSE : | |
1158 | if ($issite) { | |
58b602da | 1159 | // Nothing left to do here. |
56c062a4 | 1160 | break; |
6a16e136 | 1161 | } |
b9bcad24 | 1162 | |
6caf3f5c | 1163 | // Load the course associated with the current page into the navigation. |
6caf3f5c | 1164 | $coursenode = $this->add_course($course, false, self::COURSE_CURRENT); |
6a16e136 SH |
1165 | // If the course wasn't added then don't try going any further. |
1166 | if (!$coursenode) { | |
1167 | $canviewcourseprofile = false; | |
1168 | break; | |
1169 | } | |
e26507b3 | 1170 | |
6a16e136 SH |
1171 | // If the user is not enrolled then we only want to show the |
1172 | // course node and not populate it. | |
1173 | ||
1174 | // Not enrolled, can't view, and hasn't switched roles | |
1175 | if (!can_access_course($course)) { | |
cbd063f4 SH |
1176 | if ($coursenode->isexpandable === true) { |
1177 | // Obviously the situation has changed, update the cache and adjust the node. | |
1178 | // This occurs if the user access to a course has been revoked (one way or another) after | |
1179 | // initially logging in for this session. | |
1180 | $this->get_expand_course_cache()->set($course->id, 1); | |
1181 | $coursenode->isexpandable = true; | |
1182 | $coursenode->nodetype = self::NODETYPE_BRANCH; | |
1183 | } | |
58b602da | 1184 | // Very ugly hack - do not force "parents" to enrol into course their child is enrolled in, |
6a16e136 | 1185 | // this hack has been propagated from user/view.php to display the navigation node. (MDL-25805) |
58b602da | 1186 | if (!$this->current_user_is_parent_role()) { |
56c062a4 | 1187 | $coursenode->make_active(); |
6a16e136 SH |
1188 | $canviewcourseprofile = false; |
1189 | break; | |
1190 | } | |
1191 | } | |
6caf3f5c | 1192 | |
cbd063f4 SH |
1193 | if ($coursenode->isexpandable === false) { |
1194 | // Obviously the situation has changed, update the cache and adjust the node. | |
1195 | // This occurs if the user has been granted access to a course (one way or another) after initially | |
1196 | // logging in for this session. | |
1197 | $this->get_expand_course_cache()->set($course->id, 1); | |
1198 | $coursenode->isexpandable = true; | |
1199 | $coursenode->nodetype = self::NODETYPE_BRANCH; | |
1200 | } | |
1201 | ||
6a16e136 SH |
1202 | // Add the essentials such as reports etc... |
1203 | $this->add_course_essentials($coursenode, $course); | |
ee7084e9 MG |
1204 | // Extend course navigation with it's sections/activities |
1205 | $this->load_course_sections($course, $coursenode); | |
6a16e136 SH |
1206 | if (!$coursenode->contains_active_node() && !$coursenode->search_for_active_node()) { |
1207 | $coursenode->make_active(); | |
1208 | } | |
6caf3f5c | 1209 | |
6a16e136 SH |
1210 | break; |
1211 | case CONTEXT_MODULE : | |
1212 | if ($issite) { | |
1213 | // If this is the site course then most information will have | |
1214 | // already been loaded. | |
1215 | // However we need to check if there is more content that can | |
1216 | // yet be loaded for the specific module instance. | |
e010b850 | 1217 | $activitynode = $this->rootnodes['site']->find($this->page->cm->id, navigation_node::TYPE_ACTIVITY); |
6a16e136 SH |
1218 | if ($activitynode) { |
1219 | $this->load_activity($this->page->cm, $this->page->course, $activitynode); | |
56c062a4 | 1220 | } |
2027c10e | 1221 | break; |
6a16e136 | 1222 | } |
2027c10e | 1223 | |
6a16e136 SH |
1224 | $course = $this->page->course; |
1225 | $cm = $this->page->cm; | |
cede87e0 | 1226 | |
6a16e136 | 1227 | // Load the course associated with the page into the navigation |
58b602da | 1228 | $coursenode = $this->add_course($course, false, self::COURSE_CURRENT); |
56c062a4 | 1229 | |
6a16e136 SH |
1230 | // If the course wasn't added then don't try going any further. |
1231 | if (!$coursenode) { | |
1232 | $canviewcourseprofile = false; | |
1233 | break; | |
1234 | } | |
1235 | ||
1236 | // If the user is not enrolled then we only want to show the | |
1237 | // course node and not populate it. | |
1238 | if (!can_access_course($course)) { | |
1239 | $coursenode->make_active(); | |
1240 | $canviewcourseprofile = false; | |
1241 | break; | |
1242 | } | |
56c062a4 | 1243 | |
6a16e136 | 1244 | $this->add_course_essentials($coursenode, $course); |
56c062a4 | 1245 | |
6a16e136 | 1246 | // Load the course sections into the page |
e010b850 MG |
1247 | $this->load_course_sections($course, $coursenode, null, $cm); |
1248 | $activity = $coursenode->find($cm->id, navigation_node::TYPE_ACTIVITY); | |
069c29b9 DM |
1249 | if (!empty($activity)) { |
1250 | // Finally load the cm specific navigaton information | |
1251 | $this->load_activity($cm, $course, $activity); | |
1252 | // Check if we have an active ndoe | |
1253 | if (!$activity->contains_active_node() && !$activity->search_for_active_node()) { | |
1254 | // And make the activity node active. | |
1255 | $activity->make_active(); | |
1256 | } | |
6a16e136 SH |
1257 | } |
1258 | break; | |
1259 | case CONTEXT_USER : | |
1260 | if ($issite) { | |
1261 | // The users profile information etc is already loaded | |
1262 | // for the front page. | |
96e78552 | 1263 | break; |
6a16e136 SH |
1264 | } |
1265 | $course = $this->page->course; | |
6a16e136 | 1266 | // Load the course associated with the user into the navigation |
58b602da | 1267 | $coursenode = $this->add_course($course, false, self::COURSE_CURRENT); |
2027c10e | 1268 | |
6a16e136 SH |
1269 | // If the course wasn't added then don't try going any further. |
1270 | if (!$coursenode) { | |
1271 | $canviewcourseprofile = false; | |
1272 | break; | |
1273 | } | |
2027c10e | 1274 | |
6a16e136 SH |
1275 | // If the user is not enrolled then we only want to show the |
1276 | // course node and not populate it. | |
1277 | if (!can_access_course($course)) { | |
1278 | $coursenode->make_active(); | |
1279 | $canviewcourseprofile = false; | |
56c062a4 | 1280 | break; |
e52a5d3a | 1281 | } |
6a16e136 | 1282 | $this->add_course_essentials($coursenode, $course); |
ee7084e9 | 1283 | $this->load_course_sections($course, $coursenode); |
6a16e136 | 1284 | break; |
7d2a0492 | 1285 | } |
7a7e209d | 1286 | |
3406acde SH |
1287 | // Load for the current user |
1288 | $this->load_for_user(); | |
98556b23 | 1289 | if ($this->page->context->contextlevel >= CONTEXT_COURSE && $this->page->context->instanceid != $SITE->id && $canviewcourseprofile) { |
87c215de SH |
1290 | $this->load_for_user(null, true); |
1291 | } | |
7a7e209d SH |
1292 | // Load each extending user into the navigation. |
1293 | foreach ($this->extendforuser as $user) { | |
44303ca6 | 1294 | if ($user->id != $USER->id) { |
7a7e209d SH |
1295 | $this->load_for_user($user); |
1296 | } | |
1297 | } | |
7a7e209d | 1298 | |
a683da3c | 1299 | // Give the local plugins a chance to include some navigation if they want. |
a69ba70d DM |
1300 | foreach (core_component::get_plugin_list_with_file('local', 'lib.php', true) as $plugin => $unused) { |
1301 | $function = "local_{$plugin}_extend_navigation"; | |
1302 | $oldfunction = "local_{$plugin}_extends_navigation"; | |
1303 | ||
1304 | if (function_exists($function)) { | |
1305 | $function($this); | |
1306 | ||
1307 | } else if (function_exists($oldfunction)) { | |
1308 | debugging("Deprecated local plugin navigation callback: Please rename '{$oldfunction}' to '{$function}'. ". | |
1309 | "Support for the old callback will be dropped in Moodle 3.1", DEBUG_DEVELOPER); | |
1310 | $oldfunction($this); | |
1311 | } | |
a683da3c SH |
1312 | } |
1313 | ||
3406acde SH |
1314 | // Remove any empty root nodes |
1315 | foreach ($this->rootnodes as $node) { | |
4766a50c | 1316 | // Dont remove the home node |
75eb202e SH |
1317 | /** @var navigation_node $node */ |
1318 | if ($node->key !== 'home' && !$node->has_children() && !$node->isactive) { | |
3406acde SH |
1319 | $node->remove(); |
1320 | } | |
1321 | } | |
1322 | ||
7c4efe3b SH |
1323 | if (!$this->contains_active_node()) { |
1324 | $this->search_for_active_node(); | |
1325 | } | |
1326 | ||
3406acde | 1327 | // If the user is not logged in modify the navigation structure as detailed |
728ebac7 | 1328 | // in {@link http://docs.moodle.org/dev/Navigation_2.0_structure} |
3406acde SH |
1329 | if (!isloggedin()) { |
1330 | $activities = clone($this->rootnodes['site']->children); | |
1331 | $this->rootnodes['site']->remove(); | |
1332 | $children = clone($this->children); | |
1333 | $this->children = new navigation_node_collection(); | |
1334 | foreach ($activities as $child) { | |
1335 | $this->children->add($child); | |
1336 | } | |
1337 | foreach ($children as $child) { | |
1338 | $this->children->add($child); | |
1339 | } | |
3406acde | 1340 | } |
7d2a0492 | 1341 | return true; |
1342 | } | |
9bf5af21 | 1343 | |
58b602da SH |
1344 | /** |
1345 | * Returns true if the current user is a parent of the user being currently viewed. | |
1346 | * | |
1347 | * If the current user is not viewing another user, or if the current user does not hold any parent roles over the | |
1348 | * other user being viewed this function returns false. | |
1349 | * In order to set the user for whom we are checking against you must call {@link set_userid_for_parent_checks()} | |
1350 | * | |
5bcfd504 | 1351 | * @since Moodle 2.4 |
58b602da SH |
1352 | * @return bool |
1353 | */ | |
1354 | protected function current_user_is_parent_role() { | |
1355 | global $USER, $DB; | |
1356 | if ($this->useridtouseforparentchecks && $this->useridtouseforparentchecks != $USER->id) { | |
1357 | $usercontext = context_user::instance($this->useridtouseforparentchecks, MUST_EXIST); | |
1358 | if (!has_capability('moodle/user:viewdetails', $usercontext)) { | |
1359 | return false; | |
1360 | } | |
1361 | if ($DB->record_exists('role_assignments', array('userid' => $USER->id, 'contextid' => $usercontext->id))) { | |
1362 | return true; | |
1363 | } | |
1364 | } | |
1365 | return false; | |
1366 | } | |
1367 | ||
9bf5af21 | 1368 | /** |
31fde54f | 1369 | * Returns true if courses should be shown within categories on the navigation. |
9bf5af21 | 1370 | * |
58b602da | 1371 | * @param bool $ismycourse Set to true if you are calculating this for a course. |
9bf5af21 SH |
1372 | * @return bool |
1373 | */ | |
58b602da | 1374 | protected function show_categories($ismycourse = false) { |
9bf5af21 | 1375 | global $CFG, $DB; |
58b602da SH |
1376 | if ($ismycourse) { |
1377 | return $this->show_my_categories(); | |
1378 | } | |
9bf5af21 | 1379 | if ($this->showcategories === null) { |
58b602da SH |
1380 | $show = false; |
1381 | if ($this->page->context->contextlevel == CONTEXT_COURSECAT) { | |
1382 | $show = true; | |
1383 | } else if (!empty($CFG->navshowcategories) && $DB->count_records('course_categories') > 1) { | |
1384 | $show = true; | |
1385 | } | |
6a16e136 | 1386 | $this->showcategories = $show; |
9bf5af21 SH |
1387 | } |
1388 | return $this->showcategories; | |
1389 | } | |
1390 | ||
58b602da SH |
1391 | /** |
1392 | * Returns true if we should show categories in the My Courses branch. | |
1393 | * @return bool | |
1394 | */ | |
1395 | protected function show_my_categories() { | |
1396 | global $CFG, $DB; | |
1397 | if ($this->showmycategories === null) { | |
1398 | $this->showmycategories = !empty($CFG->navshowmycoursecategories) && $DB->count_records('course_categories') > 1; | |
1399 | } | |
1400 | return $this->showmycategories; | |
1401 | } | |
1402 | ||
3406acde | 1403 | /** |
31fde54f | 1404 | * Loads the courses in Moodle into the navigation. |
3406acde | 1405 | * |
8e8de15f SH |
1406 | * @global moodle_database $DB |
1407 | * @param string|array $categoryids An array containing categories to load courses | |
1408 | * for, OR null to load courses for all categories. | |
1409 | * @return array An array of navigation_nodes one for each course | |
3406acde | 1410 | */ |
8e8de15f | 1411 | protected function load_all_courses($categoryids = null) { |
98556b23 | 1412 | global $CFG, $DB, $SITE; |
4766a50c | 1413 | |
8e8de15f | 1414 | // Work out the limit of courses. |
4766a50c SH |
1415 | $limit = 20; |
1416 | if (!empty($CFG->navcourselimit)) { | |
1417 | $limit = $CFG->navcourselimit; | |
1418 | } | |
4766a50c | 1419 | |
8e8de15f SH |
1420 | $toload = (empty($CFG->navshowallcourses))?self::LOAD_ROOT_CATEGORIES:self::LOAD_ALL_CATEGORIES; |
1421 | ||
1422 | // If we are going to show all courses AND we are showing categories then | |
1423 | // to save us repeated DB calls load all of the categories now | |
1424 | if ($this->show_categories()) { | |
1425 | $this->load_all_categories($toload); | |
1426 | } | |
1427 | ||
1428 | // Will be the return of our efforts | |
3406acde | 1429 | $coursenodes = array(); |
8e8de15f | 1430 | |
f7ee4baa SH |
1431 | // Check if we need to show categories. |
1432 | if ($this->show_categories()) { | |
1433 | // Hmmm we need to show categories... this is going to be painful. | |
1434 | // We now need to fetch up to $limit courses for each category to | |
1435 | // be displayed. | |
1436 | if ($categoryids !== null) { | |
1437 | if (!is_array($categoryids)) { | |
1438 | $categoryids = array($categoryids); | |
8e8de15f | 1439 | } |
f7ee4baa SH |
1440 | list($categorywhere, $categoryparams) = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED, 'cc'); |
1441 | $categorywhere = 'WHERE cc.id '.$categorywhere; | |
1442 | } else if ($toload == self::LOAD_ROOT_CATEGORIES) { | |
1443 | $categorywhere = 'WHERE cc.depth = 1 OR cc.depth = 2'; | |
1444 | $categoryparams = array(); | |
1445 | } else { | |
1446 | $categorywhere = ''; | |
1447 | $categoryparams = array(); | |
1448 | } | |
8e8de15f | 1449 | |
f7ee4baa SH |
1450 | // First up we are going to get the categories that we are going to |
1451 | // need so that we can determine how best to load the courses from them. | |
1452 | $sql = "SELECT cc.id, COUNT(c.id) AS coursecount | |
1453 | FROM {course_categories} cc | |
1454 | LEFT JOIN {course} c ON c.category = cc.id | |
1455 | {$categorywhere} | |
1456 | GROUP BY cc.id"; | |
1457 | $categories = $DB->get_recordset_sql($sql, $categoryparams); | |
1458 | $fullfetch = array(); | |
1459 | $partfetch = array(); | |
1460 | foreach ($categories as $category) { | |
1461 | if (!$this->can_add_more_courses_to_category($category->id)) { | |
1462 | continue; | |
1463 | } | |
1464 | if ($category->coursecount > $limit * 5) { | |
1465 | $partfetch[] = $category->id; | |
1466 | } else if ($category->coursecount > 0) { | |
1467 | $fullfetch[] = $category->id; | |
1468 | } | |
1469 | } | |
1470 | $categories->close(); | |
1471 | ||
1472 | if (count($fullfetch)) { | |
1473 | // First up fetch all of the courses in categories where we know that we are going to | |
1474 | // need the majority of courses. | |
f7ee4baa | 1475 | list($categoryids, $categoryparams) = $DB->get_in_or_equal($fullfetch, SQL_PARAMS_NAMED, 'lcategory'); |
2e4c0c91 FM |
1476 | $ccselect = ', ' . context_helper::get_preload_record_columns_sql('ctx'); |
1477 | $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)"; | |
1478 | $categoryparams['contextlevel'] = CONTEXT_COURSE; | |
f7ee4baa SH |
1479 | $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect |
1480 | FROM {course} c | |
1481 | $ccjoin | |
fca2d3d7 | 1482 | WHERE c.category {$categoryids} |
f7ee4baa | 1483 | ORDER BY c.sortorder ASC"; |
fca2d3d7 | 1484 | $coursesrs = $DB->get_recordset_sql($sql, $categoryparams); |
f7ee4baa | 1485 | foreach ($coursesrs as $course) { |
fca2d3d7 PS |
1486 | if ($course->id == $SITE->id) { |
1487 | // This should not be necessary, frontpage is not in any category. | |
1488 | continue; | |
1489 | } | |
1490 | if (array_key_exists($course->id, $this->addedcourses)) { | |
1491 | // It is probably better to not include the already loaded courses | |
1492 | // directly in SQL because inequalities may confuse query optimisers | |
1493 | // and may interfere with query caching. | |
1494 | continue; | |
1495 | } | |
f7ee4baa | 1496 | if (!$this->can_add_more_courses_to_category($course->category)) { |
8e8de15f SH |
1497 | continue; |
1498 | } | |
db314f34 | 1499 | context_helper::preload_from_record($course); |
b0c6dc1c | 1500 | if (!$course->visible && !is_role_switched($course->id) && !has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) { |
f7ee4baa | 1501 | continue; |
8e8de15f | 1502 | } |
f7ee4baa | 1503 | $coursenodes[$course->id] = $this->add_course($course); |
8e8de15f | 1504 | } |
f7ee4baa SH |
1505 | $coursesrs->close(); |
1506 | } | |
8e8de15f | 1507 | |
f7ee4baa SH |
1508 | if (count($partfetch)) { |
1509 | // Next we will work our way through the categories where we will likely only need a small | |
1510 | // proportion of the courses. | |
1511 | foreach ($partfetch as $categoryid) { | |
2e4c0c91 FM |
1512 | $ccselect = ', ' . context_helper::get_preload_record_columns_sql('ctx'); |
1513 | $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)"; | |
8e8de15f | 1514 | $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect |
f7ee4baa SH |
1515 | FROM {course} c |
1516 | $ccjoin | |
fca2d3d7 | 1517 | WHERE c.category = :categoryid |
f7ee4baa | 1518 | ORDER BY c.sortorder ASC"; |
2e4c0c91 | 1519 | $courseparams = array('categoryid' => $categoryid, 'contextlevel' => CONTEXT_COURSE); |
f7ee4baa | 1520 | $coursesrs = $DB->get_recordset_sql($sql, $courseparams, 0, $limit * 5); |
8e8de15f | 1521 | foreach ($coursesrs as $course) { |
fca2d3d7 PS |
1522 | if ($course->id == $SITE->id) { |
1523 | // This should not be necessary, frontpage is not in any category. | |
1524 | continue; | |
1525 | } | |
1526 | if (array_key_exists($course->id, $this->addedcourses)) { | |
1527 | // It is probably better to not include the already loaded courses | |
1528 | // directly in SQL because inequalities may confuse query optimisers | |
1529 | // and may interfere with query caching. | |
1530 | // This also helps to respect expected $limit on repeated executions. | |
1531 | continue; | |
1532 | } | |
8e8de15f | 1533 | if (!$this->can_add_more_courses_to_category($course->category)) { |
f7ee4baa | 1534 | break; |
8e8de15f | 1535 | } |
db314f34 | 1536 | context_helper::preload_from_record($course); |
b0c6dc1c | 1537 | if (!$course->visible && !is_role_switched($course->id) && !has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) { |
8e8de15f SH |
1538 | continue; |
1539 | } | |
1540 | $coursenodes[$course->id] = $this->add_course($course); | |
1541 | } | |
1542 | $coursesrs->close(); | |
1543 | } | |
8e8de15f | 1544 | } |
8e8de15f | 1545 | } else { |
8e8de15f | 1546 | // Prepare the SQL to load the courses and their contexts |
f7ee4baa | 1547 | list($courseids, $courseparams) = $DB->get_in_or_equal(array_keys($this->addedcourses), SQL_PARAMS_NAMED, 'lc', false); |
2e4c0c91 FM |
1548 | $ccselect = ', ' . context_helper::get_preload_record_columns_sql('ctx'); |
1549 | $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)"; | |
1550 | $courseparams['contextlevel'] = CONTEXT_COURSE; | |
8e8de15f | 1551 | $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect |
f7ee4baa SH |
1552 | FROM {course} c |
1553 | $ccjoin | |
1554 | WHERE c.id {$courseids} | |
1555 | ORDER BY c.sortorder ASC"; | |
8e8de15f SH |
1556 | $coursesrs = $DB->get_recordset_sql($sql, $courseparams); |
1557 | foreach ($coursesrs as $course) { | |
fca2d3d7 PS |
1558 | if ($course->id == $SITE->id) { |
1559 | // frotpage is not wanted here | |
1560 | continue; | |
1561 | } | |
6caf3f5c ARN |
1562 | if ($this->page->course && ($this->page->course->id == $course->id)) { |
1563 | // Don't include the currentcourse in this nodelist - it's displayed in the Current course node | |
1564 | continue; | |
1565 | } | |
db314f34 | 1566 | context_helper::preload_from_record($course); |
b0c6dc1c | 1567 | if (!$course->visible && !is_role_switched($course->id) && !has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) { |
f7ee4baa SH |
1568 | continue; |
1569 | } | |
8e8de15f | 1570 | $coursenodes[$course->id] = $this->add_course($course); |
f7ee4baa SH |
1571 | if (count($coursenodes) >= $limit) { |
1572 | break; | |
1573 | } | |
8e8de15f SH |
1574 | } |
1575 | $coursesrs->close(); | |
3406acde | 1576 | } |
f7ee4baa | 1577 | |
3406acde SH |
1578 | return $coursenodes; |
1579 | } | |
1580 | ||
8e8de15f SH |
1581 | /** |
1582 | * Returns true if more courses can be added to the provided category. | |
1583 | * | |
98556b23 SH |
1584 | * @param int|navigation_node|stdClass $category |
1585 | * @return bool | |
8e8de15f SH |
1586 | */ |
1587 | protected function can_add_more_courses_to_category($category) { | |
1588 | global $CFG; | |
1589 | $limit = 20; | |
1590 | if (!empty($CFG->navcourselimit)) { | |
1591 | $limit = (int)$CFG->navcourselimit; | |
1592 | } | |
1593 | if (is_numeric($category)) { | |
1594 | if (!array_key_exists($category, $this->addedcategories)) { | |
1595 | return true; | |
1596 | } | |
1597 | $coursecount = count($this->addedcategories[$category]->children->type(self::TYPE_COURSE)); | |
1598 | } else if ($category instanceof navigation_node) { | |
db47f68f | 1599 | if (($category->type != self::TYPE_CATEGORY) || ($category->type != self::TYPE_MY_CATEGORY)) { |
8e8de15f SH |
1600 | return false; |
1601 | } | |
1602 | $coursecount = count($category->children->type(self::TYPE_COURSE)); | |
1603 | } else if (is_object($category) && property_exists($category,'id')) { | |
1604 | $coursecount = count($this->addedcategories[$category->id]->children->type(self::TYPE_COURSE)); | |
1605 | } | |
d4bb6462 | 1606 | return ($coursecount <= $limit); |
8e8de15f SH |
1607 | } |
1608 | ||
4766a50c SH |
1609 | /** |
1610 | * Loads all categories (top level or if an id is specified for that category) | |
1611 | * | |
e26507b3 SH |
1612 | * @param int $categoryid The category id to load or null/0 to load all base level categories |
1613 | * @param bool $showbasecategories If set to true all base level categories will be loaded as well | |
1614 | * as the requested category and any parent categories. | |
31fde54f | 1615 | * @return navigation_node|void returns a navigation node if a category has been loaded. |
4766a50c | 1616 | */ |
8e8de15f | 1617 | protected function load_all_categories($categoryid = self::LOAD_ROOT_CATEGORIES, $showbasecategories = false) { |
58b602da | 1618 | global $CFG, $DB; |
e26507b3 SH |
1619 | |
1620 | // Check if this category has already been loaded | |
8e8de15f SH |
1621 | if ($this->allcategoriesloaded || ($categoryid < 1 && $this->is_category_fully_loaded($categoryid))) { |
1622 | return true; | |
e26507b3 SH |
1623 | } |
1624 | ||
176b75b5 SH |
1625 | $catcontextsql = context_helper::get_preload_record_columns_sql('ctx'); |
1626 | $sqlselect = "SELECT cc.*, $catcontextsql | |
1627 | FROM {course_categories} cc | |
1628 | JOIN {context} ctx ON cc.id = ctx.instanceid"; | |
1629 | $sqlwhere = "WHERE ctx.contextlevel = ".CONTEXT_COURSECAT; | |
957983b7 | 1630 | $sqlorder = "ORDER BY cc.depth ASC, cc.sortorder ASC, cc.id ASC"; |
176b75b5 SH |
1631 | $params = array(); |
1632 | ||
8e8de15f SH |
1633 | $categoriestoload = array(); |
1634 | if ($categoryid == self::LOAD_ALL_CATEGORIES) { | |
176b75b5 SH |
1635 | // We are going to load all categories regardless... prepare to fire |
1636 | // on the database server! | |
8e8de15f | 1637 | } else if ($categoryid == self::LOAD_ROOT_CATEGORIES) { // can be 0 |
e26507b3 | 1638 | // We are going to load all of the first level categories (categories without parents) |
176b75b5 | 1639 | $sqlwhere .= " AND cc.parent = 0"; |
e26507b3 SH |
1640 | } else if (array_key_exists($categoryid, $this->addedcategories)) { |
1641 | // The category itself has been loaded already so we just need to ensure its subcategories | |
1642 | // have been loaded | |
85e59ac2 TP |
1643 | $addedcategories = $this->addedcategories; |
1644 | unset($addedcategories[$categoryid]); | |
6eb3da84 TP |
1645 | if (count($addedcategories) > 0) { |
1646 | list($sql, $params) = $DB->get_in_or_equal(array_keys($addedcategories), SQL_PARAMS_NAMED, 'parent', false); | |
1647 | if ($showbasecategories) { | |
1648 | // We need to include categories with parent = 0 as well | |
1649 | $sqlwhere .= " AND (cc.parent = :categoryid OR cc.parent = 0) AND cc.parent {$sql}"; | |
1650 | } else { | |
1651 | // All we need is categories that match the parent | |
1652 | $sqlwhere .= " AND cc.parent = :categoryid AND cc.parent {$sql}"; | |
1653 | } | |
e26507b3 SH |
1654 | } |
1655 | $params['categoryid'] = $categoryid; | |
4766a50c | 1656 | } else { |
e26507b3 SH |
1657 | // This category hasn't been loaded yet so we need to fetch it, work out its category path |
1658 | // and load this category plus all its parents and subcategories | |
3992a46e | 1659 | $category = $DB->get_record('course_categories', array('id' => $categoryid), 'path', MUST_EXIST); |
8e8de15f SH |
1660 | $categoriestoload = explode('/', trim($category->path, '/')); |
1661 | list($select, $params) = $DB->get_in_or_equal($categoriestoload); | |
176b75b5 | 1662 | // We are going to use select twice so double the params |
4766a50c | 1663 | $params = array_merge($params, $params); |
d4bb6462 SH |
1664 | $basecategorysql = ($showbasecategories)?' OR cc.depth = 1':''; |
1665 | $sqlwhere .= " AND (cc.id {$select} OR cc.parent {$select}{$basecategorysql})"; | |
176b75b5 SH |
1666 | } |
1667 | ||
1668 | $categoriesrs = $DB->get_recordset_sql("$sqlselect $sqlwhere $sqlorder", $params); | |
1669 | $categories = array(); | |
1670 | foreach ($categoriesrs as $category) { | |
1671 | // Preload the context.. we'll need it when adding the category in order | |
1672 | // to format the category name. | |
1673 | context_helper::preload_from_record($category); | |
1674 | if (array_key_exists($category->id, $this->addedcategories)) { | |
1675 | // Do nothing, its already been added. | |
1676 | } else if ($category->parent == '0') { | |
1677 | // This is a root category lets add it immediately | |
1678 | $this->add_category($category, $this->rootnodes['courses']); | |
1679 | } else if (array_key_exists($category->parent, $this->addedcategories)) { | |
1680 | // This categories parent has already been added we can add this immediately | |
1681 | $this->add_category($category, $this->addedcategories[$category->parent]); | |
1682 | } else { | |
1683 | $categories[] = $category; | |
1684 | } | |
4766a50c | 1685 | } |
176b75b5 | 1686 | $categoriesrs->close(); |
e26507b3 SH |
1687 | |
1688 | // Now we have an array of categories we need to add them to the navigation. | |
1689 | while (!empty($categories)) { | |
1690 | $category = reset($categories); | |
1691 | if (array_key_exists($category->id, $this->addedcategories)) { | |
1692 | // Do nothing | |
1693 | } else if ($category->parent == '0') { | |
1694 | $this->add_category($category, $this->rootnodes['courses']); | |
1695 | } else if (array_key_exists($category->parent, $this->addedcategories)) { | |
1696 | $this->add_category($category, $this->addedcategories[$category->parent]); | |
4766a50c | 1697 | } else { |
e26507b3 SH |
1698 | // This category isn't in the navigation and niether is it's parent (yet). |
1699 | // We need to go through the category path and add all of its components in order. | |
1700 | $path = explode('/', trim($category->path, '/')); | |
1701 | foreach ($path as $catid) { | |
1702 | if (!array_key_exists($catid, $this->addedcategories)) { | |
1703 | // This category isn't in the navigation yet so add it. | |
1704 | $subcategory = $categories[$catid]; | |
c4afcf84 SH |
1705 | if ($subcategory->parent == '0') { |
1706 | // Yay we have a root category - this likely means we will now be able | |
1707 | // to add categories without problems. | |
1708 | $this->add_category($subcategory, $this->rootnodes['courses']); | |
1709 | } else if (array_key_exists($subcategory->parent, $this->addedcategories)) { | |
e26507b3 SH |
1710 | // The parent is in the category (as we'd expect) so add it now. |
1711 | $this->add_category($subcategory, $this->addedcategories[$subcategory->parent]); | |
1712 | // Remove the category from the categories array. | |
1713 | unset($categories[$catid]); | |
1714 | } else { | |
1715 | // We should never ever arrive here - if we have then there is a bigger | |
1716 | // problem at hand. | |
5607036a | 1717 | throw new coding_exception('Category path order is incorrect and/or there are missing categories'); |
e26507b3 | 1718 | } |
4766a50c | 1719 | } |
4766a50c SH |
1720 | } |
1721 | } | |
e26507b3 SH |
1722 | // Remove the category from the categories array now that we know it has been added. |
1723 | unset($categories[$category->id]); | |
4766a50c | 1724 | } |
8e8de15f SH |
1725 | if ($categoryid === self::LOAD_ALL_CATEGORIES) { |
1726 | $this->allcategoriesloaded = true; | |
1727 | } | |
e26507b3 | 1728 | // Check if there are any categories to load. |
8e8de15f SH |
1729 | if (count($categoriestoload) > 0) { |
1730 | $readytoloadcourses = array(); | |
1731 | foreach ($categoriestoload as $category) { | |
1732 | if ($this->can_add_more_courses_to_category($category)) { | |
1733 | $readytoloadcourses[] = $category; | |
1734 | } | |
1735 | } | |
1736 | if (count($readytoloadcourses)) { | |
1737 | $this->load_all_courses($readytoloadcourses); | |
1738 | } | |
4766a50c | 1739 | } |
58b602da SH |
1740 | |
1741 | // Look for all categories which have been loaded | |
1742 | if (!empty($this->addedcategories)) { | |
1743 | $categoryids = array(); | |
1744 | foreach ($this->addedcategories as $category) { | |
1745 | if ($this->can_add_more_courses_to_category($category)) { | |
1746 | $categoryids[] = $category->key; | |
1747 | } | |
1748 | } | |
bb900d13 PS |
1749 | if ($categoryids) { |
1750 | list($categoriessql, $params) = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED); | |
1751 | $params['limit'] = (!empty($CFG->navcourselimit))?$CFG->navcourselimit:20; | |
1752 | $sql = "SELECT cc.id, COUNT(c.id) AS coursecount | |
1753 | FROM {course_categories} cc | |
1754 | JOIN {course} c ON c.category = cc.id | |
1755 | WHERE cc.id {$categoriessql} | |
1756 | GROUP BY cc.id | |
1757 | HAVING COUNT(c.id) > :limit"; | |
1758 | $excessivecategories = $DB->get_records_sql($sql, $params); | |
1759 | foreach ($categories as &$category) { | |
1760 | if (array_key_exists($category->key, $excessivecategories) && !$this->can_add_more_courses_to_category($category)) { | |
30142c19 | 1761 | $url = new moodle_url('/course/index.php', array('categoryid' => $category->key)); |
bb900d13 PS |
1762 | $category->add(get_string('viewallcourses'), $url, self::TYPE_SETTING); |
1763 | } | |
58b602da SH |
1764 | } |
1765 | } | |
1766 | } | |
4766a50c SH |
1767 | } |
1768 | ||
1769 | /** | |
1770 | * Adds a structured category to the navigation in the correct order/place | |
1771 | * | |
db47f68f RT |
1772 | * @param stdClass $category category to be added in navigation. |
1773 | * @param navigation_node $parent parent navigation node | |
1774 | * @param int $nodetype type of node, if category is under MyHome then it's TYPE_MY_CATEGORY | |
1775 | * @return void. | |
4766a50c | 1776 | */ |
db47f68f | 1777 | protected function add_category(stdClass $category, navigation_node $parent, $nodetype = self::TYPE_CATEGORY) { |
e26507b3 | 1778 | if (array_key_exists($category->id, $this->addedcategories)) { |
563329e8 | 1779 | return; |
e26507b3 | 1780 | } |
30142c19 | 1781 | $url = new moodle_url('/course/index.php', array('categoryid' => $category->id)); |
b0c6dc1c | 1782 | $context = context_coursecat::instance($category->id); |
63390481 | 1783 | $categoryname = format_string($category->name, true, array('context' => $context)); |
db47f68f | 1784 | $categorynode = $parent->add($categoryname, $url, $nodetype, $categoryname, $category->id); |
e26507b3 | 1785 | if (empty($category->visible)) { |
0601e0ee | 1786 | if (has_capability('moodle/category:viewhiddencategories', context_system::instance())) { |
e26507b3 SH |
1787 | $categorynode->hidden = true; |
1788 | } else { | |
1789 | $categorynode->display = false; | |
14337688 | 1790 | } |
4766a50c | 1791 | } |
082513ba | 1792 | $this->addedcategories[$category->id] = $categorynode; |
4766a50c SH |
1793 | } |
1794 | ||
3406acde SH |
1795 | /** |
1796 | * Loads the given course into the navigation | |
7d2a0492 | 1797 | * |
3406acde SH |
1798 | * @param stdClass $course |
1799 | * @return navigation_node | |
1800 | */ | |
1801 | protected function load_course(stdClass $course) { | |
98556b23 SH |
1802 | global $SITE; |
1803 | if ($course->id == $SITE->id) { | |
80c69522 | 1804 | // This is always loaded during initialisation |
e26507b3 SH |
1805 | return $this->rootnodes['site']; |
1806 | } else if (array_key_exists($course->id, $this->addedcourses)) { | |
80c69522 | 1807 | // The course has already been loaded so return a reference |
e26507b3 | 1808 | return $this->addedcourses[$course->id]; |
3406acde | 1809 | } else { |
80c69522 | 1810 | // Add the course |
e26507b3 | 1811 | return $this->add_course($course); |
3406acde | 1812 | } |
3406acde SH |
1813 | } |
1814 | ||
1815 | /** | |
1816 | * Loads all of the courses section into the navigation. | |
1817 | * | |
e010b850 MG |
1818 | * This function calls method from current course format, see |
1819 | * {@link format_base::extend_course_navigation()} | |
1820 | * If course module ($cm) is specified but course format failed to create the node, | |
1821 | * the activity node is created anyway. | |
3406acde | 1822 | * |
e010b850 | 1823 | * By default course formats call the method {@link global_navigation::load_generic_course_sections()} |
3406acde | 1824 | * |
3406acde SH |
1825 | * @param stdClass $course Database record for the course |
1826 | * @param navigation_node $coursenode The course node within the navigation | |
e010b850 MG |
1827 | * @param null|int $sectionnum If specified load the contents of section with this relative number |
1828 | * @param null|cm_info $cm If specified make sure that activity node is created (either | |
1829 | * in containg section or by calling load_stealth_activity() ) | |
3406acde | 1830 | */ |
e010b850 MG |
1831 | protected function load_course_sections(stdClass $course, navigation_node $coursenode, $sectionnum = null, $cm = null) { |
1832 | global $CFG, $SITE; | |
ee7084e9 | 1833 | require_once($CFG->dirroot.'/course/lib.php'); |
e010b850 MG |
1834 | if (isset($cm->sectionnum)) { |
1835 | $sectionnum = $cm->sectionnum; | |
1836 | } | |
1837 | if ($sectionnum !== null) { | |
1838 | $this->includesectionnum = $sectionnum; | |
1839 | } | |
1840 | course_get_format($course)->extend_course_navigation($this, $coursenode, $sectionnum, $cm); | |
1841 | if (isset($cm->id)) { | |
1842 | $activity = $coursenode->find($cm->id, self::TYPE_ACTIVITY); | |
1843 | if (empty($activity)) { | |
1844 | $activity = $this->load_stealth_activity($coursenode, get_fast_modinfo($course)); | |
1845 | } | |
1846 | } | |
1847 | } | |
3406acde | 1848 | |
e26507b3 SH |
1849 | /** |
1850 | * Generates an array of sections and an array of activities for the given course. | |
1851 | * | |
1852 | * This method uses the cache to improve performance and avoid the get_fast_modinfo call | |
1853 | * | |
1854 | * @param stdClass $course | |
1855 | * @return array Array($sections, $activities) | |
1856 | */ | |
1857 | protected function generate_sections_and_activities(stdClass $course) { | |
1858 | global $CFG; | |
1859 | require_once($CFG->dirroot.'/course/lib.php'); | |
1860 | ||
c18facf2 | 1861 | $modinfo = get_fast_modinfo($course); |
b5cf83f0 | 1862 | $sections = $modinfo->get_section_info_all(); |
850acb35 MG |
1863 | |
1864 | // For course formats using 'numsections' trim the sections list | |
1865 | $courseformatoptions = course_get_format($course)->get_format_options(); | |
1866 | if (isset($courseformatoptions['numsections'])) { | |
1867 | $sections = array_slice($sections, 0, $courseformatoptions['numsections']+1, true); | |
b5cf83f0 | 1868 | } |
850acb35 | 1869 | |
c18facf2 | 1870 | $activities = array(); |
e26507b3 | 1871 | |
c18facf2 | 1872 | foreach ($sections as $key => $section) { |
2d9c0d11 | 1873 | // Clone and unset summary to prevent $SESSION bloat (MDL-31802). |
51591b2c AO |
1874 | $sections[$key] = clone($section); |
1875 | unset($sections[$key]->summary); | |
c18facf2 SH |
1876 | $sections[$key]->hasactivites = false; |
1877 | if (!array_key_exists($section->section, $modinfo->sections)) { | |
1878 | continue; | |
1879 | } | |
1880 | foreach ($modinfo->sections[$section->section] as $cmid) { | |
1881 | $cm = $modinfo->cms[$cmid]; | |
c18facf2 SH |
1882 | $activity = new stdClass; |
1883 | $activity->id = $cm->id; | |
1884 | $activity->course = $course->id; | |
1885 | $activity->section = $section->section; | |
1886 | $activity->name = $cm->name; | |
1887 | $activity->icon = $cm->icon; | |
1888 | $activity->iconcomponent = $cm->iconcomponent; | |
1889 | $activity->hidden = (!$cm->visible); | |
1890 | $activity->modname = $cm->modname; | |
1891 | $activity->nodetype = navigation_node::NODETYPE_LEAF; | |
73ee2fda DP |
1892 | $activity->onclick = $cm->onclick; |
1893 | $url = $cm->url; | |
c18facf2 SH |
1894 | if (!$url) { |
1895 | $activity->url = null; | |
1896 | $activity->display = false; | |
1897 | } else { | |
73ee2fda | 1898 | $activity->url = $url->out(); |
4fd2a16e | 1899 | $activity->display = $cm->uservisible ? true : false; |
c18facf2 SH |
1900 | if (self::module_extends_navigation($cm->modname)) { |
1901 | $activity->nodetype = navigation_node::NODETYPE_BRANCH; | |
d67e4821 | 1902 | } |
e26507b3 | 1903 | } |
c18facf2 SH |
1904 | $activities[$cmid] = $activity; |
1905 | if ($activity->display) { | |
1906 | $sections[$key]->hasactivites = true; | |
1907 | } | |
e26507b3 | 1908 | } |
e26507b3 | 1909 | } |
c18facf2 | 1910 | |
e26507b3 SH |
1911 | return array($sections, $activities); |
1912 | } | |
1913 | ||
3406acde SH |
1914 | /** |
1915 | * Generically loads the course sections into the course's navigation. | |
1916 | * | |
1917 | * @param stdClass $course | |
1918 | * @param navigation_node $coursenode | |
3406acde SH |
1919 | * @return array An array of course section nodes |
1920 | */ | |
ee7084e9 | 1921 | public function load_generic_course_sections(stdClass $course, navigation_node $coursenode) { |
98556b23 | 1922 | global $CFG, $DB, $USER, $SITE; |
df997f84 | 1923 | require_once($CFG->dirroot.'/course/lib.php'); |
435a512e | 1924 | |
e26507b3 | 1925 | list($sections, $activities) = $this->generate_sections_and_activities($course); |
0f4ab67d | 1926 | |
7487c856 | 1927 | $navigationsections = array(); |
e26507b3 | 1928 | foreach ($sections as $sectionid => $section) { |
7487c856 | 1929 | $section = clone($section); |
98556b23 | 1930 | if ($course->id == $SITE->id) { |
e26507b3 | 1931 | $this->load_section_activities($coursenode, $section->section, $activities); |
3406acde | 1932 | } else { |
ce4dfd27 | 1933 | if (!$section->uservisible || (!$this->showemptysections && |
d67e4821 | 1934 | !$section->hasactivites && $this->includesectionnum !== $section->section)) { |
3406acde SH |
1935 | continue; |
1936 | } | |
ce4dfd27 | 1937 | |
ee7084e9 MG |
1938 | $sectionname = get_section_name($course, $section); |
1939 | $url = course_get_url($course, $section->section, array('navigation' => true)); | |
ad470097 | 1940 | |
3406acde SH |
1941 | $sectionnode = $coursenode->add($sectionname, $url, navigation_node::TYPE_SECTION, null, $section->id); |
1942 | $sectionnode->nodetype = navigation_node::NODETYPE_BRANCH; | |
ce4dfd27 | 1943 | $sectionnode->hidden = (!$section->visible || !$section->available); |
e010b850 | 1944 | if ($this->includesectionnum !== false && $this->includesectionnum == $section->section) { |
e26507b3 | 1945 | $this->load_section_activities($sectionnode, $section->section, $activities); |
3406acde SH |
1946 | } |
1947 | $section->sectionnode = $sectionnode; | |
7487c856 | 1948 | $navigationsections[$sectionid] = $section; |
3406acde SH |
1949 | } |
1950 | } | |
7487c856 | 1951 | return $navigationsections; |
3406acde | 1952 | } |
e010b850 | 1953 | |
3406acde SH |
1954 | /** |
1955 | * Loads all of the activities for a section into the navigation structure. | |
1956 | * | |
1957 | * @param navigation_node $sectionnode | |
1958 | * @param int $sectionnumber | |
93123b17 | 1959 | * @param array $activities An array of activites as returned by {@link global_navigation::generate_sections_and_activities()} |
1580cfdb | 1960 | * @param stdClass $course The course object the section and activities relate to. |
3406acde SH |
1961 | * @return array Array of activity nodes |
1962 | */ | |
1580cfdb | 1963 | protected function load_section_activities(navigation_node $sectionnode, $sectionnumber, array $activities, $course = null) { |
98556b23 | 1964 | global $CFG, $SITE; |
dee1a0fd SH |
1965 | // A static counter for JS function naming |
1966 | static $legacyonclickcounter = 0; | |
3406acde | 1967 | |
e26507b3 | 1968 | $activitynodes = array(); |
4037098e SH |
1969 | if (empty($activities)) { |
1970 | return $activitynodes; | |
1971 | } | |
1972 | ||
1973 | if (!is_object($course)) { | |
1974 | $activity = reset($activities); | |
1975 | $courseid = $activity->course; | |
1976 | } else { | |
1977 | $courseid = $course->id; | |
1978 | } | |
98556b23 | 1979 | $showactivities = ($courseid != $SITE->id || !empty($CFG->navshowfrontpagemods)); |
4037098e | 1980 | |
e26507b3 SH |
1981 | foreach ($activities as $activity) { |
1982 | if ($activity->section != $sectionnumber) { | |
3406acde SH |
1983 | continue; |
1984 | } | |
e26507b3 SH |
1985 | if ($activity->icon) { |
1986 | $icon = new pix_icon($activity->icon, get_string('modulename', $activity->modname), $activity->iconcomponent); | |
3406acde | 1987 | } else { |
e26507b3 | 1988 | $icon = new pix_icon('icon', get_string('modulename', $activity->modname), $activity->modname); |
3406acde | 1989 | } |
dee1a0fd SH |
1990 | |
1991 | // Prepare the default name and url for the node | |
b0c6dc1c | 1992 | $activityname = format_string($activity->name, true, array('context' => context_module::instance($activity->id))); |
dee1a0fd SH |
1993 | $action = new moodle_url($activity->url); |
1994 | ||
1995 | // Check if the onclick property is set (puke!) | |
1996 | if (!empty($activity->onclick)) { | |
1997 | // Increment the counter so that we have a unique number. | |
1998 | $legacyonclickcounter++; | |
1999 | // Generate the function name we will use | |
2000 | $functionname = 'legacy_activity_onclick_handler_'.$legacyonclickcounter; | |
2001 | $propogrationhandler = ''; | |
2002 | // Check if we need to cancel propogation. Remember inline onclick | |
2003 | // events would return false if they wanted to prevent propogation and the | |
2004 | // default action. | |
2005 | if (strpos($activity->onclick, 'return false')) { | |
2006 | $propogrationhandler = 'e.halt();'; | |
2007 | } | |
2008 | // Decode the onclick - it has already been encoded for display (puke) | |
e5ad278a | 2009 | $onclick = htmlspecialchars_decode($activity->onclick, ENT_QUOTES); |
dee1a0fd SH |
2010 | // Build the JS function the click event will call |
2011 | $jscode = "function {$functionname}(e) { $propogrationhandler $onclick }"; | |
2012 | $this->page->requires->js_init_code($jscode); | |
2013 | // Override the default url with the new action link | |
2014 | $action = new action_link($action, $activityname, new component_action('click', $functionname)); | |
2015 | } | |
2016 | ||
2017 | $activitynode = $sectionnode->add($activityname, $action, navigation_node::TYPE_ACTIVITY, null, $activity->id, $icon); | |
e26507b3 SH |
2018 | $activitynode->title(get_string('modulename', $activity->modname)); |
2019 | $activitynode->hidden = $activity->hidden; | |
4037098e | 2020 | $activitynode->display = $showactivities && $activity->display; |
e26507b3 SH |
2021 | $activitynode->nodetype = $activity->nodetype; |
2022 | $activitynodes[$activity->id] = $activitynode; | |
3406acde SH |
2023 | } |
2024 | ||
e26507b3 | 2025 | return $activitynodes; |
3406acde | 2026 | } |
2a62743c PS |
2027 | /** |
2028 | * Loads a stealth module from unavailable section | |
2029 | * @param navigation_node $coursenode | |
2030 | * @param stdClass $modinfo | |
2031 | * @return navigation_node or null if not accessible | |
2032 | */ | |
2033 | protected function load_stealth_activity(navigation_node $coursenode, $modinfo) { | |
2034 | if (empty($modinfo->cms[$this->page->cm->id])) { | |
2035 | return null; | |
2036 | } | |
2037 | $cm = $modinfo->cms[$this->page->cm->id]; | |
2a62743c PS |
2038 | if ($cm->icon) { |
2039 | $icon = new pix_icon($cm->icon, get_string('modulename', $cm->modname), $cm->iconcomponent); | |
2040 | } else { | |
2041 | $icon = new pix_icon('icon', get_string('modulename', $cm->modname), $cm->modname); | |
2042 | } | |
73ee2fda | 2043 | $url = $cm->url; |
2a62743c PS |
2044 | $activitynode = $coursenode->add(format_string($cm->name), $url, navigation_node::TYPE_ACTIVITY, null, $cm->id, $icon); |
2045 | $activitynode->title(get_string('modulename', $cm->modname)); | |
2046 | $activitynode->hidden = (!$cm->visible); | |
4fd2a16e MG |
2047 | if (!$cm->uservisible) { |
2048 | // Do not show any error here, let the page handle exception that activity is not visible for the current user. | |
2049 | // Also there may be no exception at all in case when teacher is logged in as student. | |
2050 | $activitynode->display = false; | |
2051 | } else if (!$url) { | |
0d8b6a69 | 2052 | // Don't show activities that don't have links! |
2a62743c | 2053 | $activitynode->display = false; |
e26507b3 | 2054 | } else if (self::module_extends_navigation($cm->modname)) { |
2a62743c PS |
2055 | $activitynode->nodetype = navigation_node::NODETYPE_BRANCH; |
2056 | } | |
2057 | return $activitynode; | |
2058 | } | |
3406acde SH |
2059 | /** |
2060 | * Loads the navigation structure for the given activity into the activities node. | |
2061 | * | |
2062 | * This method utilises a callback within the modules lib.php file to load the | |
2063 | * content specific to activity given. | |
2064 | * | |
2065 | * The callback is a method: {modulename}_extend_navigation() | |
2066 | * Examples: | |
93123b17 EL |
2067 | * * {@link forum_extend_navigation()} |
2068 | * * {@link workshop_extend_navigation()} | |
3406acde | 2069 | * |
f0dcc212 | 2070 | * @param cm_info|stdClass $cm |
3406acde SH |
2071 | * @param stdClass $course |
2072 | * @param navigation_node $activity | |
2073 | * @return bool | |
2074 | */ | |
0d8b6a69 | 2075 | protected function load_activity($cm, stdClass $course, navigation_node $activity) { |
3406acde | 2076 | global $CFG, $DB; |
44303ca6 | 2077 | |
f0dcc212 SH |
2078 | // make sure we have a $cm from get_fast_modinfo as this contains activity access details |
2079 | if (!($cm instanceof cm_info)) { | |
2080 | $modinfo = get_fast_modinfo($course); | |
2081 | $cm = $modinfo->get_cm($cm->id); | |
2082 | } | |
577c8964 | 2083 | $activity->nodetype = navigation_node::NODETYPE_LEAF; |
3406acde SH |
2084 | $activity->make_active(); |
2085 | $file = $CFG->dirroot.'/mod/'.$cm->modname.'/lib.php'; | |
2086 | $function = $cm->modname.'_extend_navigation'; | |
2087 | ||
2088 | if (file_exists($file)) { | |
2089 | require_once($file); | |
2090 | if (function_exists($function)) { | |
2091 | $activtyrecord = $DB->get_record($cm->modname, array('id' => $cm->instance), '*', MUST_EXIST); | |
2092 | $function($activity, $course, $activtyrecord, $cm); | |
3406acde SH |
2093 | } |
2094 | } | |
577c8964 MG |
2095 | |
2096 | // Allow the active advanced grading method plugin to append module navigation | |
2097 | $featuresfunc = $cm->modname.'_supports'; | |
2098 | if (function_exists($featuresfunc) && $featuresfunc(FEATURE_ADVANCED_GRADING)) { | |
2099 | require_once($CFG->dirroot.'/grade/grading/lib.php'); | |
6cdfe1a8 | 2100 | $gradingman = get_grading_manager($cm->context, 'mod_'.$cm->modname); |
577c8964 MG |
2101 | $gradingman->extend_navigation($this, $activity); |
2102 | } | |
2103 | ||
2104 | return $activity->has_children(); | |
3406acde SH |
2105 | } |
2106 | /** | |
4d00fded | 2107 | * Loads user specific information into the navigation in the appropriate place. |
3406acde SH |
2108 | * |
2109 | * If no user is provided the current user is assumed. | |
2110 | * | |
3406acde | 2111 | * @param stdClass $user |
4d00fded | 2112 | * @param bool $forceforcontext probably force something to be loaded somewhere (ask SamH if not sure what this means) |
3406acde | 2113 | * @return bool |
7a7e209d | 2114 | */ |
87c215de | 2115 | protected function load_for_user($user=null, $forceforcontext=false) { |
98556b23 | 2116 | global $DB, $CFG, $USER, $SITE; |
4f0c2d00 | 2117 | |
7a7e209d SH |
2118 | if ($user === null) { |
2119 | // We can't require login here but if the user isn't logged in we don't | |
2120 | // want to show anything | |
b9d4c7d3 | 2121 | if (!isloggedin() || isguestuser()) { |
7a7e209d SH |
2122 | return false; |
2123 | } | |
2124 | $user = $USER; | |
7a7e209d SH |
2125 | } else if (!is_object($user)) { |
2126 | // If the user is not an object then get them from the database | |
e141bc81 SH |
2127 | $select = context_helper::get_preload_record_columns_sql('ctx'); |
2128 | $sql = "SELECT u.*, $select | |
2129 | FROM {user} u | |
2130 | JOIN {context} ctx ON u.id = ctx.instanceid | |
2131 | WHERE u.id = :userid AND | |
2132 | ctx.contextlevel = :contextlevel"; | |
2133 | $user = $DB->get_record_sql($sql, array('userid' => (int)$user, 'contextlevel' => CONTEXT_USER), MUST_EXIST); | |
2134 | context_helper::preload_from_record($user); | |
7a7e209d | 2135 | } |
136ca7c8 SH |
2136 | |
2137 | $iscurrentuser = ($user->id == $USER->id); | |
2138 | ||
b0c6dc1c | 2139 | $usercontext = context_user::instance($user->id); |
7a7e209d SH |
2140 | |
2141 | // Get the course set against the page, by default this will be the site | |
3406acde SH |
2142 | $course = $this->page->course; |
2143 | $baseargs = array('id'=>$user->id); | |
98556b23 | 2144 | if ($course->id != $SITE->id && (!$iscurrentuser || $forceforcontext)) { |
58b602da | 2145 | $coursenode = $this->add_course($course, false, self::COURSE_CURRENT); |
7a7e209d | 2146 | $baseargs['course'] = $course->id; |
b0c6dc1c | 2147 | $coursecontext = context_course::instance($course->id); |
7a7e209d | 2148 | $issitecourse = false; |
7d2a0492 | 2149 | } else { |
7a7e209d | 2150 | // Load all categories and get the context for the system |
b0c6dc1c | 2151 | $coursecontext = context_system::instance(); |
7a7e209d SH |
2152 | $issitecourse = true; |
2153 | } | |
2154 | ||
2155 | // Create a node to add user information under. | |
87c215de | 2156 | if ($iscurrentuser && !$forceforcontext) { |
3406acde SH |
2157 | // If it's the current user the information will go under the profile root node |
2158 | $usernode = $this->rootnodes['myprofile']; | |
e96bc3f9 | 2159 | $course = get_site(); |
b0c6dc1c | 2160 | $coursecontext = context_course::instance($course->id); |
e96bc3f9 | 2161 | $issitecourse = true; |
7a7e209d SH |
2162 | } else { |
2163 | if (!$issitecourse) { | |
2164 | // Not the current user so add it to the participants node for the current course | |
3406acde | 2165 | $usersnode = $coursenode->get('participants', navigation_node::TYPE_CONTAINER); |
ad93ddd5 | 2166 | $userviewurl = new moodle_url('/user/view.php', $baseargs); |
7a7e209d SH |
2167 | } else { |
2168 | // This is the site so add a users node to the root branch | |
3406acde | 2169 | $usersnode = $this->rootnodes['users']; |
8b0614d9 DP |
2170 | if (has_capability('moodle/course:viewparticipants', $coursecontext)) { |
2171 | $usersnode->action = new moodle_url('/user/index.php', array('id'=>$course->id)); | |
2172 | } | |
ad93ddd5 | 2173 | $userviewurl = new moodle_url('/user/profile.php', $baseargs); |
7a7e209d | 2174 | } |
f5c1e621 SH |
2175 | if (!$usersnode) { |
2176 | // We should NEVER get here, if the course hasn't been populated | |
2177 | // with a participants node then the navigaiton either wasn't generated | |
2178 | // for it (you are missing a require_login or set_context call) or | |
2179 | // you don't have access.... in the interests of no leaking informatin | |
2180 | // we simply quit... | |
2181 | return false; | |
2182 | } | |
7a7e209d | 2183 | // Add a branch for the current user |
76565fa1 AG |
2184 | $canseefullname = has_capability('moodle/site:viewfullnames', $coursecontext); |
2185 | $usernode = $usersnode->add(fullname($user, $canseefullname), $userviewurl, self::TYPE_USER, null, $user->id); | |
3406acde | 2186 | |
5ac851fb SH |
2187 | if ($this->page->context->contextlevel == CONTEXT_USER && $user->id == $this->page->context->instanceid) { |
2188 | $usernode->make_active(); | |
2189 | } | |
7a7e209d SH |
2190 | } |
2191 | ||
2192 | // If the user is the current user or has permission to view the details of the requested | |
2193 | // user than add a view profile link. | |
507a7a9a | 2194 | if ($iscurrentuser || has_capability('moodle/user:viewdetails', $coursecontext) || has_capability('moodle/user:viewdetails', $usercontext)) { |
87c215de | 2195 | if ($issitecourse || ($iscurrentuser && !$forceforcontext)) { |
03d9401e MD |
2196 | $usernode->add(get_string('viewprofile'), new moodle_url('/user/profile.php',$baseargs)); |
2197 | } else { | |
2198 | $usernode->add(get_string('viewprofile'), new moodle_url('/user/view.php',$baseargs)); | |
2199 | } | |
7a7e209d SH |
2200 | } |
2201 | ||
356a6de3 SH |
2202 | if (!empty($CFG->navadduserpostslinks)) { |
2203 | // Add nodes for forum posts and discussions if the user can view either or both | |
2204 | // There are no capability checks here as the content of the page is based | |
2205 | // purely on the forums the current user has access too. | |
2206 | $forumtab = $usernode->add(get_string('forumposts', 'forum')); | |
2207 | $forumtab->add(get_string('posts', 'forum'), new moodle_url('/mod/forum/user.php', $baseargs)); | |
2208 | $forumtab->add(get_string('discussions', 'forum'), new moodle_url('/mod/forum/user.php', array_merge($baseargs, array('mode'=>'discussions')))); | |
2209 | } | |
7a7e209d | 2210 | |
27bad0a6 | 2211 | // Add blog nodes |
850d2db8 | 2212 | if (!empty($CFG->enableblogs)) { |
e26507b3 SH |
2213 | if (!$this->cache->cached('userblogoptions'.$user->id)) { |
2214 | require_once($CFG->dirroot.'/blog/lib.php'); | |
2215 | // Get all options for the user | |
2216 | $options = blog_get_options_for_user($user); | |
2217 | $this->cache->set('userblogoptions'.$user->id, $options); | |
2218 | } else { | |
2219 | $options = $this->cache->{'userblogoptions'.$user->id}; | |
2220 | } | |
2221 | ||
27bad0a6 SH |
2222 | if (count($options) > 0) { |
2223 | $blogs = $usernode->add(get_string('blogs', 'blog'), null, navigation_node::TYPE_CONTAINER); | |
c000545d JF |
2224 | foreach ($options as $type => $option) { |
2225 | if ($type == "rss") { | |
2226 | $blogs->add($option['string'], $option['link'], settings_navigation::TYPE_SETTING, null, null, new pix_icon('i/rss', '')); | |
2227 | } else { | |
2228 | $blogs->add($option['string'], $option['link']); | |
2229 | } | |
27bad0a6 SH |
2230 | } |
2231 | } | |
2232 | } | |
2233 | ||
af7bc6cd SH |
2234 | // Add the messages link. |
2235 | // It is context based so can appear in "My profile" and in course participants information. | |
5ac851fb | 2236 | if (!empty($CFG->messaging)) { |
0e1bd87c | 2237 | $messageargs = array('user1' => $USER->id); |
447df209 | 2238 | if ($USER->id != $user->id) { |
0e1bd87c MG |
2239 | $messageargs['user2'] = $user->id; |
2240 | } | |
2241 | if ($course->id != $SITE->id) { | |
2242 | $messageargs['viewing'] = MESSAGE_VIEW_COURSE. $course->id; | |
5ac851fb SH |
2243 | } |
2244 | $url = new moodle_url('/message/index.php',$messageargs); | |
2245 | $usernode->add(get_string('messages', 'message'), $url, self::TYPE_SETTING, null, 'messages'); | |
c81b9f69 | 2246 | } |
c81b9f69 | 2247 | |
af7bc6cd SH |
2248 | // Add the "My private files" link. |
2249 | // This link doesn't have a unique display for course context so only display it under "My profile". | |
2250 | if ($issitecourse && $iscurrentuser && has_capability('moodle/user:manageownfiles', $usercontext)) { | |
4c886459 | 2251 | $url = new moodle_url('/user/files.php'); |
82af55d7 | 2252 | $usernode->add(get_string('myfiles'), $url, self::TYPE_SETTING); |
78765507 DC |
2253 | } |
2254 | ||
2188a697 | 2255 | if (!empty($CFG->enablebadges) && $iscurrentuser && |
af7bc6cd | 2256 | has_capability('moodle/badges:manageownbadges', $usercontext)) { |
27806552 YB |
2257 | $url = new moodle_url('/badges/mybadges.php'); |
2258 | $usernode->add(get_string('mybadges', 'badges'), $url, self::TYPE_SETTING); | |
2259 | } | |
2260 | ||
7a7e209d | 2261 | // Add a node to view the users notes if permitted |
507a7a9a | 2262 | if (!empty($CFG->enablenotes) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $coursecontext)) { |
3406acde | 2263 | $url = new moodle_url('/notes/index.php',array('user'=>$user->id)); |
963402c2 | 2264 | if ($coursecontext->instanceid != SITEID) { |
3406acde SH |
2265 | $url->param('course', $coursecontext->instanceid); |
2266 | } | |
2267 | $usernode->add(get_string('notes', 'notes'), $url); | |
7a7e209d SH |
2268 | } |
2269 | ||
c9451960 AG |
2270 | // Show the my grades node. |
2271 | if (($issitecourse && $iscurrentuser) || has_capability('moodle/user:viewdetails', $usercontext)) { | |
2272 | require_once($CFG->dirroot . '/user/lib.php'); | |
2273 | // Set the grades node to link to the "My grades" page. | |
2274 | if ($course->id == SITEID) { | |
2275 | $url = user_mygrades_url($user->id, $course->id); | |
2276 | } else { // Otherwise we are in a course and should redirect to the user grade report (Activity report version). | |
2277 | $url = new moodle_url('/course/user.php', array('mode' => 'grade', 'id' => $course->id, 'user' => $user->id)); | |
2278 | } | |
2279 | if ($USER->id != $user->id) { | |
2280 | $usernode->add(get_string('grades', 'grades'), $url); | |
2281 | } else { | |
2282 | $usernode->add(get_string('mygrades', 'grades'), $url); | |
2283 | } | |
2284 | } | |
2285 | ||
7a7e209d | 2286 | // If the user is the current user add the repositories for the current user |
9acb8241 | 2287 | $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields)); |
8309caa6 FM |
2288 | if (!$iscurrentuser && |
2289 | $course->id == $SITE->id && | |
2290 | has_capability('moodle/user:viewdetails', $usercontext) && | |
2291 | (!in_array('mycourses', $hiddenfields) || has_capability('moodle/user:viewhiddendetails', $coursecontext))) { | |
9acb8241 SH |
2292 | |
2293 | // Add view grade report is permitted | |
bd3b3bba | 2294 | $reports = core_component::get_plugin_list('gradereport'); |
9acb8241 SH |
2295 | arsort($reports); // user is last, we want to test it first |
2296 | ||
2297 | $userscourses = enrol_get_users_courses($user->id); | |
2298 | $userscoursesnode = $usernode->add(get_string('courses')); | |
69816a5c | 2299 | |
30aca4a7 | 2300 | $count = 0; |
9acb8241 | 2301 | foreach ($userscourses as $usercourse) { |
30aca4a7 SH |
2302 | if ($count === (int)$CFG->navcourselimit) { |
2303 | $url = new moodle_url('/user/profile.php', array('id' => $user->id, 'showallcourses' => 1)); | |
2304 | $userscoursesnode->add(get_string('showallcourses'), $url); | |
2305 | break; | |
2306 | } | |
2307 | $count++; | |
b0c6dc1c | 2308 | $usercoursecontext = context_course::instance($usercourse->id); |
8ebbb06a SH |
2309 | $usercourseshortname = format_string($usercourse->shortname, true, array('context' => $usercoursecontext)); |
2310 | $usercoursenode = $userscoursesnode->add($usercourseshortname, new moodle_url('/user/view.php', array('id'=>$user->id, 'course'=>$usercourse->id)), self::TYPE_CONTAINER); | |
9acb8241 SH |
2311 | |
2312 | $gradeavailable = has_capability('moodle/grade:viewall', $usercoursecontext); | |
2313 | if (!$gradeavailable && !empty($usercourse->showgrades) && is_array($reports) && !empty($reports)) { | |
2314 | foreach ($reports as $plugin => $plugindir) { | |
2315 | if (has_capability('gradereport/'.$plugin.':view', $usercoursecontext)) { | |
2316 | //stop when the first visible plugin is found | |
2317 | $gradeavailable = true; | |
2318 | break; | |
deaf04c7 | 2319 | } |
9acb8241 SH |
2320 | } |
2321 | } | |
2322 | ||
2323 | if ($gradeavailable) { | |
2324 | $url = new moodle_url('/grade/report/index.php', array('id'=>$usercourse->id)); | |
2325 | $usercoursenode->add(get_string('grades'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/grades', '')); | |
2326 | } | |
2327 | ||
2328 | // Add a node to view the users notes if permitted | |
2329 | if (!empty($CFG->enablenotes) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $usercoursecontext)) { | |
2330 | $url = new moodle_url('/notes/index.php',array('user'=>$user->id, 'course'=>$usercourse->id)); | |
2331 | $usercoursenode->add(get_string('notes', 'notes'), $url, self::TYPE_SETTING); | |
2332 | } | |
2333 | ||
1344b0ca | 2334 | if (can_access_course($usercourse, $user->id)) { |
9acb8241 SH |
2335 | $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', '')); |
2336 | } | |
2337 | ||
4d00fded PS |
2338 | $reporttab = $usercoursenode->add(get_string('activityreports')); |
2339 | ||
2340 | $reports = get_plugin_list_with_function('report', 'extend_navigation_user', 'lib.php'); | |
2341 | foreach ($reports as $reportfunction) { | |
2342 | $reportfunction($reporttab, $user, $usercourse); | |
2343 | } | |
2344 | ||
4d00fded | 2345 | $reporttab->trim_if_empty(); |
9acb8241 | 2346 | } |
7a7e209d SH |
2347 | } |
2348 | return true; | |
2349 | } | |
2350 | ||
2351 | /** | |
3406acde | 2352 | * This method simply checks to see if a given module can extend the navigation. |
7d2a0492 | 2353 | * |
31fde54f | 2354 | * @todo (MDL-25290) A shared caching solution should be used to save details on what extends navigation. |
e26507b3 | 2355 | * |
7d2a0492 | 2356 | * @param string $modname |
2357 | * @return bool | |
2358 | */ | |
e010b850 | 2359 | public static function module_extends_navigation($modname) { |
7d2a0492 | 2360 | global $CFG; |
e26507b3 SH |
2361 | static $extendingmodules = array(); |
2362 | if (!array_key_exists($modname, $extendingmodules)) { | |
2363 | $extendingmodules[$modname] = false; | |
2364 | $file = $CFG->dirroot.'/mod/'.$modname.'/lib.php'; | |
2365 | if (file_exists($file)) { | |
2366 | $function = $modname.'_extend_navigation'; | |
2367 | require_once($file); | |
2368 | $extendingmodules[$modname] = (function_exists($function)); | |
7d2a0492 | 2369 | } |
2370 | } | |
e26507b3 | 2371 | return $extendingmodules[$modname]; |
7d2a0492 | 2372 | } |
2373 | /** | |
3406acde | 2374 | * Extends the navigation for the given user. |
435a512e | 2375 | * |
3406acde | 2376 | * @param stdClass $user A user from the database |
7d2a0492 | 2377 | */ |
3406acde SH |
2378 | public function extend_for_user($user) { |
2379 | $this->extendforuser[] = $user; | |
5d07e957 SH |
2380 | } |
2381 | ||
2382 | /** | |
2383 | * Returns all of the users the navigation is being extended for | |
2384 | * | |
31fde54f | 2385 | * @return array An array of extending users. |
5d07e957 SH |
2386 | */ |
2387 | public function get_extending_users() { | |
2388 | return $this->extendforuser; | |
7d2a0492 | 2389 | } |
7d2a0492 | 2390 | /** |
3406acde | 2391 | * Adds the given course to the navigation structure. |
7d2a0492 | 2392 | * |
3406acde | 2393 | * @param stdClass $course |
8e8de15f SH |
2394 | * @param bool $forcegeneric |
2395 | * @param bool $ismycourse | |
3406acde | 2396 | * @return navigation_node |
7d2a0492 | 2397 | */ |
6caf3f5c | 2398 | public function add_course(stdClass $course, $forcegeneric = false, $coursetype = self::COURSE_OTHER) { |
98556b23 | 2399 | global $CFG, $SITE; |
44303ca6 | 2400 | |
e26507b3 SH |
2401 | // We found the course... we can return it now :) |
2402 | if (!$forcegeneric && array_key_exists($course->id, $this->addedcourses)) { | |
2403 | return $this->addedcourses[$course->id]; | |
2404 | } | |
2405 | ||
b0c6dc1c | 2406 | $coursecontext = context_course::instance($course->id); |
8ebbb06a | 2407 | |
98556b23 | 2408 | if ($course->id != $SITE->id && !$course->visible) { |
e26507b3 SH |
2409 | if (is_role_switched($course->id)) { |
2410 | // user has to be able to access course in order to switch, let's skip the visibility test here | |
8ebbb06a | 2411 | } else if (!has_capability('moodle/course:viewhiddencourses', $coursecontext)) { |
e26507b3 | 2412 | return false; |
44303ca6 | 2413 | } |
7d2a0492 | 2414 | } |
7d2a0492 | 2415 | |
98556b23 | 2416 | $issite = ($course->id == $SITE->id); |
8ebbb06a | 2417 | $shortname = format_string($course->shortname, true, array('context' => $coursecontext)); |
d20337f1 SH |
2418 | $fullname = format_string($course->fullname, true, array('context' => $coursecontext)); |
2419 | // This is the name that will be shown for the course. | |
2420 | $coursename = empty($CFG->navshowfullcoursenames) ? $shortname : $fullname; | |
4766a50c | 2421 | |
cbd063f4 SH |
2422 | // Can the user expand the course to see its content. |
2423 | $canexpandcourse = true; | |
4766a50c | 2424 | if ($issite) { |
3406acde | 2425 | $parent = $this; |
4766a50c | 2426 | $url = null; |
016ba638 | 2427 | if (empty($CFG->usesitenameforsitepages)) { |
d20337f1 | 2428 | $coursename = get_string('sitepages'); |
016ba638 | 2429 | } |
6caf3f5c ARN |
2430 | } else if ($coursetype == self::COURSE_CURRENT) { |
2431 | $parent = $this->rootnodes['currentcourse']; | |
2432 | $url = new moodle_url('/course/view.php', array('id'=>$course->id)); | |
2433 | } else if ($coursetype == self::COURSE_MY && !$forcegeneric) { | |
db47f68f | 2434 | if (!empty($CFG->navshowmycoursecategories) && ($parent = $this->rootnodes['mycourses']->find($course->category, self::TYPE_MY_CATEGORY))) { |
b0712163 SH |
2435 | // Nothing to do here the above statement set $parent to the category within mycourses. |
2436 | } else { | |
2437 | $parent = $this->rootnodes['mycourses']; | |
2438 | } | |
3406acde | 2439 | $url = new moodle_url('/course/view.php', array('id'=>$course->id)); |
7a7e209d | 2440 | } else { |
3406acde | 2441 | $parent = $this->rootnodes['courses']; |
a6855934 | 2442 | $url = new moodle_url('/course/view.php', array('id'=>$course->id)); |
cbd063f4 SH |
2443 | // They can only expand the course if they can access it. |
2444 | $canexpandcourse = $this->can_expand_course($course); | |
58b602da SH |
2445 | if (!empty($course->category) && $this->show_categories($coursetype == self::COURSE_MY)) { |
2446 | if (!$this->is_category_fully_loaded($course->category)) { | |
8e8de15f | 2447 | // We need to load the category structure for this course |
80c69522 | 2448 | $this->load_all_categories($course->category, false); |
8e8de15f SH |
2449 | } |
2450 | if (array_key_exists($course->category, $this->addedcategories)) { | |
2451 | $parent = $this->addedcategories[$course->category]; | |
2452 | // This could lead to the course being created so we should check whether it is the case again | |
2453 | if (!$forcegeneric && array_key_exists($course->id, $this->addedcourses)) { | |
2454 | return $this->addedcourses[$course->id]; | |
2455 | } | |
3992a46e | 2456 | } |
4766a50c SH |
2457 | } |
2458 | } | |
2459 | ||
d20337f1 | 2460 | $coursenode = $parent->add($coursename, $url, self::TYPE_COURSE, $shortname, $course->id); |
3406acde | 2461 | $coursenode->hidden = (!$course->visible); |
1d8a1a87 SH |
2462 | // We need to decode &'s here as they will have been added by format_string above and attributes will be encoded again |
2463 | // later. | |
2464 | $coursenode->title(str_replace('&', '&', $fullname)); | |
cbd063f4 SH |
2465 | if ($canexpandcourse) { |
2466 | // This course can be expanded by the user, make it a branch to make the system aware that its expandable by ajax. | |
2467 | $coursenode->nodetype = self::NODETYPE_BRANCH; | |
2468 | $coursenode->isexpandable = true; | |
2469 | } else { | |
2470 | $coursenode->nodetype = self::NODETYPE_LEAF; | |
2471 | $coursenode->isexpandable = false; | |
2472 | } | |
e26507b3 | 2473 | if (!$forcegeneric) { |
082513ba | 2474 | $this->addedcourses[$course->id] = $coursenode; |
e26507b3 | 2475 | } |
e26507b3 | 2476 | |
3406acde | 2477 | return $coursenode; |
7d2a0492 | 2478 | } |
8e8de15f | 2479 | |
cbd063f4 SH |
2480 | /** |
2481 | * Returns a cache instance to use for the expand course cache. | |
2482 | * @return cache_session | |
2483 | */ | |
2484 | protected function get_expand_course_cache() { | |
2485 | if ($this->cacheexpandcourse === null) { | |
2486 | $this->cacheexpandcourse = cache::make('core', 'navigation_expandcourse'); | |
2487 | } | |
2488 | return $this->cacheexpandcourse; | |
2489 | } | |
2490 | ||
2491 | /** | |
2492 | * Checks if a user can expand a course in the navigation. | |
2493 | * | |
2494 | * We use a cache here because in order to be accurate we need to call can_access_course which is a costly function. | |
2495 | * Because this functionality is basic + non-essential and because we lack good event triggering this cache | |
2496 | * permits stale data. | |
2497 | * In the situation the user is granted access to a course after we've initialised this session cache the cache | |
2498 | * will be stale. | |
2499 | * It is brought up to date in only one of two ways. | |
2500 | * 1. The user logs out and in again. | |
2501 | * 2. The user browses to the course they've just being given access to. | |
2502 | * | |
2503 | * Really all this controls is whether the node is shown as expandable or not. It is uber un-important. | |
2504 | * | |
2505 | * @param stdClass $course | |
2506 | * @return bool | |
2507 | */ | |
2508 | protected function can_expand_course($course) { | |
2509 | $cache = $this->get_expand_course_cache(); | |
2510 | $canexpand = $cache->get($course->id); | |
2511 | if ($canexpand === false) { | |
2512 | $canexpand = isloggedin() && can_access_course($course); | |
2513 | $canexpand = (int)$canexpand; | |
2514 | $cache->set($course->id, $canexpand); | |
2515 | } | |
2516 | return ($canexpand === 1); | |
2517 | } | |
2518 | ||
8e8de15f SH |
2519 | /** |
2520 | * Returns true if the category has already been loaded as have any child categories | |
2521 | * | |
2522 | * @param int $categoryid | |
2523 | * @return bool | |
2524 | */ | |
2525 | protected function is_category_fully_loaded($categoryid) { | |
2526 | return (array_key_exists($categoryid, $this->addedcategories) && ($this->allcategoriesloaded || $this->addedcategories[$categoryid]->children->count() > 0)); | |
2527 | } | |
2528 | ||
7d2a0492 | 2529 | /** |
3406acde | 2530 | * Adds essential course nodes to the navigation for the given course. |
7d2a0492 | 2531 | * |
3406acde | 2532 | * This method adds nodes such as reports, blogs and participants |
7d2a0492 | 2533 | * |
3406acde SH |
2534 | * @param navigation_node $coursenode |
2535 | * @param stdClass $course | |
31fde54f | 2536 | * @return bool returns true on successful addition of a node. |
7d2a0492 | 2537 | */ |
2027c10e | 2538 | public function add_course_essentials($coursenode, stdClass $course) { |
98556b23 | 2539 | global $CFG, $SITE; |
7d2a0492 | 2540 | |
98556b23 | 2541 | if ($course->id == $SITE->id) { |
3406acde | 2542 | return $this->add_front_page_course_essentials($coursenode, $course); |
7d2a0492 | 2543 | } |
7d2a0492 | 2544 | |
2027c10e | 2545 | if ($coursenode == false || !($coursenode instanceof navigation_node) || $coursenode->get('participants', navigation_node::TYPE_CONTAINER)) { |
3406acde | 2546 | return true; |
7d2a0492 | 2547 | } |
7d2a0492 | 2548 | |
3406acde SH |
2549 | //Participants |
2550 | if (has_capability('moodle/course:viewparticipants', $this->page->context)) { | |
3406acde | 2551 | $participants = $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id), self::TYPE_CONTAINER, get_string('participants'), 'participants'); |
24f4bfcf SC |
2552 | if (!empty($CFG->enableblogs)) { |
2553 | if (($CFG->bloglevel == BLOG_GLOBAL_LEVEL or ($CFG->bloglevel == BLOG_SITE_LEVEL and (isloggedin() and !isguestuser()))) | |
2554 | and has_capability('moodle/blog:view', context_system::instance())) { | |
0967e635 MG |
2555 | $blogsurls = new moodle_url('/blog/index.php'); |
2556 | if ($course->id == $SITE->id) { | |
2557 | $blogsurls->param('courseid', 0); | |
2558 | } else if ($currentgroup = groups_get_course_group($course, true)) { | |
2559 | $blogsurls->param('groupid', $currentgroup); | |
2560 | } else { | |
2561 | $blogsurls->param('courseid', $course->id); | |
2562 | } | |
24f4bfcf SC |
2563 | $participants->add(get_string('blogscourse','blog'), $blogsurls->out()); |
2564 | } | |
3406acde SH |
2565 | } |
2566 | if (!empty($CFG->enablenotes) && (has_capability('moodle/notes:manage', $this->page->context) || has_capability('moodle/notes:view', $this->page->context))) { | |
41eae0d9 | 2567 | $participants->add(get_string('notes','notes'), new moodle_url('/notes/index.php', array('filtertype'=>'course', 'filterselect'=>$course->id))); |
3406acde | 2568 | } |
533299cb | 2569 | } else if (count($this->extendforuser) > 0 || $this->page->course->id == $course->id) { |
3406acde SH |
2570 | $participants = $coursenode->add(get_string('participants'), null, self::TYPE_CONTAINER, get_string('participants'), 'participants'); |
2571 | } | |
2572 | ||
27806552 | 2573 | // Badges. |
1dcb9ff1 YB |
2574 | if (!empty($CFG->enablebadges) && !empty($CFG->badges_allowcoursebadges) && |
2575 | has_capability('moodle/badges:viewbadges', $this->page->context)) { | |
2576 | $url = new moodle_url('/badges/view.php', array('type' => 2, 'id' => $course->id)); | |
27806552 YB |
2577 | |
2578 | $coursenode->add(get_string('coursebadges', 'badges'), null, | |
2579 | navigation_node::TYPE_CONTAINER, null, 'coursebadges'); | |
2580 | $coursenode->get('coursebadges')->add(get_string('badgesview', 'badges'), $url, | |
2581 | navigation_node::TYPE_SETTING, null, 'badgesview', | |
2582 | new pix_icon('i/badge', get_string('badgesview', 'badges'))); | |
2583 | } | |
2584 | ||
7d2a0492 | 2585 | return true; |
2586 | } | |
deaf04c7 | 2587 | /** |
31fde54f | 2588 | * This generates the structure of the course that won't be generated when |
deaf04c7 SH |
2589 | * the modules and sections are added. |
2590 | * | |
2591 | * Things such as the reports branch, the participants branch, blogs... get | |
2592 | * added to the course node by this method. | |
2593 | * | |
2594 | * @param navigation_node $coursenode | |
2595 | * @param stdClass $course | |
2596 | * @return bool True for successfull generation | |
2597 | */ | |
3406acde SH |
2598 | public function add_front_page_course_essentials(navigation_node $coursenode, stdClass $course) { |
2599 | global $CFG; | |
7d2a0492 | 2600 | |
1fa692ed | 2601 | if ($coursenode == false || $coursenode->get('frontpageloaded', navigation_node::TYPE_CUSTOM)) { |
3406acde | 2602 | return true; |
7a7e209d SH |
2603 | } |
2604 | ||
1fa692ed SH |
2605 | // Hidden node that we use to determine if the front page navigation is loaded. |
2606 | // This required as there are not other guaranteed nodes that may be loaded. | |
2607 | $coursenode->add('frontpageloaded', null, self::TYPE_CUSTOM, null, 'frontpageloaded')->display = false; | |
2608 | ||
3406acde | 2609 | //Participants |
0601e0ee | 2610 | if (has_capability('moodle/course:viewparticipants', context_system::instance())) { |
3406acde SH |
2611 | $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id), self::TYPE_CUSTOM, get_string('participants'), 'participants'); |
2612 | } | |
435a512e | 2613 | |
83a5e4fc | 2614 | $filterselect = 0; |
593270c6 MD |
2615 | |
2616 | // Blogs | |
850d2db8 | 2617 | if (!empty($CFG->enableblogs) |
8f6c1f34 | 2618 | and ($CFG->bloglevel == BLOG_GLOBAL_LEVEL or ($CFG->bloglevel == BLOG_SITE_LEVEL and (isloggedin() and !isguestuser()))) |
b0c6dc1c | 2619 | and has_capability('moodle/blog:view', context_system::instance())) { |
8f6c1f34 | 2620 | $blogsurls = new moodle_url('/blog/index.php', array('courseid' => $filterselect)); |
ec21eaba | 2621 | $coursenode->add(get_string('blogssite','blog'), $blogsurls->out()); |
7d2a0492 | 2622 | } |
593270c6 | 2623 | |
27806552 | 2624 | //Badges |
1dcb9ff1 | 2625 | if (!empty($CFG->enablebadges) && has_capability('moodle/badges:viewbadges', $this->page->context)) { |
27806552 YB |
2626 | $url = new moodle_url($CFG->wwwroot . '/badges/view.php', array('type' => 1)); |
2627 | $coursenode->add(get_string('sitebadges', 'badges'), $url, navigation_node::TYPE_CUSTOM); | |
2628 | } | |
2629 | ||
593270c6 | 2630 | // Notes |
3406acde SH |
2631 | if (!empty($CFG->enablenotes) && (has_capability('moodle/notes:manage', $this->page->context) || has_capability('moodle/notes:view', $this->page->context))) { |
2632 | $coursenode->add(get_string('notes','notes'), new moodle_url('/notes/index.php', array('filtertype'=>'course', 'filterselect'=>$filterselect))); | |
2633 | } | |
593270c6 MD |
2634 | |
2635 | // Tags | |
2636 | if (!empty($CFG->usetags) && isloggedin()) { | |
3406acde | 2637 | $coursenode->add(get_string('tags', 'tag'), new moodle_url('/tag/search.php')); |
7d2a0492 | 2638 | } |
6644741d | 2639 | |
e7f9b7ab SH |
2640 | if (isloggedin()) { |
2641 | // Calendar | |
2642 | $calendarurl = new moodle_url('/calendar/view.php', array('view' => 'month')); | |
2643 | $coursenode->add(get_string('calendar', 'calendar'), $calendarurl, self::TYPE_CUSTOM, null, 'calendar'); | |
2644 | } | |
6644741d | 2645 | |
3406acde | 2646 | return true; |
6644741d | 2647 | } |
da3ab9c4 | 2648 | |
3406acde SH |
2649 | /** |
2650 | * Clears the navigation cache | |
2651 | */ | |
2652 | public function clear_cache() { | |
2653 | $this->cache->clear(); | |
da3ab9c4 | 2654 | } |
88f77c3c | 2655 | |
deaf04c7 SH |
2656 | /** |
2657 | * Sets an expansion limit for the navigation | |
2658 | * | |
2659 | * The expansion limit is used to prevent the display of content that has a type | |
2660 | * greater than the provided $type. | |
2661 | * | |
2662 | * Can be used to ensure things such as activities or activity content don't get | |
2663 | * shown on the navigation. | |
2664 | * They are still generated in order to ensure the navbar still makes sense. | |
2665 | * | |
2666 | * @param int $type One of navigation_node::TYPE_* | |
31fde54f | 2667 | * @return bool true when complete. |
deaf04c7 | 2668 | */ |
88f77c3c | 2669 | public function set_expansion_limit($type) { |
98556b23 | 2670 | global $SITE; |
88f77c3c | 2671 | $nodes = $this->find_all_of_type($type); |
8718ffba SH |
2672 | |
2673 | // We only want to hide specific types of nodes. | |
2674 | // Only nodes that represent "structure" in the navigation tree should be hidden. | |
2675 | // If we hide all nodes then we risk hiding vital information. | |
2676 | $typestohide = array( | |
2677 | self::TYPE_CATEGORY, | |
2678 | self::TYPE_COURSE, | |
2679 | self::TYPE_SECTION, | |
2680 | self::TYPE_ACTIVITY | |
2681 | ); | |
2682 | ||
ba7b1ca5 | 2683 | foreach ($nodes as $node) { |
1af67ecb | 2684 | // We need to generate the full site node |
98556b23 | 2685 | if ($type == self::TYPE_COURSE && $node->key == $SITE->id) { |
1af67ecb SH |
2686 | continue; |
2687 | } | |
ba7b1ca5 | 2688 | foreach ($node->children as $child) { |
8718ffba | 2689 | $child->hide($typestohide); |
88f77c3c SH |
2690 | } |
2691 | } | |
2692 | return true; | |
2693 | } | |
deaf04c7 SH |
2694 | /** |
2695 | * Attempts to get the navigation with the given key from this nodes children. | |
2696 | * | |
2697 | * This function only looks at this nodes children, it does NOT look recursivily. | |
2698 | * If the node can't be found then false is returned. | |
2699 | * | |
93123b17 | 2700 | * If you need to search recursivily then use the {@link global_navigation::find()} method. |
deaf04c7 | 2701 | * |
93123b17 | 2702 | * Note: If you are trying to set the active node {@link navigation_node::override_active_url()} |
deaf04c7 SH |
2703 | * may be of more use to you. |
2704 | * | |
2705 | * @param string|int $key The key of the node you wish to receive. | |
2706 | * @param int $type One of navigation_node::TYPE_* | |
2707 | * @return navigation_node|false | |
2708 | */ | |
e2b436d0 | 2709 | public function get($key, $type = null) { |
246a9b05 SH |
2710 | if (!$this->initialised) { |
2711 | $this->initialise(); | |
2712 | } | |
54dc15ab | 2713 | return parent::get($key, $type); |
e2b436d0 SH |
2714 | } |
2715 | ||
deaf04c7 | 2716 | /** |
31fde54f | 2717 | * Searches this nodes children and their children to find a navigation node |
deaf04c7 SH |
2718 | * with the matching key and type. |
2719 | * | |
2720 | * This method is recursive and searches children so until either a node is | |
31fde54f | 2721 | * found or there are no more nodes to search. |
deaf04c7 SH |
2722 | * |
2723 | * If you know that the node being searched for is a child of this node | |
93123b17 | 2724 | * then use the {@link global_navigation::get()} method instead. |
deaf04c7 | 2725 | * |
93123b17 | 2726 | * Note: If you are trying to set the active node {@link navigation_node::override_active_url()} |
deaf04c7 SH |
2727 | * may be of more use to you. |
2728 | * | |
2729 | * @param string|int $key The key of the node you wish to receive. | |
2730 | * @param int $type One of navigation_node::TYPE_* | |
2731 | * @return navigation_node|false | |
2732 | */ | |
e2b436d0 | 2733 | public function find($key, $type) { |
246a9b05 SH |
2734 | if (!$this->initialised) { |
2735 | $this->initialise(); | |
2736 | } | |
58b602da SH |
2737 | if ($type == self::TYPE_ROOTNODE && array_key_exists($key, $this->rootnodes)) { |
2738 | return $this->rootnodes[$key]; | |
2739 | } | |
54dc15ab | 2740 | return parent::find($key, $type); |
e2b436d0 | 2741 | } |
f87ce4e9 SH |
2742 | |
2743 | /** | |
2744 | * They've expanded the 'my courses' branch. | |
2745 | */ | |
2746 | protected function load_courses_enrolled() { | |
2747 | global $CFG, $DB; | |
2748 | $sortorder = 'visible DESC'; | |
a75dfd6f EL |
2749 | // Prevent undefined $CFG->navsortmycoursessort errors. |
2750 | if (empty($CFG->navsortmycoursessort)) { | |
2751 | $CFG->navsortmycoursessort = 'sortorder'; | |
2752 | } | |
f87ce4e9 SH |
2753 | // Append the chosen sortorder. |
2754 | $sortorder = $sortorder . ',' . $CFG->navsortmycoursessort . ' ASC'; | |
2755 | $courses = enrol_get_my_courses(null, $sortorder); | |
c629c91f | 2756 | if (count($courses) && $this->show_my_categories()) { |
f87ce4e9 SH |
2757 | // OK Actually we are loading categories. We only want to load categories that have a parent of 0. |
2758 | // In order to make sure we load everything required we must first find the categories that are not | |
2759 | // base categories and work out the bottom category in thier path. | |
2760 | $categoryids = array(); | |
2761 | foreach ($courses as $course) { | |
2762 | $categoryids[] = $course->category; | |
2763 | } | |
2764 | $categoryids = array_unique($categoryids); | |
2765 | list($sql, $params) = $DB->get_in_or_equal($categoryids); | |
2766 | $categories = $DB->get_recordset_select('course_categories', 'id '.$sql.' AND parent <> 0', $params, 'sortorder, id', 'id, path'); | |
2767 | foreach ($categories as $category) { | |
2768 | $bits = explode('/', trim($category->path,'/')); | |
2769 | $categoryids[] = array_shift($bits); | |
2770 | } | |
2771 | $categoryids = array_unique($categoryids); | |
2772 | $categories->close(); | |
2773 | ||
2774 | // Now we load the base categories. | |
2775 | list($sql, $params) = $DB->get_in_or_equal($categoryids); | |
2776 | $categories = $DB->get_recordset_select('course_categories', 'id '.$sql.' AND parent = 0', $params, 'sortorder, id'); | |
2777 | foreach ($categories as $category) { | |
257b59e7 | 2778 | $this->add_category($category, $this->rootnodes['mycourses'], self::TYPE_MY_CATEGORY); |
f87ce4e9 SH |
2779 | } |
2780 | $categories->close(); | |
2781 | } else { | |
2782 | foreach ($courses as $course) { | |
2783 | $this->add_course($course, false, self::COURSE_MY); | |
2784 | } | |
2785 | } | |
2786 | } | |
7d2a0492 | 2787 | } |
2788 | ||
2789 | /** | |
98556b23 | 2790 | * The global navigation class used especially for AJAX requests. |
7d2a0492 | 2791 | * |
2792 | * The primary methods that are used in the global navigation class have been overriden | |
2793 | * to ensure that only the relevant branch is generated at the root of the tree. | |
2794 | * This can be done because AJAX is only used when the backwards structure for the | |
2795 | * requested branch exists. | |
2796 | * This has been done only because it shortens the amounts of information that is generated | |
2797 | * which of course will speed up the response time.. because no one likes laggy AJAX. | |
2798 | * | |
31fde54f AG |
2799 | * @package core |
2800 | * @category navigation | |
7d2a0492 | 2801 | * @copyright 2009 Sam Hemelryk |
2802 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
2803 | */ | |
507a7a9a | 2804 | class global_navigation_for_ajax extends global_navigation { |
3406acde | 2805 | |
31fde54f | 2806 | /** @var int used for determining what type of navigation_node::TYPE_* is being used */ |
39ae5e54 | 2807 | protected $branchtype; |
31fde54f AG |
2808 | |
2809 | /** @var int the instance id */ | |
39ae5e54 SH |
2810 | protected $instanceid; |
2811 | ||
31fde54f | 2812 | /** @var array Holds an array of expandable nodes */ |
3406acde SH |
2813 | protected $expandable = array(); |
2814 | ||
7d2a0492 | 2815 | /** |
31fde54f AG |
2816 | * Constructs the navigation for use in an AJAX request |
2817 | * | |
2818 | * @param moodle_page $page moodle_page object | |
2819 | * @param int $branchtype | |
2820 | * @param int $id | |
3406acde | 2821 | */ |
246a9b05 | 2822 | public function __construct($page, $branchtype, $id) { |
4766a50c | 2823 | $this->page = $page; |
3406acde SH |
2824 | $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME); |
2825 | $this->children = new navigation_node_collection(); | |
39ae5e54 SH |
2826 | $this->branchtype = $branchtype; |
2827 | $this->instanceid = $id; | |
2828 | $this->initialise(); | |
3406acde SH |
2829 | } |
2830 | /** | |
2831 | * Initialise the navigation given the type and id for the branch to expand. | |
7d2a0492 | 2832 | * |
31fde54f | 2833 | * @return array An array of the expandable nodes |
7d2a0492 | 2834 | */ |
39ae5e54 | 2835 | public function initialise() { |
58b602da | 2836 | global $DB, $SITE; |
507a7a9a | 2837 | |
7d2a0492 | 2838 | if ($this->initialised || during_initial_install()) { |
95b97515 | 2839 | return $this->expandable; |
7d2a0492 | 2840 | } |
246a9b05 SH |
2841 | $this->initialised = true; |
2842 | ||
2843 | $this->rootnodes = array(); | |
e26507b3 | 2844 | $this->rootnodes['site'] = $this->add_course($SITE); |
58b602da | 2845 | $this->rootnodes['mycourses'] = $this->add(get_string('mycourses'), new moodle_url('/my'), self::TYPE_ROOTNODE, null, 'mycourses'); |
246a9b05 | 2846 | $this->rootnodes['courses'] = $this->add(get_string('courses'), null, self::TYPE_ROOTNODE, null, 'courses'); |
956e2e8a SH |
2847 | // The courses branch is always displayed, and is always expandable (although may be empty). |
2848 | // This mimicks what is done during {@link global_navigation::initialise()}. | |
2849 | $this->rootnodes['courses']->isexpandable = true; | |
507a7a9a SH |
2850 | |
2851 | // Branchtype will be one of navigation_node::TYPE_* | |
39ae5e54 | 2852 | switch ($this->branchtype) { |
58b602da SH |
2853 | case 0: |
2854 | if ($this->instanceid === 'mycourses') { | |
2855 | $this->load_courses_enrolled(); | |
2856 | } else if ($this->instanceid === 'courses') { | |
2857 | $this->load_courses_other(); | |
2858 | } | |
2859 | break; | |
4766a50c | 2860 | case self::TYPE_CATEGORY : |
d4bb6462 | 2861 | $this->load_category($this->instanceid); |
4766a50c | 2862 | break; |
db47f68f RT |
2863 | case self::TYPE_MY_CATEGORY : |
2864 | $this->load_category($this->instanceid, self::TYPE_MY_CATEGORY); | |
2865 | break; | |
507a7a9a | 2866 | case self::TYPE_COURSE : |
74df2951 | 2867 | $course = $DB->get_record('course', array('id' => $this->instanceid), '*', MUST_EXIST); |
817d39b8 SH |
2868 | if (!can_access_course($course)) { |
2869 | // Thats OK all courses are expandable by default. We don't need to actually expand it we can just | |
2870 | // add the course node and break. This leads to an empty node. | |
2871 | $this->add_course($course); | |
2872 | break; | |
2873 | } | |
04bcd1ce | 2874 | require_course_login($course, true, null, false, true); |
b0c6dc1c | 2875 | $this->page->set_context(context_course::instance($course->id)); |
3406acde SH |
2876 | $coursenode = $this->add_course($course); |
2877 | $this->add_course_essentials($coursenode, $course); | |
ee7084e9 | 2878 | $this->load_course_sections($course, $coursenode); |
7d2a0492 | 2879 | break; |
507a7a9a | 2880 | case self::TYPE_SECTION : |
3406acde | 2881 | $sql = 'SELECT c.*, cs.section AS sectionnumber |
507a7a9a SH |
2882 | FROM {course} c |
2883 | LEFT JOIN {course_sections} cs ON cs.course = c.id | |
2884 | WHERE cs.id = ?'; | |
39ae5e54 | 2885 | $course = $DB->get_record_sql($sql, array($this->instanceid), MUST_EXIST); |
04bcd1ce | 2886 | require_course_login($course, true, null, false, true); |
b0c6dc1c | 2887 | $this->page->set_context(context_course::instance($course->id)); |
3406acde SH |
2888 | $coursenode = $this->add_course($course); |
2889 | $this->add_course_essentials($coursenode, $course); | |
e010b850 | 2890 | $this->load_course_sections($course, $coursenode, $course->sectionnumber); |
7d2a0492 | 2891 | break; |
507a7a9a | 2892 | case self::TYPE_ACTIVITY : |
c78262b5 SH |
2893 | $sql = "SELECT c.* |
2894 | FROM {course} c | |
2895 | JOIN {course_modules} cm ON cm.course = c.id | |
2896 | WHERE cm.id = :cmid"; | |
2897 | $params = array('cmid' => $this->instanceid); | |
2898 | $course = $DB->get_record_sql($sql, $params, MUST_EXIST); | |
f0dcc212 SH |
2899 | $modinfo = get_fast_modinfo($course); |
2900 | $cm = $modinfo->get_cm($this->instanceid); | |
04bcd1ce | 2901 | require_course_login($course, true, $cm, false, true); |
b0c6dc1c | 2902 | $this->page->set_context(context_module::instance($cm->id)); |
3406acde | 2903 | $coursenode = $this->load_course($course); |
5c28d159 SH |
2904 | $this->load_course_sections($course, $coursenode, null, $cm); |
2905 | $activitynode = $coursenode->find($cm->id, self::TYPE_ACTIVITY); | |
2906 | if ($activitynode) { | |
2907 | $modulenode = $this->load_activity($cm, $course, $activitynode); | |
1aa1e9b5 | 2908 | } |
7d2a0492 | 2909 | break; |
507a7a9a | 2910 | default: |
3406acde | 2911 | throw new Exception('Unknown type'); |
507a7a9a | 2912 | return $this->expandable; |
7d2a0492 | 2913 | } |
588a3953 | 2914 | |
98556b23 | 2915 | if ($this->page->context->contextlevel == CONTEXT_COURSE && $this->page->context->instanceid != $SITE->id) { |
588a3953 SH |
2916 | $this->load_for_user(null, true); |
2917 | } | |
2918 | ||
507a7a9a | 2919 | $this->find_expandable($this->expandable); |
507a7a9a | 2920 | return $this->expandable; |
246a9b05 SH |
2921 | } |
2922 | ||
58b602da SH |
2923 | /** |
2924 | * They've expanded the general 'courses' branch. | |
2925 | */ | |
2926 | protected function load_courses_other() { | |
2927 | $this->load_all_courses(); | |
2928 | } | |
2929 | ||
d4bb6462 SH |
2930 | /** |
2931 | * Loads a single category into the AJAX navigation. | |
2932 | * | |
2933 | * This function is special in that it doesn't concern itself with the parent of | |
2934 | * the requested category or its siblings. | |
2935 | * This is because with the AJAX navigation we know exactly what is wanted and only need to | |
2936 | * request that. | |
2937 | * | |
2938 | * @global moodle_database $DB | |
db47f68f RT |
2939 | * @param int $categoryid id of category to load in navigation. |
2940 | * @param int $nodetype type of node, if category is under MyHome then it's TYPE_MY_CATEGORY | |
2941 | * @return void. | |
d4bb6462 | 2942 | */ |
db47f68f | 2943 | protected function load_category($categoryid, $nodetype = self::TYPE_CATEGORY) { |
d4bb6462 SH |
2944 | global $CFG, $DB; |
2945 | ||
2946 | $limit = 20; | |
2947 | if (!empty($CFG->navcourselimit)) { | |
2948 | $limit = (int)$CFG->navcourselimit; | |
2949 | } | |
2950 | ||
2951 | $catcontextsql = context_helper::get_preload_record_columns_sql('ctx'); | |
2952 | $sql = "SELECT cc.*, $catcontextsql | |
2953 | FROM {course_categories} cc | |
2954 | JOIN {context} ctx ON cc.id = ctx.instanceid | |
2955 | WHERE ctx.contextlevel = ".CONTEXT_COURSECAT." AND | |
2956 | (cc.id = :categoryid1 OR cc.parent = :categoryid2) | |
957983b7 | 2957 | ORDER BY cc.depth ASC, cc.sortorder ASC, cc.id ASC"; |
d4bb6462 SH |
2958 | $params = array('categoryid1' => $categoryid, 'categoryid2' => $categoryid); |
2959 | $categories = $DB->get_recordset_sql($sql, $params, 0, $limit); | |
0627e1ce | 2960 | $categorylist = array(); |
d4bb6462 SH |
2961 | $subcategories = array(); |
2962 | $basecategory = null; | |
2963 | foreach ($categories as $category) { | |
0627e1ce | 2964 | $categorylist[] = $category->id; |
d4bb6462 SH |
2965 | context_helper::preload_from_record($category); |
2966 | if ($category->id == $categoryid) { | |
db47f68f | 2967 | $this->add_category($category, $this, $nodetype); |
d4bb6462 SH |
2968 | $basecategory = $this->addedcategories[$category->id]; |
2969 | } else { | |
42b40f99 | 2970 | $subcategories[$category->id] = $category; |
d4bb6462 SH |
2971 | } |
2972 | } | |
2973 | $categories->close(); | |
2974 | ||
d4bb6462 | 2975 | |
42b40f99 DV |
2976 | // If category is shown in MyHome then only show enrolled courses and hide empty subcategories, |
2977 | // else show all courses. | |
db47f68f RT |
2978 | if ($nodetype === self::TYPE_MY_CATEGORY) { |
2979 | $courses = enrol_get_my_courses(); | |
42b40f99 DV |
2980 | $categoryids = array(); |
2981 | ||
19263336 | 2982 | // Only search for categories if basecategory was found. |
42b40f99 | 2983 | if (!is_null($basecategory)) { |
19263336 | 2984 | // Get course parent category ids. |
42b40f99 DV |
2985 | foreach ($courses as $course) { |
2986 | $categoryids[] = $course->category; | |
2987 | } | |
2988 | ||
19263336 EL |
2989 | // Get a unique list of category ids which a part of the path |
2990 | // to user's courses. | |
2991 | $coursesubcategories = array(); | |
2992 | $addedsubcategories = array(); | |
42b40f99 DV |
2993 | |
2994 | list($sql, $params) = $DB->get_in_or_equal($categoryids); | |
2995 | $categories = $DB->get_recordset_select('course_categories', 'id '.$sql, $params, 'sortorder, id', 'id, path'); | |
2996 | ||
2997 | foreach ($categories as $category){ | |
19263336 | 2998 | $coursesubcategories = array_merge($coursesubcategories, explode('/', trim($category->path, "/"))); |
42b40f99 | 2999 | } |
19263336 | 3000 | $coursesubcategories = array_unique($coursesubcategories); |
42b40f99 | 3001 | |
19263336 EL |
3002 | // Only add a subcategory if it is part of the path to user's course and |
3003 | // wasn't already added. | |
3004 | foreach ($subcategories as $subid => $subcategory) { | |
3005 | if (in_array($subid, $coursesubcategories) && | |
3006 | !in_array($subid, $addedsubcategories)) { | |
42b40f99 | 3007 | $this->add_category($subcategory, $basecategory, $nodetype); |
19263336 | 3008 | $addedsubcategories[] = $subid; |
42b40f99 DV |
3009 | } |
3010 | } | |
3011 | } | |
19263336 | 3012 | |
db47f68f | 3013 | foreach ($courses as $course) { |
0627e1ce RT |
3014 | // Add course if it's in category. |
3015 | if (in_array($course->category, $categorylist)) { | |
3016 | $this->add_course($course, true, self::COURSE_MY); | |
3017 | } | |
db47f68f RT |
3018 | } |
3019 | } else { | |
42b40f99 DV |
3020 | if (!is_null($basecategory)) { |
3021 | foreach ($subcategories as $key=>$category) { | |
3022 | $this->add_category($category, $basecategory, $nodetype); | |
3023 | } | |
3024 | } | |
db47f68f RT |
3025 | $courses = $DB->get_recordset('course', array('category' => $categoryid), 'sortorder', '*' , 0, $limit); |
3026 | foreach ($courses as $course) { | |
3027 | $this->add_course($course); | |
3028 | } | |
3029 | $courses->close(); | |
d4bb6462 | 3030 | } |
d4bb6462 SH |
3031 | } |
3032 | ||
deaf04c7 SH |
3033 | /** |
3034 | * Returns an array of expandable nodes | |
3035 | * @return array | |
3036 | */ | |
246a9b05 SH |
3037 | public function get_expandable() { |
3038 | return $this->expandable; | |
7d2a0492 | 3039 | } |
7d2a0492 | 3040 | } |
3041 | ||
3042 | /** | |
3043 | * Navbar class | |
3044 | * | |
3045 | * This class is used to manage the navbar, which is initialised from the navigation | |
3046 | * object held by PAGE | |
3047 | * | |
31fde54f AG |
3048 | * @package core |
3049 | * @category navigation | |
7d2a0492 | 3050 | * @copyright 2009 Sam Hemelryk |
3051 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
3052 | */ | |
3053 | class navbar extends navigation_node { | |
31fde54f | 3054 | /** @var bool A switch for whether the navbar is initialised or not */ |
7d2a0492 | 3055 | protected $initialised = false; |
31fde54f | 3056 | /** @var mixed keys used to reference the nodes on the navbar */ |
7d2a0492 | 3057 | protected $keys = array(); |
31fde54f | 3058 | /** @var null|string content of the navbar */ |
7d2a0492 | 3059 | protected $content = null; |
31fde54f | 3060 | /** @var moodle_page object the moodle page that this navbar belongs to */ |
7d2a0492 | 3061 | protected $page; |
31fde54f | 3062 | /** @var bool A switch for whether to ignore the active navigation information */ |
31759089 | 3063 | protected $ignoreactive = false; |
31fde54f | 3064 | /** @var bool A switch to let us know if we are in the middle of an install */ |
7d2a0492 | 3065 | protected $duringinstall = false; |
31fde54f | 3066 | /** @var bool A switch for whether the navbar has items */ |
7a7e209d | 3067 | protected $hasitems = false; |
31fde54f | 3068 | /** @var array An array of navigation nodes for the navbar */ |