Navbar class. More...

Inheritance diagram for navbar:

Public Member Functions
	__construct (moodle_page $page)
	The almighty constructor.

	__wakeup ()
	Resets the page specific information on this node if it is being unserialised.

	action ()
	Get the action url for this navigation node.

	action_link_actions ()
	Return an array consisting of the actions for the action link.

	actionattributes ()
	Return an array consisting of the additional attributes for the action url.

	add ($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, pix_icon $icon=null)
	Add a new breadcrumb_navigation_node to the navbar, overrides parent\add.

	add_attribute (string $name, string $value)
	Adds an HTML attribute to this node.

	add_class ($class)
	Adds a CSS class to this node.

	add_node (navigation_node $childnode, $beforekey=null)
	Adds a navigation node as a child of this one, given a $node object created using the create function.

	build_flat_navigation_list (flat_navigation $nodes, $showdivider=false, $label='')
	Walk the tree building up a list of all the flat navigation nodes.

	check_if_active ($strength=URL_MATCH_EXACT)
	Checks if this node is the active node.

	contains_active_node ()
	Checks if this node or any of its children contain the active node.

	find ($key, $type)
	Searches for a node of the given type with the given key.

	find_active_node ()
	Finds the active node.

	find_all_of_type ($type)
	Finds all nodes of a given type (recursive)

	find_expandable (array &$expandable)
	Finds all nodes that are expandable by AJAX.

	force_open ()
	Forces this node to be open and at the same time forces open all parents until the root node.

	get ($key, $type=null)
	Gets a navigation node.

	get_children_key_list ()
	Return a list of all the keys of all the child nodes.

	get_content ($shorttext=false)
	Gets the content for this node.

	get_css_type ()
	Gets the CSS class to add to this node to describe its type.

	get_items ()
	Returns an array of breadcrumb_navigation_nodes that make up the navbar.

	get_siblings ()
	Get a list of sibling navigation nodes at the same level as this one.

	get_tabs_array (array $inactive=array(), $return=false)
	Creates a tab representation of this nodes children that can be used with print_tabs to produce the tabs on a page.

	get_title ()
	Gets the title to use for this node.

	has_action ()
	Used to easily determine if this link in the breadcrumbs has a valid action/url.

	has_children ()
	Checks if this node has or could have any children.

	has_internal_action ()
	Used to easily determine if the action is an internal link.

	has_items ()
	Quick check to see if the navbar will have items in.

	has_siblings ()
	True if this nav node has siblings in the tree.

	hide (array $typestohide=null)
	Hides the node and any children it has.

	ignore_active ($setting=true)
	Turn on/off ignore active.

	is_action_link ()
	Check whether the node's action is of type action_link.

	is_hidden ()
	Used to easily determine if this link in the breadcrumbs is hidden.

	is_short_branch ()
	To better balance the admin tree, we want to group all the short top branches together.

	make_active ()
	Marks this node as active and forces it open.

	make_inactive ()
	Marks a node as inactive and recusised back to the base of the tree doing the same to all parents.

	prepend ($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, pix_icon $icon=null)
	Prepends a new navigation_node to the start of the navbar.

	remove ()
	Removes this node.

	remove_class ($class)
	Removes a CSS class from this node.

	search_for_active_node ($strength=URL_MATCH_BASE)
	Searches all children for the best matching active node.

	set_force_into_more_menu (bool $forceintomoremenu=false)
	Sets whether the node and its children should be added into a "more" menu whenever possible.

	set_parent (navigation_node $parent)
	Sets the parent for this node and if this node is active ensures that the tree is properly adjusted as well.

	set_show_in_secondary_navigation (bool $show=true)
	Sets whether the node and its children should be displayed in the "secondary" navigation when applicable.

	title (?string $title=null)
	Sets the title for this node and forces Moodle to utilise it.

	trim_if_empty ()
	Removes this node if it is empty.

Static Public Member Functions
static	create ($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, pix_icon $icon=null)
	Creates a navigation node, ready to add it as a child using add_node function.

static	override_active_url (moodle_url $url, $loadadmintree=false)
	This sets the URL that the URL of new nodes get compared to when locating the active node.

static	require_admin_tree ()
	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 Attributes
moodle_url action_link null	$action = null
	An action for the node (link)

array	$attributes = []
	An array of HTML attributes for the node.

array	$children = array()
	An array of child node objects.

array	$classes = array()
	An array of CSS classes for the node.

bool	$collapse = false
	If set to true the node will be collapsed by default.

bool	$display = true
	If set to false the node will not be displayed.

bool	$forceintomoremenu = false
	If set to true this node will be forced into a "more" menu whenever possible.

bool	$forceopen = false
	If set to true the node will be expanded by default.

bool	$forcetitle = false
	If set to true a title will be added to the action no matter what.

bool	$haschildren
	node that have children.

string	$helpbutton = null
	A string that can be used to build a help button.

bool	$hidden = false
	If set to true the node will be dimmed.

bool	$hideicon = false
	Override to not display the icon even if one is provided.

pix_icon	$icon = null
	The path to an icon to use for this node.

int	$id = null
	Parameter to aid the coder in tracking [optional].

mixed	$includesectionnum = false
	If set to an int, that section will be included even if it has no activities.

bool	$includesettingsbase = false
	A switch for whether we want to include the root node in the navbar.

bool	$isactive = false
	If set to true the node will be recognised as active.

bool	$isexpandable = false
	Set to true if we KNOW that this node can be expanded.

string int	$key = null
	The identifier for the node, used to retrieve the node.

bool	$mainnavonly = false
	If set to true the the navigation bar should ignore this node.

string	$moremenuid
	unique identifier.

int	$nodetype = self::NODETYPE_LEAF
	See NODETYPE_* constants defined for this class.

navigation_node	$parent = null
	A reference to the node parent, you should never set this directly you should always call set_parent.

bool	$preceedwithhr = false
	If set to true then an HR will be printed before the node.

bool	$requiresajaxloading = false
	does the node need to be loaded via ajax

string	$shorttext = null
	Short text to use if requested [optional].

bool	$showchildreninsubmenu = false
	If set to true the children of this node will be displayed within a submenu when applicable.

bool	$showinflatnavigation = false
	If set to true this node will be added to the "flat" navigation.

bool	$showinsecondarynavigation = true
	If set to true this node will be displayed in the "secondary" navigation when applicable.

string	$tab
	tab element ID.

string lang_string	$text = null
	The text to use for the node.

string	$title = null
	The title attribute for an action if one is defined.

int	$type = self::TYPE_UNKNOWN
	See TYPE_* constants defined for this class.

const	COURSE_CURRENT = 2
	var int Course the current user is currently viewing

const	COURSE_INDEX_PAGE = 'courseindexpage'
	var string The course index page navigation node

const	COURSE_MY = 1
	var int Course the current user is enrolled in but not viewing

const	COURSE_OTHER = 0
	var int Course the current user is not enrolled in

int const	NODETYPE_BRANCH = 1
	Used to identify this node a branch, happens with children 1.

int const	NODETYPE_LEAF = 0
	Used to identify this node a leaf (default) 0.

int const	TYPE_ACTIVITY = 40
	Activity node type, e.g.

int const	TYPE_CATEGORY = 10
	Category node type 10.

int const	TYPE_CONTAINER = 90
	Setting node type, used for containers of no importance 90.

int const	TYPE_COURSE = 20
	Course node type 20.

int const	TYPE_CUSTOM = 60
	A custom node type, default when adding without specifing type 60.

const	TYPE_MY_CATEGORY = 11
	var int Category displayed in MyHome navigation node

int const	TYPE_RESOURCE = 50
	Resource node type, e.g.

int const	TYPE_ROOTNODE = 0
	System node type 0.

int const	TYPE_SECTION = 30
	Course Structure node type 30.

int const	TYPE_SETTING = 70
	Setting node type, used only within settings nav 70.

int const	TYPE_SITE_ADMIN = 71
	site admin branch node type, used only within settings nav 71

int const	TYPE_SYSTEM = 1
	System node type 1.

null const	TYPE_UNKNOWN = null
	Unknown node type null.

int const	TYPE_USER = 80
	Setting node type, used only within settings nav 80.

Static Public Attributes
static bool	$autofindactive = true
	toogles auto matching of active node

Protected Member Functions
	add_context_locking_node (\navigation_node $node, context $context)
	Add the menu item to handle locking and unlocking of a conext.

Protected Attributes
null string	$content = null
	content of the navbar

bool	$duringinstall = false
	A switch to let us know if we are in the middle of an install.

bool	$hasitems = false
	A switch for whether the navbar has items.

bool	$ignoreactive = false
	A switch for whether to ignore the active navigation information.

bool	$initialised = false
	A switch for whether the navbar is initialised or not.

array	$items
	An array of navigation nodes for the navbar.

mixed	$keys = array()
	keys used to reference the nodes on the navbar

array	$namedtypes

moodle_page	$page
	object the moodle page that this navbar belongs to

breadcrumb_navigation_node[]	$prependchildren = array()
	$prependchildren

Static Protected Attributes
static moodle_url	$fullmeurl = null

static bool	$loadadmintree = false
	should we load full admin tree or rely on AJAX for performance reasons

Detailed Description

Navbar class.

This class is used to manage the navbar, which is initialised from the navigation object held by PAGE

Copyright: 2009 Sam Hemelryk

License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Constructor & Destructor Documentation

◆ __construct()

navbar::__construct ( moodle_page $page )

The almighty constructor.

Parameters

moodle_page $page

Member Function Documentation

◆ action()

navigation_node::action ( )

inherited

Get the action url for this navigation node.

Called from templates.

Since: Moodle 3.2

◆ action_link_actions()

navigation_node::action_link_actions ( )

inherited

Return an array consisting of the actions for the action link.

Return values

array Formatted array to parse in a template

◆ actionattributes()

navigation_node::actionattributes ( )

inherited

Return an array consisting of the additional attributes for the action url.

Return values

array Formatted array to parse in a template

◆ add()

navbar::add	(		$text,
			$action = null,
			$type = self::TYPE_CUSTOM,
			$shorttext = null,
			$key = null,
		pix_icon	$icon = null )

Add a new breadcrumb_navigation_node to the navbar, overrides parent\add.

This function overrides breadcrumb_navigation_node::add() so that we can change the way nodes get added to allow us to simply call add and have the node added to the end of the navbar

Parameters

string	$text
string \| moodle_url \| action_link	$action	An action to associate with this node.
int	$type	One of navigation_node\TYPE_*
string	$shorttext
string \| int	$key	A key to identify this node with. Key + type is unique to a parent.
pix_icon	$icon	An optional icon to use for this node.

Return values

navigation_node

Reimplemented from navigation_node.

◆ add_attribute()

navigation_node::add_attribute	(	string	$name,
		string	$value )

inherited

Adds an HTML attribute to this node.

Parameters

string	$name
string	$value

◆ add_class()

navigation_node::add_class ( $class )

inherited

Adds a CSS class to this node.

Parameters

string $class

Return values

bool

◆ add_context_locking_node()

navigation_node::add_context_locking_node	(	\navigation_node	$node,
		context	$context )

protectedinherited

Add the menu item to handle locking and unlocking of a conext.

Parameters

navigation_node	$node	Node to add
context	$context	The context to be locked

◆ add_node()

navigation_node::add_node	(	navigation_node	$childnode,
			$beforekey = null )

inherited

Adds a navigation node as a child of this one, given a $node object created using the create function.

Parameters

navigation_node	$childnode	Node to add
string	$beforekey

Return values

navigation_node The added node

◆ build_flat_navigation_list()

navigation_node::build_flat_navigation_list	(	flat_navigation	$nodes,
			$showdivider = false,
			$label = '' )

inherited

Walk the tree building up a list of all the flat navigation nodes.

Deprecated: since Moodle 4.0

Parameters

flat_navigation	$nodes	List of the found flat navigation nodes.
boolean	$showdivider	Show a divider before the first node.
string	$label	A label for the collection of navigation links.

◆ check_if_active()

navigation_node::check_if_active ( $strength = URL_MATCH_EXACT )

inherited

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.

Parameters

int $strength One of URL_MATCH_EXACT, URL_MATCH_PARAMS, or URL_MATCH_BASE

Return values

bool

◆ contains_active_node()

navigation_node::contains_active_node ( )

inherited

Checks if this node or any of its children contain the active node.

Recursive.

Return values

bool

◆ create()

static navigation_node::create	(		$text,
			$action = null,
			$type = self::TYPE_CUSTOM,
			$shorttext = null,
			$key = null,
		pix_icon	$icon = null )

staticinherited

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.)

Parameters

string	$text
moodle_url \| action_link	$action
int	$type
string	$shorttext
string \| int	$key
pix_icon	$icon

Return values

navigation_node

◆ find()

navigation_node::find	(		$key,
			$type )

inherited

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.

Parameters

int \| string	$key	The key of the node we are looking for
?int	$type	One of navigation_node\TYPE_*

Return values

navigation_node|false

Reimplemented in global_navigation.

◆ find_active_node()

navigation_node::find_active_node ( )

inherited

Finds the active node.

Searches this nodes children plus all of the children for the active node and returns it if found.

Recursive.

Return values

navigation_node|false

◆ find_all_of_type()

navigation_node::find_all_of_type ( $type )

inherited

Finds all nodes of a given type (recursive)

Parameters

int $type One of navigation_node\TYPE_*

Return values

array

◆ find_expandable()

navigation_node::find_expandable ( array & $expandable )

inherited

Finds all nodes that are expandable by AJAX.

Parameters

array $expandable An array by reference to populate with expandable nodes.

◆ force_open()

navigation_node::force_open ( )

inherited

Forces this node to be open and at the same time forces open all parents until the root node.

Recursive.

◆ get()

navbar::get	(		$key,
			$type = null )

Gets a navigation node.

Parameters

string \| int	$key	for referencing the navbar nodes
int	$type	breadcrumb_navigation_node\TYPE_*

Return values

breadcrumb_navigation_node|bool

Reimplemented from navigation_node.

◆ get_children_key_list()

navigation_node::get_children_key_list ( )

inherited

Return a list of all the keys of all the child nodes.

Return values

array the keys.

◆ get_content()

navigation_node::get_content ( $shorttext = false )

inherited

Gets the content for this node.

Parameters

bool $shorttext If true shorttext is used rather than the normal text

Return values

string

◆ get_css_type()

navigation_node::get_css_type ( )

inherited

Gets the CSS class to add to this node to describe its type.

Return values

string

◆ get_items()

navbar::get_items ( )

Returns an array of breadcrumb_navigation_nodes that make up the navbar.

Return values

array

◆ get_siblings()

navigation_node::get_siblings ( )

inherited

Get a list of sibling navigation nodes at the same level as this one.

Return values

bool|array of navigation_node

◆ get_tabs_array()

navigation_node::get_tabs_array	(	array	$inactive = array(),
			$return = false )

inherited

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());

Parameters

array	$inactive
bool	$return

Return values

array Array (tabs, selected, inactive, activated, return)

◆ get_title()

navigation_node::get_title ( )

inherited

Gets the title to use for this node.

Return values

string

◆ has_action()

navigation_node::has_action ( )

inherited

Used to easily determine if this link in the breadcrumbs has a valid action/url.

Return values

boolean

◆ has_children()

navigation_node::has_children ( )

inherited

Checks if this node has or could have any children.

Return values

bool	Returns true if it has children or could have (by AJAX expansion)

◆ has_internal_action()

navigation_node::has_internal_action ( )

inherited

Used to easily determine if the action is an internal link.

Return values

bool

◆ has_items()

navbar::has_items ( )

Quick check to see if the navbar will have items in.

Return values

bool	Returns true if the navbar will have items, false otherwise

◆ has_siblings()

navigation_node::has_siblings ( )

inherited

True if this nav node has siblings in the tree.

Return values

bool

◆ hide()

navigation_node::hide ( array $typestohide = null )

inherited

Hides the node and any children it has.

Since: Moodle 2.5

Parameters

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.

◆ ignore_active()

navbar::ignore_active ( $setting = true )

Turn on/off ignore active.

Parameters

bool $setting

◆ is_action_link()

navigation_node::is_action_link ( )

inherited

Check whether the node's action is of type action_link.

Return values

bool

◆ is_hidden()

navigation_node::is_hidden ( )

inherited

Used to easily determine if this link in the breadcrumbs is hidden.

Return values

boolean

◆ is_short_branch()

navigation_node::is_short_branch ( )

inherited

To better balance the admin tree, we want to group all the short top branches together.

This means < 8 nodes and no subtrees.

Return values

bool

◆ make_active()

navigation_node::make_active ( )

inherited

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 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.

◆ override_active_url()

static navigation_node::override_active_url	(	moodle_url	$url,
			$loadadmintree = false )

staticinherited

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.

Parameters

moodle_url	$url	The url to use for the fullmeurl.
bool	$loadadmintree	use true if the URL point to administration tree

◆ prepend()

navbar::prepend	(		$text,
			$action = null,
			$type = self::TYPE_CUSTOM,
			$shorttext = null,
			$key = null,
		pix_icon	$icon = null )

Prepends a new navigation_node to the start of the navbar.

Parameters

string	$text
string \| moodle_url \| action_link	$action	An action to associate with this node.
int	$type	One of navigation_node\TYPE_*
string	$shorttext
string \| int	$key	A key to identify this node with. Key + type is unique to a parent.
pix_icon	$icon	An optional icon to use for this node.

Return values

navigation_node

◆ remove()

navigation_node::remove ( )

inherited

Removes this node.

Return values

bool

◆ remove_class()

navigation_node::remove_class ( $class )

inherited

Removes a CSS class from this node.

Parameters

string $class

Return values

bool	True if the class was successfully removed.

◆ search_for_active_node()

navigation_node::search_for_active_node ( $strength = URL_MATCH_BASE )

inherited

Searches all children for the best matching active node.

Parameters

int $strength The url match to be made.

Return values

navigation_node|false

◆ set_force_into_more_menu()

navigation_node::set_force_into_more_menu ( bool $forceintomoremenu = false )

inherited

Sets whether the node and its children should be added into a "more" menu whenever possible.

Parameters

bool $forceintomoremenu

◆ set_parent()

navigation_node::set_parent ( navigation_node $parent )

inherited

Sets the parent for this node and if this node is active ensures that the tree is properly adjusted as well.

Parameters

navigation_node $parent

◆ set_show_in_secondary_navigation()

navigation_node::set_show_in_secondary_navigation ( bool $show = true )

inherited

Sets whether the node and its children should be displayed in the "secondary" navigation when applicable.

Parameters

bool $show

◆ title()

navigation_node::title ( ?string $title = null )

inherited

Sets the title for this node and forces Moodle to utilise it.

Note that this method is named identically to the public "title" property of the class, which unfortunately confuses our Mustache renderer, because it will see the method and try and call it without any arguments (hence must be nullable) before trying to access the public property

Parameters

string | null $title

Return values

string

Member Data Documentation

◆ $isexpandable

bool navigation_node::$isexpandable = false

inherited

Set to true if we KNOW that this node can be expanded.

◆ $namedtypes

array navigation_node::$namedtypes

protectedinherited

Initial value:

= array(0 => 'system', 10 => 'category', 20 => 'course', 30 => 'structure', 40 => 'activity',
                                  50 => 'resource', 60 => 'custom', 70 => 'setting', 71 => 'siteadmin', 80 => 'user',
                                  90 => 'container')

◆ TYPE_ACTIVITY

int const navigation_node::TYPE_ACTIVITY = 40

inherited

Activity node type, e.g.

Forum, Quiz 40

◆ TYPE_RESOURCE

int const navigation_node::TYPE_RESOURCE = 50

inherited

Resource node type, e.g.

Link to a file, or label 50

The documentation for this class was generated from the following file:

lib/navigationlib.php

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ action()

◆ action_link_actions()

◆ actionattributes()

◆ add()

◆ add_attribute()

◆ add_class()

◆ add_context_locking_node()

◆ add_node()

◆ build_flat_navigation_list()

◆ check_if_active()

◆ contains_active_node()

◆ create()

◆ find()

◆ find_active_node()

◆ find_all_of_type()

◆ find_expandable()

◆ force_open()

◆ get()

◆ get_children_key_list()

◆ get_content()

◆ get_css_type()

◆ get_items()

◆ get_siblings()

◆ get_tabs_array()

◆ get_title()

◆ has_action()

◆ has_children()

◆ has_internal_action()

◆ has_items()

◆ has_siblings()

◆ hide()

◆ ignore_active()

◆ is_action_link()

◆ is_hidden()

◆ is_short_branch()

◆ make_active()

◆ override_active_url()

◆ prepend()

◆ remove()

◆ remove_class()

◆ search_for_active_node()

◆ set_force_into_more_menu()

◆ set_parent()

◆ set_show_in_secondary_navigation()

◆ title()

Member Data Documentation

◆ $isexpandable

◆ $namedtypes

◆ TYPE_ACTIVITY

◆ TYPE_RESOURCE