/lib/navigationlib.php
PHP | 4905 lines | 2966 code | 392 blank | 1547 comment | 899 complexity | aca9fb727abc7da1c073158d58ad1c88 MD5 | raw file
Possible License(s): GPL-3.0, LGPL-2.1, BSD-3-Clause, Apache-2.0
Large files files are truncated, but you can click here to view the full file
- <?php
- // This file is part of Moodle - http://moodle.org/
- //
- // Moodle is free software: you can redistribute it and/or modify
- // it under the terms of the GNU General Public License as published by
- // the Free Software Foundation, either version 3 of the License, or
- // (at your option) any later version.
- //
- // Moodle is distributed in the hope that it will be useful,
- // but WITHOUT ANY WARRANTY; without even the implied warranty of
- // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- // GNU General Public License for more details.
- //
- // You should have received a copy of the GNU General Public License
- // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
- /**
- * This file contains classes used to manage the navigation structures within Moodle.
- *
- * @since Moodle 2.0
- * @package core
- * @copyright 2009 Sam Hemelryk
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
- defined('MOODLE_INTERNAL') || die();
- /**
- * The name that will be used to separate the navigation cache within SESSION
- */
- define('NAVIGATION_CACHE_NAME', 'navigation');
- define('NAVIGATION_SITE_ADMIN_CACHE_NAME', 'navigationsiteadmin');
- /**
- * This class is used to represent a node in a navigation tree
- *
- * This class is used to represent a node in a navigation tree within Moodle,
- * the tree could be one of global navigation, settings navigation, or the navbar.
- * Each node can be one of two types either a Leaf (default) or a branch.
- * When a node is first created it is created as a leaf, when/if children are added
- * the node then becomes a branch.
- *
- * @package core
- * @category navigation
- * @copyright 2009 Sam Hemelryk
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
- class navigation_node implements renderable {
- /** @var int Used to identify this node a leaf (default) 0 */
- const NODETYPE_LEAF = 0;
- /** @var int Used to identify this node a branch, happens with children 1 */
- const NODETYPE_BRANCH = 1;
- /** @var null Unknown node type null */
- const TYPE_UNKNOWN = null;
- /** @var int System node type 0 */
- const TYPE_ROOTNODE = 0;
- /** @var int System node type 1 */
- const TYPE_SYSTEM = 1;
- /** @var int Category node type 10 */
- const TYPE_CATEGORY = 10;
- /** var int Category displayed in MyHome navigation node */
- const TYPE_MY_CATEGORY = 11;
- /** @var int Course node type 20 */
- const TYPE_COURSE = 20;
- /** @var int Course Structure node type 30 */
- const TYPE_SECTION = 30;
- /** @var int Activity node type, e.g. Forum, Quiz 40 */
- const TYPE_ACTIVITY = 40;
- /** @var int Resource node type, e.g. Link to a file, or label 50 */
- const TYPE_RESOURCE = 50;
- /** @var int A custom node type, default when adding without specifing type 60 */
- const TYPE_CUSTOM = 60;
- /** @var int Setting node type, used only within settings nav 70 */
- const TYPE_SETTING = 70;
- /** @var int site admin branch node type, used only within settings nav 71 */
- const TYPE_SITE_ADMIN = 71;
- /** @var int Setting node type, used only within settings nav 80 */
- const TYPE_USER = 80;
- /** @var int Setting node type, used for containers of no importance 90 */
- const TYPE_CONTAINER = 90;
- /** var int Course the current user is not enrolled in */
- const COURSE_OTHER = 0;
- /** var int Course the current user is enrolled in but not viewing */
- const COURSE_MY = 1;
- /** var int Course the current user is currently viewing */
- const COURSE_CURRENT = 2;
- /** @var int Parameter to aid the coder in tracking [optional] */
- public $id = null;
- /** @var string|int The identifier for the node, used to retrieve the node */
- public $key = null;
- /** @var string The text to use for the node */
- public $text = null;
- /** @var string Short text to use if requested [optional] */
- public $shorttext = null;
- /** @var string The title attribute for an action if one is defined */
- public $title = null;
- /** @var string A string that can be used to build a help button */
- public $helpbutton = null;
- /** @var moodle_url|action_link|null An action for the node (link) */
- public $action = null;
- /** @var pix_icon The path to an icon to use for this node */
- public $icon = null;
- /** @var int See TYPE_* constants defined for this class */
- public $type = self::TYPE_UNKNOWN;
- /** @var int See NODETYPE_* constants defined for this class */
- public $nodetype = self::NODETYPE_LEAF;
- /** @var bool If set to true the node will be collapsed by default */
- public $collapse = false;
- /** @var bool If set to true the node will be expanded by default */
- public $forceopen = false;
- /** @var array An array of CSS classes for the node */
- public $classes = array();
- /** @var navigation_node_collection An array of child nodes */
- public $children = array();
- /** @var bool If set to true the node will be recognised as active */
- public $isactive = false;
- /** @var bool If set to true the node will be dimmed */
- public $hidden = false;
- /** @var bool If set to false the node will not be displayed */
- public $display = true;
- /** @var bool If set to true then an HR will be printed before the node */
- public $preceedwithhr = false;
- /** @var bool If set to true the the navigation bar should ignore this node */
- public $mainnavonly = false;
- /** @var bool If set to true a title will be added to the action no matter what */
- public $forcetitle = false;
- /** @var navigation_node A reference to the node parent, you should never set this directly you should always call set_parent */
- public $parent = null;
- /** @var bool Override to not display the icon even if one is provided **/
- public $hideicon = false;
- /** @var bool Set to true if we KNOW that this node can be expanded. */
- public $isexpandable = false;
- /** @var array */
- protected $namedtypes = array(0=>'system',10=>'category',20=>'course',30=>'structure',40=>'activity',50=>'resource',60=>'custom',70=>'setting',71=>'siteadmin', 80=>'user');
- /** @var moodle_url */
- protected static $fullmeurl = null;
- /** @var bool toogles auto matching of active node */
- public static $autofindactive = true;
- /** @var bool should we load full admin tree or rely on AJAX for performance reasons */
- protected static $loadadmintree = false;
- /** @var mixed If set to an int, that section will be included even if it has no activities */
- public $includesectionnum = false;
- /**
- * Constructs a new navigation_node
- *
- * @param array|string $properties Either an array of properties or a string to use
- * as the text for the node
- */
- public function __construct($properties) {
- if (is_array($properties)) {
- // Check the array for each property that we allow to set at construction.
- // text - The main content for the node
- // shorttext - A short text if required for the node
- // icon - The icon to display for the node
- // type - The type of the node
- // key - The key to use to identify the node
- // parent - A reference to the nodes parent
- // action - The action to attribute to this node, usually a URL to link to
- if (array_key_exists('text', $properties)) {
- $this->text = $properties['text'];
- }
- if (array_key_exists('shorttext', $properties)) {
- $this->shorttext = $properties['shorttext'];
- }
- if (!array_key_exists('icon', $properties)) {
- $properties['icon'] = new pix_icon('i/navigationitem', '');
- }
- $this->icon = $properties['icon'];
- if ($this->icon instanceof pix_icon) {
- if (empty($this->icon->attributes['class'])) {
- $this->icon->attributes['class'] = 'navicon';
- } else {
- $this->icon->attributes['class'] .= ' navicon';
- }
- }
- if (array_key_exists('type', $properties)) {
- $this->type = $properties['type'];
- } else {
- $this->type = self::TYPE_CUSTOM;
- }
- if (array_key_exists('key', $properties)) {
- $this->key = $properties['key'];
- }
- // This needs to happen last because of the check_if_active call that occurs
- if (array_key_exists('action', $properties)) {
- $this->action = $properties['action'];
- if (is_string($this->action)) {
- $this->action = new moodle_url($this->action);
- }
- if (self::$autofindactive) {
- $this->check_if_active();
- }
- }
- if (array_key_exists('parent', $properties)) {
- $this->set_parent($properties['parent']);
- }
- } else if (is_string($properties)) {
- $this->text = $properties;
- }
- if ($this->text === null) {
- throw new coding_exception('You must set the text for the node when you create it.');
- }
- // Instantiate a new navigation node collection for this nodes children
- $this->children = new navigation_node_collection();
- }
- /**
- * Checks if this node is the active node.
- *
- * This is determined by comparing the action for the node against the
- * defined URL for the page. A match will see this node marked as active.
- *
- * @param int $strength One of URL_MATCH_EXACT, URL_MATCH_PARAMS, or URL_MATCH_BASE
- * @return bool
- */
- public function check_if_active($strength=URL_MATCH_EXACT) {
- global $FULLME, $PAGE;
- // Set fullmeurl if it hasn't already been set
- if (self::$fullmeurl == null) {
- if ($PAGE->has_set_url()) {
- self::override_active_url(new moodle_url($PAGE->url));
- } else {
- self::override_active_url(new moodle_url($FULLME));
- }
- }
- // Compare the action of this node against the fullmeurl
- if ($this->action instanceof moodle_url && $this->action->compare(self::$fullmeurl, $strength)) {
- $this->make_active();
- return true;
- }
- return false;
- }
- /**
- * This sets the URL that the URL of new nodes get compared to when locating
- * the active node.
- *
- * The active node is the node that matches the URL set here. By default this
- * is either $PAGE->url or if that hasn't been set $FULLME.
- *
- * @param moodle_url $url The url to use for the fullmeurl.
- * @param bool $loadadmintree use true if the URL point to administration tree
- */
- public static function override_active_url(moodle_url $url, $loadadmintree = false) {
- // Clone the URL, in case the calling script changes their URL later.
- self::$fullmeurl = new moodle_url($url);
- // True means we do not want AJAX loaded admin tree, required for all admin pages.
- if ($loadadmintree) {
- // Do not change back to false if already set.
- self::$loadadmintree = true;
- }
- }
- /**
- * Use when page is linked from the admin tree,
- * if not used navigation could not find the page using current URL
- * because the tree is not fully loaded.
- */
- public static function require_admin_tree() {
- self::$loadadmintree = true;
- }
- /**
- * Creates a navigation node, ready to add it as a child using add_node
- * function. (The created node needs to be added before you can use it.)
- * @param string $text
- * @param moodle_url|action_link $action
- * @param int $type
- * @param string $shorttext
- * @param string|int $key
- * @param pix_icon $icon
- * @return navigation_node
- */
- public static function create($text, $action=null, $type=self::TYPE_CUSTOM,
- $shorttext=null, $key=null, pix_icon $icon=null) {
- // Properties array used when creating the new navigation node
- $itemarray = array(
- 'text' => $text,
- 'type' => $type
- );
- // Set the action if one was provided
- if ($action!==null) {
- $itemarray['action'] = $action;
- }
- // Set the shorttext if one was provided
- if ($shorttext!==null) {
- $itemarray['shorttext'] = $shorttext;
- }
- // Set the icon if one was provided
- if ($icon!==null) {
- $itemarray['icon'] = $icon;
- }
- // Set the key
- $itemarray['key'] = $key;
- // Construct and return
- return new navigation_node($itemarray);
- }
- /**
- * Adds a navigation node as a child of this node.
- *
- * @param string $text
- * @param moodle_url|action_link $action
- * @param int $type
- * @param string $shorttext
- * @param string|int $key
- * @param pix_icon $icon
- * @return navigation_node
- */
- public function add($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, pix_icon $icon=null) {
- // Create child node
- $childnode = self::create($text, $action, $type, $shorttext, $key, $icon);
- // Add the child to end and return
- return $this->add_node($childnode);
- }
- /**
- * Adds a navigation node as a child of this one, given a $node object
- * created using the create function.
- * @param navigation_node $childnode Node to add
- * @param string $beforekey
- * @return navigation_node The added node
- */
- public function add_node(navigation_node $childnode, $beforekey=null) {
- // First convert the nodetype for this node to a branch as it will now have children
- if ($this->nodetype !== self::NODETYPE_BRANCH) {
- $this->nodetype = self::NODETYPE_BRANCH;
- }
- // Set the parent to this node
- $childnode->set_parent($this);
- // Default the key to the number of children if not provided
- if ($childnode->key === null) {
- $childnode->key = $this->children->count();
- }
- // Add the child using the navigation_node_collections add method
- $node = $this->children->add($childnode, $beforekey);
- // If added node is a category node or the user is logged in and it's a course
- // then mark added node as a branch (makes it expandable by AJAX)
- $type = $childnode->type;
- if (($type == self::TYPE_CATEGORY) || (isloggedin() && ($type == self::TYPE_COURSE)) || ($type == self::TYPE_MY_CATEGORY) ||
- ($type === self::TYPE_SITE_ADMIN)) {
- $node->nodetype = self::NODETYPE_BRANCH;
- }
- // If this node is hidden mark it's children as hidden also
- if ($this->hidden) {
- $node->hidden = true;
- }
- // Return added node (reference returned by $this->children->add()
- return $node;
- }
- /**
- * Return a list of all the keys of all the child nodes.
- * @return array the keys.
- */
- public function get_children_key_list() {
- return $this->children->get_key_list();
- }
- /**
- * Searches for a node of the given type with the given key.
- *
- * This searches this node plus all of its children, and their children....
- * If you know the node you are looking for is a child of this node then please
- * use the get method instead.
- *
- * @param int|string $key The key of the node we are looking for
- * @param int $type One of navigation_node::TYPE_*
- * @return navigation_node|false
- */
- public function find($key, $type) {
- return $this->children->find($key, $type);
- }
- /**
- * Get the child of this node that has the given key + (optional) type.
- *
- * If you are looking for a node and want to search all children + thier children
- * then please use the find method instead.
- *
- * @param int|string $key The key of the node we are looking for
- * @param int $type One of navigation_node::TYPE_*
- * @return navigation_node|false
- */
- public function get($key, $type=null) {
- return $this->children->get($key, $type);
- }
- /**
- * Removes this node.
- *
- * @return bool
- */
- public function remove() {
- return $this->parent->children->remove($this->key, $this->type);
- }
- /**
- * Checks if this node has or could have any children
- *
- * @return bool Returns true if it has children or could have (by AJAX expansion)
- */
- public function has_children() {
- return ($this->nodetype === navigation_node::NODETYPE_BRANCH || $this->children->count()>0 || $this->isexpandable);
- }
- /**
- * Marks this node as active and forces it open.
- *
- * Important: If you are here because you need to mark a node active to get
- * the navigation to do what you want have you looked at {@link navigation_node::override_active_url()}?
- * You can use it to specify a different URL to match the active navigation node on
- * rather than having to locate and manually mark a node active.
- */
- public function make_active() {
- $this->isactive = true;
- $this->add_class('active_tree_node');
- $this->force_open();
- if ($this->parent !== null) {
- $this->parent->make_inactive();
- }
- }
- /**
- * Marks a node as inactive and recusised back to the base of the tree
- * doing the same to all parents.
- */
- public function make_inactive() {
- $this->isactive = false;
- $this->remove_class('active_tree_node');
- if ($this->parent !== null) {
- $this->parent->make_inactive();
- }
- }
- /**
- * Forces this node to be open and at the same time forces open all
- * parents until the root node.
- *
- * Recursive.
- */
- public function force_open() {
- $this->forceopen = true;
- if ($this->parent !== null) {
- $this->parent->force_open();
- }
- }
- /**
- * Adds a CSS class to this node.
- *
- * @param string $class
- * @return bool
- */
- public function add_class($class) {
- if (!in_array($class, $this->classes)) {
- $this->classes[] = $class;
- }
- return true;
- }
- /**
- * Removes a CSS class from this node.
- *
- * @param string $class
- * @return bool True if the class was successfully removed.
- */
- public function remove_class($class) {
- if (in_array($class, $this->classes)) {
- $key = array_search($class,$this->classes);
- if ($key!==false) {
- unset($this->classes[$key]);
- return true;
- }
- }
- return false;
- }
- /**
- * Sets the title for this node and forces Moodle to utilise it.
- * @param string $title
- */
- public function title($title) {
- $this->title = $title;
- $this->forcetitle = true;
- }
- /**
- * Resets the page specific information on this node if it is being unserialised.
- */
- public function __wakeup(){
- $this->forceopen = false;
- $this->isactive = false;
- $this->remove_class('active_tree_node');
- }
- /**
- * Checks if this node or any of its children contain the active node.
- *
- * Recursive.
- *
- * @return bool
- */
- public function contains_active_node() {
- if ($this->isactive) {
- return true;
- } else {
- foreach ($this->children as $child) {
- if ($child->isactive || $child->contains_active_node()) {
- return true;
- }
- }
- }
- return false;
- }
- /**
- * Finds the active node.
- *
- * Searches this nodes children plus all of the children for the active node
- * and returns it if found.
- *
- * Recursive.
- *
- * @return navigation_node|false
- */
- public function find_active_node() {
- if ($this->isactive) {
- return $this;
- } else {
- foreach ($this->children as &$child) {
- $outcome = $child->find_active_node();
- if ($outcome !== false) {
- return $outcome;
- }
- }
- }
- return false;
- }
- /**
- * Searches all children for the best matching active node
- * @return navigation_node|false
- */
- public function search_for_active_node() {
- if ($this->check_if_active(URL_MATCH_BASE)) {
- return $this;
- } else {
- foreach ($this->children as &$child) {
- $outcome = $child->search_for_active_node();
- if ($outcome !== false) {
- return $outcome;
- }
- }
- }
- return false;
- }
- /**
- * Gets the content for this node.
- *
- * @param bool $shorttext If true shorttext is used rather than the normal text
- * @return string
- */
- public function get_content($shorttext=false) {
- if ($shorttext && $this->shorttext!==null) {
- return format_string($this->shorttext);
- } else {
- return format_string($this->text);
- }
- }
- /**
- * Gets the title to use for this node.
- *
- * @return string
- */
- public function get_title() {
- if ($this->forcetitle || $this->action != null){
- return $this->title;
- } else {
- return '';
- }
- }
- /**
- * Gets the CSS class to add to this node to describe its type
- *
- * @return string
- */
- public function get_css_type() {
- if (array_key_exists($this->type, $this->namedtypes)) {
- return 'type_'.$this->namedtypes[$this->type];
- }
- return 'type_unknown';
- }
- /**
- * Finds all nodes that are expandable by AJAX
- *
- * @param array $expandable An array by reference to populate with expandable nodes.
- */
- public function find_expandable(array &$expandable) {
- foreach ($this->children as &$child) {
- if ($child->display && $child->has_children() && $child->children->count() == 0) {
- $child->id = 'expandable_branch_'.$child->type.'_'.clean_param($child->key, PARAM_ALPHANUMEXT);
- $this->add_class('canexpand');
- $expandable[] = array('id' => $child->id, 'key' => $child->key, 'type' => $child->type);
- }
- $child->find_expandable($expandable);
- }
- }
- /**
- * Finds all nodes of a given type (recursive)
- *
- * @param int $type One of navigation_node::TYPE_*
- * @return array
- */
- public function find_all_of_type($type) {
- $nodes = $this->children->type($type);
- foreach ($this->children as &$node) {
- $childnodes = $node->find_all_of_type($type);
- $nodes = array_merge($nodes, $childnodes);
- }
- return $nodes;
- }
- /**
- * Removes this node if it is empty
- */
- public function trim_if_empty() {
- if ($this->children->count() == 0) {
- $this->remove();
- }
- }
- /**
- * Creates a tab representation of this nodes children that can be used
- * with print_tabs to produce the tabs on a page.
- *
- * call_user_func_array('print_tabs', $node->get_tabs_array());
- *
- * @param array $inactive
- * @param bool $return
- * @return array Array (tabs, selected, inactive, activated, return)
- */
- public function get_tabs_array(array $inactive=array(), $return=false) {
- $tabs = array();
- $rows = array();
- $selected = null;
- $activated = array();
- foreach ($this->children as $node) {
- $tabs[] = new tabobject($node->key, $node->action, $node->get_content(), $node->get_title());
- if ($node->contains_active_node()) {
- if ($node->children->count() > 0) {
- $activated[] = $node->key;
- foreach ($node->children as $child) {
- if ($child->contains_active_node()) {
- $selected = $child->key;
- }
- $rows[] = new tabobject($child->key, $child->action, $child->get_content(), $child->get_title());
- }
- } else {
- $selected = $node->key;
- }
- }
- }
- return array(array($tabs, $rows), $selected, $inactive, $activated, $return);
- }
- /**
- * Sets the parent for this node and if this node is active ensures that the tree is properly
- * adjusted as well.
- *
- * @param navigation_node $parent
- */
- public function set_parent(navigation_node $parent) {
- // Set the parent (thats the easy part)
- $this->parent = $parent;
- // Check if this node is active (this is checked during construction)
- if ($this->isactive) {
- // Force all of the parent nodes open so you can see this node
- $this->parent->force_open();
- // Make all parents inactive so that its clear where we are.
- $this->parent->make_inactive();
- }
- }
- /**
- * Hides the node and any children it has.
- *
- * @since Moodle 2.5
- * @param array $typestohide Optional. An array of node types that should be hidden.
- * If null all nodes will be hidden.
- * If an array is given then nodes will only be hidden if their type mtatches an element in the array.
- * e.g. array(navigation_node::TYPE_COURSE) would hide only course nodes.
- */
- public function hide(array $typestohide = null) {
- if ($typestohide === null || in_array($this->type, $typestohide)) {
- $this->display = false;
- if ($this->has_children()) {
- foreach ($this->children as $child) {
- $child->hide($typestohide);
- }
- }
- }
- }
- }
- /**
- * Navigation node collection
- *
- * This class is responsible for managing a collection of navigation nodes.
- * It is required because a node's unique identifier is a combination of both its
- * key and its type.
- *
- * Originally an array was used with a string key that was a combination of the two
- * however it was decided that a better solution would be to use a class that
- * implements the standard IteratorAggregate interface.
- *
- * @package core
- * @category navigation
- * @copyright 2010 Sam Hemelryk
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
- class navigation_node_collection implements IteratorAggregate {
- /**
- * A multidimensional array to where the first key is the type and the second
- * key is the nodes key.
- * @var array
- */
- protected $collection = array();
- /**
- * An array that contains references to nodes in the same order they were added.
- * This is maintained as a progressive array.
- * @var array
- */
- protected $orderedcollection = array();
- /**
- * A reference to the last node that was added to the collection
- * @var navigation_node
- */
- protected $last = null;
- /**
- * The total number of items added to this array.
- * @var int
- */
- protected $count = 0;
- /**
- * Adds a navigation node to the collection
- *
- * @param navigation_node $node Node to add
- * @param string $beforekey If specified, adds before a node with this key,
- * otherwise adds at end
- * @return navigation_node Added node
- */
- public function add(navigation_node $node, $beforekey=null) {
- global $CFG;
- $key = $node->key;
- $type = $node->type;
- // First check we have a 2nd dimension for this type
- if (!array_key_exists($type, $this->orderedcollection)) {
- $this->orderedcollection[$type] = array();
- }
- // Check for a collision and report if debugging is turned on
- if ($CFG->debug && array_key_exists($key, $this->orderedcollection[$type])) {
- debugging('Navigation node intersect: Adding a node that already exists '.$key, DEBUG_DEVELOPER);
- }
- // Find the key to add before
- $newindex = $this->count;
- $last = true;
- if ($beforekey !== null) {
- foreach ($this->collection as $index => $othernode) {
- if ($othernode->key === $beforekey) {
- $newindex = $index;
- $last = false;
- break;
- }
- }
- if ($newindex === $this->count) {
- debugging('Navigation node add_before: Reference node not found ' . $beforekey .
- ', options: ' . implode(' ', $this->get_key_list()), DEBUG_DEVELOPER);
- }
- }
- // Add the node to the appropriate place in the by-type structure (which
- // is not ordered, despite the variable name)
- $this->orderedcollection[$type][$key] = $node;
- if (!$last) {
- // Update existing references in the ordered collection (which is the
- // one that isn't called 'ordered') to shuffle them along if required
- for ($oldindex = $this->count; $oldindex > $newindex; $oldindex--) {
- $this->collection[$oldindex] = $this->collection[$oldindex - 1];
- }
- }
- // Add a reference to the node to the progressive collection.
- $this->collection[$newindex] = $this->orderedcollection[$type][$key];
- // Update the last property to a reference to this new node.
- $this->last = $this->orderedcollection[$type][$key];
- // Reorder the array by index if needed
- if (!$last) {
- ksort($this->collection);
- }
- $this->count++;
- // Return the reference to the now added node
- return $node;
- }
- /**
- * Return a list of all the keys of all the nodes.
- * @return array the keys.
- */
- public function get_key_list() {
- $keys = array();
- foreach ($this->collection as $node) {
- $keys[] = $node->key;
- }
- return $keys;
- }
- /**
- * Fetches a node from this collection.
- *
- * @param string|int $key The key of the node we want to find.
- * @param int $type One of navigation_node::TYPE_*.
- * @return navigation_node|null
- */
- public function get($key, $type=null) {
- if ($type !== null) {
- // If the type is known then we can simply check and fetch
- if (!empty($this->orderedcollection[$type][$key])) {
- return $this->orderedcollection[$type][$key];
- }
- } else {
- // Because we don't know the type we look in the progressive array
- foreach ($this->collection as $node) {
- if ($node->key === $key) {
- return $node;
- }
- }
- }
- return false;
- }
- /**
- * Searches for a node with matching key and type.
- *
- * This function searches both the nodes in this collection and all of
- * the nodes in each collection belonging to the nodes in this collection.
- *
- * Recursive.
- *
- * @param string|int $key The key of the node we want to find.
- * @param int $type One of navigation_node::TYPE_*.
- * @return navigation_node|null
- */
- public function find($key, $type=null) {
- if ($type !== null && array_key_exists($type, $this->orderedcollection) && array_key_exists($key, $this->orderedcollection[$type])) {
- return $this->orderedcollection[$type][$key];
- } else {
- $nodes = $this->getIterator();
- // Search immediate children first
- foreach ($nodes as &$node) {
- if ($node->key === $key && ($type === null || $type === $node->type)) {
- return $node;
- }
- }
- // Now search each childs children
- foreach ($nodes as &$node) {
- $result = $node->children->find($key, $type);
- if ($result !== false) {
- return $result;
- }
- }
- }
- return false;
- }
- /**
- * Fetches the last node that was added to this collection
- *
- * @return navigation_node
- */
- public function last() {
- return $this->last;
- }
- /**
- * Fetches all nodes of a given type from this collection
- *
- * @param string|int $type node type being searched for.
- * @return array ordered collection
- */
- public function type($type) {
- if (!array_key_exists($type, $this->orderedcollection)) {
- $this->orderedcollection[$type] = array();
- }
- return $this->orderedcollection[$type];
- }
- /**
- * Removes the node with the given key and type from the collection
- *
- * @param string|int $key The key of the node we want to find.
- * @param int $type
- * @return bool
- */
- public function remove($key, $type=null) {
- $child = $this->get($key, $type);
- if ($child !== false) {
- foreach ($this->collection as $colkey => $node) {
- if ($node->key === $key && $node->type == $type) {
- unset($this->collection[$colkey]);
- $this->collection = array_values($this->collection);
- break;
- }
- }
- unset($this->orderedcollection[$child->type][$child->key]);
- $this->count--;
- return true;
- }
- return false;
- }
- /**
- * Gets the number of nodes in this collection
- *
- * This option uses an internal count rather than counting the actual options to avoid
- * a performance hit through the count function.
- *
- * @return int
- */
- public function count() {
- return $this->count;
- }
- /**
- * Gets an array iterator for the collection.
- *
- * This is required by the IteratorAggregator interface and is used by routines
- * such as the foreach loop.
- *
- * @return ArrayIterator
- */
- public function getIterator() {
- return new ArrayIterator($this->collection);
- }
- }
- /**
- * The global navigation class used for... the global navigation
- *
- * This class is used by PAGE to store the global navigation for the site
- * and is then used by the settings nav and navbar to save on processing and DB calls
- *
- * See
- * {@link lib/pagelib.php} {@link moodle_page::initialise_theme_and_output()}
- * {@link lib/ajax/getnavbranch.php} Called by ajax
- *
- * @package core
- * @category navigation
- * @copyright 2009 Sam Hemelryk
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
- class global_navigation extends navigation_node {
- /** @var moodle_page The Moodle page this navigation object belongs to. */
- protected $page;
- /** @var bool switch to let us know if the navigation object is initialised*/
- protected $initialised = false;
- /** @var array An array of course information */
- protected $mycourses = array();
- /** @var array An array for containing root navigation nodes */
- protected $rootnodes = array();
- /** @var bool A switch for whether to show empty sections in the navigation */
- protected $showemptysections = true;
- /** @var bool A switch for whether courses should be shown within categories on the navigation. */
- protected $showcategories = null;
- /** @var null@var bool A switch for whether or not to show categories in the my courses branch. */
- protected $showmycategories = null;
- /** @var array An array of stdClasses for users that the navigation is extended for */
- protected $extendforuser = array();
- /** @var navigation_cache */
- protected $cache;
- /** @var array An array of course ids that are present in the navigation */
- protected $addedcourses = array();
- /** @var bool */
- protected $allcategoriesloaded = false;
- /** @var array An array of category ids that are included in the navigation */
- protected $addedcategories = array();
- /** @var int expansion limit */
- protected $expansionlimit = 0;
- /** @var int userid to allow parent to see child's profile page navigation */
- protected $useridtouseforparentchecks = 0;
- /** @var cache_session A cache that stores information on expanded courses */
- protected $cacheexpandcourse = null;
- /** Used when loading categories to load all top level categories [parent = 0] **/
- const LOAD_ROOT_CATEGORIES = 0;
- /** Used when loading categories to load all categories **/
- const LOAD_ALL_CATEGORIES = -1;
- /**
- * Constructs a new global navigation
- *
- * @param moodle_page $page The page this navigation object belongs to
- */
- public function __construct(moodle_page $page) {
- global $CFG, $SITE, $USER;
- if (during_initial_install()) {
- return;
- }
- if (get_home_page() == HOMEPAGE_SITE) {
- // We are using the site home for the root element
- $properties = array(
- 'key' => 'home',
- 'type' => navigation_node::TYPE_SYSTEM,
- 'text' => get_string('home'),
- 'action' => new moodle_url('/')
- );
- } else {
- // We are using the users my moodle for the root element
- $properties = array(
- 'key' => 'myhome',
- 'type' => navigation_node::TYPE_SYSTEM,
- 'text' => get_string('myhome'),
- 'action' => new moodle_url('/my/')
- );
- }
- // Use the parents constructor.... good good reuse
- parent::__construct($properties);
- // Initalise and set defaults
- $this->page = $page;
- $this->forceopen = true;
- $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
- }
- /**
- * Mutator to set userid to allow parent to see child's profile
- * page navigation. See MDL-25805 for initial issue. Linked to it
- * is an issue explaining why this is a REALLY UGLY HACK thats not
- * for you to use!
- *
- * @param int $userid userid of profile page that parent wants to navigate around.
- */
- public function set_userid_for_parent_checks($userid) {
- $this->useridtouseforparentchecks = $userid;
- }
- /**
- * Initialises the navigation object.
- *
- * This causes the navigation object to look at the current state of the page
- * that it is associated with and then load the appropriate content.
- *
- * This should only occur the first time that the navigation structure is utilised
- * which will normally be either when the navbar is called to be displayed or
- * when a block makes use of it.
- *
- * @return bool
- */
- public function initialise() {
- global $CFG, $SITE, $USER;
- // Check if it has already been initialised
- if ($this->initialised || during_initial_install()) {
- return true;
- }
- $this->initialised = true;
- // Set up the five base root nodes. These are nodes where we will put our
- // content and are as follows:
- // site: Navigation for the front page.
- // myprofile: User profile information goes here.
- // currentcourse: The course being currently viewed.
- // mycourses: The users courses get added here.
- // courses: Additional courses are added here.
- // users: Other users information loaded here.
- $this->rootnodes = array();
- if (get_home_page() == HOMEPAGE_SITE) {
- // The home element should be my moodle because the root element is the site
- if (isloggedin() && !isguestuser()) { // Makes no sense if you aren't logged in
- $this->rootnodes['home'] = $this->add(get_string('myhome'), new moodle_url('/my/'), self::TYPE_SETTING, null, 'home');
- }
- } else {
- // The home element should be the site because the root node is my moodle
- $this->rootnodes['home'] = $this->add(get_string('sitehome'), new moodle_url('/'), self::TYPE_SETTING, null, 'home');
- if (!empty($CFG->defaulthomepage) && ($CFG->defaulthomepage == HOMEPAGE_MY)) {
- // We need to stop automatic redirection
- $this->rootnodes['home']->action->param('redirect', '0');
- }
- }
- $this->rootnodes['site'] = $this->add_course($SITE);
- $this->rootnodes['myprofile'] = $this->add(get_string('myprofile'), null, self::TYPE_USER, null, 'myprofile');
- $this->rootnodes['currentcourse'] = $this->add(get_string('currentcourse'), null, self::TYPE_ROOTNODE, null, 'currentcourse');
- $this->rootnodes['mycourses'] = $this->add(get_string('mycourses'), new moodle_url('/my/'), self::TYPE_ROOTNODE, null, 'mycourses');
- $this->rootnodes['courses'] = $this->add(get_string('courses'), new moodle_url('/course/index.php'), self::TYPE_ROOTNODE, null, 'courses');
- $this->rootnodes['users'] = $this->add(get_string('users'), null, self::TYPE_ROOTNODE, null, 'users');
- // We always load the frontpage course to ensure it is available without
- // JavaScript enabled.
- $this->add_front_page_course_essentials($this->rootnodes['site'], $SITE);
- $this->load_course_sections($SITE, $this->rootnodes['site']);
- $course = $this->page->course;
- // $issite gets set to true if the current pages course is the sites frontpage course
- $issite = ($this->page->course->id == $SITE->id);
- // Determine if the user is enrolled in any course.
- $enrolledinanycourse = enrol_user_sees_own_courses();
- $this->rootnodes['currentcourse']->mainnavonly = true;
- if ($enrolledinanycourse) {
- $this->rootnodes['mycourses']->isexpandable = true;
- if ($CFG->navshowallcourses) {
- // When we show all courses we need to show both the my courses and the regular courses branch.
- $this->rootnodes['courses']->isexpandable = true;
- }
- } else {
- $this->rootnodes['courses']->isexpandable = true;
- }
- if ($this->rootnodes['mycourses']->isactive) {
- $this->load_courses_enrolled();
- }
- $canviewcourseprofile = true;
- // Next load context specific content into the navigation
- switch ($this->page->context->contextlevel) {
- case CONTEXT_SYSTEM :
- // Nothing left to do here I feel.
- break;
- case CONTEXT_COURSECAT :
- // This is essential, we must load categories.
- $this->load_all_categories($this->page->context->instanceid, true);
- break;
- case CONTEXT_BLOCK :
- case CONTEXT_COURSE :
- if ($issite) {
- // Nothing left to do here.
- break;
- }
- // Load the course associated with the current page into the navigation.
- $coursenode = $this->add_course($course, false, self::COURSE_CURRENT);
- // If the course wasn't added then don't try going any further.
- if (!$coursenode) {
- $canviewcourseprofile = false;
- break;
- }
- // If the user is not enrolled then we only want to show the
- // course node and not populate it.
- // Not enrolled, can't view, and hasn't switched roles
- if (!can_access_course($course)) {
- if ($coursenode->isexpandable === true) {
- // Obviously the situation has changed, update the cache and adjust the node.
- // This occurs if the user access to a course has been revoked (one way or another) after
- // initially logging in for this session.
- $this->get_expand_course_cache()->set($course->id, 1);
- $coursenode->isexpandable = true;
- $coursenode->nodetype = self::NODETYPE_BRANCH;
- }
- // Very ugly hack - do not force "parents" to enrol into course their child is enrolled in,
- // this hack has been propagated from user/view.php to display the navigation node. (MDL-25805)
- if (!$this->current_user_is_parent_role()) {
- $coursenode->make_active();
- $canviewcourseprofile = false;
- break;
- }
- }
- if ($coursenode->isexpandable === false) {
- // Obviously the situation has changed, update the cache and adjust the node.
- // This occurs if the user has been granted access to a course (one way or another) after initially
- // logging in for this session.
- $this->get_expand_course_cache()->set($course->id, 1);
- $coursenode->isexpandable = true;
- $coursenode->nodetype = self::NODETYPE_BRANCH;
- }
- // Add the essentials such as reports etc...
- $this->add_course_essentials($coursenode, $course);
- // Extend course navigation with it's sections/activities
- $this->load_course_sections($course, $coursenode);
- if (!$coursenode->contains_active_node() && !$coursenode->search_for_active_node()) {
- $coursenode->make_active();
- }
- break;
- case CONTEXT_MODULE :
- if ($issite) {
- // If this is the site course then most information will have
- // already been loaded.
- // However we need to check if there is more content that can
- // yet be loaded for the specific module instance.
- $activitynode = $this->rootnodes['site']->find($this->page->cm->id, navigation_node::TYPE_ACTIVITY);
- if ($activitynode) {
- $this->load_activity($this->page->cm, $this->page->course, $activitynode);
- }
- break;
- }
- $course = $this->page->course;
- $cm = $this->page->cm;
- // Load the course associated with the page into the navigation
- $coursenode = $this->add_course($course, false, self::COURSE_CURRENT);
- // If the course wasn't added then don't try going any further.
- if (!$coursenode) {
- $canviewcourseprofile = false;
- break;
- }
- // If the user is not enrolled then we only want to show the
- // course node and not populate it.
- if (!can_access_course($course)) {
- $coursenode->make_active();
- $canviewcourseprofile = false;
- break;
- }
- $this->add_course_essentials($coursenode, $course);
- // Load the course sections into the page
- $this->load_course_sections($course, $coursenode, null, $cm);
- $activity = $coursenode->find($cm->id, navigation_node::TYPE_ACTIVITY);
- if (!empty($activity)) {
- // Finally load the cm specific navigaton information
- $this->load_activity($cm, $course, $activity);
- // Check if we have an active ndoe
- if (!$activity->contains_active_node() && !$activity->search_for_active_node()) {
- // And make the activity node active.
- $activity->make_active();
- }
- }
- break;
- case CONTEXT_USER :
- if ($issite) {
- // The users profile information etc is already loaded
- // for the front page.
- break;
- }
- $course = $this->page->course;
- // Load the course associated with the user into the navigation
- $coursenode = $this->add_course($course, false, self::COURSE_CURRENT);
- // If the course wasn't added then don't try going any further.
- if (!$coursenode) {
- $canviewcourseprofile = false;
- break;
- }
- // If the user is not enrolled then we only want to show the
- // course node and not populate it.
- if (!can_access_course($course)) {
- $coursenode->make_active();
- $canviewcourseprofile = false;
- break;
- }
- $this->add_course_essentials($coursenode, $course);
- $this->load_course_sections($course, $coursenode);
- break;
- }
- // Load for the current user
- $this->load_for_user();
- if ($this->page->context->contextlevel >= CONTEXT_COURSE && $this->page->context->instanceid != $SITE->id && $canviewcourseprofile) {
- $this->load_for_user(null, true);
- }
- // Load each extending user into the navigation.
- foreach ($this->extendforuser as $user) {
- if ($user->id != $USER->id) {
- $this->load_for_user($user);
- }
- }
- // Give the l…
Large files files are truncated, but you can click here to view the full file